Merge pull request #9 from venthur/feat/entry_points

Added CLI interface for ad-hoc validation

Author: p1c2u

README.md

@@ -17,6 +17,12 @@ OpenAPI Spec Validator is a Python library that validates OpenAPI Specs against
 
 ## Usage
 
+Command Line Interface:
+
+```bash
+$ openapi_spec_validator some.yaml
+```
+
 Validate spec:
 
 ```python

openapi_spec_validator/__main__.py

@@ -0,0 +1,48 @@
+import logging
+import argparse
+import os
+import sys
+
+from openapi_spec_validator import validate_spec_url, validate_v2_spec_url
+from openapi_spec_validator.exceptions import ValidationError
+
+logger = logging.getLogger(__name__)
+logging.basicConfig(
+    format='%(asctime)s %(levelname)s %(name)s %(message)s',
+    level=logging.WARNING
+)
+
+
+def main(args=None):
+    parser = argparse.ArgumentParser()
+    parser.add_argument('filename', help="Absolute or relative path to file")
+    parser.add_argument(
+        '--schema',
+        help="OpenAPI schema (default: 3.0.0)",
+        type=str,
+        choices=['2.0', '3.0.0'],
+        default='3.0.0'
+    )
+    args = parser.parse_args(args)
+    filename = args.filename
+    filename = os.path.abspath(filename)
+    # choose the validator
+    if args.schema == '2.0':
+        validate_url = validate_v2_spec_url
+    elif args.schema == '3.0.0':
+        validate_url = validate_spec_url
+    # validate
+    try:
+        validate_url('file://'+filename)
+    except ValidationError as e:
+        print(e)
+        sys.exit(1)
+    except Exception as e:
+        print(e)
+        sys.exit(2)
+    else:
+        print('OK')
+
+
+if __name__ == '__main__':
+    main()

setup.py

@@ -61,6 +61,11 @@ def run_tests(self):
         ],
     },
     include_package_data=True,
+    entry_points={
+        'console_scripts': [
+            'openapi-spec-validator = openapi_spec_validator.__main__:main'
+        ]
+    },
     install_requires=[
         "jsonschema",
         "pyaml",

tests/integration/test_main.py

@@ -0,0 +1,46 @@
+import pytest
+
+from openapi_spec_validator.__main__ import main
+
+
+def test_schema_default():
+    """Test default schema is 3.0.0"""
+    testargs = ['./tests/integration/data/v3.0/petstore.yaml']
+    main(testargs)
+
+
+def test_schema_v3():
+    """No errors when calling proper v3 file."""
+    testargs = ['--schema', '3.0.0',
+                './tests/integration/data/v3.0/petstore.yaml']
+    main(testargs)
+
+
+def test_schema_v2():
+    """No errors when calling with proper v2 file."""
+    testargs = ['--schema', '2.0',
+                './tests/integration/data/v2.0/petstore.yaml']
+    main(testargs)
+
+
+def test_schema_unknown():
+    """Errors on running with unknown schema."""
+    testargs = ['--schema', 'x.x',
+                './tests/integration/data/v2.0/petstore.yaml']
+    with pytest.raises(SystemExit):
+        main(testargs)
+
+
+def test_validation_error():
+    """SystemExit on running with ValidationError."""
+    testargs = ['--schema', '3.0.0',
+                './tests/integration/data/v2.0/petstore.yaml']
+    with pytest.raises(SystemExit):
+        main(testargs)
+
+
+def test_nonexisting_file():
+    """Calling with non-existing file should sys.exit."""
+    testargs = ['i_dont_exist.yaml']
+    with pytest.raises(SystemExit):
+        main(testargs)