python-openapi/openapi-core#296: Extend alises and adapt tests for OpenAPI 3.1

Author: nezhar

openapi_spec_validator/__init__.py

@@ -17,12 +17,17 @@
 __all__ = [
     'openapi_v2_spec_validator',
     'openapi_v3_spec_validator',
+    'openapi_v30_spec_validator',
     'openapi_v31_spec_validator',
     'validate_v2_spec',
     'validate_v3_spec',
+    'validate_v30_spec',
+    'validate_v31_spec',
     'validate_spec',
     'validate_v2_spec_url',
     'validate_v3_spec_url',
+    'validate_v30_spec_url',
+    'validate_v31_spec_url',
     'validate_spec_url',
 ]
 
@@ -47,13 +52,13 @@
 )
 
 # v3.0 spec
-schema_v3, schema_v3_url = get_openapi_schema('3.0')
-openapi_v3_validator_factory = Draft4JSONSpecValidatorFactory(
-    schema_v3, schema_v3_url,
+schema_v30, schema_v30_url = get_openapi_schema('3.0')
+openapi_v30_validator_factory = Draft4JSONSpecValidatorFactory(
+    schema_v30, schema_v30_url,
     resolver_handlers=default_handlers,
 )
-openapi_v3_spec_validator = SpecValidator(
-    openapi_v3_validator_factory,
+openapi_v30_spec_validator = SpecValidator(
+    openapi_v30_validator_factory,
     resolver_handlers=default_handlers,
 )
 
@@ -68,21 +73,27 @@
     resolver_handlers=default_handlers,
 )
 
-
 # shortcuts
 validate_v2_spec = validate_spec_factory(openapi_v2_spec_validator.validate)
 validate_v2_spec_url = validate_spec_url_factory(
     openapi_v2_spec_validator.validate, default_handlers)
 
-validate_v3_spec = validate_spec_factory(openapi_v3_spec_validator.validate)
-validate_v3_spec_url = validate_spec_url_factory(
-    openapi_v3_spec_validator.validate, default_handlers)
+validate_v30_spec = validate_spec_factory(openapi_v30_spec_validator.validate)
+validate_v30_spec_url = validate_spec_url_factory(
+    openapi_v30_spec_validator.validate, default_handlers)
 
 
 validate_v31_spec = validate_spec_factory(openapi_v31_spec_validator.validate)
 validate_v31_spec_url = validate_spec_url_factory(
     openapi_v31_spec_validator.validate, default_handlers)
 
+# aliases to the latest v3 version
+schema_v3 = schema_v31
+schema_v3_url = schema_v31_url
+openapi_v3_validator_factory = openapi_v31_validator_factory
+openapi_v3_spec_validator = openapi_v31_spec_validator
+validate_v3_spec = validate_v31_spec
+validate_v3_spec_url = validate_v31_spec_url
 
 # aliases to the latest version
 validate_spec = validate_v3_spec

openapi_spec_validator/__main__.py

@@ -5,7 +5,9 @@
 from jsonschema.exceptions import best_match
 
 from openapi_spec_validator import (
-    openapi_v2_spec_validator, openapi_v3_spec_validator,
+    openapi_v2_spec_validator,
+    openapi_v30_spec_validator,
+    openapi_v31_spec_validator,
 )
 from openapi_spec_validator.exceptions import ValidationError
 from openapi_spec_validator.readers import read_from_stdin, read_from_filename
@@ -50,10 +52,10 @@ def main(args=None):
     )
     parser.add_argument(
         '--schema',
-        help="OpenAPI schema (default: 3.0.0)",
+        help="OpenAPI schema (default: 3.1.0)",
         type=str,
-        choices=['2.0', '3.0.0'],
-        default='3.0.0'
+        choices=['2.0', '3.0.0', '3.1.0'],
+        default='3.1.0'
     )
     args = parser.parse_args(args)
 
@@ -72,7 +74,8 @@ def main(args=None):
     # choose the validator
     validators = {
         '2.0': openapi_v2_spec_validator,
-        '3.0.0': openapi_v3_spec_validator,
+        '3.0.0': openapi_v30_spec_validator,
+        '3.1.0': openapi_v31_spec_validator,
     }
     validator = validators[args.schema]
 

