/
test_resolving_parser.py
165 lines (122 loc) · 5.64 KB
/
test_resolving_parser.py
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
# -*- coding: utf-8 -*-
"""Test suite for prance.ResolvingParser ."""
__author__ = 'Jens Finkhaeuser'
__copyright__ = 'Copyright (c) 2016-2018 Jens Finkhaeuser'
__license__ = 'MIT +no-false-attribs'
__all__ = ()
import pytest
from unittest.mock import patch
from prance import ResolvingParser
from prance import ValidationError
from . import none_of
def mock_get_petstore(*args, **kwargs):
from .mock_response import MockResponse, PETSTORE_YAML
return MockResponse(text = PETSTORE_YAML)
@pytest.fixture
def petstore_parser():
return ResolvingParser('tests/specs/petstore.yaml')
@pytest.fixture
@patch('requests.get')
def with_externals_parser(mock_get):
mock_get.side_effect = mock_get_petstore
return ResolvingParser('tests/specs/with_externals.yaml')
@pytest.fixture
def petstore_parser_from_string():
yaml = None
with open('tests/specs/petstore.yaml', 'rb') as f:
x = f.read()
yaml = x.decode('utf8')
return ResolvingParser(spec_string = yaml)
@pytest.fixture
def issue_1_parser():
return ResolvingParser('tests/specs/issue_1.json')
@pytest.mark.skipif(none_of('openapi-spec-validator', 'swagger-spec-validator', 'flex'), reason='Missing backends')
def test_basics(petstore_parser):
assert petstore_parser.specification, 'No specs loaded!'
@pytest.mark.skipif(none_of('openapi-spec-validator', 'swagger-spec-validator', 'flex'), reason='Missing backends')
def test_petstore_resolve(petstore_parser):
assert petstore_parser.specification, 'No specs loaded!'
# The petstore references /definitions/Pet in /definitions/Pets, and uses
# /definitions/Pets in the 200 response to the /pets path. So let's check
# whether we can find something of /definitions/Pet there...
res = petstore_parser.specification['paths']['/pets']['get']['responses']
assert res['200']['schema']['type'] == 'array', 'Did not resolve right!'
@pytest.mark.skipif(none_of('openapi-spec-validator', 'swagger-spec-validator', 'flex'), reason='Missing backends')
def test_with_externals_resolve(with_externals_parser):
assert with_externals_parser.specification, 'No specs loaded!'
# The specs are a simplified version of the petstore example, with some
# external references.
# - Test that the list pets call returns the right thing from the external
# definitions.yaml
res = with_externals_parser.specification['paths']['/pets']['get']
res = res['responses']
assert res['200']['schema']['type'] == 'array'
# - Test that the get single pet call returns the right thing from the
# remote petstore definition
res = with_externals_parser.specification['paths']['/pets/{petId}']['get']
res = res['responses']
assert 'id' in res['200']['schema']['required']
# - Test that error responses contain a message from error.json
res = with_externals_parser.specification['paths']['/pets']['get']
res = res['responses']
assert 'message' in res['default']['schema']['required']
@pytest.mark.skipif(none_of('openapi-spec-validator', 'swagger-spec-validator', 'flex'), reason='Missing backends')
def test_relative_urls_from_string(petstore_parser_from_string):
# This must succeed
assert petstore_parser_from_string.yaml(), 'Did not get YAML representation of specs!'
@pytest.mark.skipif(none_of('openapi-spec-validator', 'swagger-spec-validator', 'flex'), reason='Missing backends')
def test_issue_1_relative_path_references(issue_1_parser):
# Must resolve references correctly
params = issue_1_parser.specification["paths"]["/test"]["parameters"]
assert 'id' in params[0]['schema']['required']
@pytest.mark.skipif(none_of('openapi-spec-validator'), reason='Missing backends')
def test_issue_39_sequence_indices():
# Must not fail to parse
parser = ResolvingParser('tests/specs/issue_39.yaml', backend = 'openapi-spec-validator')
# The /useCase path should have two values in its response example.
example = parser.specification['paths']['/useCase']['get']['responses']['200']['content']['application/json']['examples']['response']
assert 'value' in example
assert len(example['value']) == 2
# However, the /test path should have only one of the strings.
example = parser.specification['paths']['/test']['get']['responses']['200']['content']['application/json']['example']
assert example == 'some really long or specific string'
@pytest.mark.skipif(none_of('openapi-spec-validator'), reason='Missing backends')
def test_issue_51_encoding_error():
# Parsing used to throw - but shouldn't after heuristic change.
parser = ResolvingParser('tests/specs/issue_51/openapi-main.yaml',
lazy = True, backend = 'openapi-spec-validator',
strict = True)
parser.parse()
# Parsing with setting an explicit and wrong file encoding should raise
# an error, effectively reverting to the old behaviour
parser = ResolvingParser('tests/specs/issue_51/openapi-main.yaml',
lazy = True, backend = 'openapi-spec-validator',
strict = True,
encoding = 'iso-8859-2')
from yaml.reader import ReaderError
with pytest.raises(ReaderError):
parser.parse()
@pytest.mark.skipif(none_of('openapi-spec-validator'), reason='Missing backends')
def test_issue_65_partial_resolution_files():
specs = '''openapi: "3.0.0"
info:
title: ''
version: '1.0.0'
paths: {}
components:
schemas:
SampleArray:
type: array
items:
$ref: '#/components/schemas/ItemType'
ItemType:
type: integer
'''
from prance.util import resolver
parser = ResolvingParser(
spec_string = specs,
resolve_types = resolver.RESOLVE_FILES
)
from prance.util.path import path_get
val = path_get(parser.specification, ('components', 'schemas', 'SampleArray', 'items'))
assert '$ref' in val