Merge pull request Yelp#11 from dnephin/python3

Python3 support

Author: prat0318

.travis.yml

@@ -4,13 +4,15 @@ env:
   - TOX_ENV=py26
   - TOX_ENV=py27
   - TOX_ENV=py26-simplejson
+  - TOX_ENV=py33
+  - TOX_ENV=py34
   - TOX_ENV=docs
 
 install:
   - pip install tox coveralls
 
 script:
-  - make test
+  - tox -e $TOX_ENV
 
 after_success:
   - tox -e cover

setup.py

@@ -32,6 +32,7 @@
         'jsonschema',
         'PyYAML',
         'setuptools',
+        'six',
     ],
     license=about['__license__']
 )

swagger_spec_validator/__about__.py

@@ -7,7 +7,7 @@
 __summary__ = "Validation of Swagger specifications"
 __uri__ = "http://github.com/Yelp/swagger_spec_validator"
 
-__version__ = "1.0.9"
+__version__ = "1.0.10"
 
 __author__ = "John Billings"
 __email__ = "[email protected]"

swagger_spec_validator/common.py

@@ -1,3 +1,4 @@
+import contextlib
 import sys
 
 try:
@@ -7,6 +8,8 @@
 from jsonschema import RefResolver
 import jsonschema
 from pkg_resources import resource_filename
+import six
+from six.moves.urllib import request
 
 TIMEOUT_SEC = 1
 
@@ -16,7 +19,10 @@ def wrapper(*args, **kwargs):
         try:
             method(*args, **kwargs)
         except Exception as e:
-            raise SwaggerValidationError(str(e)), None, sys.exc_info()[2]
+            six.reraise(
+                SwaggerValidationError,
+                SwaggerValidationError(str(e)),
+                sys.exc_info()[2])
     return wrapper
 
 
@@ -34,6 +40,11 @@ def validate_json(json_document, schema_path):
     jsonschema.validate(json_document, schema, resolver=resolver)
 
 
+def load_json(url):
+    with contextlib.closing(request.urlopen(url, timeout=TIMEOUT_SEC)) as fh:
+        return json.loads(fh.read().decode('utf-8'))
+
+
 class SwaggerValidationError(Exception):
     """Exception raised in case of a validation error."""
     pass

swagger_spec_validator/util.py

@@ -1,10 +1,8 @@
 import logging
-import urllib2
 
 from swagger_spec_validator import validator12, validator20
 from swagger_spec_validator.common import (SwaggerValidationError,
-                                           TIMEOUT_SEC,
-                                           json,
+                                           load_json,
                                            wrap_exception)
 
 
@@ -48,6 +46,6 @@ def validate_spec_url(spec_url):
       For Swagger 1.2, this is the URL to the resource listing in api-docs.
       For Swagger 2.0, this is the URL to swagger.json in api-docs.
     """
-    spec_json = json.load(urllib2.urlopen(spec_url, timeout=TIMEOUT_SEC))
+    spec_json = load_json(spec_url)
     validator = get_validator(spec_json, spec_url)
     validator.validate_spec(spec_json, spec_url)

swagger_spec_validator/validator12.py

@@ -1,20 +1,21 @@
 # -*- coding: utf-8 -*-
+"""
+Validate Swagger Specs against the Swagger 1.2 Specification.  The
+validator aims to check for full compliance with the Specification.
 
-# Validate Swagger Specs against the Swagger 1.2 Specification.  The
-# validator aims to check for full compliance with the Specification.
-#
-# The validator uses the published jsonschema files for basic structural
-# validation, augmented with custom validation code where necessary.
-#
-# https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md
+The validator uses the published jsonschema files for basic structural
+validation, augmented with custom validation code where necessary.
+
+https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md
+"""
 import logging
 import os
-import urllib2
-from urlparse import urlparse
+
+import six
+from six.moves.urllib.parse import urlparse
 
 from swagger_spec_validator.common import (SwaggerValidationError,
-                                           TIMEOUT_SEC,
-                                           json,
+                                           load_json,
                                            validate_json,
                                            wrap_exception)
 
@@ -26,10 +27,7 @@
 
 def get_model_ids(api_declaration):
     models = api_declaration.get('models', {})
-    model_ids = []
-    for model in models.itervalues():
-        model_ids.append(model['id'])
-    return model_ids
+    return [model['id'] for model in six.itervalues(models)]
 
 
 def get_resource_path(url, resource):
@@ -72,8 +70,7 @@ def validate_spec_url(url):
     """
 
     log.info('Validating %s' % url)
-    resource_listing = json.load(urllib2.urlopen(url, timeout=TIMEOUT_SEC))
-    validate_spec(resource_listing, url)
+    validate_spec(load_json(url), url)
 
 
 def validate_spec(resource_listing, url):
@@ -95,8 +92,7 @@ def validate_spec(resource_listing, url):
     for api in resource_listing['apis']:
         path = get_resource_path(url, api['path'])
         log.info('Validating %s' % path)
