specmatic 0.7.7__tar.gz → 0.7.9__tar.gz

{specmatic-0.7.7/specmatic.egg-info → specmatic-0.7.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: specmatic
-Version: 0.7.7
+Version: 0.7.9
 Summary: A Python module for using the Specmatic Library.
 Home-page: https://github.com/znsio/specmatic-python-extensions
 Author: Specmatic Builders
@@ -28,6 +28,8 @@ The open api specification can be present either locally or in a [Central Contra
 - Declare an empty class in it called 'TestContract'.
   Specmatic will use this class to inject tests dynamically into it when you run it via say PyTest.
 
+## WSGI Apps
+
 #### To run contract tests with a stub for a wsgi app (like Flask):  
 ``````
 class TestContract:
@@ -55,6 +57,35 @@ Specmatic.test_wsgi_app(app,
 -  You can run this test from either your IDE or command line by pointing pytest to your test folder:
    ``````pytest test -v -s``````  
 - NOTE: Please ensure that you set the '-v' and '-s' flags while running pytest as otherwise pytest may swallow up the console output.
+- [Click here](https://specmatic.in/documentation/service_virtualization_tutorial.html) to learn more about stubbing/service virtualization.  
+
+#### To run contract tests using a central contract repository:
+
+``````
+Specmatic.test_wsgi_app(app,
+                        TestContract,
+                        project_root=PROJECT_ROOT,
+                        stub_host=stub_host,
+                        stub_port=stub_port,
+                        expectation_files=[expectation_json_file])
+``````                        
+
+- When using a [central contract repository](https://specmatic.in/documentation/central_contract_repository.html), provide the absolute path to the root folder
+  of your application in the 'project_root' parameter.
+- You would need to have a specmatic.json file in your project root directory. [Click here](https://specmatic.in/documentation/central_contract_repository.html#specmaticjson) to learn
+  more about the specmatic.json file.
+
+
+#### To run contract tests without a stub, set the 'with_stub' parameter as False:
+
+``````
+Specmatic.test_wsgi_app(app,
+                        TestContract,
+                        with_stub=False,
+                        project_root=ROOT_DIR)
+``````                        
+
+## ASGI Apps
 
 #### To run contract tests with a stub for an asgi app (like sanic):
 ``````
@@ -73,7 +104,18 @@ Specmatic.test_asgi_app('main:app',
   - the rest of the arguments are similar to that of the ``````Specmatic.test_wsgi_app()`````` method.
 
 
-- [Click here](https://specmatic.in/documentation/service_virtualization_tutorial.html) to learn more about stubbing/service virtualization.
+## Common Issues
+- **'Error loading ASGI app'** error when running Specmatic.test_asgi_app()  
+   This error occurs due to incorrect module being specified in the app module parameter 'module:app' string.
+ 
+   #### Solutions:
+   - Try to identify the correct module in which your app variable is instantiated/imported.  
+     For example if your 'app' variable is declared in main.py, try passing 'main:app'.  
+   - Try running the app using uvicorn directly:  
+     `````` uvciron 'main:app' ``````  
+     If you are able to get the app started using uvicorn, it will work with specmatic too.  
+
+## Sample Projects
 - [Check out the Specmatic Order BFF Python repo](https://github.com/znsio/specmatic-order-bff-python/) to see more examples of how to use specmatic with a Flask app.  
 - [Check out the Specmatic Order BFF Python Sanic repo](https://github.com/znsio/specmatic-order-bff-python-sanic/) to see more examples of how to use specmatic with a Sanic app.  
 - [Check out the Specmatic Order API Python repo](https://github.com/znsio/specmatic-order-api-python/) to see an examples of how to just run tests without using a stub.  

{specmatic-0.7.7 → specmatic-0.7.9}/README.md

@@ -19,6 +19,8 @@ The open api specification can be present either locally or in a [Central Contra
 - Declare an empty class in it called 'TestContract'.
   Specmatic will use this class to inject tests dynamically into it when you run it via say PyTest.
 
+## WSGI Apps
+
 #### To run contract tests with a stub for a wsgi app (like Flask):  
 ``````
 class TestContract:
@@ -46,6 +48,35 @@ Specmatic.test_wsgi_app(app,
 -  You can run this test from either your IDE or command line by pointing pytest to your test folder:
    ``````pytest test -v -s``````  
 - NOTE: Please ensure that you set the '-v' and '-s' flags while running pytest as otherwise pytest may swallow up the console output.
+- [Click here](https://specmatic.in/documentation/service_virtualization_tutorial.html) to learn more about stubbing/service virtualization.  
+
+#### To run contract tests using a central contract repository:
+
+``````
+Specmatic.test_wsgi_app(app,
+                        TestContract,
+                        project_root=PROJECT_ROOT,
+                        stub_host=stub_host,
+                        stub_port=stub_port,
+                        expectation_files=[expectation_json_file])
+``````                        
+
+- When using a [central contract repository](https://specmatic.in/documentation/central_contract_repository.html), provide the absolute path to the root folder
+  of your application in the 'project_root' parameter.
+- You would need to have a specmatic.json file in your project root directory. [Click here](https://specmatic.in/documentation/central_contract_repository.html#specmaticjson) to learn
+  more about the specmatic.json file.
+
+
+#### To run contract tests without a stub, set the 'with_stub' parameter as False:
+
+``````
+Specmatic.test_wsgi_app(app,
+                        TestContract,
+                        with_stub=False,
+                        project_root=ROOT_DIR)
+``````                        
+
+## ASGI Apps
 
 #### To run contract tests with a stub for an asgi app (like sanic):
 ``````
@@ -64,7 +95,18 @@ Specmatic.test_asgi_app('main:app',
   - the rest of the arguments are similar to that of the ``````Specmatic.test_wsgi_app()`````` method.
 
 
-- [Click here](https://specmatic.in/documentation/service_virtualization_tutorial.html) to learn more about stubbing/service virtualization.
+## Common Issues
+- **'Error loading ASGI app'** error when running Specmatic.test_asgi_app()  
+   This error occurs due to incorrect module being specified in the app module parameter 'module:app' string.
+ 
+   #### Solutions:
+   - Try to identify the correct module in which your app variable is instantiated/imported.  
+     For example if your 'app' variable is declared in main.py, try passing 'main:app'.  
+   - Try running the app using uvicorn directly:  
+     `````` uvciron 'main:app' ``````  
+     If you are able to get the app started using uvicorn, it will work with specmatic too.  
+
+## Sample Projects
 - [Check out the Specmatic Order BFF Python repo](https://github.com/znsio/specmatic-order-bff-python/) to see more examples of how to use specmatic with a Flask app.  
 - [Check out the Specmatic Order BFF Python Sanic repo](https://github.com/znsio/specmatic-order-bff-python-sanic/) to see more examples of how to use specmatic with a Sanic app.  
 - [Check out the Specmatic Order API Python repo](https://github.com/znsio/specmatic-order-api-python/) to see an examples of how to just run tests without using a stub.  

{specmatic-0.7.7 → specmatic-0.7.9}/setup.py

@@ -2,24 +2,10 @@ import os
 from pathlib import Path
 
 from setuptools import setup, find_packages
-import urllib.request
 
+from build_utils import get_version, download_specmatic_jar
 
-def download_specmatic_jar(version):
-    file_url = f'https://github.com/znsio/specmatic/releases/download/{version}/specmatic.jar'
-    file_path = 'specmatic/core/specmatic.jar'
-    print(f"Downloading core jar from: {file_url}")
-    urllib.request.urlretrieve(file_url, file_path)
-
-
-def get_version():
-    version = {}
-    with open(os.path.join('specmatic', 'version.py')) as file:
-        exec(file.read(), version)
-    return version
-
-
-version = get_version()
+version = get_version(os.path.join('specmatic', 'version.py'))
 
 download_specmatic_jar(version['__specmatic_version__'])
 
@@ -38,9 +24,9 @@ setup(
     packages=find_packages(exclude=['test', 'test.*']),
     include_package_data=True,
     install_requires=[
-       'pytest==7.3.1',
-       'requests>=2.0.0',
-       'Werkzeug==2.3.3',
-       'uvicorn>=0.18.0'
+        'pytest==7.3.1',
+        'requests>=2.0.0',
+        'Werkzeug==2.3.3',
+        'uvicorn>=0.18.0'
     ]
 )

{specmatic-0.7.7 → specmatic-0.7.9}/specmatic/version.py

@@ -1,2 +1,2 @@
-__version__ = '0.7.7'
+__version__ = '0.7.9'
 __specmatic_version__ = '0.67.0'

{specmatic-0.7.7 → specmatic-0.7.9/specmatic.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: specmatic
-Version: 0.7.7
+Version: 0.7.9
 Summary: A Python module for using the Specmatic Library.
 Home-page: https://github.com/znsio/specmatic-python-extensions
 Author: Specmatic Builders
@@ -28,6 +28,8 @@ The open api specification can be present either locally or in a [Central Contra
 - Declare an empty class in it called 'TestContract'.
   Specmatic will use this class to inject tests dynamically into it when you run it via say PyTest.
 
+## WSGI Apps
+
 #### To run contract tests with a stub for a wsgi app (like Flask):  
 ``````
 class TestContract:
@@ -55,6 +57,35 @@ Specmatic.test_wsgi_app(app,
 -  You can run this test from either your IDE or command line by pointing pytest to your test folder:
    ``````pytest test -v -s``````  
 - NOTE: Please ensure that you set the '-v' and '-s' flags while running pytest as otherwise pytest may swallow up the console output.
+- [Click here](https://specmatic.in/documentation/service_virtualization_tutorial.html) to learn more about stubbing/service virtualization.  
+
+#### To run contract tests using a central contract repository:
+
+``````
+Specmatic.test_wsgi_app(app,
+                        TestContract,
+                        project_root=PROJECT_ROOT,
+                        stub_host=stub_host,
+                        stub_port=stub_port,
+                        expectation_files=[expectation_json_file])
+``````                        
+
+- When using a [central contract repository](https://specmatic.in/documentation/central_contract_repository.html), provide the absolute path to the root folder
+  of your application in the 'project_root' parameter.
+- You would need to have a specmatic.json file in your project root directory. [Click here](https://specmatic.in/documentation/central_contract_repository.html#specmaticjson) to learn
+  more about the specmatic.json file.
+
+
+#### To run contract tests without a stub, set the 'with_stub' parameter as False:
+
+``````
+Specmatic.test_wsgi_app(app,
+                        TestContract,
+                        with_stub=False,
+                        project_root=ROOT_DIR)
+``````                        
+
+## ASGI Apps
 
 #### To run contract tests with a stub for an asgi app (like sanic):
 ``````
@@ -73,7 +104,18 @@ Specmatic.test_asgi_app('main:app',
   - the rest of the arguments are similar to that of the ``````Specmatic.test_wsgi_app()`````` method.
 
 
-- [Click here](https://specmatic.in/documentation/service_virtualization_tutorial.html) to learn more about stubbing/service virtualization.
+## Common Issues
+- **'Error loading ASGI app'** error when running Specmatic.test_asgi_app()  
+   This error occurs due to incorrect module being specified in the app module parameter 'module:app' string.
+ 
+   #### Solutions:
+   - Try to identify the correct module in which your app variable is instantiated/imported.  
+     For example if your 'app' variable is declared in main.py, try passing 'main:app'.  
+   - Try running the app using uvicorn directly:  
+     `````` uvciron 'main:app' ``````  
+     If you are able to get the app started using uvicorn, it will work with specmatic too.  
+
+## Sample Projects
 - [Check out the Specmatic Order BFF Python repo](https://github.com/znsio/specmatic-order-bff-python/) to see more examples of how to use specmatic with a Flask app.  
 - [Check out the Specmatic Order BFF Python Sanic repo](https://github.com/znsio/specmatic-order-bff-python-sanic/) to see more examples of how to use specmatic with a Sanic app.  
 - [Check out the Specmatic Order API Python repo](https://github.com/znsio/specmatic-order-api-python/) to see an examples of how to just run tests without using a stub.  

{specmatic-0.7.7 → specmatic-0.7.9}/specmatic.egg-info/SOURCES.txt

@@ -24,11 +24,4 @@ specmatic/servers/__init__.py
 specmatic/servers/app_server.py
 specmatic/servers/asgi_server_thread.py
 specmatic/servers/wsgi_server.py
-specmatic/servers/wsgi_server_thread.py
-test/test_contract_using_api.py
-test/test_contract_using_api_with_autowiring.py
-test/test_contract_using_api_with_central_repo.py
-test/test_contract_using_decorators.py
-test/test_contract_using_decorators_with_central_repo.py
-test/test_contract_with_sanic_app.py
-test/test_contract_with_sanic_app_with_autowiring.py
+specmatic/servers/wsgi_server_thread.py

specmatic-0.7.7/test/test_contract_using_api.py

@@ -1,32 +0,0 @@
-import pytest
-
-from specmatic.core.specmatic import Specmatic
-from specmatic.utils import get_project_root
-from test.flask_app import app
-
-app_host = "127.0.0.1"
-app_port = 5000
-stub_host = "127.0.0.1"
-stub_port = 8080
-PROJECT_ROOT = get_project_root()
-expectation_json_file = PROJECT_ROOT + '/test/data/expectation.json'
-app_contract_file = PROJECT_ROOT + '/test/spec/product-search-bff-api.yaml'
-stub_contract_file = PROJECT_ROOT + '/test/spec/api_order_v1.yaml'
-
-
-class TestContract:
-    pass
-
-
-Specmatic.test_wsgi_app(app,
-                        TestContract,
-                        app_contracts=[app_contract_file],
-                        stub_contracts=[stub_contract_file],
-                        app_host=app_host,
-                        app_port=app_port,
-                        stub_host=stub_host,
-                        stub_port=stub_port,
-                        expectation_files=[expectation_json_file])
-
-if __name__ == '__main__':
-    pytest.main()

specmatic-0.7.7/test/test_contract_using_api_with_autowiring.py

@@ -1,38 +0,0 @@
-import os
-
-import pytest
-
-from specmatic.core.specmatic import Specmatic
-from specmatic.utils import get_project_root
-from test.flask_app import app
-
-stub_host = "127.0.0.1"
-stub_port = 8080
-PROJECT_ROOT = get_project_root()
-expectation_json_file = PROJECT_ROOT + '/test/data/expectation.json'
-
-
-class TestContract:
-    pass
-
-
-def update_app_config_with_stub_info(app, host: str, port: int):
-    app.config['ORDER_API_HOST'] = host
-    app.config['ORDER_API_PORT'] = str(port)
-
-
-def reset_app_config(app):
-    app.config["ORDER_API_HOST"] = os.getenv("ORDER_API_HOST")
-    app.config["ORDER_API_PORT"] = os.getenv("ORDER_API_PORT")
-
-
-Specmatic.test_wsgi_app(app,
-                        TestContract,
-                        project_root=PROJECT_ROOT,
-                        expectation_files=[expectation_json_file],
-                        app_config_update_func=update_app_config_with_stub_info)
-
-reset_app_config(app)
-
-if __name__ == '__main__':
-    pytest.main()

specmatic-0.7.7/test/test_contract_using_api_with_central_repo.py

@@ -1,27 +0,0 @@
-import pytest
-
-from specmatic.core.specmatic import Specmatic
-from specmatic.utils import get_project_root
-from test.flask_app import app
-
-app_host = "127.0.0.1"
-app_port = 5000
-stub_host = "127.0.0.1"
-stub_port = 8080
-PROJECT_ROOT = get_project_root()
-expectation_json_file = PROJECT_ROOT + '/test/data/expectation.json'
-
-
-class TestContract:
-    pass
-
-
-Specmatic.test_wsgi_app(app,
-                        TestContract,
-                        project_root=PROJECT_ROOT,
-                        stub_host=stub_host,
-                        stub_port=stub_port,
-                        expectation_files=[expectation_json_file])
-
-if __name__ == '__main__':
-    pytest.main()

specmatic-0.7.7/test/test_contract_using_decorators.py

@@ -1,25 +0,0 @@
-import pytest
-
-from specmatic.core.decorators import specmatic_contract_test, specmatic_stub, start_wsgi_app
-from specmatic.utils import get_project_root
-from test.flask_app import app
-
-app_host = "127.0.0.1"
-app_port = 5000
-stub_host = "127.0.0.1"
-stub_port = 8080
-PROJECT_ROOT = get_project_root()
-expectation_json_file = PROJECT_ROOT + '/test/data/expectation.json'
-service_contract_file = PROJECT_ROOT + '/test/spec/product-search-bff-api.yaml'
-stub_contract_file = PROJECT_ROOT + '/test/spec/api_order_v1.yaml'
-
-
-@specmatic_contract_test(app_host, app_port, contract_files=[service_contract_file])
-@start_wsgi_app(app, app_host, app_port)
-@specmatic_stub(stub_host, stub_port, expectations=[expectation_json_file], contract_files=[stub_contract_file])
-class TestContractWithLocalSpecs:
-    pass
-
-
-if __name__ == '__main__':
-    pytest.main()

specmatic-0.7.7/test/test_contract_using_decorators_with_central_repo.py

@@ -1,24 +0,0 @@
-import pytest
-
-from specmatic.core.decorators import specmatic_contract_test, specmatic_stub, start_wsgi_app
-from specmatic.utils import get_project_root
-from test.flask_app import app
-
-app_host = "127.0.0.1"
-app_port = 5000
-stub_host = "127.0.0.1"
-stub_port = 8080
-PROJECT_ROOT = get_project_root()
-APP_ROOT = PROJECT_ROOT + '/test'
-expectation_json_file = PROJECT_ROOT + '/test/data/expectation.json'
-
-
-@specmatic_contract_test(project_root=PROJECT_ROOT)
-@start_wsgi_app(app)
-@specmatic_stub(stub_host, stub_port, PROJECT_ROOT, [expectation_json_file])
-class TestContract:
-    pass
-
-
-if __name__ == '__main__':
-    pytest.main()

specmatic-0.7.7/test/test_contract_with_sanic_app.py

@@ -1,34 +0,0 @@
-import pytest
-
-from specmatic.core.specmatic import Specmatic
-from specmatic.utils import get_project_root
-
-PROJECT_ROOT = get_project_root()
-
-app_host = "127.0.0.1"
-app_port = 8000
-stub_host = "127.0.0.1"
-stub_port = 8080
-
-expectation_json_file = PROJECT_ROOT + '/test/data/expectation.json'
-app_contract_file = PROJECT_ROOT + '/test/spec/product-search-bff-api.yaml'
-stub_contract_file = PROJECT_ROOT + '/test/spec/api_order_v1.yaml'
-app_module = PROJECT_ROOT + '/test/sanic_app'
-
-
-class TestContract:
-    pass
-
-
-Specmatic.test_asgi_app('test.sanic_app:app',
-                        TestContract,
-                        app_contracts=[app_contract_file],
-                        stub_contracts=[stub_contract_file],
-                        app_host=app_host,
-                        app_port=app_port,
-                        stub_host=stub_host,
-                        stub_port=stub_port,
-                        expectation_files=[expectation_json_file])
-
-if __name__ == '__main__':
-    pytest.main()

specmatic-0.7.7/test/test_contract_with_sanic_app_with_autowiring.py

@@ -1,51 +0,0 @@
-import pytest
-import configparser
-
-from specmatic.core.specmatic import Specmatic
-from specmatic.utils import get_project_root
-
-PROJECT_ROOT = get_project_root()
-
-app_host = "127.0.0.1"
-app_port = 8000
-stub_host = "127.0.0.1"
-stub_port = 8080
-
-expectation_json_file = PROJECT_ROOT + '/test/data/expectation.json'
-app_contract_file = PROJECT_ROOT + '/test/spec/product-search-bff-api.yaml'
-stub_contract_file = PROJECT_ROOT + '/test/spec/api_order_v1.yaml'
-app_module = PROJECT_ROOT + '/test/sanic_app'
-
-
-class TestContract:
-    pass
-
-
-def update_app_config_with_stub_info(host: str, port: int):
-    config = configparser.ConfigParser()
-    config.read('config.ini')
-    config['dev']['ORDER_API_HOST'] = host
-    config['dev']['ORDER_API_PORT'] = str(port)
-    with open('./../config.ini', 'w') as configfile:
-        config.write(configfile)
-
-
-def reset_app_config():
-    config = configparser.ConfigParser()
-    config.read('config.ini')
-    config['dev']['ORDER_API_HOST'] = '127.0.0.1'
-    config['dev']['ORDER_API_PORT'] = '8080'
-    with open('./../config.ini', 'w') as configfile:
-        config.write(configfile)
-
-
-Specmatic.test_asgi_app('test.sanic_app:app',
-                        TestContract,
-                        project_root=PROJECT_ROOT,
-                        expectation_files=[expectation_json_file],
-                        app_config_update_func=update_app_config_with_stub_info)
-
-reset_app_config()
-
-if __name__ == '__main__':
-    pytest.main()