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
+32
View File
@@ -0,0 +1,32 @@
import os
class PytestTestRunner(object):
"""Runs pytest to discover and run tests."""
def __init__(self, verbosity=1, failfast=False, keepdb=False, **kwargs):
self.verbosity = verbosity
self.failfast = failfast
self.keepdb = keepdb
def run_tests(self, test_labels):
"""Run pytest and return the exitcode.
It translates some of Django's test command option to pytest's.
"""
import pytest
argv = []
if self.verbosity == 0:
argv.append('--quiet')
if self.verbosity == 2:
argv.append('--verbose')
if self.verbosity == 3:
argv.append('-vv')
if self.failfast:
argv.append('--exitfirst')
if self.keepdb:
argv.append('--reuse-db')
argv.extend(test_labels)
os.chdir('..')
return pytest.main(argv)
+4
View File
@@ -1,5 +1,7 @@
import os
import sys
# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
@@ -115,3 +117,5 @@ USE_TZ = True
# https://docs.djangoproject.com/en/1.11/howto/static-files/
STATIC_URL = '/static/'
TEST_RUNNER = 'testproj.runner.PytestTestRunner'
+91
View File
@@ -0,0 +1,91 @@
import json
from django.test import TestCase
from ruamel import yaml
from drf_swagger import openapi, codecs
from drf_swagger.generators import OpenAPISchemaGenerator
class SchemaGeneratorTest(TestCase):
def setUp(self):
self.generator = OpenAPISchemaGenerator(
info=openapi.Info("Test generator", "v1"),
version="v2",
)
self.codec_json = codecs.OpenAPICodecJson(['flex', 'ssv'])
self.codec_yaml = codecs.OpenAPICodecYaml(['ssv', 'flex'])
def _validate_schema(self, 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(self):
self.generator.get_schema(None, True)
def test_schema_is_valid(self):
swagger = self.generator.get_schema(None, True)
self.codec_yaml.encode(swagger)
def test_invalid_schema_fails(self):
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 self.assertRaises(codecs.SwaggerValidationError):
self.codec_json.encode(swagger)
def test_json_codec_roundtrip(self):
swagger = self.generator.get_schema(None, True)
json_bytes = self.codec_json.encode(swagger)
self._validate_schema(json.loads(json_bytes.decode('utf-8')))
def test_yaml_codec_roundtrip(self):
swagger = self.generator.get_schema(None, True)
json_bytes = self.codec_yaml.encode(swagger)
self._validate_schema(yaml.safe_load(json_bytes.decode('utf-8')))
class SchemaTest(TestCase):
def setUp(self):
self.generator = OpenAPISchemaGenerator(
info=openapi.Info("Test generator", "v1"),
version="v2",
)
self.codec_json = codecs.OpenAPICodecJson(['flex', 'ssv'])
self.codec_yaml = codecs.OpenAPICodecYaml(['ssv', 'flex'])
self.swagger = self.generator.get_schema(None, True)
json_bytes = self.codec_yaml.encode(self.swagger)
self.swagger_dict = yaml.safe_load(json_bytes.decode('utf-8'))
def test_paths_not_empty(self):
self.assertTrue(bool(self.swagger_dict['paths']))
def test_appropriate_status_codes(self):
snippets_list = self.swagger_dict['paths']['/snippets/']
self.assertTrue('200' in snippets_list['get']['responses'])
self.assertTrue('201' in snippets_list['post']['responses'])
snippets_detail = self.swagger_dict['paths']['/snippets/{id}/']
self.assertTrue('200' in snippets_detail['get']['responses'])
self.assertTrue('200' in snippets_detail['put']['responses'])
self.assertTrue('200' in snippets_detail['patch']['responses'])
self.assertTrue('204' in snippets_detail['delete']['responses'])
def test_operation_docstrings(self):
snippets_list = self.swagger_dict['paths']['/snippets/']
self.assertEqual(snippets_list['get']['description'], "SnippetList classdoc")
self.assertEqual(snippets_list['post']['description'], "post method docstring")
snippets_detail = self.swagger_dict['paths']['/snippets/{id}/']
self.assertEqual(snippets_detail['get']['description'], "SnippetDetail classdoc")
self.assertEqual(snippets_detail['put']['description'], "put class docstring")
self.assertEqual(snippets_detail['patch']['description'], "patch method docstring")
self.assertEqual(snippets_detail['delete']['description'], "delete method docstring")