Merge pull request #4 from p1c2u/feature/separate-spec-files-test

Separate spec files

Author: p1c2u

README.md

@@ -23,7 +23,16 @@ Validate spec:
 
 from openapi_spec_validator import validate_spec
 
-validate_spec(spec)
+validate_spec(spec_dict)
+```
+
+Add `spec_url` to validate spec with relative files:
+
+```python
+
+from openapi_spec_validator import validate_spec
+
+validate_spec(spec_dict,spec_url='file:///path/to/spec/openapi.yaml')
 ```
 
 You can also validate spec from url:

openapi_spec_validator/shortcuts.py

@@ -3,8 +3,8 @@
 
 
 def validate_spec_factory(validator_callable):
-    def validate(spec):
-        return validator_callable(spec)
+    def validate(spec, spec_url=''):
+        return validator_callable(spec, spec_url=spec_url)
     return validate
 
 

tests/integration/conftest.py

@@ -2,11 +2,18 @@
 
 import pytest
 from six.moves.urllib import request
+from six.moves.urllib.parse import urlunparse
 from yaml import safe_load
 
 from openapi_spec_validator import openapi_v3_spec_validator
 
 
+def spec_url(spec_file, schema='file'):
+    directory = path.abspath(path.dirname(__file__))
+    full_path = path.join(directory, spec_file)
+    return urlunparse((schema, None, full_path, None, None, None))
+
+
 def spec_from_file(spec_file):
     directory = path.abspath(path.dirname(__file__))
     path_full = path.join(directory, spec_file)
@@ -27,6 +34,7 @@ class Factory(dict):
 @pytest.fixture
 def factory():
     return Factory(
+        spec_url=spec_url,
         spec_from_file=spec_from_file,
         spec_from_url=spec_from_url,
     )

tests/integration/data/v3.0/petstore-separate/common/schemas/Error.yaml

@@ -0,0 +1,10 @@
+type: object
+required:
+  - code
+  - message
+properties:
+  code:
+    type: integer
+    format: int32
+  message:
+    type: string

tests/integration/data/v3.0/petstore-separate/spec/openapi.yaml

@@ -0,0 +1,81 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  license:
+    name: 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: "schemas/Pets.yaml"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "../common/schemas/Error.yaml"
+    post:
+      summary: Create a pet
+      operationId: createPets
+      tags:
+        - pets
+      responses:
+        '201':
+          description: Null response
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "../common/schemas/Error.yaml"
+  /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: "schemas/Pets.yaml"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "../common/schemas/Error.yaml"

tests/integration/data/v3.0/petstore-separate/spec/schemas/Pet.yaml

@@ -0,0 +1,11 @@
+required:
+  - id
+  - name
+properties:
+  id:
+    type: integer
+    format: int64
+  name:
+    type: string
+  tag:
+    type: string

tests/integration/data/v3.0/petstore-separate/spec/schemas/Pets.yaml

@@ -0,0 +1,3 @@
+type: array
+items:
+  $ref: "schemas/Pet.yaml"

tests/integration/test_validate.py

@@ -5,15 +5,23 @@
 
 class BaseTestValidOpeAPIv3Validator(object):
 
-    def test_valid(self, validator, spec):
-        return validator.validate(spec)
+    @pytest.fixture
+    def spec_url(self):
+        return ''
+
+    def test_valid(self, validator, spec, spec_url):
+        return validator.validate(spec, spec_url=spec_url)
 
 
 class BaseTestFailedOpeAPIv3Validator(object):
 
-    def test_failed(self, validator, spec):
+    @pytest.fixture
+    def spec_url(self):
+        return ''
+
+    def test_failed(self, validator, spec, spec_url):
         with pytest.raises(ValidationError):
-            validator.validate(spec)
+            validator.validate(spec, spec_url=spec_url)
 
 
 class TestLocalEmptyExample(BaseTestFailedOpeAPIv3Validator):
@@ -30,6 +38,19 @@ def spec(self, factory):
         return factory.spec_from_file("data/v3.0/petstore.yaml")
 
 
+class TestLocalPetstoreSeparateExample(BaseTestValidOpeAPIv3Validator):
+
+    spec_file = "data/v3.0/petstore-separate/spec/openapi.yaml"
+
+    @pytest.fixture
+    def spec_url(self, factory):
+        return factory.spec_url(self.spec_file)
+
+    @pytest.fixture
+    def spec(self, factory):
+        return factory.spec_from_file(self.spec_file)
+
+
 class TestPetstoreExample(BaseTestValidOpeAPIv3Validator):
 
     @pytest.fixture