specmatic 2.24.0__tar.gz → 2.29.0__tar.gz

{specmatic-2.24.0/specmatic.egg-info → specmatic-2.29.0}/PKG-INFO

@@ -1,10 +1,11 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: specmatic
-Version: 2.24.0
+Version: 2.29.0
 Summary: A Python module for using the Specmatic Library.
 Home-page: https://github.com/specmatic/specmatic-python-extensions
 Author: Specmatic Builders
 Author-email: info@core.in
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 Requires-Dist: pytest>=7.3.1
 Requires-Dist: requests>=2.26.0
@@ -13,6 +14,14 @@ Requires-Dist: uvicorn>=0.18.0
 Requires-Dist: fastapi>=0.70.0
 Requires-Dist: flask>=2.2.5
 Requires-Dist: sanic>=22.12.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # Specmatic Python
 This is a Python library to run [Specmatic](https://specmatic.io).
@@ -23,7 +32,7 @@ Specmatic is a contract driven development tool that allows us to turn OpenAPI c
   The specmatic python library provides three main functions:
   - The ability to start and stop a python web app like flask/sanic.
   - The ability to run specmatic in test mode against an open api contract/spec.
-  - The ability to stub out an api dependency using the specmatic stub feature.
+  - The ability to mock out an api dependency using the specmatic mock feature.
 
 #### Running Contract Tests
 A contract test validates an open api specification against a running api service.  
@@ -46,7 +55,7 @@ The open api specification can be present either locally or in a [Central Contra
   
 #### How does it work
 - Specmatic uses the TestContract class defined above to inject tests dynamically into it when you run it via PyTest or UnitTest.  
-- The Specmatic Python package, invokes the Specmatic executable jar (via command line) in a separate process to start stubs and run tests.  
+- The Specmatic Python package, invokes the Specmatic executable jar (via command line) in a separate process to start mocks and run tests.  
 - It is the specmatic jar which runs the contract tests and generates a JUnit test summary report.  
 - The Specmatic Python package ingests the JUnit test summary report and generates test methods corresponding to every contract test.  
 - These dynamic test methods are added to the  ```TestContract``` class and hence we seem them reported seamlessly by PyTest/Unittest like this:
@@ -60,23 +69,22 @@ test/test_contract_with_coverage.py::TestContract::test_Scenario: GET /products
 
 ## WSGI Apps
 
-#### To run contract tests with a stub for a wsgi app (like Flask):  
+#### To run contract tests with a mock for a wsgi app (like Flask):
 
 ``````python
 class TestContract:
     pass
-    
-    
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_wsgi_app(app, app_host, app_port) \
-    .test(TestContract) \
+
+
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_wsgi_app(app, app_host, app_port)
+    .test(TestContract)
     .run()
- 
- 
+
 if __name__ == '__main__':
-pytest.main()
+    pytest.main()
 `````` 
 
 - In this, we are passing:
@@ -84,16 +92,16 @@ pytest.main()
   - app_host and app_port. If they are not specified, the app will be started on a random available port on 127.0.0.1.
   - You would need a [specmatic config](https://specmatic.io/documentation/specmatic_json.html) file to be present in the root directory of your project.
   - an empty test class.
-  - stub_host, stub_port, optional list of json files to set expectations on the stub.  
-    The stub_host, stub_port will be used to run the specmatic stub server.   
-    If they are not supplied, the stub will be started on a random available port on 127.0.0.1.    
-    [Click here](https://specmatic.io/documentation/service_virtualization_tutorial.html) to learn more about stubbing/service virtualization.
+  - mock_host, mock_port, optional list of json files to set expectations on the mock.  
+    The mock_host, mock_port will be used to run the specmatic mock server.   
+    If they are not supplied, the mock will be started on a random available port on 127.0.0.1.    
+    [Click here](https://specmatic.io/documentation/service_virtualization_tutorial.html) to learn more about mocking/service virtualization.
 -  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.
   
 
-#### To run contract tests without a stub:
+#### To run contract tests without a mock:
 
 ``````python
 class TestContract:
@@ -108,33 +116,35 @@ Specmatic() \
 
 ## ASGI Apps
 
-#### To run contract tests with a stub for an asgi app (like sanic):
+#### To run contract tests with a mock for an asgi app (like sanic):
 - If you are using an asgi app like sanic, fastapi, use the ``````with_asgi_app`````` function and pass it a string in the 'module:app' format.
+
 ``````python
 class TestContract:
     pass
-    
-    
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_asgi_app('main:app', app_host, app_port) \
-    .test(TestContract) \
+
+
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_asgi_app('main:app', app_host, app_port)
+    .test(TestContract)
     .run()
 ``````
 
-### Passing extra arguments to stub/test
+### Passing extra arguments to mock/test
 - To pass arguments like '--strict', '--testBaseUrl', pass them as a list to the 'args' parameter:
+
 ``````python
 class TestContract:
     pass
 
 
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file], ['--strict']) \
-    .with_wsgi_app(app, port=app_port) \
-    .test(TestContract, args=['--testBaseURL=http://localhost:5000']) \
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file], ['--strict'])
+    .with_wsgi_app(app, port=app_port)
+    .test(TestContract, args=['--testBaseURL=http://localhost:5000'])
     .run()
 ``````
 
@@ -148,11 +158,11 @@ class TestContract:
     pass
 
 
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_wsgi_app(app, app_host, app_port) \
-    .test_with_api_coverage_for_flask_app(TestContract, app) \
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_wsgi_app(app, app_host, app_port)
+    .test_with_api_coverage_for_flask_app(TestContract, app)
     .run()
 ``````
 
@@ -163,11 +173,11 @@ class TestContract:
     pass
 
 
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_asgi_app('main:app', app_host, app_port) \
-    .test_with_api_coverage_for_sanic_app(TestContract, app) \
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_asgi_app('main:app', app_host, app_port)
+    .test_with_api_coverage_for_sanic_app(TestContract, app)
     .run()
 ``````
 
@@ -178,11 +188,11 @@ class TestContract:
     pass
 
 
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_asgi_app('main:app', app_host, app_port) \
-    .test_with_api_coverage_for_fastapi_app(TestContract, app) \
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_asgi_app('main:app', app_host, app_port)
+    .test_with_api_coverage_for_fastapi_app(TestContract, app)
     .run()
 ``````
 
@@ -193,14 +203,14 @@ The ``````CoverageRoute`````` class has two properties:
 ``````url`````` : This represents your route url in this format: `````` /orders/{order_id}``````  
 ``````method`````` : A list of HTTP methods supported on the route, for instance : ``````['GET', 'POST']``````  
 
-You can then enable coverage by passing your adapter like this:  
+You can then enable coverage by passing your adapter like this:
 
 ``````python
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_asgi_app('main:app', app_host, app_port) \
-    .test_with_api_coverage(TestContract, MyAppRouteAdapter(app)) \
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_asgi_app('main:app', app_host, app_port)
+    .test_with_api_coverage(TestContract, MyAppRouteAdapter(app))
     .run()
 ``````
 
@@ -215,7 +225,8 @@ You can also easily implement your own coverage server if you have written a cus
 The only point to remember in mind is that the EndPointsApi url should return a list of routes in the format used buy Spring Actuator's ```````/actuator/mappings``````` endpoint
 as described [here](https://docs.spring.io/spring-boot/docs/current/actuator-api/htmlsingle/#mappings).  
 
-Here's an example where we start both our FastApi app and coverage server outside the specmatic api call.  
+Here's an example where we start both our FastApi app and coverage server outside the specmatic api call.
+
 ``````python
 app_server = ASGIAppServer('test.apps.fast_api:app', app_host, app_port)
 coverage_server = FastApiAppCoverageServer(app)
@@ -228,11 +239,11 @@ class TestContract:
     pass
 
 
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_endpoints_api(coverage_server.endpoints_api) \
-    .test(TestContract, app_host, app_port) \
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_endpoints_api(coverage_server.endpoints_api)
+    .test(TestContract, app_host, app_port)
     .run()
 
 app_server.stop()
@@ -253,7 +264,7 @@ coverage_server.stop()
 ## Sample Projects
 - [Check out the Specmatic Order BFF Python repo](https://github.com/specmatic/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/specmatic/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/specmatic/specmatic-order-api-python/) to see an examples of how to just run tests without using a stub.  
+- [Check out the Specmatic Order API Python repo](https://github.com/specmatic/specmatic-order-api-python/) to see an examples of how to just run tests without using a mock.  
 
 
 

{specmatic-2.24.0 → specmatic-2.29.0}/README.md

@@ -7,7 +7,7 @@ Specmatic is a contract driven development tool that allows us to turn OpenAPI c
   The specmatic python library provides three main functions:
   - The ability to start and stop a python web app like flask/sanic.
   - The ability to run specmatic in test mode against an open api contract/spec.
-  - The ability to stub out an api dependency using the specmatic stub feature.
+  - The ability to mock out an api dependency using the specmatic mock feature.
 
 #### Running Contract Tests
 A contract test validates an open api specification against a running api service.  
@@ -30,7 +30,7 @@ The open api specification can be present either locally or in a [Central Contra
   
 #### How does it work
 - Specmatic uses the TestContract class defined above to inject tests dynamically into it when you run it via PyTest or UnitTest.  
-- The Specmatic Python package, invokes the Specmatic executable jar (via command line) in a separate process to start stubs and run tests.  
+- The Specmatic Python package, invokes the Specmatic executable jar (via command line) in a separate process to start mocks and run tests.  
 - It is the specmatic jar which runs the contract tests and generates a JUnit test summary report.  
 - The Specmatic Python package ingests the JUnit test summary report and generates test methods corresponding to every contract test.  
 - These dynamic test methods are added to the  ```TestContract``` class and hence we seem them reported seamlessly by PyTest/Unittest like this:
@@ -44,23 +44,22 @@ test/test_contract_with_coverage.py::TestContract::test_Scenario: GET /products
 
 ## WSGI Apps
 
-#### To run contract tests with a stub for a wsgi app (like Flask):  
+#### To run contract tests with a mock for a wsgi app (like Flask):
 
 ``````python
 class TestContract:
     pass
-    
-    
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_wsgi_app(app, app_host, app_port) \
-    .test(TestContract) \
+
+
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_wsgi_app(app, app_host, app_port)
+    .test(TestContract)
     .run()
- 
- 
+
 if __name__ == '__main__':
-pytest.main()
+    pytest.main()
 `````` 
 
 - In this, we are passing:
@@ -68,16 +67,16 @@ pytest.main()
   - app_host and app_port. If they are not specified, the app will be started on a random available port on 127.0.0.1.
   - You would need a [specmatic config](https://specmatic.io/documentation/specmatic_json.html) file to be present in the root directory of your project.
   - an empty test class.
-  - stub_host, stub_port, optional list of json files to set expectations on the stub.  
-    The stub_host, stub_port will be used to run the specmatic stub server.   
-    If they are not supplied, the stub will be started on a random available port on 127.0.0.1.    
-    [Click here](https://specmatic.io/documentation/service_virtualization_tutorial.html) to learn more about stubbing/service virtualization.
+  - mock_host, mock_port, optional list of json files to set expectations on the mock.  
+    The mock_host, mock_port will be used to run the specmatic mock server.   
+    If they are not supplied, the mock will be started on a random available port on 127.0.0.1.    
+    [Click here](https://specmatic.io/documentation/service_virtualization_tutorial.html) to learn more about mocking/service virtualization.
 -  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.
   
 
-#### To run contract tests without a stub:
+#### To run contract tests without a mock:
 
 ``````python
 class TestContract:
@@ -92,33 +91,35 @@ Specmatic() \
 
 ## ASGI Apps
 
-#### To run contract tests with a stub for an asgi app (like sanic):
+#### To run contract tests with a mock for an asgi app (like sanic):
 - If you are using an asgi app like sanic, fastapi, use the ``````with_asgi_app`````` function and pass it a string in the 'module:app' format.
+
 ``````python
 class TestContract:
     pass
-    
-    
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_asgi_app('main:app', app_host, app_port) \
-    .test(TestContract) \
+
+
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_asgi_app('main:app', app_host, app_port)
+    .test(TestContract)
     .run()
 ``````
 
-### Passing extra arguments to stub/test
+### Passing extra arguments to mock/test
 - To pass arguments like '--strict', '--testBaseUrl', pass them as a list to the 'args' parameter:
+
 ``````python
 class TestContract:
     pass
 
 
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file], ['--strict']) \
-    .with_wsgi_app(app, port=app_port) \
-    .test(TestContract, args=['--testBaseURL=http://localhost:5000']) \
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file], ['--strict'])
+    .with_wsgi_app(app, port=app_port)
+    .test(TestContract, args=['--testBaseURL=http://localhost:5000'])
     .run()
 ``````
 
@@ -132,11 +133,11 @@ class TestContract:
     pass
 
 
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_wsgi_app(app, app_host, app_port) \
-    .test_with_api_coverage_for_flask_app(TestContract, app) \
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_wsgi_app(app, app_host, app_port)
+    .test_with_api_coverage_for_flask_app(TestContract, app)
     .run()
 ``````
 
@@ -147,11 +148,11 @@ class TestContract:
     pass
 
 
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_asgi_app('main:app', app_host, app_port) \
-    .test_with_api_coverage_for_sanic_app(TestContract, app) \
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_asgi_app('main:app', app_host, app_port)
+    .test_with_api_coverage_for_sanic_app(TestContract, app)
     .run()
 ``````
 
@@ -162,11 +163,11 @@ class TestContract:
     pass
 
 
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_asgi_app('main:app', app_host, app_port) \
-    .test_with_api_coverage_for_fastapi_app(TestContract, app) \
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_asgi_app('main:app', app_host, app_port)
+    .test_with_api_coverage_for_fastapi_app(TestContract, app)
     .run()
 ``````
 
@@ -177,14 +178,14 @@ The ``````CoverageRoute`````` class has two properties:
 ``````url`````` : This represents your route url in this format: `````` /orders/{order_id}``````  
 ``````method`````` : A list of HTTP methods supported on the route, for instance : ``````['GET', 'POST']``````  
 
-You can then enable coverage by passing your adapter like this:  
+You can then enable coverage by passing your adapter like this:
 
 ``````python
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_asgi_app('main:app', app_host, app_port) \
-    .test_with_api_coverage(TestContract, MyAppRouteAdapter(app)) \
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_asgi_app('main:app', app_host, app_port)
+    .test_with_api_coverage(TestContract, MyAppRouteAdapter(app))
     .run()
 ``````
 
@@ -199,7 +200,8 @@ You can also easily implement your own coverage server if you have written a cus
 The only point to remember in mind is that the EndPointsApi url should return a list of routes in the format used buy Spring Actuator's ```````/actuator/mappings``````` endpoint
 as described [here](https://docs.spring.io/spring-boot/docs/current/actuator-api/htmlsingle/#mappings).  
 
-Here's an example where we start both our FastApi app and coverage server outside the specmatic api call.  
+Here's an example where we start both our FastApi app and coverage server outside the specmatic api call.
+
 ``````python
 app_server = ASGIAppServer('test.apps.fast_api:app', app_host, app_port)
 coverage_server = FastApiAppCoverageServer(app)
@@ -212,11 +214,11 @@ class TestContract:
     pass
 
 
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_endpoints_api(coverage_server.endpoints_api) \
-    .test(TestContract, app_host, app_port) \
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_endpoints_api(coverage_server.endpoints_api)
+    .test(TestContract, app_host, app_port)
     .run()
 
 app_server.stop()
@@ -237,7 +239,7 @@ coverage_server.stop()
 ## Sample Projects
 - [Check out the Specmatic Order BFF Python repo](https://github.com/specmatic/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/specmatic/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/specmatic/specmatic-order-api-python/) to see an examples of how to just run tests without using a stub.  
+- [Check out the Specmatic Order API Python repo](https://github.com/specmatic/specmatic-order-api-python/) to see an examples of how to just run tests without using a mock.  
 
 
 

{specmatic-2.24.0 → specmatic-2.29.0}/setup.py

@@ -14,6 +14,7 @@ long_description = (this_directory / "README.md").read_text()
 
 setup(
     name='specmatic',
+    python_requires='>=3.11',
     version=version['__version__'],
     description='A Python module for using the Specmatic Library.',
     long_description=long_description,

{specmatic-2.24.0 → specmatic-2.29.0}/specmatic/core/decorators.py

@@ -1,6 +1,6 @@
 import unittest
 
-from specmatic.core.specmatic_stub import SpecmaticStub
+from specmatic.core.specmatic_mock import SpecmaticMock
 from specmatic.core.specmatic_test import SpecmaticTest
 from specmatic.coverage.app_route_adapter import AppRouteAdapter
 from specmatic.coverage.servers.coverage_server import CoverageServer
@@ -11,15 +11,15 @@ from specmatic.servers.wsgi_app_server import WSGIAppServer
 from specmatic.utils import get_junit_report_file_path
 
 
-def specmatic_stub(host: str = '127.0.0.1', port: int = 0, project_root: str = '', expectations=None,
+def specmatic_mock(host: str = '127.0.0.1', port: int = 0, project_root: str = '', expectations=None,
                    specmatic_config_file_path: str = ''):
     def decorator(cls):
         try:
-            cls.stub = SpecmaticStub(host, port, project_root, specmatic_config_file_path)
-            cls.stub.set_expectations(expectations)
+            cls.mock = SpecmaticMock(host, port, project_root, specmatic_config_file_path)
+            cls.mock.set_expectations(expectations)
         except Exception as e:
-            if hasattr(cls, 'stub'):
-                cls.stub.stop()
+            if hasattr(cls, 'mock'):
+                cls.mock.stop()
             if hasattr(cls, 'app'):
                 cls.app.stop()
             print(f"Error: {e}")
@@ -60,15 +60,15 @@ def specmatic_contract_test(host: str = '127.0.0,1', port: int = 0,
         except Exception as e:
             if hasattr(cls, 'app'):
                 cls.app.stop()
-            if hasattr(cls, 'stub'):
-                cls.stub.stop()
+            if hasattr(cls, 'mock'):
+                cls.mock.stop()
             if hasattr(cls, 'coverage_server'):
                 cls.coverage_server.stop()
             print(f"Error: {e}")
             raise e
         finally:
-            if hasattr(cls, 'stub'):
-                cls.stub.stop()
+            if hasattr(cls, 'mock'):
+                cls.mock.stop()
             if hasattr(cls, 'app'):
                 cls.app.stop()
             if hasattr(cls, 'coverage_server'):
@@ -84,8 +84,8 @@ def start_wsgi_app(app, host: str = '127.0.0.1', port: int = 0):
             cls.app.start()
             return cls
         except Exception as e:
-            if hasattr(cls, 'stub'):
-                cls.stub.stop()
+            if hasattr(cls, 'mock'):
+                cls.mock.stop()
             if hasattr(cls, 'app'):
                 cls.app.stop()
             print(f"Error: {e}")
@@ -101,8 +101,8 @@ def start_asgi_app(app_module: str, host: str = '127.0.0.1', port: int = 0):
             cls.app.start()
             return cls
         except Exception as e:
-            if hasattr(cls, 'stub'):
-                cls.stub.stop()
+            if hasattr(cls, 'mock'):
+                cls.mock.stop()
             if hasattr(cls, 'app'):
                 cls.app.stop()
             print(f"Error: {e}")

{specmatic-2.24.0 → specmatic-2.29.0}/specmatic/core/specmatic.py

@@ -1,7 +1,7 @@
 import unittest
 
 from specmatic.coverage.app_route_adapter import AppRouteAdapter
-from specmatic.core.specmatic_stub import SpecmaticStub
+from specmatic.core.specmatic_mock import SpecmaticMock
 from specmatic.core.specmatic_test import SpecmaticTest
 from specmatic.generators.pytest_generator import PyTestGenerator
 from specmatic.generators.unittest_generator import UnitTestGenerator
@@ -25,11 +25,11 @@ class Specmatic:
         self.set_app_config_func = None
         self.app_server = None
 
-        self.stub_host = None
-        self.stub_port = None
+        self.mock_host = None
+        self.mock_port = None
         self.expectations = None
-        self.stub_args = None
-        self.stub = None
+        self.mock_args = None
+        self.mock = None
 
         self.test_class = None
         self.test_host = None
@@ -39,7 +39,7 @@ class Specmatic:
         self.project_root = ''
         self.specmatic_config_file_path = ''
 
-        self.run_stub = False
+        self.run_mock = False
         self.run_app = False
         self.run_tests = False
 
@@ -54,12 +54,12 @@ class Specmatic:
         self.specmatic_config_file_path = specmatic_config_file_path
         return self
 
-    def with_stub(self, stub_host: str = '127.0.0.1', stub_port: int = 0, expectations=None, args=None):
-        self.stub_host = stub_host
-        self.stub_port = stub_port
-        self.run_stub = True
+    def with_mock(self, mock_host: str = '127.0.0.1', mock_port: int = 0, expectations=None, args=None):
+        self.mock_host = mock_host
+        self.mock_port = mock_port
+        self.run_mock = True
         self.expectations = expectations
-        self.stub_args = args
+        self.mock_args = args
         return self
 
     def app(self, app_server: AppServer):
@@ -136,13 +136,13 @@ class Specmatic:
                 self.app_server = ASGIAppServer(self.app_module, self.app_host, self.app_port, self.set_app_config_func,
                                                 self.reset_app_config_func)
 
-    def __start_stub(self):
-        if self.run_stub:
-            self.stub = SpecmaticStub(self.stub_host, self.stub_port, self.project_root, self.specmatic_config_file_path,
-                                      self.stub_args)
-            self.stub.set_expectations(self.expectations)
+    def __start_mock(self):
+        if self.run_mock:
+            self.mock = SpecmaticMock(self.mock_host, self.mock_port, self.project_root, self.specmatic_config_file_path,
+                                      self.mock_args)
+            self.mock.set_expectations(self.expectations)
             if self.app_server is not None:
-                self.app_server.set_app_config(self.stub.host, self.stub.port)
+                self.app_server.set_app_config(self.mock.host, self.mock.port)
 
     def __execute_tests(self):
         if self.run_tests:
@@ -169,7 +169,7 @@ class Specmatic:
     def run(self):
         try:
             self.__init_app_server()
-            self.__start_stub()
+            self.__start_mock()
             self.__execute_tests()
         except Exception as e:
             print(f"Error: {e}")
@@ -180,5 +180,5 @@ class Specmatic:
             if self.app_server is not None:
                 self.app_server.stop()
                 self.app_server.reset_app_config()
-            if self.stub is not None:
-                self.stub.stop()
+            if self.mock is not None:
+                self.mock.stop()

specmatic-2.24.0/specmatic/core/specmatic_stub.py → specmatic-2.29.0/specmatic/core/specmatic_mock.py

@@ -11,25 +11,25 @@ import requests
 from specmatic.core.specmatic_base import SpecmaticBase
 
 
-class SpecmaticStub(SpecmaticBase):
+class SpecmaticMock(SpecmaticBase):
 
     def __init__(self, host: str = '127.0.0.1', port: int = 0, project_root: str = '',
                  specmatic_config_file_path: str = '', args=None):
         super().__init__(host, port, project_root, specmatic_config_file_path, args)
-        self.__stub_started_event = None
+        self.__mock_started_event = None
         self.__process = None
         self.__free_port_message = 'Free port found'
-        self.__stub_serving_message = 'serving endpoints from specs'
+        self.__mock_serving_message = 'serving endpoints from specs'
         self.__error_queue = Queue()
         self.__start()
 
     def __start(self):
         try:
-            self.__stub_started_event = threading.Event()
-            self.__start_specmatic_stub_in_subprocess()
-            self.__start_reading_stub_output()
-            self.__start_reading_stub_error_output()
-            self.__wait_till_stub_has_started()
+            self.__mock_started_event = threading.Event()
+            self.__start_specmatic_mock_in_subprocess()
+            self.__start_reading_mock_output()
+            self.__start_reading_mock_error_output()
+            self.__wait_till_mock_has_started()
         except Exception as e:
             self.stop()
             print(f"Error: {e}")
@@ -37,13 +37,13 @@ class SpecmaticStub(SpecmaticBase):
 
     def stop(self):
         if self.__process is not None:
-            print(f"\n Shutting down specmatic stub server on {self.host}:{self.port}, please wait ...")
+            print(f"\n Shutting down specmatic mock server on {self.host}:{self.port}, please wait ...")
             self.__process.kill()
 
     def set_expectations(self, file_paths: list[str], port: int|None = None):
         port = port or self.port
         if port is None:
-            raise Exception("The port needs to be specified, as the stub started on a random port and extraction failed from logs")
+            raise Exception("The port needs to be specified, as the mock started on a random port and extraction failed from logs")
 
         if file_paths is None:
             file_paths = []
@@ -68,49 +68,49 @@ class SpecmaticStub(SpecmaticBase):
     def __get_expectations_api_url(self, port):
         return f'http://{self.host}:{port}/_specmatic/expectations'
 
-    def __start_specmatic_stub_in_subprocess(self):
-        stub_command = self.__create_stub_process_command()
+    def __start_specmatic_mock_in_subprocess(self):
+        mock_command = self.__create_mock_process_command()
         if self.host != '' and self.port != 0:
-            print(f"\n Starting specmatic stub server on {self.host}:{self.port}")
-        self.__process = subprocess.Popen(stub_command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+            print(f"\n Starting specmatic mock server on {self.host}:{self.port}")
+        self.__process = subprocess.Popen(mock_command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 
-    def __start_reading_stub_output(self):
+    def __start_reading_mock_output(self):
         stdout_reader = threading.Thread(target=self.__read_process_output, daemon=True)
         stdout_reader.start()
 
-    def __start_reading_stub_error_output(self):
+    def __start_reading_mock_error_output(self):
         error_reader = threading.Thread(target=self.__read_process_error_output, daemon=True)
         error_reader.start()
 
-    def __wait_till_stub_has_started(self):
-        self.__stub_started_event.wait()
+    def __wait_till_mock_has_started(self):
+        self.__mock_started_event.wait()
         if not self.__error_queue.empty():
             error = self.__error_queue.get()
-            raise Exception(f"An exception occurred while starting the stub: {error}")
+            raise Exception(f"An exception occurred while starting the mock: {error}")
 
     def __read_process_output(self):
-        def signal_event_if_stub_has_started(line):
+        def signal_event_if_mock_has_started(line):
             if self.__free_port_message in line and self.port == 0:
                 self.port = line.split(self.__free_port_message + ":")[1].strip()
 
-            if self.__stub_serving_message in line:
+            if self.__mock_serving_message in line:
                 if self.port == 0:
-                    self.port = self._extract_port(line.split(self.__stub_serving_message)[0])
-                self.__stub_started_event.set()
+                    self.port = self._extract_port(line.split(self.__mock_serving_message)[0])
+                self.__mock_started_event.set()
 
         def read_and_print_output_line_by_line():
             for line in iter(self.__process.stdout.readline, ''):
                 if line:
                     line = line.decode().rstrip()
                     print(line)
-                    signal_event_if_stub_has_started(line)
+                    signal_event_if_mock_has_started(line)
 
         try:
             read_and_print_output_line_by_line()
         except Exception:
             tb = traceback.format_exc()
             self.__error_queue.put(tb)
-            self.__stub_started_event.set()
+            self.__mock_started_event.set()
 
     @staticmethod
     def _extract_port(text: str) -> str:
@@ -135,11 +135,11 @@ class SpecmaticStub(SpecmaticBase):
                 if line or self.__process.poll() is not None:
                     line = line.decode().rstrip()
                     print(line)
-                    raise Exception('Stub process terminated due to an error ' + line)
+                    raise Exception('Mock process terminated due to an error ' + line)
         except Exception:
             tb = traceback.format_exc()
             self.__error_queue.put(tb)
-            self.__stub_started_event.set()
+            self.__mock_started_event.set()
 
-    def __create_stub_process_command(self):
+    def __create_mock_process_command(self):
         return self.create_command_array('stub')

{specmatic-2.24.0 → specmatic-2.29.0}/specmatic/servers/asgi_app_server.py

@@ -69,9 +69,9 @@ class ASGIAppServer(AppServer):
     def port(self):
         return self.app_port
 
-    def set_app_config(self, stub_host: str, stub_port: int):
+    def set_app_config(self, mock_host: str, mock_port: int):
         if self.set_app_config_func is not None:
-            self.set_app_config_func(stub_host, stub_port)
+            self.set_app_config_func(mock_host, mock_port)
 
     def reset_app_config(self):
         if self.reset_app_config_func is not None:

{specmatic-2.24.0 → specmatic-2.29.0}/specmatic/servers/wsgi_app_server.py

@@ -34,9 +34,9 @@ class WSGIAppServer(AppServer):
     def port(self):
         return self.app_port
 
-    def set_app_config(self, stub_host: str, stub_port: int):
+    def set_app_config(self, mock_host: str, mock_port: int):
         if self.set_app_config_func is not None:
-            self.set_app_config_func(self.app, stub_host, stub_port)
+            self.set_app_config_func(self.app, mock_host, mock_port)
 
     def reset_app_config(self):
         if self.reset_app_config_func is not None:

specmatic-2.29.0/specmatic/version.py

@@ -0,0 +1,2 @@
+__version__ = '2.29.0'
+__specmatic_version__ = '2.29.0'

{specmatic-2.24.0 → specmatic-2.29.0/specmatic.egg-info}/PKG-INFO

@@ -1,10 +1,11 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: specmatic
-Version: 2.24.0
+Version: 2.29.0
 Summary: A Python module for using the Specmatic Library.
 Home-page: https://github.com/specmatic/specmatic-python-extensions
 Author: Specmatic Builders
 Author-email: info@core.in
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 Requires-Dist: pytest>=7.3.1
 Requires-Dist: requests>=2.26.0
@@ -13,6 +14,14 @@ Requires-Dist: uvicorn>=0.18.0
 Requires-Dist: fastapi>=0.70.0
 Requires-Dist: flask>=2.2.5
 Requires-Dist: sanic>=22.12.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # Specmatic Python
 This is a Python library to run [Specmatic](https://specmatic.io).
@@ -23,7 +32,7 @@ Specmatic is a contract driven development tool that allows us to turn OpenAPI c
   The specmatic python library provides three main functions:
   - The ability to start and stop a python web app like flask/sanic.
   - The ability to run specmatic in test mode against an open api contract/spec.
-  - The ability to stub out an api dependency using the specmatic stub feature.
+  - The ability to mock out an api dependency using the specmatic mock feature.
 
 #### Running Contract Tests
 A contract test validates an open api specification against a running api service.  
@@ -46,7 +55,7 @@ The open api specification can be present either locally or in a [Central Contra
   
 #### How does it work
 - Specmatic uses the TestContract class defined above to inject tests dynamically into it when you run it via PyTest or UnitTest.  
-- The Specmatic Python package, invokes the Specmatic executable jar (via command line) in a separate process to start stubs and run tests.  
+- The Specmatic Python package, invokes the Specmatic executable jar (via command line) in a separate process to start mocks and run tests.  
 - It is the specmatic jar which runs the contract tests and generates a JUnit test summary report.  
 - The Specmatic Python package ingests the JUnit test summary report and generates test methods corresponding to every contract test.  
 - These dynamic test methods are added to the  ```TestContract``` class and hence we seem them reported seamlessly by PyTest/Unittest like this:
@@ -60,23 +69,22 @@ test/test_contract_with_coverage.py::TestContract::test_Scenario: GET /products
 
 ## WSGI Apps
 
-#### To run contract tests with a stub for a wsgi app (like Flask):  
+#### To run contract tests with a mock for a wsgi app (like Flask):
 
 ``````python
 class TestContract:
     pass
-    
-    
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_wsgi_app(app, app_host, app_port) \
-    .test(TestContract) \
+
+
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_wsgi_app(app, app_host, app_port)
+    .test(TestContract)
     .run()
- 
- 
+
 if __name__ == '__main__':
-pytest.main()
+    pytest.main()
 `````` 
 
 - In this, we are passing:
@@ -84,16 +92,16 @@ pytest.main()
   - app_host and app_port. If they are not specified, the app will be started on a random available port on 127.0.0.1.
   - You would need a [specmatic config](https://specmatic.io/documentation/specmatic_json.html) file to be present in the root directory of your project.
   - an empty test class.
-  - stub_host, stub_port, optional list of json files to set expectations on the stub.  
-    The stub_host, stub_port will be used to run the specmatic stub server.   
-    If they are not supplied, the stub will be started on a random available port on 127.0.0.1.    
-    [Click here](https://specmatic.io/documentation/service_virtualization_tutorial.html) to learn more about stubbing/service virtualization.
+  - mock_host, mock_port, optional list of json files to set expectations on the mock.  
+    The mock_host, mock_port will be used to run the specmatic mock server.   
+    If they are not supplied, the mock will be started on a random available port on 127.0.0.1.    
+    [Click here](https://specmatic.io/documentation/service_virtualization_tutorial.html) to learn more about mocking/service virtualization.
 -  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.
   
 
-#### To run contract tests without a stub:
+#### To run contract tests without a mock:
 
 ``````python
 class TestContract:
@@ -108,33 +116,35 @@ Specmatic() \
 
 ## ASGI Apps
 
-#### To run contract tests with a stub for an asgi app (like sanic):
+#### To run contract tests with a mock for an asgi app (like sanic):
 - If you are using an asgi app like sanic, fastapi, use the ``````with_asgi_app`````` function and pass it a string in the 'module:app' format.
+
 ``````python
 class TestContract:
     pass
-    
-    
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_asgi_app('main:app', app_host, app_port) \
-    .test(TestContract) \
+
+
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_asgi_app('main:app', app_host, app_port)
+    .test(TestContract)
     .run()
 ``````
 
-### Passing extra arguments to stub/test
+### Passing extra arguments to mock/test
 - To pass arguments like '--strict', '--testBaseUrl', pass them as a list to the 'args' parameter:
+
 ``````python
 class TestContract:
     pass
 
 
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file], ['--strict']) \
-    .with_wsgi_app(app, port=app_port) \
-    .test(TestContract, args=['--testBaseURL=http://localhost:5000']) \
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file], ['--strict'])
+    .with_wsgi_app(app, port=app_port)
+    .test(TestContract, args=['--testBaseURL=http://localhost:5000'])
     .run()
 ``````
 
@@ -148,11 +158,11 @@ class TestContract:
     pass
 
 
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_wsgi_app(app, app_host, app_port) \
-    .test_with_api_coverage_for_flask_app(TestContract, app) \
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_wsgi_app(app, app_host, app_port)
+    .test_with_api_coverage_for_flask_app(TestContract, app)
     .run()
 ``````
 
@@ -163,11 +173,11 @@ class TestContract:
     pass
 
 
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_asgi_app('main:app', app_host, app_port) \
-    .test_with_api_coverage_for_sanic_app(TestContract, app) \
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_asgi_app('main:app', app_host, app_port)
+    .test_with_api_coverage_for_sanic_app(TestContract, app)
     .run()
 ``````
 
@@ -178,11 +188,11 @@ class TestContract:
     pass
 
 
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_asgi_app('main:app', app_host, app_port) \
-    .test_with_api_coverage_for_fastapi_app(TestContract, app) \
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_asgi_app('main:app', app_host, app_port)
+    .test_with_api_coverage_for_fastapi_app(TestContract, app)
     .run()
 ``````
 
@@ -193,14 +203,14 @@ The ``````CoverageRoute`````` class has two properties:
 ``````url`````` : This represents your route url in this format: `````` /orders/{order_id}``````  
 ``````method`````` : A list of HTTP methods supported on the route, for instance : ``````['GET', 'POST']``````  
 
-You can then enable coverage by passing your adapter like this:  
+You can then enable coverage by passing your adapter like this:
 
 ``````python
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_asgi_app('main:app', app_host, app_port) \
-    .test_with_api_coverage(TestContract, MyAppRouteAdapter(app)) \
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_asgi_app('main:app', app_host, app_port)
+    .test_with_api_coverage(TestContract, MyAppRouteAdapter(app))
     .run()
 ``````
 
@@ -215,7 +225,8 @@ You can also easily implement your own coverage server if you have written a cus
 The only point to remember in mind is that the EndPointsApi url should return a list of routes in the format used buy Spring Actuator's ```````/actuator/mappings``````` endpoint
 as described [here](https://docs.spring.io/spring-boot/docs/current/actuator-api/htmlsingle/#mappings).  
 
-Here's an example where we start both our FastApi app and coverage server outside the specmatic api call.  
+Here's an example where we start both our FastApi app and coverage server outside the specmatic api call.
+
 ``````python
 app_server = ASGIAppServer('test.apps.fast_api:app', app_host, app_port)
 coverage_server = FastApiAppCoverageServer(app)
@@ -228,11 +239,11 @@ class TestContract:
     pass
 
 
-Specmatic() \
-    .with_project_root(PROJECT_ROOT) \
-    .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_endpoints_api(coverage_server.endpoints_api) \
-    .test(TestContract, app_host, app_port) \
+Specmatic()
+    .with_project_root(PROJECT_ROOT)
+    .with_mock(mock_host, mock_port, [expectation_json_file])
+    .with_endpoints_api(coverage_server.endpoints_api)
+    .test(TestContract, app_host, app_port)
     .run()
 
 app_server.stop()
@@ -253,7 +264,7 @@ coverage_server.stop()
 ## Sample Projects
 - [Check out the Specmatic Order BFF Python repo](https://github.com/specmatic/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/specmatic/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/specmatic/specmatic-order-api-python/) to see an examples of how to just run tests without using a stub.  
+- [Check out the Specmatic Order API Python repo](https://github.com/specmatic/specmatic-order-api-python/) to see an examples of how to just run tests without using a mock.  
 
 
 

{specmatic-2.24.0 → specmatic-2.29.0}/specmatic.egg-info/SOURCES.txt

@@ -15,7 +15,7 @@ specmatic/core/decorators.py
 specmatic/core/specmatic.jar
 specmatic/core/specmatic.py
 specmatic/core/specmatic_base.py
-specmatic/core/specmatic_stub.py
+specmatic/core/specmatic_mock.py
 specmatic/core/specmatic_test.py
 specmatic/coverage/__init__.py
 specmatic/coverage/app_route_adapter.py

specmatic-2.24.0/specmatic/version.py

@@ -1,2 +0,0 @@
-__version__ = '2.24.0'
-__specmatic_version__ = '2.24.0'