-        api_declaration = json.load(urllib2.urlopen(path, timeout=TIMEOUT_SEC))
-        validate_api_declaration(api_declaration)
+        validate_api_declaration(load_json(path))
 
 
 def validate_data_type(obj, model_ids, allow_arrays=True, allow_voids=False,
@@ -163,7 +159,7 @@ def validate_model(model, model_name, model_ids):
                 'Model "%s": required property "%s" not found' %
                 (model_name, required))
 
-    for prop_name, prop in model.get('properties', {}).iteritems():
+    for prop_name, prop in six.iteritems(model.get('properties', {})):
         try:
             validate_data_type(prop, model_ids, allow_refs=True)
         except SwaggerValidationError as e:
@@ -219,7 +215,7 @@ def validate_api_declaration(api_declaration):
     for api in api_declaration['apis']:
         validate_api(api, model_ids)
 
-    for model_name, model in api_declaration.get('models', {}).iteritems():
+    for model_name, model in six.iteritems(api_declaration.get('models', {})):
         validate_model(model, model_name, model_ids)
 
 

swagger_spec_validator/validator20.py

@@ -1,10 +1,10 @@
 import logging
 import string
-import urllib2
+
+import six
 
 from swagger_spec_validator.common import (SwaggerValidationError,
-                                           TIMEOUT_SEC,
-                                           json,
+                                           load_json,
                                            validate_json,
                                            wrap_exception)
 
@@ -20,8 +20,7 @@ def validate_spec_url(spec_url):
     :raises: :py:class:`swagger_spec_validator.SwaggerValidationError`
     """
     log.info('Validating %s' % spec_url)
-    spec_json = json.load(urllib2.urlopen(spec_url, timeout=TIMEOUT_SEC))
-    validate_spec(spec_json)
+    validate_spec(load_json(spec_url))
 
 
 def validate_spec(spec_json, _spec_url=None):
@@ -52,7 +51,7 @@ def validate_apis(apis):
     :raises: :py:class:`swagger_spec_validator.SwaggerValidationError`
     :raises: :py:class:`jsonschema.exceptions.ValidationError`
     """
-    for api_name, api_body in apis.iteritems():
+    for api_name, api_body in six.iteritems(apis):
         api_params = api_body.get('parameters', [])
         validate_duplicate_param(api_params)
         for oper_name in api_body:

tests/validator12/run_test.py

@@ -1,3 +1,4 @@
+from __future__ import print_function
 import glob
 import json
 import os
@@ -21,7 +22,7 @@ def run_json_tests_with_func(json_test_paths, func):
         # e.g. "api_declarations/array_nested_fail.json"
         test_name = os.sep.join(json_test_path.split(os.sep)[-2:])
 
-        print 'Testing %s...' % test_name
+        print('Testing %s...' % test_name)
 
         if test_name.endswith('_pass.json'):
             func(test_data)

tests/validator12/validate_spec_test.py

@@ -1,4 +1,3 @@
-import json
 import os
 
 import mock
@@ -18,19 +17,17 @@
 
 
 def get_resource_listing():
-    return json.load(read_contents(RESOURCE_LISTING_FILE))
+    return read_contents(RESOURCE_LISTING_FILE)
 
 
 def test_http_success():
     mock_responses = make_mock_responses([API_DECLARATION_FILE])
 
-    with mock.patch('swagger_spec_validator.util.urllib2.urlopen',
-                    side_effect=mock_responses) as mock_urlopen:
+    with mock.patch('swagger_spec_validator.validator12.load_json',
+                    side_effect=mock_responses) as mock_load_json:
         validate_spec(get_resource_listing(), 'http://localhost/api-docs')
 
-        mock_urlopen.assert_has_calls([
-            mock.call('http://localhost/api-docs/foo', timeout=1),
-        ])
+        mock_load_json.assert_called_once_with('http://localhost/api-docs/foo')
 
 
 def test_file_uri_success():
@@ -39,7 +36,7 @@ def test_file_uri_success():
         validate_spec(get_resource_listing(),
                       'file://{0}'.format(RESOURCE_LISTING_FILE))
 
-        expected = json.load(read_contents(API_DECLARATION_FILE))
+        expected = read_contents(API_DECLARATION_FILE)
         mock_api.assert_called_once_with(expected)
 
 

tests/validator12/validate_spec_url_test.py

@@ -3,7 +3,6 @@
 
 import mock
 import pytest
-import StringIO
 
 from swagger_spec_validator.common import SwaggerValidationError
 from swagger_spec_validator.validator12 import validate_spec_url
@@ -14,8 +13,8 @@
 
 
 def read_contents(file_name):
-    with open(file_name) as f:
-        return StringIO.StringIO(f.read())
+    with open(file_name, 'r') as f:
+        return json.load(f)
 
 
 def make_mock_responses(file_names):
@@ -26,13 +25,13 @@ def test_http_success():
     mock_responses = make_mock_responses([RESOURCE_LISTING_FILE,
                                           API_DECLARATION_FILE])
 
