Restructure project to add test support

* separated drf_swagger and testproj modules, moved both out of project root
* added testing support via pytest and tox
* enabled Travis CI
* integrated coverage & Coveralls
This commit is contained in:
Cristi Vîjdea
2017-12-02 22:46:07 +01:00
parent 207973ae5a
commit 2b0d80dc0f
44 changed files with 314 additions and 14 deletions
+30
View File
@@ -0,0 +1,30 @@
import pytest
from ruamel import yaml
from drf_swagger import openapi, codecs
from drf_swagger.generators import OpenAPISchemaGenerator
@pytest.fixture
def generator():
return OpenAPISchemaGenerator(
info=openapi.Info("Test generator", "v1"),
version="v2",
)
@pytest.fixture
def codec_json():
return codecs.OpenAPICodecJson(['flex', 'ssv'])
@pytest.fixture
def codec_yaml():
return codecs.OpenAPICodecYaml(['ssv', 'flex'])
@pytest.fixture
def swagger_dict():
swagger = generator().get_schema(None, True)
json_bytes = codec_yaml().encode(swagger)
return yaml.safe_load(json_bytes.decode('utf-8'))
+51
View File
@@ -0,0 +1,51 @@
import json
from ruamel import yaml
from drf_swagger import openapi, codecs
from drf_swagger.generators import OpenAPISchemaGenerator
import pytest
def validate_schema(swagger):
from flex.core import parse as validate_flex
from swagger_spec_validator.validator20 import validate_spec as validate_ssv
validate_flex(swagger)
validate_ssv(swagger)
def test_schema_generates_without_errors(generator):
generator.get_schema(None, True)
def test_schema_is_valid(generator, codec_yaml):
swagger = generator.get_schema(None, True)
codec_yaml.encode(swagger)
def test_invalid_schema_fails(codec_json):
bad_generator = OpenAPISchemaGenerator(
info=openapi.Info(
"Test generator", "v1",
contact=openapi.Contact(name=69, email=[])
),
version="v2",
)
swagger = bad_generator.get_schema(None, True)
with pytest.raises(codecs.SwaggerValidationError):
codec_json.encode(swagger)
def test_json_codec_roundtrip(codec_json, generator):
swagger = generator.get_schema(None, True)
json_bytes = codec_json.encode(swagger)
validate_schema(json.loads(json_bytes.decode('utf-8')))
def test_yaml_codec_roundtrip(codec_yaml, generator):
swagger = generator.get_schema(None, True)
json_bytes = codec_yaml.encode(swagger)
validate_schema(yaml.safe_load(json_bytes.decode('utf-8')))
+24
View File
@@ -0,0 +1,24 @@
def test_paths_not_empty(swagger_dict):
assert bool(swagger_dict['paths'])
def test_appropriate_status_codes(swagger_dict):
snippets_list = swagger_dict['paths']['/snippets/']
assert '200' in snippets_list['get']['responses']
assert '201' in snippets_list['post']['responses']
snippets_detail = swagger_dict['paths']['/snippets/{id}/']
assert '200' in snippets_detail['get']['responses']
assert '200' in snippets_detail['put']['responses']
assert '200' in snippets_detail['patch']['responses']
assert '204' in snippets_detail['delete']['responses']
def test_operation_docstrings(swagger_dict):
snippets_list = swagger_dict['paths']['/snippets/']
assert snippets_list['get']['description'] == "SnippetList classdoc"
assert snippets_list['post']['description'] == "post method docstring"
snippets_detail = swagger_dict['paths']['/snippets/{id}/']
assert snippets_detail['get']['description'] == "SnippetDetail classdoc"
assert snippets_detail['put']['description'] == "put class docstring"
assert snippets_detail['patch']['description'] == "patch method docstring"
assert snippets_detail['delete']['description'] == "delete method docstring"