File: test_convert_responses.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,991 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_responses() test suite."""

import pytest

import sphinxcontrib.openapi._lib2to3 as lib2to3


@pytest.fixture(scope="function")
def convert_responses(oas_fragment):
    def _wrapper(responses, produces):
        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"]["responses"] = responses
        oas2["paths"]["/test"]["get"]["produces"] = produces

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

    return _wrapper


def test_minimal(convert_responses, oas_fragment):
    converted = convert_responses(
        oas_fragment(
            """
            '200':
              description: a response description
            """
        ),
        produces=["application/json"],
    )
    assert converted == oas_fragment(
        """
        '200':
          description: a response description
        """
    )


def test_complete(convert_responses, oas_fragment):
    converted = convert_responses(
        oas_fragment(
            """
            '200':
              description: a response description
              examples:
                application/json:
                  something: important
              headers:
                X-Test:
                  description: Is it a test?
                  type: string
              schema:
                items:
                  format: int32
                  type: integer
                type: array
            """
        ),
        produces=["application/json"],
    )
    assert converted == oas_fragment(
        """
        '200':
          description: a response description
          content:
            application/json:
              example:
                something: important
              schema:
                items:
                  format: int32
                  type: integer
                type: array
          headers:
            X-Test:
              description: Is it a test?
              schema:
                type: string
        """
    )


def test_multiple(convert_responses, oas_fragment):
    converted = convert_responses(
        oas_fragment(
            """
            '200':
              description: OK
              schema:
                items:
                  format: int32
                  type: integer
                type: array
            '400':
              description: Bad Request
              headers:
                X-Test:
                  description: Is it a test?
                  type: string
            default:
              description: Internal Server Error
            """
        ),
        produces=["application/json"],
    )
    assert converted == oas_fragment(
        """
        '200':
          content:
            application/json:
              schema:
                items:
                  format: int32
                  type: integer
                type: array
          description: OK
        '400':
          description: Bad Request
          headers:
            X-Test:
              description: Is it a test?
              schema:
                type: string
        default:
          description: Internal Server Error
        """
    )


def test_vendor_extensions(convert_responses, oas_fragment):
    converted = convert_responses(
        oas_fragment(
            """
            '200':
              description: a response description
            x-vendor-ext: vendor-ext
            """
        ),
        produces=["application/json"],
    )
    assert converted == oas_fragment(
        """
        '200':
          description: a response description
        x-vendor-ext: vendor-ext
        """
    )