File: test_convert_parameter.py

package info (click to toggle)
sphinxcontrib-openapi 0.8.4-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 876 kB
  • sloc: python: 7,575; makefile: 15
file content (427 lines) | stat: -rw-r--r-- 9,033 bytes parent folder | download | duplicates (2)
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
""".convert_parameter() test suite."""

import pytest

import sphinxcontrib.openapi._lib2to3 as lib2to3


@pytest.fixture(scope="function")
def convert_parameter(oas_fragment):
    def _wrapper(parameter):
        oas2 = oas_fragment(
            """
            swagger: "2.0"
            info:
              title: An example spec
              version: "1.0"
            paths:
              /test:
                get:
                  responses:
                    '200':
                      description: a response description
            """
        )
        oas2["paths"]["/test"]["get"]["parameters"] = [parameter]

        oas3 = lib2to3.convert(oas2)
        return oas3["paths"]["/test"]["get"]["parameters"][0]

    return _wrapper


def test_in_header_complete(convert_parameter, oas_fragment):
    converted = convert_parameter(
        oas_fragment(
            """
            description: token to be passed as a header
            in: header
            items:
              format: int64
              type: integer
            name: token
            required: true
            type: array
            """
        )
    )
    assert converted == oas_fragment(
        """
        description: token to be passed as a header
        in: header
        name: token
        required: true
        schema:
          items:
            format: int64
            type: integer
          type: array
        """
    )


def test_in_path_complete(convert_parameter, oas_fragment):
    converted = convert_parameter(
        oas_fragment(
            """
            description: username to fetch
            in: path
            name: username
            required: true
            type: string
            """
        ),
    )
    assert converted == oas_fragment(
        """
        description: username to fetch
        in: path
        name: username
        required: true
        schema:
          type: string
        """
    )


def test_in_query_complete(convert_parameter, oas_fragment):
    converted = convert_parameter(
        oas_fragment(
            """
            description: ID of the object to fetch
            in: query
            items:
              type: string
            name: id
            required: false
            type: array
            """
        ),
    )
    assert converted == oas_fragment(
        """
        description: ID of the object to fetch
        in: query
        name: id
        required: false
        schema:
          items:
            type: string
          type: array
        """
    )


def test_in_header_minimal(convert_parameter, oas_fragment):
    converted = convert_parameter(
        oas_fragment(
            """
            in: header
            name: token
            type: string
            """
        ),
    )
    assert converted == oas_fragment(
        """
        in: header
        name: token
        schema:
          type: string
        """
    )


def test_in_path_minimal(convert_parameter, oas_fragment):
    converted = convert_parameter(
        oas_fragment(
            """
            in: path
            name: username
            required: true
            type: string
            """
        ),
    )
    assert converted == oas_fragment(
        """
        in: path
        name: username
        required: true
        schema:
          type: string
        """
    )


def test_in_query_minimal(convert_parameter, oas_fragment):
    converted = convert_parameter(
        oas_fragment(
            """
            in: query
            name: id
            type: string
            """
        ),
    )
    assert converted == oas_fragment(
        """
        in: query
        name: id
        schema:
          type: string
        """
    )


def test_collectionFormat_is_csv_path(convert_parameter, oas_fragment):
    converted = convert_parameter(
        oas_fragment(
            """
            collectionFormat: csv
            in: path
            items:
              type: string
            name: username
            required: true
            type: array
            """
        ),
    )
    assert converted == oas_fragment(
        """
        in: path
        name: username
        required: true
        schema:
          items:
            type: string
          type: array
        style: simple
        """
    )


def test_collectionFormat_is_csv_header(convert_parameter, oas_fragment):
    converted = convert_parameter(
        oas_fragment(
            """
            collectionFormat: csv
            in: header
            items:
              type: string
            name: username
            type: array
            """
        ),
    )
    assert converted == oas_fragment(
        """
        in: header
        name: username
        schema:
          items:
            type: string
          type: array
        style: simple
        """
    )


def test_collectionFormat_is_csv(convert_parameter, oas_fragment):
    converted = convert_parameter(
        oas_fragment(
            """
            collectionFormat: csv
            in: query
            items:
              type: string
            name: id
            type: array
            """
        ),
    )
    assert converted == oas_fragment(
        """
        explode: false
        in: query
        name: id
        schema:
          items:
            type: string
          type: array
        style: form
        """
    )


def test_collectionFormat_is_multi(convert_parameter, oas_fragment):
    converted = convert_parameter(
        oas_fragment(
            """
            collectionFormat: multi
            in: query
            items:
              type: string
            name: id
            type: array
            """
        ),
    )
    assert converted == oas_fragment(
        """
        explode: true
        in: query
        name: id
        schema:
          items:
            type: string
          type: array
        style: form
        """
    )


def test_collectionFormat_is_ssv(convert_parameter, oas_fragment):
    converted = convert_parameter(
        oas_fragment(
            """
            collectionFormat: ssv
            in: query
            items:
              type: string
            name: id
            type: array
            """
        ),
    )
    assert converted == oas_fragment(
        """
        in: query
        name: id
        schema:
          items:
            type: string
          type: array
        style: spaceDelimited
        """
    )


def test_collectionFormat_is_pipes(convert_parameter, oas_fragment):
    converted = convert_parameter(
        oas_fragment(
            """
            collectionFormat: pipes
            in: query
            items:
              type: string
            name: id
            type: array
            """
        ),
    )
    assert converted == oas_fragment(
        """
        in: query
        name: id
        schema:
          items:
            type: string
          type: array
        style: pipeDelimited
        """
    )


def test_collectionFormat_is_tsv(convert_parameter, oas_fragment):
    converted = convert_parameter(
        oas_fragment(
            """
            collectionFormat: tsv
            in: query
            items:
              type: string
            name: id
            type: array
            """
        ),
    )
    assert converted == oas_fragment(
        """
        in: query
        name: id
        schema:
          items:
            type: string
          type: array
        """
    )


def test_in_header_vendor_extensions(convert_parameter, oas_fragment):
    converted = convert_parameter(
        oas_fragment(
            """
            in: header
            name: token
            type: string
            x-vendor-ext: vendor-ext
            """
        ),
    )
    assert converted == oas_fragment(
        """
        in: header
        name: token
        schema:
          type: string
        x-vendor-ext: vendor-ext
        """
    )


def test_in_path_vendor_extensions(convert_parameter, oas_fragment):
    converted = convert_parameter(
        oas_fragment(
            """
            in: path
            name: username
            required: true
            type: string
            x-vendor-ext: vendor-ext
            """
        ),
    )
    assert converted == oas_fragment(
        """
        in: path
        name: username
        required: true
        schema:
          type: string
        x-vendor-ext: vendor-ext
        """
    )


def test_in_query_vendor_extensions(convert_parameter, oas_fragment):
    converted = convert_parameter(
        oas_fragment(
            """
            in: query
            name: id
            type: string
            x-vendor-ext: vendor-ext
            """
        ),
    )
    assert converted == oas_fragment(
        """
        in: query
        name: id
        schema:
          type: string
        x-vendor-ext: vendor-ext
        """
    )