specmatic 0.7.7__py3-none-any.whl → 0.7.9__py3-none-any.whl

specmatic/version.py

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

{specmatic-0.7.7.dist-info → specmatic-0.7.9.dist-info}/METADATA

@@ -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
@@ -32,6 +32,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:
@@ -59,6 +61,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):
 ``````
@@ -77,7 +108,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.dist-info → specmatic-0.7.9.dist-info}/RECORD

@@ -1,6 +1,6 @@
 specmatic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 specmatic/utils.py,sha256=6JDPqpO51ykl0MWCOa32jkUOXZ-0RZ6N5Ng9_7r7XaU,519
-specmatic/version.py,sha256=TwcJ8cxe8cfx0wSv0EFyVAvgtbm6mlT4rN5aCZA-mRc,55
+specmatic/version.py,sha256=3j9vspSwxjc28ZVOEY5GmYzD-kxAKvOR925YMRQ8KG0,55
 specmatic/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 specmatic/core/decorators.py,sha256=rh70o8SUe04oCqbF07JHCjNvoPN5VkO1xT9NgNiN8ao,2565
 specmatic/core/specmatic.jar,sha256=S0FO6mbbx-7LNGI2dUiJQMEvU5YpxQptMCExW5DtiBo,87153377
@@ -17,7 +17,7 @@ specmatic/servers/app_server.py,sha256=RK8ah6pHN5wrj5QgtF-o-uMbXOVS7GgFChBzLW5U9
 specmatic/servers/asgi_server_thread.py,sha256=FHcYdhNLKPQqI0dBrF1n4QJHPpUNAPmIFGd2_J-zU0E,515
 specmatic/servers/wsgi_server.py,sha256=uSMxAAFOcnCN2zM5RzPZP0tyk5FLeimCCxhgWtP7_h0,593
 specmatic/servers/wsgi_server_thread.py,sha256=XUEYW7-FP1a-5EkQVGc3FI_jkDQBocArxHLiCn3JJvc,691
-specmatic-0.7.7.dist-info/METADATA,sha256=QwjWtjhKXhuURHjNYiWEB5Z1fQ0btlTc8FU_fCteu44,4611
-specmatic-0.7.7.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-specmatic-0.7.7.dist-info/top_level.txt,sha256=E7kQ78YacKBoKKeKWR_N83exlG8r5J0wlzlGqFmvIfo,10
-specmatic-0.7.7.dist-info/RECORD,,
+specmatic-0.7.9.dist-info/METADATA,sha256=BjZJgTtjm1tRc_8bAKLa8l0O4ubp5G61SM0Fvq3XOmc,6353
+specmatic-0.7.9.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+specmatic-0.7.9.dist-info/top_level.txt,sha256=E7kQ78YacKBoKKeKWR_N83exlG8r5J0wlzlGqFmvIfo,10
+specmatic-0.7.9.dist-info/RECORD,,