-    with mock.patch('swagger_spec_validator.util.urllib2.urlopen',
-                    side_effect=mock_responses) as mock_urlopen:
+    with mock.patch('swagger_spec_validator.validator12.load_json',
+                    side_effect=mock_responses) as mock_load_json:
         validate_spec_url('http://localhost/api-docs')
 
-        mock_urlopen.assert_has_calls([
-            mock.call('http://localhost/api-docs', timeout=1),
-            mock.call('http://localhost/api-docs/foo', timeout=1),
+        mock_load_json.assert_has_calls([
+            mock.call('http://localhost/api-docs'),
+            mock.call('http://localhost/api-docs/foo'),
         ])
 
 
@@ -41,7 +40,7 @@ def test_file_uri_success():
     with mock.patch(mock_string) as mock_api:
         validate_spec_url('file://{0}'.format(RESOURCE_LISTING_FILE))
 
-        expected = json.load(read_contents(API_DECLARATION_FILE))
+        expected = read_contents(API_DECLARATION_FILE)
         mock_api.assert_called_once_with(expected)
 
 

tests/validator20/validate_rich_spec_test.py

@@ -16,8 +16,8 @@ def test_failure_on_duplicate_api_parameters(swagger_spec):
     swagger_spec['paths']['/pet']['parameters'] = [param1, param2]
     with pytest.raises(SwaggerValidationError) as exc_info:
         validate_spec(swagger_spec)
-    assert("Duplicate param found with (name, in): ('foo', 'query')"
-           in exc_info.value)
+    assert ("Duplicate param found with (name, in): ('foo', 'query')"
+            in str(exc_info.value))
 
 
 def test_failure_on_duplicate_operation_parameters(swagger_spec):
@@ -26,29 +26,30 @@ def test_failure_on_duplicate_operation_parameters(swagger_spec):
     swagger_spec['paths']['/pet']['post']['parameters'].extend([param1, param2])
     with pytest.raises(SwaggerValidationError) as exc_info:
         validate_spec(swagger_spec)
-    assert("Duplicate param found with (name, in): ('foo', 'query')"
-           in exc_info.value)
+    assert ("Duplicate param found with (name, in): ('foo', 'query')"
+            in str(exc_info.value))
 
 
 def test_failure_on_unresolvable_path_parameter(swagger_spec):
     swagger_spec['paths']['/pet/{foo}'] = swagger_spec['paths']['/pet']
     with pytest.raises(SwaggerValidationError) as exc_info:
         validate_spec(swagger_spec)
-    assert("Path Parameter used is not defined: foo" in exc_info.value)
+    assert "Path Parameter used is not defined: foo" in str(exc_info.value)
 
 
 def test_failure_on_path_parameter_used_but_not_defined(swagger_spec):
     swagger_spec['paths']['/user/{username}']['get']['parameters'][0]['name'] = '_'
     with pytest.raises(SwaggerValidationError) as exc_info:
         validate_spec(swagger_spec)
-    assert("Path Parameter used is not defined: username" in exc_info.value)
+    assert "Path Parameter used is not defined: username" in str(exc_info.value)
 
 
 def test_failure_on_unresolvable_ref_of_props_required_list(swagger_spec):
     swagger_spec['definitions']['Pet']['required'].append('bla')
     with pytest.raises(SwaggerValidationError) as exc_info:
         validate_spec(swagger_spec)
-    assert "Required list has properties not defined: ['bla']" in exc_info.value
+    assert ("Required list has properties not defined: ['bla']"
+            in str(exc_info.value))
 
 # TODO: validate definitions of references made by $ref, commented them for now.
 """

tests/validator20/validate_spec_url_test.py

@@ -1,19 +1,17 @@
+import json
 import mock
 import pytest
-import StringIO
 
 from swagger_spec_validator.common import SwaggerValidationError
 from swagger_spec_validator.validator20 import validate_spec_url
 
 
 def test_success(petstore_contents):
-    mock_responses = [StringIO.StringIO(petstore_contents)]
     with mock.patch(
-            'swagger_spec_validator.util.urllib2.urlopen',
-            side_effect=mock_responses) as mock_urlopen:
+            'swagger_spec_validator.validator20.load_json',
+            return_value=json.loads(petstore_contents)) as mock_load_json:
         validate_spec_url('http://localhost/api-docs')
-        mock_urlopen.assert_has_calls([
-            mock.call('http://localhost/api-docs', timeout=1)])
+        mock_load_json.assert_called_once_with('http://localhost/api-docs')
 
 
 def test_raise_SwaggerValidationError_on_urlopen_error():

tox.ini

@@ -1,8 +1,11 @@
 [tox]
-envlist = py26,py27,py26-simplejson
+envlist = py26,py27,py26-simplejson,py33,py34
 
 [testenv]
 deps =
+    # Pin a pre-release version of jsonschema with a fix for py3.x
+    # Remove this once jsonschema > 2.4.0 is released
+    git+https://github.com/Julian/jsonschema.git@168237288#egg=jsonschema
     flake8
     mock
     pytest