forked from cebe/php-openapi
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathReaderTest.php
More file actions
148 lines (125 loc) · 5.15 KB
/
ReaderTest.php
File metadata and controls
148 lines (125 loc) · 5.15 KB
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
<?php
class ReaderTest extends \PHPUnit\Framework\TestCase
{
public function testReadJson()
{
$openapi = \cebe\openapi\Reader::readFromJson(<<<JSON
{
"openapi": "3.0.0",
"info": {
"title": "Test API",
"version": "1.0.0"
},
"paths": {
}
}
JSON
);
$this->assertApiContent($openapi);
}
public function testReadYaml()
{
$openapi = \cebe\openapi\Reader::readFromYaml(<<<YAML
openapi: 3.0.0
info:
title: "Test API"
version: "1.0.0"
paths:
/somepath:
YAML
);
$this->assertApiContent($openapi);
}
/**
* Test if reading YAML file with anchors works
*/
public function testReadYamlWithAnchors()
{
$openApiFile = __DIR__ . '/spec/data/traits-mixins.yaml';
$openapi = \cebe\openapi\Reader::readFromYamlFile($openApiFile);
$this->assertApiContent($openapi);
$putOperation = $openapi->paths['/foo']->put;
$this->assertEquals('create foo', $putOperation->description);
$this->assertTrue($putOperation->responses->hasResponse('200'));
$this->assertTrue($putOperation->responses->hasResponse('404'));
$this->assertTrue($putOperation->responses->hasResponse('428'));
$this->assertTrue($putOperation->responses->hasResponse('default'));
$respOk = $putOperation->responses->getResponse('200');
$this->assertEquals('request succeeded', $respOk->description);
$this->assertEquals('the request id', $respOk->headers['X-Request-Id']->description);
$resp404 = $putOperation->responses->getResponse('404');
$this->assertEquals('resource not found', $resp404->description);
$this->assertEquals('the request id', $resp404->headers['X-Request-Id']->description);
$resp428 = $putOperation->responses->getResponse('428');
$this->assertEquals('resource not found', $resp428->description);
$this->assertEquals('the request id', $resp428->headers['X-Request-Id']->description);
$respDefault = $putOperation->responses->getResponse('default');
$this->assertEquals('resource not found', $respDefault->description);
$this->assertEquals('the request id', $respDefault->headers['X-Request-Id']->description);
$foo = $openapi->components->schemas['Foo'];
$this->assertArrayHasKey('uuid', $foo->properties);
$this->assertArrayHasKey('name', $foo->properties);
$this->assertArrayHasKey('id', $foo->properties);
$this->assertArrayHasKey('description', $foo->properties);
$this->assertEquals('uuid of the resource', $foo->properties['uuid']->description);
}
private function assertApiContent(\cebe\openapi\spec\OpenApi $openapi)
{
$result = $openapi->validate();
$this->assertEquals([], $openapi->getErrors());
$this->assertTrue($result);
$this->assertEquals("3.0.0", $openapi->openapi);
$this->assertEquals("Test API", $openapi->info->title);
$this->assertEquals("1.0.0", $openapi->info->version);
}
/**
* @see https://github.com/symfony/symfony/issues/34805
*/
public function testSymfonyYamlBugHunt()
{
// skip test on symfony/yaml 5.0 due to bug https://github.com/symfony/symfony/issues/34805
$installed = json_decode(file_get_contents(__DIR__ . '/../vendor/composer/installed.json'), true);
// Check for composer 2.0 structure
if (array_key_exists('packages', $installed)) {
$installed = $installed['packages'];
}
foreach($installed as $pkg) {
if ($pkg['name'] === 'symfony/yaml' && version_compare($pkg['version'], 'v4.4', '>=')) {
$this->markTestSkipped(
'This test is incompatible with symfony/yaml 4.4 and 5.0, see symfony bug https://github.com/symfony/symfony/issues/34805'
);
}
}
$openApiFile = __DIR__ . '/../vendor/oai/openapi-specification/examples/v3.0/uspto.yaml';
$openapi = \cebe\openapi\Reader::readFromYamlFile($openApiFile);
$inlineYamlExample = $openapi->paths['/']->get->responses['200']->content['application/json']->example;
if (method_exists($this, 'assertIsArray')) {
$this->assertIsArray($inlineYamlExample);
} else {
$this->assertInternalType('array', $inlineYamlExample);
}
$expectedArray = json_decode(<<<JSON
{
"total": 2,
"apis": [
{
"apiKey": "oa_citations",
"apiVersionNumber": "v1",
"apiUrl": "https://developer.uspto.gov/ds-api/oa_citations/v1/fields",
"apiDocumentationUrl": "https://developer.uspto.gov/ds-api-docs/index.html?url=https://developer.uspto.gov/ds-api/swagger/docs/oa_citations.json"
},
{
"apiKey": "cancer_moonshot",
"apiVersionNumber": "v1",
"apiUrl": "https://developer.uspto.gov/ds-api/cancer_moonshot/v1/fields",
"apiDocumentationUrl": "https://developer.uspto.gov/ds-api-docs/index.html?url=https://developer.uspto.gov/ds-api/swagger/docs/cancer_moonshot.json"
}
]
}
JSON
, true);
$this->assertEquals($expectedArray, $inlineYamlExample);
}
// TODO test invalid JSON
// TODO test invalid YAML
}