File: test_convert_request_body.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 (160 lines) | stat: -rw-r--r-- 3,795 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
""".convert_request_body() test suite."""

import pytest

import sphinxcontrib.openapi._lib2to3 as lib2to3


_MISSING = object()


@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"].get("requestBody", _MISSING)

    return _wrapper


def test_minimal(convert_request_body, oas_fragment):
    converted = convert_request_body(
        oas_fragment(
            """
            consumes:
              - application/json
            parameters:
              - in: body
                name: user
                schema:
                  $ref: '#/definitions/User'
            """
        ),
    )
    assert converted == oas_fragment(
        """
        content:
          application/json:
            schema:
              $ref: '#/definitions/User'
        """
    )


def test_complete(convert_request_body, oas_fragment):
    converted = convert_request_body(
        oas_fragment(
            """
            consumes:
              - application/json
            parameters:
              - description: user to add to the system
                in: body
                name: user
                required: true
                schema:
                  $ref: '#/definitions/User'
            """
        ),
    )
    assert converted == oas_fragment(
        """
        content:
          application/json:
            schema:
              $ref: '#/definitions/User'
        description: user to add to the system
        required: true
        """
    )


def test_no_consumes(convert_request_body, oas_fragment):
    converted = convert_request_body(
        oas_fragment(
            """
            parameters:
              - in: body
                name: user
                schema:
                  $ref: '#/definitions/User'
            """
        ),
    )
    assert converted == oas_fragment(
        """
        content:
          '*/*':
            schema:
              $ref: '#/definitions/User'
        """
    )


def test_header_path_query_are_ignored(convert_request_body, oas_fragment):
    converted = convert_request_body(
        oas_fragment(
            """
            parameters:
              - in: header
                name: token
                type: string
              - in: path
                name: username
                required: true
                type: string
              - in: query
                name: id
                type: string
            """
        ),
    )
    assert converted is _MISSING


def test_body_and_others(convert_request_body, oas_fragment):
    converted = convert_request_body(
        oas_fragment(
            """
            parameters:
              - in: header
                name: token
                type: string
              - in: path
                name: username
                required: true
                type: string
              - in: body
                name: user
                schema:
                  $ref: '#/definitions/User'
              - in: query
                name: id
                type: string
            """
        ),
    )
    assert converted == oas_fragment(
        """
        content:
          '*/*':
            schema:
              $ref: '#/definitions/User'
        """
    )