forked from cebe/php-openapi
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathParameterTest.php
More file actions
238 lines (208 loc) · 7.18 KB
/
Copy pathParameterTest.php
File metadata and controls
238 lines (208 loc) · 7.18 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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
<?php
use cebe\openapi\Reader;
use cebe\openapi\spec\Parameter;
/**
* @covers \cebe\openapi\spec\Parameter
*/
class ParameterTest extends \PHPUnit\Framework\TestCase
{
public function testRead()
{
/** @var $parameter Parameter */
$parameter = Reader::readFromYaml(<<<'YAML'
name: token
in: header
description: token to be passed as a header
required: true
schema:
type: array
items:
type: integer
format: int64
style: simple
YAML
, Parameter::class);
$result = $parameter->validate();
$this->assertEquals([], $parameter->getErrors());
$this->assertTrue($result);
$this->assertEquals('token', $parameter->name);
$this->assertEquals('header', $parameter->in);
$this->assertEquals('token to be passed as a header', $parameter->description);
$this->assertTrue($parameter->required);
$this->assertInstanceOf(\cebe\openapi\spec\Schema::class, $parameter->schema);
$this->assertEquals('array', $parameter->schema->type);
$this->assertEquals('simple', $parameter->style);
/** @var $parameter Parameter */
$parameter = Reader::readFromYaml(<<<'YAML'
in: query
name: coordinates
content:
application/json:
schema:
type: object
required:
- lat
- long
properties:
lat:
type: number
long:
type: number
YAML
, Parameter::class);
$result = $parameter->validate();
$this->assertEquals([], $parameter->getErrors());
$this->assertTrue($result);
$this->assertEquals('coordinates', $parameter->name);
$this->assertEquals('query', $parameter->in);
// required default value is false.
$this->assertFalse($parameter->required);
// deprecated default value is false.
$this->assertFalse($parameter->deprecated);
// allowEmptyValue default value is false.
$this->assertFalse($parameter->allowEmptyValue);
$this->assertInstanceOf(\cebe\openapi\spec\MediaType::class, $parameter->content['application/json']);
$this->assertInstanceOf(\cebe\openapi\spec\Schema::class, $parameter->content['application/json']->schema);
}
public function testDefaultValuesQuery()
{
/** @var $parameter Parameter */
$parameter = Reader::readFromYaml(<<<'YAML'
name: token
in: query
YAML
, Parameter::class);
$result = $parameter->validate();
$this->assertEquals([], $parameter->getErrors());
$this->assertTrue($result);
// default value for style parameter in query param
$this->assertEquals('form', $parameter->style);
$this->assertTrue($parameter->explode);
$this->assertFalse($parameter->allowReserved);
}
public function testDefaultValuesPath()
{
/** @var $parameter Parameter */
$parameter = Reader::readFromYaml(<<<'YAML'
name: token
in: path
required: true
YAML
, Parameter::class);
$result = $parameter->validate();
$this->assertEquals([], $parameter->getErrors());
$this->assertTrue($result);
// default value for style parameter in query param
$this->assertEquals('simple', $parameter->style);
$this->assertFalse($parameter->explode);
}
public function testDefaultValuesHeader()
{
/** @var $parameter Parameter */
$parameter = Reader::readFromYaml(<<<'YAML'
name: token
in: header
YAML
, Parameter::class);
$result = $parameter->validate();
$this->assertEquals([], $parameter->getErrors());
$this->assertTrue($result);
// default value for style parameter in query param
$this->assertEquals('simple', $parameter->style);
$this->assertFalse($parameter->explode);
}
public function testDefaultValuesCookie()
{
/** @var $parameter Parameter */
$parameter = Reader::readFromYaml(<<<'YAML'
name: token
in: cookie
YAML
, Parameter::class);
$result = $parameter->validate();
$this->assertEquals([], $parameter->getErrors());
$this->assertTrue($result);
// default value for style parameter in query param
$this->assertEquals('form', $parameter->style);
$this->assertTrue($parameter->explode);
}
public function testItValidatesSchemaAndContentCombination()
{
/** @var $parameter Parameter */
$parameter = Reader::readFromYaml(<<<'YAML'
name: token
in: cookie
schema:
type: object
content:
application/json:
schema:
type: object
YAML
, Parameter::class);
$result = $parameter->validate();
$this->assertEquals(['A Parameter Object MUST contain either a schema property, or a content property, but not both.'], $parameter->getErrors());
$this->assertFalse($result);
}
public function testItValidatesContentCanHaveOnlySingleKey()
{
/** @var $parameter Parameter */
$parameter = Reader::readFromYaml(<<<'YAML'
name: token
in: cookie
content:
application/json:
schema:
type: object
application/xml:
schema:
type: object
YAML
, Parameter::class);
$result = $parameter->validate();
$this->assertEquals(['A Parameter Object with Content property MUST have A SINGLE content type.'], $parameter->getErrors());
$this->assertFalse($result);
}
public function testItValidatesSupportedSerializationStyles()
{
// 1. Prepare test inputs
$specTemplate = <<<YAML
name: token
required: true
in: %s
style: %s
YAML;
$goodCombinations = [
'path' => ['simple', 'label', 'matrix'],
'query' => ['form', 'spaceDelimited', 'pipeDelimited', 'deepObject'],
'header' => ['simple'],
'cookie' => ['form'],
];
$badCombinations = [
'path' => ['unknown', 'form', 'spaceDelimited', 'pipeDelimited', 'deepObject'],
'query' => ['unknown', 'simple', 'label', 'matrix'],
'header' => ['unknown', 'form', 'spaceDelimited', 'pipeDelimited', 'deepObject', 'matrix'],
'cookie' => ['unknown', 'spaceDelimited', 'pipeDelimited', 'deepObject', 'matrix', 'label', 'matrix'],
];
// 2. Run tests for valid input
foreach($goodCombinations as $in=>$styles) {
foreach($styles as $style) {
/** @var $parameter Parameter */
$parameter = Reader::readFromYaml(sprintf($specTemplate, $in, $style) , Parameter::class);
$result = $parameter->validate();
$this->assertEquals([], $parameter->getErrors());
$this->assertTrue($result);
}
}
// 2. Run tests for invalid input
foreach($badCombinations as $in=>$styles) {
foreach($styles as $style) {
/** @var $parameter Parameter */
$parameter = Reader::readFromYaml(sprintf($specTemplate, $in, $style) , Parameter::class);
$result = $parameter->validate();
$this->assertEquals(['A Parameter Object DOES NOT support this serialization style.'], $parameter->getErrors());
$this->assertFalse($result);
}
}
}
}