1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
<?php
namespace MediaWiki\Tests\Rest\Handler;
use JsonSchemaAssertionTrait;
use MediaWiki\Config\ServiceOptions;
use MediaWiki\MainConfigNames;
use MediaWiki\Rest\BasicAccess\StaticBasicAuthorizer;
use MediaWiki\Rest\Handler\DiscoveryHandler;
use MediaWiki\Rest\Reporter\MWErrorReporter;
use MediaWiki\Rest\RequestData;
use MediaWiki\Rest\RequestInterface;
use MediaWiki\Rest\ResponseFactory;
use MediaWiki\Rest\Router;
use MediaWiki\Rest\Validator\Validator;
use MediaWikiIntegrationTestCase;
use PHPUnit\Framework\Assert;
use PHPUnit\Framework\Constraint\Constraint;
use Wikimedia\Message\ITextFormatter;
use Wikimedia\Message\MessageSpecifier;
/**
* @covers \MediaWiki\Rest\Handler\DiscoveryHandler
*
* @group Database
*/
class DiscoveryHandlerTest extends MediaWikiIntegrationTestCase {
use HandlerTestTrait;
use JsonSchemaAssertionTrait;
private function createRouter(
RequestInterface $request,
$specFile
): Router {
$services = $this->getServiceContainer();
$conf = $services->getMainConfig();
$authority = $this->mockRegisteredUltimateAuthority();
$authorizer = new StaticBasicAuthorizer();
$objectFactory = $services->getObjectFactory();
$restValidator = new Validator( $objectFactory,
$request,
$authority
);
$formatter = new class implements ITextFormatter {
public function getLangCode() {
return 'qqx';
}
public function format( MessageSpecifier $message ): string {
return $message->dump();
}
};
$responseFactory = new ResponseFactory( [ $formatter ] );
return ( new Router(
[ $specFile ],
[],
new ServiceOptions( Router::CONSTRUCTOR_OPTIONS, $conf ),
$services->getLocalServerObjectCache(),
$responseFactory,
$authorizer,
$authority,
$objectFactory,
$restValidator,
new MWErrorReporter(),
$services->getHookContainer(),
$this->getSession( true )
) );
}
private function newHandler() {
$config = $this->getServiceContainer()->getMainConfig();
return new DiscoveryHandler(
$config
);
}
private function assertWellFormedDiscoveryDoc( array $discovery ) {
$schemaFile = MW_INSTALL_PATH . '/docs/rest/discovery-1.0.json';
$this->assertMatchesJsonSchema( $schemaFile, $discovery, [
'https://www.mediawiki.org/schema/mwapi-1.0' => MW_INSTALL_PATH . '/docs/rest/mwapi-1.0.json',
'https://spec.openapis.org/oas/3.0/schema/2021-09-28' => __DIR__ . '/data/OpenApi-3.0.json',
] );
}
private static function assertContainsRecursive(
array $expected,
array $actual,
string $message = ''
) {
foreach ( $expected as $key => $value ) {
Assert::assertArrayHasKey( $key, $actual, $message );
if ( is_array( $value ) ) {
Assert::assertIsArray( $actual[$key], $message );
self::assertContainsRecursive( $value, $actual[$key], $message );
} elseif ( $value instanceof Constraint ) {
$value->evaluate( $actual[$key], $message );
} else {
Assert::assertSame( $value, $actual[$key], $message );
}
}
}
public function testGetInfoSpecSuccess() {
$this->overrideConfigValues( [
MainConfigNames::Sitename => 'Test Site',
MainConfigNames::RightsText => 'Test License',
MainConfigNames::RightsUrl => 'https://example.com/license',
MainConfigNames::EmergencyContact => 'test@example.com',
MainConfigNames::CanonicalServer => 'https://example.com:1234',
MainConfigNames::RestPath => '/api',
] );
$request = new RequestData( [] );
$router = $this->createRouter( $request, __DIR__ . '/SpecTestRoutes.json' );
$handler = $this->newHandler();
$response = $this->executeHandler(
$handler,
$request,
[],
[],
[],
[],
null,
null,
$router
);
$this->assertSame( 200, $response->getStatusCode() );
$this->assertArrayHasKey( 'Content-Type', $response->getHeaders() );
$this->assertSame( 'application/json', $response->getHeaderLine( 'Content-Type' ) );
$data = json_decode( (string)$response->getBody(), true );
$this->assertIsArray( $data, 'Body must be a JSON array' );
$this->assertWellFormedDiscoveryDoc( $data );
$expected = [
'info' => [
'title' => 'Test Site',
'contact' => [
'email' => 'test@example.com',
],
],
'servers' => [
[ 'url' => 'https://example.com:1234/api', ],
],
'modules' => [
'mock/v1' => [
'info' => [
'version' => '1.0',
'title' => 'test module',
],
'base' => 'https://example.com:1234/api/mock/v1',
'spec' => 'https://example.com:1234/api/specs/v0/module/mock%2Fv1',
],
],
];
self::assertContainsRecursive( $expected, $data );
}
}
|
