1- # pylint:disable=wildcard-import
2- # pylint:disable=unused-import
31# pylint:disable=unused-variable
42# pylint:disable=unused-argument
53# pylint:disable=redefined-outer-name
1311import yaml
1412from openapi_spec_validator import validate_spec
1513from openapi_spec_validator .exceptions import OpenAPIValidationError
16-
17- from utils import (dump_specs , is_json_schema , is_openapi_schema ,
18- list_files_in_api_specs , load_specs , specs_folder )
14+ from utils import (
15+ dump_specs ,
16+ is_json_schema ,
17+ is_openapi_schema ,
18+ list_files_in_api_specs ,
19+ load_specs ,
20+ specs_folder ,
21+ )
1922
2023# Conventions
2124_REQUIRED_FIELDS = ["error" , "data" ]
2225CONVERTED_SUFFIX = "-converted.yaml"
2326_FAKE_SCHEMA_NAME = "FakeSchema"
2427
2528_FAKE_OPEN_API_HEADERS = {
26- "openapi" : "3.0.0" ,
27- "info" :{
28- "title" : "An include file to define sortable attributes" ,
29- "version" : "1.0.0"
30- },
31- "paths" : {},
32- "components" : {
33- "parameters" :{},
34- "schemas" :{}
35- }
36- }
29+ "openapi" : "3.0.0" ,
30+ "info" : {
31+ "title" : "An include file to define sortable attributes" ,
32+ "version" : "1.0.0" ,
33+ },
34+ "paths" : {},
35+ "components" : {"parameters" : {}, "schemas" : {}},
36+ }
37+
3738
3839def add_namespace_for_converted_schemas (schema_specs : dict ):
3940 # schemas converted from jsonschema do not have an overarching namespace.
4041 # the openapi validator does not like this
4142 # we use the jsonschema title to create a fake namespace
42- fake_schema_specs = {
43- _FAKE_SCHEMA_NAME : schema_specs
44- }
43+ fake_schema_specs = {_FAKE_SCHEMA_NAME : schema_specs }
4544 return fake_schema_specs
4645
46+
4747def change_references_to_schemas (filepath : Path , specs : dict ):
48- from os .path import relpath , isabs , join , abspath , exists
48+ from os .path import relpath , isabs , join , abspath , exists
4949
5050 filedir = filepath .parent
5151
@@ -54,36 +54,44 @@ def change_references_to_schemas(filepath: Path, specs: dict):
5454 # navigate specs
5555 change_references_to_schemas (filepath , value )
5656
57- elif key in ("allOf" , "oneOf" , "anyOf" ): # navigates allOf, oneOf, anyOf
57+ elif key in ("allOf" , "oneOf" , "anyOf" ): # navigates allOf, oneOf, anyOf
5858 for item in value :
5959 change_references_to_schemas (filepath , item )
6060
61- elif key == "$ref" :
61+ elif key == "$ref" :
6262 # Ensures value = "file_ref#section_ref"
6363 value = str (value )
64- if value .startswith ('#' ):
64+ if value .startswith ("#" ):
6565 value = str (filepath ) + value
66- elif '#' not in value :
66+ elif "#" not in value :
6767 value = value + "# "
6868
69-
7069 file_ref , section_ref = value .split ("#" )
7170
7271 if not isabs (file_ref ):
73- file_ref = str (filedir / file_ref )
72+ file_ref = str (filedir / file_ref )
7473
75- file_ref = abspath (file_ref ) # resolves
74+ file_ref = abspath (file_ref ) # resolves
7675 assert exists (file_ref ), file_ref
7776
78- if 'schemas' in file_ref : # reference to a schema file (i.e. inside a schemas folder)
79- if not section_ref .startswith ('/components/schemas/' ): # not updated!
80- section_ref = "/components/schemas/" + section_ref .lstrip ('/' ).strip ()
81- if file_ref .endswith (CONVERTED_SUFFIX ): # fake name used in converted schemas
77+ if (
78+ "schemas" in file_ref
79+ ): # reference to a schema file (i.e. inside a schemas folder)
80+ if not section_ref .startswith ("/components/schemas/" ): # not updated!
81+ section_ref = (
82+ "/components/schemas/" + section_ref .lstrip ("/" ).strip ()
83+ )
84+ if file_ref .endswith (
85+ CONVERTED_SUFFIX
86+ ): # fake name used in converted schemas
8287 section_ref += _FAKE_SCHEMA_NAME
8388
84- file_ref = "./" + relpath (file_ref , filedir ) if not filepath .samefile (file_ref ) else ""
85- specs [key ] = file_ref + "#" + section_ref
86-
89+ file_ref = (
90+ "./" + relpath (file_ref , filedir )
91+ if not filepath .samefile (file_ref )
92+ else ""
93+ )
94+ specs [key ] = file_ref + "#" + section_ref
8795
8896
8997@pytest .fixture ("session" )
@@ -98,20 +106,22 @@ def converted_specs_testdir(api_specs_dir, all_api_specs_tails, tmpdir_factory):
98106
99107 """
100108 basedir = api_specs_dir
101- testdir = Path ( tmpdir_factory .mktemp ("converted-specs" ) )
109+ testdir = Path (tmpdir_factory .mktemp ("converted-specs" ))
102110
103111 print (testdir )
104112
105113 for tail in all_api_specs_tails :
106114
107115 # directory with converted specs
108- os .makedirs (testdir / tail .parent , exist_ok = True )
116+ os .makedirs (testdir / tail .parent , exist_ok = True )
109117
110- specs = load_specs (basedir / tail )
118+ specs = load_specs (basedir / tail )
111119
112- if "schemas" in str (tail ) and \
113- not is_openapi_schema (specs ) and \
114- not is_json_schema (specs ):
120+ if (
121+ "schemas" in str (tail )
122+ and not is_openapi_schema (specs )
123+ and not is_json_schema (specs )
124+ ):
115125
116126 # convert to valid openapi
117127 if tail .name .endswith (CONVERTED_SUFFIX ):
@@ -121,16 +131,16 @@ def converted_specs_testdir(api_specs_dir, all_api_specs_tails, tmpdir_factory):
121131 new_specs ["components" ]["schemas" ] = specs
122132
123133 # change references
124- change_references_to_schemas (basedir / tail , new_specs )
125- dump_specs (new_specs , testdir / tail )
134+ change_references_to_schemas (basedir / tail , new_specs )
135+ dump_specs (new_specs , testdir / tail )
126136
127137 elif is_openapi_schema (specs ):
128138 new_specs = specs
129139 # change references
130- change_references_to_schemas (basedir / tail , new_specs )
131- dump_specs (new_specs , testdir / tail )
140+ change_references_to_schemas (basedir / tail , new_specs )
141+ dump_specs (new_specs , testdir / tail )
132142 else :
133- shutil .copy2 (basedir / tail , testdir / tail )
143+ shutil .copy2 (basedir / tail , testdir / tail )
134144
135145 return testdir
136146
0 commit comments