tests/integration/conftest.py

@@ -5,8 +5,8 @@
 from urllib.parse import urlunparse
 from yaml import safe_load
 
-from openapi_spec_validator import (openapi_v3_spec_validator,
-                                    openapi_v2_spec_validator,
+from openapi_spec_validator import (openapi_v2_spec_validator,
+                                    openapi_v30_spec_validator,
                                     openapi_v31_spec_validator)
 from openapi_spec_validator.schemas import read_yaml_file
 
@@ -43,15 +43,15 @@ def factory():
 
 
 @pytest.fixture
-def validator():
-    return openapi_v3_spec_validator
+def validator_v2():
+    return openapi_v2_spec_validator
 
 
 @pytest.fixture
-def validator_v31():
-    return openapi_v31_spec_validator
+def validator_v30():
+    return openapi_v30_spec_validator
 
 
 @pytest.fixture
-def swagger_validator():
-    return openapi_v2_spec_validator
+def validator_v31():
+    return openapi_v31_spec_validator

tests/integration/data/v3.1/petstore.yaml

@@ -0,0 +1,112 @@
+openapi: "3.1.0"
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  license:
+    name: MIT License
+    identifier: MIT
+servers:
+  - url: http://petstore.swagger.io/v1
+paths:
+  /pets:
+    get:
+      summary: List all pets
+      operationId: listPets
+      tags:
+        - pets
+      parameters:
+        - name: limit
+          in: query
+          description: How many items to return at one time (max 100)
+          required: false
+          schema:
+            type: integer
+            format: int32
+      responses:
+        200:
+          description: An paged array of pets
+          headers:
+            x-next:
+              description: A link to the next page of responses
+              schema:
+                type: string
+          content:
+            application/json:    
+              schema:
+                $ref: "#/components/schemas/Pets"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+    post:
+      summary: Create a pet
+      operationId: createPets
+      tags:
+        - pets
+      responses:
+        '201':
+          description: Null response
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+  /pets/{petId}:
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      tags:
+        - pets
+      parameters:
+        - name: petId
+          in: path
+          required: true
+          description: The id of the pet to retrieve
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Expected response to a valid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Pets"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+components:
+  schemas:
+    Pet:
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string
+        $ref:
+          type: string
+    Pets:
+      type: array
+      items:
+        $ref: "#/components/schemas/Pet"
+    Error:
+      required:
+        - code
+        - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string

tests/integration/test_main.py

@@ -7,13 +7,20 @@
 
 
 def test_schema_default():
-    """Test default schema is 3.0.0"""
-    testargs = ['./tests/integration/data/v3.0/petstore.yaml']
+    """Test default schema is 3.1.0"""
+    testargs = ['./tests/integration/data/v3.1/petstore.yaml']
     main(testargs)
 
 
-def test_schema_v3():
-    """No errors when calling proper v3 file."""
+def test_schema_v31():
+    """No errors when calling proper v3.1 file."""
+    testargs = ['--schema', '3.1.0',
+                './tests/integration/data/v3.1/petstore.yaml']
+    main(testargs)
+
+
+def test_schema_v30():
+    """No errors when calling proper v3.0 file."""
     testargs = ['--schema', '3.0.0',
                 './tests/integration/data/v3.0/petstore.yaml']
     main(testargs)
@@ -28,7 +35,10 @@ def test_schema_v2():
 
 def test_errors_on_missing_description_best(capsys):
     """An error is obviously printed given an empty schema."""
-    testargs = ['./tests/integration/data/v3.0/missing-description.yaml']
+    testargs = [
+        './tests/integration/data/v3.0/missing-description.yaml',
+        '--schema=3.0.0'
+    ]
     with pytest.raises(SystemExit):
         main(testargs)
     out, err = capsys.readouterr()
@@ -42,7 +52,8 @@ def test_errors_on_missing_description_full(capsys):
     """An error is obviously printed given an empty schema."""
     testargs = [
         "./tests/integration/data/v3.0/missing-description.yaml",
-        "--errors=all"
+        "--errors=all",
+        "--schema=3.0.0",
     ]
     with pytest.raises(SystemExit):
         main(testargs)
@@ -70,7 +81,7 @@ def test_validation_error():
 
 
 @mock.patch(
-    'openapi_spec_validator.__main__.openapi_v3_spec_validator.validate',
+    'openapi_spec_validator.__main__.openapi_v30_spec_validator.validate',
     side_effect=Exception,
 )
 def test_unknown_error(m_validate):
@@ -95,6 +106,6 @@ def test_schema_stdin():
         spec_lines = spec_file.readlines()
     spec_io = StringIO("".join(spec_lines))
 
-    testargs = ['-']
+    testargs = ['--schema', '3.0.0', '-']
     with mock.patch('openapi_spec_validator.__main__.sys.stdin', spec_io):
         main(testargs)

tests/integration/test_shortcuts.py

@@ -1,10 +1,10 @@
 import pytest
 
 from openapi_spec_validator import (
-    validate_spec, validate_spec_url,
     validate_v2_spec, validate_v2_spec_url,
     validate_spec_url_factory,
-    openapi_v2_spec_validator, openapi_v3_spec_validator,
+    openapi_v2_spec_validator, openapi_v30_spec_validator,
+    validate_v30_spec_url, validate_v30_spec,
 )
 from openapi_spec_validator.exceptions import OpenAPIValidationError
 from openapi_spec_validator.handlers.urllib import UrllibHandler
@@ -26,14 +26,14 @@ def test_failed(self, spec):
 class BaseTestValidValidteSpec:
 
     def test_valid(self, spec):
-        validate_spec(spec)
+        validate_v30_spec(spec)
 
 
 class BaseTestFaliedValidateSpec:
 
     def test_failed(self, spec):
         with pytest.raises(OpenAPIValidationError):
-            validate_spec(spec)
+            validate_v30_spec(spec)
 
 
 class BaseTestValidValidateSpecUrl:
@@ -70,15 +70,15 @@ def test_failed(self, spec_url):
             validate_v2_spec_url(spec_url)
 
 
-class BaseTestValidValidateV3SpecUrl(BaseTestValidValidateSpecUrl):
+class BaseTestValidValidateV30SpecUrl(BaseTestValidValidateSpecUrl):
 
     @pytest.fixture
     def validate_spec_url_callable(self, urllib_handlers):
         return validate_spec_url_factory(
-            openapi_v3_spec_validator.validate, urllib_handlers)
+            openapi_v30_spec_validator.validate, urllib_handlers)
 
     def test_default_valid(self, spec_url):
