specmatic 0.8.2__tar.gz → 0.9.1__tar.gz

{specmatic-0.8.2/specmatic.egg-info → specmatic-0.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: specmatic
-Version: 0.8.2
+Version: 0.9.1
 Summary: A Python module for using the Specmatic Library.
 Home-page: https://github.com/znsio/specmatic-python-extensions
 Author: Specmatic Builders
@@ -41,28 +41,24 @@ The open api specification can be present either locally or in a [Central Contra
 ## WSGI Apps
 
 #### To run contract tests with a stub for a wsgi app (like Flask):  
-- Create an instance of a ``````WSGIAppServer`````` by passing it your app object, host, port:  
-``````app_server = WSGIAppServer(app, app_host, app_port)``````
-- Note:
-  - The host and port are optional. 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.json](https://specmatic.in/documentation/specmatic_json.html) file to be present in the root directory of your project.
-- To run tests using a stub for your dependencies:
+
 ``````
 class TestContract:
     pass
     
     
-app_server = WSGIAppServer(app, app_host, app_port)
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
-    .stub(stub_host, stub_port, [expectation_json_file]) \
-    .app(app_server) \
+    .with_stub(stub_host, stub_port, [expectation_json_file]) \
+    .with_wsgi_app(app, app_host, app_port) \
     .test(TestContract) \
     .run()
 `````` 
 
 - In this, we are passing:
-  - an instance of the WSGIAppServer class. 
+  - an instance of your asgi app like flask 
+  - 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.json](https://specmatic.in/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.   
@@ -79,11 +75,9 @@ Specmatic() \
 class TestContract:
     pass
     
-    
-app_server = WSGIAppServer(app, app_host, app_port)
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
-    .app(app_server) \
+    .with_wsgi_app(app, app_host, app_port) \
     .test(TestContract) \
     .run()
 ``````                        
@@ -91,20 +85,16 @@ Specmatic() \
 ## ASGI Apps
 
 #### To run contract tests with a stub for an asgi app (like sanic):
-- Create an instance of a ``````ASGIAppServer`````` by passing it a string in the 'module:app' format for your asgi app, host, port:  
-``````app_server = ASGIAppServer('main:app', app_host, app_port)``````  
- If host and port are not specified, the app will be started on a random available port on 127.0.0.1.
-- You can now use the ``````ASGIAppServer`````` object to run tests just like we do it for WSGI apps:
+- 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.
 ``````
 class TestContract:
     pass
     
     
-app_server = ASGIAppServer('main:app', app_host, app_port)
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
-    .stub(stub_host, stub_port, [expectation_json_file]) \
-    .app(app_server) \
+    .with_stub(stub_host, stub_port, [expectation_json_file]) \
+    .with_asgi_app('main:app', app_host, app_port) \
     .test(TestContract) \
     .run()
 ``````
@@ -116,18 +106,17 @@ class TestContract:
     pass
 
 
-app_server = WSGIAppServer(app, app_host, app_port)
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
-    .stub(stub_host, stub_port, [expectation_json_file], ['--strict']) \
-    .app(app_server) \
+    .with_stub(stub_host, stub_port, [expectation_json_file], ['--strict']) \
+    .with_wsgi_app(app, port=app_port) \
     .test(TestContract, args=['--testBaseURL=http://localhost:5000']) \
     .run()
 ``````
 
 ## Common Issues
 - **'Error loading ASGI app'** 
-   This error occurs due to incorrect module being specified in the app module parameter 'module:app' string.
+   This error occurs when an incorrect app module string is passed to the ``````with_asgi_app`````` function.  
  
    #### Solutions:
    - Try to identify the correct module in which your app variable is instantiated/imported.  

{specmatic-0.8.2 → specmatic-0.9.1}/README.md

@@ -32,28 +32,24 @@ The open api specification can be present either locally or in a [Central Contra
 ## WSGI Apps
 
 #### To run contract tests with a stub for a wsgi app (like Flask):  
-- Create an instance of a ``````WSGIAppServer`````` by passing it your app object, host, port:  
-``````app_server = WSGIAppServer(app, app_host, app_port)``````
-- Note:
-  - The host and port are optional. 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.json](https://specmatic.in/documentation/specmatic_json.html) file to be present in the root directory of your project.
-- To run tests using a stub for your dependencies:
+
 ``````
 class TestContract:
     pass
     
     
-app_server = WSGIAppServer(app, app_host, app_port)
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
-    .stub(stub_host, stub_port, [expectation_json_file]) \
-    .app(app_server) \
+    .with_stub(stub_host, stub_port, [expectation_json_file]) \
+    .with_wsgi_app(app, app_host, app_port) \
     .test(TestContract) \
     .run()
 `````` 
 
 - In this, we are passing:
-  - an instance of the WSGIAppServer class. 
+  - an instance of your asgi app like flask 
+  - 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.json](https://specmatic.in/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.   
@@ -70,11 +66,9 @@ Specmatic() \
 class TestContract:
     pass
     
-    
-app_server = WSGIAppServer(app, app_host, app_port)
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
-    .app(app_server) \
+    .with_wsgi_app(app, app_host, app_port) \
     .test(TestContract) \
     .run()
 ``````                        
@@ -82,20 +76,16 @@ Specmatic() \
 ## ASGI Apps
 
 #### To run contract tests with a stub for an asgi app (like sanic):
-- Create an instance of a ``````ASGIAppServer`````` by passing it a string in the 'module:app' format for your asgi app, host, port:  
-``````app_server = ASGIAppServer('main:app', app_host, app_port)``````  
- If host and port are not specified, the app will be started on a random available port on 127.0.0.1.
-- You can now use the ``````ASGIAppServer`````` object to run tests just like we do it for WSGI apps:
+- 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.
 ``````
 class TestContract:
     pass
     
     
-app_server = ASGIAppServer('main:app', app_host, app_port)
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
-    .stub(stub_host, stub_port, [expectation_json_file]) \
-    .app(app_server) \
+    .with_stub(stub_host, stub_port, [expectation_json_file]) \
+    .with_asgi_app('main:app', app_host, app_port) \
     .test(TestContract) \
     .run()
 ``````
@@ -107,18 +97,17 @@ class TestContract:
     pass
 
 
-app_server = WSGIAppServer(app, app_host, app_port)
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
-    .stub(stub_host, stub_port, [expectation_json_file], ['--strict']) \
-    .app(app_server) \
+    .with_stub(stub_host, stub_port, [expectation_json_file], ['--strict']) \
+    .with_wsgi_app(app, port=app_port) \
     .test(TestContract, args=['--testBaseURL=http://localhost:5000']) \
     .run()
 ``````
 
 ## Common Issues
 - **'Error loading ASGI app'** 
-   This error occurs due to incorrect module being specified in the app module parameter 'module:app' string.
+   This error occurs when an incorrect app module string is passed to the ``````with_asgi_app`````` function.  
  
    #### Solutions:
    - Try to identify the correct module in which your app variable is instantiated/imported.  

specmatic-0.9.1/specmatic/core/specmatic.py

@@ -0,0 +1,138 @@
+import unittest
+
+from specmatic.core.specmatic_stub import SpecmaticStub
+from specmatic.core.specmatic_test import SpecmaticTest
+from specmatic.generators.pytest_generator import PyTestGenerator
+from specmatic.generators.unittest_generator import UnitTestGenerator
+from specmatic.servers.app_server import AppServer
+from specmatic.servers.asgi_app_server import ASGIAppServer
+from specmatic.servers.wsgi_app_server import WSGIAppServer
+from specmatic.utils import get_junit_report_file_path
+
+
+class Specmatic:
+    def __init__(self):
+        self.app = None
+        self.app_module = ''
+        self.app_host = '127.0.0.1'
+        self.app_port = 0
+        self.reset_app_config_func = None
+        self.set_app_config_func = None
+        self.app_server = None
+
+        self.stub_host = None
+        self.stub_port = None
+        self.expectations = None
+        self.stub_args = None
+        self.stub = None
+
+        self.test_class = None
+        self.test_host = None
+        self.test_port = None
+        self.test_args = None
+
+        self.project_root = ''
+        self.specmatic_json_file_path = ''
+
+        self.run_stub = False
+        self.run_app = False
+        self.run_tests = False
+
+    def with_project_root(self, project_root):
+        self.project_root = project_root
+        return self
+
+    def with_specmatic_json_file_path(self, specmatic_json_file_path):
+        self.specmatic_json_file_path = specmatic_json_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
+        self.expectations = expectations
+        self.stub_args = args
+        return self
+
+    def app(self, app_server: AppServer):
+        self.app_server = app_server
+        self.run_app = True
+        return self
+
+    def with_wsgi_app(self, app, host: str = '127.0.0.1', port: int = 0, set_app_config_func=None,
+                      reset_app_config_func=None):
+        self.app = app
+        self.app_host = host
+        self.app_port = port
+        self.set_app_config_func = set_app_config_func
+        self.reset_app_config_func = reset_app_config_func
+        self.run_app = True
+        return self
+
+    def with_asgi_app(self, app_module: str, host: str = '127.0.0.1', port: int = 0, set_app_config_func=None,
+                      reset_app_config_func=None):
+        self.app_module = app_module
+        self.app_host = host
+        self.app_port = port
+        self.set_app_config_func = set_app_config_func
+        self.reset_app_config_func = reset_app_config_func
+        self.run_app = True
+        return self
+
+    def test(self, test_class, test_host: str = '127.0.0.1', test_port: int = 0, args=None):
+        self.test_class = test_class
+        self.test_host = test_host
+        self.test_port = test_port
+        self.test_args = args
+        self.run_tests = True
+        return self
+
+    def __init_app_server(self):
+        if self.run_app:
+            if self.app is None and self.app_module == '':
+                raise Exception('Please specify either an app or an app_module.')
+            if self.app is not None and self.app_module != '':
+                raise Exception('Please specify only one of app or app_module, and not both.')
+            if self.app is not None:
+                self.app_server = WSGIAppServer(self.app, self.app_host, self.app_port, self.set_app_config_func,
+                                                self.reset_app_config_func)
+            else:
+                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_json_file_path,
+                                      self.stub_args)
+            self.stub.set_expectations(self.expectations)
+            self.app_server.set_app_config(self.stub.host, self.stub.port)
+
+    def __execute_tests(self):
+        if self.run_tests:
+            if self.app_server is not None:
+                self.app_server.start()
+                self.test_host = self.app_server.host
+                self.test_port = self.app_server.port
+            SpecmaticTest(self.test_host, self.test_port, self.project_root,
+                          self.specmatic_json_file_path, self.test_args).run()
+            if issubclass(self.test_class, unittest.TestCase):
+                print("Injecting unittest methods")
+                UnitTestGenerator(self.test_class, get_junit_report_file_path()).generate()
+            else:
+                print("Injecting pytest methods")
+                PyTestGenerator(self.test_class, get_junit_report_file_path()).generate()
+
+    def run(self):
+        try:
+            self.__init_app_server()
+            self.__start_stub()
+            self.__execute_tests()
+        except Exception as e:
+            print(f"Error: {e}")
+            raise e
+        finally:
+            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()

{specmatic-0.8.2 → specmatic-0.9.1}/specmatic/servers/asgi_app_server.py

@@ -43,6 +43,9 @@ class ASGIAppServer(AppServer):
     def __read_process_output(self):
         try:
             for line in iter(self.__process.stdout.readline, ''):
+                if self.__process.poll() is not None:
+                    line = line.decode()
+                    raise Exception('App process terminated due to an error ' + line)
                 if line:
                     line = line.decode().rstrip()
                     print(line)

{specmatic-0.8.2 → specmatic-0.9.1}/specmatic/version.py

@@ -1,2 +1,2 @@
-__version__ = '0.8.2'
+__version__ = '0.9.1'
 __specmatic_version__ = '0.68.0'

{specmatic-0.8.2 → specmatic-0.9.1/specmatic.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: specmatic
-Version: 0.8.2
+Version: 0.9.1
 Summary: A Python module for using the Specmatic Library.
 Home-page: https://github.com/znsio/specmatic-python-extensions
 Author: Specmatic Builders
@@ -41,28 +41,24 @@ The open api specification can be present either locally or in a [Central Contra
 ## WSGI Apps
 
 #### To run contract tests with a stub for a wsgi app (like Flask):  
-- Create an instance of a ``````WSGIAppServer`````` by passing it your app object, host, port:  
-``````app_server = WSGIAppServer(app, app_host, app_port)``````
-- Note:
-  - The host and port are optional. 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.json](https://specmatic.in/documentation/specmatic_json.html) file to be present in the root directory of your project.
-- To run tests using a stub for your dependencies:
+
 ``````
 class TestContract:
     pass
     
     
-app_server = WSGIAppServer(app, app_host, app_port)
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
-    .stub(stub_host, stub_port, [expectation_json_file]) \
-    .app(app_server) \
+    .with_stub(stub_host, stub_port, [expectation_json_file]) \
+    .with_wsgi_app(app, app_host, app_port) \
     .test(TestContract) \
     .run()
 `````` 
 
 - In this, we are passing:
-  - an instance of the WSGIAppServer class. 
+  - an instance of your asgi app like flask 
+  - 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.json](https://specmatic.in/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.   
@@ -79,11 +75,9 @@ Specmatic() \
 class TestContract:
     pass
     
-    
-app_server = WSGIAppServer(app, app_host, app_port)
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
-    .app(app_server) \
+    .with_wsgi_app(app, app_host, app_port) \
     .test(TestContract) \
     .run()
 ``````                        
@@ -91,20 +85,16 @@ Specmatic() \
 ## ASGI Apps
 
 #### To run contract tests with a stub for an asgi app (like sanic):
-- Create an instance of a ``````ASGIAppServer`````` by passing it a string in the 'module:app' format for your asgi app, host, port:  
-``````app_server = ASGIAppServer('main:app', app_host, app_port)``````  
- If host and port are not specified, the app will be started on a random available port on 127.0.0.1.
-- You can now use the ``````ASGIAppServer`````` object to run tests just like we do it for WSGI apps:
+- 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.
 ``````
 class TestContract:
     pass
     
     
-app_server = ASGIAppServer('main:app', app_host, app_port)
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
-    .stub(stub_host, stub_port, [expectation_json_file]) \
-    .app(app_server) \
+    .with_stub(stub_host, stub_port, [expectation_json_file]) \
+    .with_asgi_app('main:app', app_host, app_port) \
     .test(TestContract) \
     .run()
 ``````
@@ -116,18 +106,17 @@ class TestContract:
     pass
 
 
-app_server = WSGIAppServer(app, app_host, app_port)
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
-    .stub(stub_host, stub_port, [expectation_json_file], ['--strict']) \
-    .app(app_server) \
+    .with_stub(stub_host, stub_port, [expectation_json_file], ['--strict']) \
+    .with_wsgi_app(app, port=app_port) \
     .test(TestContract, args=['--testBaseURL=http://localhost:5000']) \
     .run()
 ``````
 
 ## Common Issues
 - **'Error loading ASGI app'** 
-   This error occurs due to incorrect module being specified in the app module parameter 'module:app' string.
+   This error occurs when an incorrect app module string is passed to the ``````with_asgi_app`````` function.  
  
    #### Solutions:
    - Try to identify the correct module in which your app variable is instantiated/imported.  

specmatic-0.8.2/specmatic/core/specmatic.py

@@ -1,85 +0,0 @@
-import unittest
-
-from specmatic.core.specmatic_stub import SpecmaticStub
-from specmatic.core.specmatic_test import SpecmaticTest
-from specmatic.generators.pytest_generator import PyTestGenerator
-from specmatic.generators.unittest_generator import UnitTestGenerator
-from specmatic.servers.app_server import AppServer
-from specmatic.utils import get_junit_report_file_path
-
-
-class Specmatic:
-    def __init__(self):
-        self.test_args = None
-        self.stub_args = None
-        self.test_class = None
-        self.test_port = None
-        self.test_host = None
-        self.app_server = None
-        self.expectations = None
-        self.stub_port = None
-        self.stub_host = None
-        self.run_stub = False
-        self.run_app = False
-        self.run_tests = False
-        self.project_root = ''
-        self.specmatic_json_file_path = ''
-
-    def with_project_root(self, project_root):
-        self.project_root = project_root
-        return self
-
-    def with_specmatic_json_file_path(self, specmatic_json_file_path):
-        self.specmatic_json_file_path = specmatic_json_file_path
-        return self
-
-    def 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
-        self.expectations = expectations
-        self.stub_args = args
-        return self
-
-    def app(self, app_server: AppServer):
-        self.app_server = app_server
-        self.run_app = True
-        return self
-
-    def test(self, test_class, test_host: str = '127.0.0.1', test_port: int = 0, args=None):
-        self.test_class = test_class
-        self.test_host = test_host
-        self.test_port = test_port
-        self.test_args = args
-        self.run_tests = True
-        return self
-
-    def run(self):
-        stub = None
-        try:
-            if self.run_stub:
-                stub = SpecmaticStub(self.stub_host, self.stub_port, self.project_root, self.specmatic_json_file_path, self.stub_args)
-                stub.set_expectations(self.expectations)
-                self.app_server.set_app_config(stub.host, stub.port)
-            if self.run_app:
-                self.app_server.start()
-                self.test_host = self.app_server.host
-                self.test_port = self.app_server.port
-            if self.run_tests:
-                SpecmaticTest(self.test_host, self.test_port, self.project_root,
-                              self.specmatic_json_file_path, self.test_args).run()
-                if issubclass(self.test_class,  unittest.TestCase):
-                    print("Injecting unittest methods")
-                    UnitTestGenerator(self.test_class, get_junit_report_file_path()).generate()
-                else:
-                    print("Injecting pytest methods")
-                    PyTestGenerator(self.test_class, get_junit_report_file_path()).generate()
-        except Exception as e:
-            print(f"Error: {e}")
-            raise e
-        finally:
-            if self.app_server is not None:
-                self.app_server.stop()
-                self.app_server.reset_app_config()
-            if stub is not None:
-                stub.stop()