File: test_convert_request_body_formdata.py

package info (click to toggle)
sphinxcontrib-openapi 0.8.4-4
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 880 kB
  • sloc: python: 7,575; makefile: 23
file content (378 lines) | stat: -rw-r--r-- 9,421 bytes parent folder | download
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
""".convert_request_body() test suite."""

import pytest

import sphinxcontrib.openapi._lib2to3 as lib2to3


@pytest.fixture(scope="function")
def convert_request_body(oas_fragment):
    def _wrapper(operation_fragment):
        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"].update(operation_fragment)

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

    return _wrapper


def test_minimal(convert_request_body, oas_fragment):
    converted = convert_request_body(
        oas_fragment(
            """
            parameters:
              - in: formData
                name: user
                type: string
            """
        ),
    )
    assert converted == oas_fragment(
        """
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                user:
                  type: string
              type: object
        """
    )


def test_complete(convert_request_body, oas_fragment):
    converted = convert_request_body(
        oas_fragment(
            """
            parameters:
              - description: a name of the user
                in: formData
                name: user
                type: string
                required: true
            """
        ),
    )
    assert converted == oas_fragment(
        """
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                user:
                  description: a name of the user
                  type: string
              required: [user]
        """
    )


def test_complex_schema(convert_request_body, oas_fragment):
    converted = convert_request_body(
        oas_fragment(
            """
            parameters:
              - format: int32
                in: formData
                maximum: 100
                minimum: 5
                name: age
                type: integer
            """
        ),
    )
    assert converted == oas_fragment(
        """
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                age:
                  format: int32
                  maximum: 100
                  minimum: 5
                  type: integer
              type: object
        """
    )


def test_consumes_urlencoded(convert_request_body, oas_fragment):
    converted = convert_request_body(
        oas_fragment(
            """
            consumes:
              - application/x-www-form-urlencoded
            parameters:
              - description: a name of the user
                in: formData
                name: user
                type: string
            """
        ),
    )
    assert converted == oas_fragment(
        """
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                user:
                  description: a name of the user
                  type: string
              type: object
        """
    )


def test_consumes_form_data(convert_request_body, oas_fragment):
    converted = convert_request_body(
        oas_fragment(
            """
            consumes:
              - multipart/form-data
            parameters:
              - description: a name of the user
                in: formData
                name: user
                type: string
            """
        ),
    )
    assert converted == oas_fragment(
        """
        content:
          multipart/form-data:
            schema:
              properties:
                user:
                  description: a name of the user
                  type: string
              type: object
        """
    )


def test_consumes_urlencoded_and_form_data(convert_request_body, oas_fragment):
    converted = convert_request_body(
        oas_fragment(
            """
            consumes:
              - application/x-www-form-urlencoded
              - multipart/form-data
            parameters:
              - description: a name of the user
                in: formData
                name: user
                type: string
            """
        ),
    )
    assert converted == oas_fragment(
        """
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                user:
                  description: a name of the user
                  type: string
              type: object
          multipart/form-data:
            schema:
              properties:
                user:
                  description: a name of the user
                  type: string
              type: object
        """
    )


def test_required(convert_request_body, oas_fragment):
    converted = convert_request_body(
        oas_fragment(
            """
            parameters:
              - description: a name of the user
                in: formData
                name: user
                required: true
                type: string
            """
        ),
    )
    assert converted == oas_fragment(
        """
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                user:
                  description: a name of the user
                  type: string
              required:
                - user
              type: object
        """
    )


def test_multiple(convert_request_body, oas_fragment):
    converted = convert_request_body(
        oas_fragment(
            """
            parameters:
              - description: a name of the user
                in: formData
                name: user
                type: string
              - description: a status of the user
                in: formData
                name: status
                type: string
            """
        ),
    )
    assert converted == oas_fragment(
        """
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                status:
                  description: a status of the user
                  type: string
                user:
                  description: a name of the user
                  type: string
              type: object
        """
    )


def test_type_file_implicit_form_data(convert_request_body, oas_fragment):
    converted = convert_request_body(
        oas_fragment(
            """
            parameters:
              - description: a user pic
                in: formData
                name: userpic
                type: file
            """
        ),
    )
    assert converted == oas_fragment(
        """
        content:
          multipart/form-data:
            schema:
              properties:
                userpic:
                  description: a user pic
                  type: file
              type: object
        """
    )


def test_type_file_consumes_form_data(convert_request_body, oas_fragment):
    converted = convert_request_body(
        oas_fragment(
            """
            consumes:
              - multipart/form-data
            parameters:
              - description: a user pic
                in: formData
                name: userpic
                type: file
            """
        ),
    )
    assert converted == oas_fragment(
        """
        content:
          multipart/form-data:
            schema:
              properties:
                userpic:
                  description: a user pic
                  type: file
              type: object
        """
    )


def test_consumes_json_and_urlencoded(convert_request_body, oas_fragment):
    converted = convert_request_body(
        oas_fragment(
            """
            consumes:
              - application/json
              - application/x-www-form-urlencoded
            parameters:
              - description: a name of the user
                in: formData
                name: user
                type: string
            """
        ),
    )
    assert converted == oas_fragment(
        """
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                user:
                  description: a name of the user
                  type: string
              type: object
        """
    )


def test_consumes_json_and_form_data(convert_request_body, oas_fragment):
    converted = convert_request_body(
        oas_fragment(
            """
            consumes:
              - application/json
              - multipart/form-data
            parameters:
              - description: a name of the user
                in: formData
                name: user
                type: string
            """
        ),
    )
    assert converted == oas_fragment(
        """
        content:
          multipart/form-data:
            schema:
              properties:
                user:
                  description: a name of the user
                  type: string
              type: object
        """
    )