-        validate_spec_url(spec_url)
+        validate_v30_spec_url(spec_url)
 
     def test_urllib_valid(self, validate_spec_url_callable, spec_url):
         validate_spec_url_callable(spec_url)
@@ -88,7 +88,7 @@ class BaseTestFaliedValidateSpecUrl:
 
     def test_failed(self, spec_url):
         with pytest.raises(OpenAPIValidationError):
-            validate_spec_url(spec_url)
+            validate_v30_spec_url(spec_url)
 
 
 class TestLocalEmptyExample(BaseTestFaliedValidateSpec):
@@ -145,7 +145,7 @@ def spec_url(self):
         )
 
 
-class TestPetstoreExample(BaseTestValidValidateV3SpecUrl):
+class TestPetstoreExample(BaseTestValidValidateV30SpecUrl):
 
     @pytest.fixture
     def spec_url(self):
@@ -156,7 +156,7 @@ def spec_url(self):
         )
 
 
-class TestApiWithExample(BaseTestValidValidateV3SpecUrl):
+class TestApiWithExample(BaseTestValidValidateV30SpecUrl):
 
     @pytest.fixture
     def spec_url(self):
@@ -167,7 +167,7 @@ def spec_url(self):
         )
 
 
-class TestPetstoreExpandedExample(BaseTestValidValidateV3SpecUrl):
+class TestPetstoreExpandedExample(BaseTestValidValidateV30SpecUrl):
 
     @pytest.fixture
     def spec_url(self):