specmatic 0.9.0__tar.gz → 0.9.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: specmatic
-Version: 0.9.0
+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
@@ -50,9 +50,7 @@ class TestContract:
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
     .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_app(app) \
-    .with_app_host(app_host)\
-    .with_app_port(app_port)\
+    .with_wsgi_app(app, app_host, app_port) \
     .test(TestContract) \
     .run()
 `````` 
@@ -79,9 +77,7 @@ class TestContract:
     
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
-    .with_app(app) \
-    .with_app_host(app_host)\
-    .with_app_port(app_port)\
+    .with_wsgi_app(app, app_host, app_port) \
     .test(TestContract) \
     .run()
 ``````                        
@@ -89,7 +85,7 @@ Specmatic() \
 ## ASGI Apps
 
 #### To run contract tests with a stub for an asgi app (like sanic):
-- If you are using an asgi app like sanic, fastapi, use the ``````with_app_module`````` function and pass it a string in the 'module:app' format.
+- 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
@@ -98,9 +94,7 @@ class TestContract:
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
     .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_app_module('main:app') \
-    .with_app_host(app_host) \
-    .with_app_port(app_port) \
+    .with_asgi_app('main:app', app_host, app_port) \
     .test(TestContract) \
     .run()
 ``````
@@ -115,15 +109,14 @@ class TestContract:
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
     .with_stub(stub_host, stub_port, [expectation_json_file], ['--strict']) \
-    .with_app(app) \
-    .with_app_port(app_port) \
+    .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.0 → specmatic-0.9.1}/README.md

@@ -41,9 +41,7 @@ class TestContract:
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
     .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_app(app) \
-    .with_app_host(app_host)\
-    .with_app_port(app_port)\
+    .with_wsgi_app(app, app_host, app_port) \
     .test(TestContract) \
     .run()
 `````` 
@@ -70,9 +68,7 @@ class TestContract:
     
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
-    .with_app(app) \
-    .with_app_host(app_host)\
-    .with_app_port(app_port)\
+    .with_wsgi_app(app, app_host, app_port) \
     .test(TestContract) \
     .run()
 ``````                        
@@ -80,7 +76,7 @@ Specmatic() \
 ## ASGI Apps
 
 #### To run contract tests with a stub for an asgi app (like sanic):
-- If you are using an asgi app like sanic, fastapi, use the ``````with_app_module`````` function and pass it a string in the 'module:app' format.
+- 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
@@ -89,9 +85,7 @@ class TestContract:
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
     .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_app_module('main:app') \
-    .with_app_host(app_host) \
-    .with_app_port(app_port) \
+    .with_asgi_app('main:app', app_host, app_port) \
     .test(TestContract) \
     .run()
 ``````
@@ -106,15 +100,14 @@ class TestContract:
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
     .with_stub(stub_host, stub_port, [expectation_json_file], ['--strict']) \
-    .with_app(app) \
-    .with_app_port(app_port) \
+    .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.0 → specmatic-0.9.1}/specmatic/core/specmatic.py

@@ -12,26 +12,31 @@ from specmatic.utils import get_junit_report_file_path
 
 class Specmatic:
     def __init__(self):
-        self.reset_app_config_func = None
-        self.set_app_config_func = None
+        self.app = None
+        self.app_module = ''
         self.app_host = '127.0.0.1'
         self.app_port = 0
-        self.app_module = ''
-        self.app = None
-        self.test_args = None
+        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_port = None
         self.test_host = None
-        self.app_server = None
-        self.expectations = None
-        self.stub_port = None
-        self.stub_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
-        self.project_root = ''
-        self.specmatic_json_file_path = ''
 
     def with_project_root(self, project_root):
         self.project_root = project_root
@@ -54,30 +59,24 @@ class Specmatic:
         self.run_app = True
         return self
 
-    def with_app(self, app):
+    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_app_module(self, app_module: str):
+    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.run_app = True
-        return self
-
-    def with_app_host(self, host: str):
         self.app_host = host
-        return self
-
-    def with_app_port(self, port: int):
         self.app_port = port
-        return self
-
-    def with_set_app_config_func(self, set_app_config_func):
         self.set_app_config_func = set_app_config_func
-        return self
-
-    def with_reset_app_config_func(self, reset_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):
@@ -88,38 +87,46 @@ class Specmatic:
         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):
-        stub = None
         try:
-            if self.run_app:
-                if self.app is None and self.app_module == '':
-                    raise Exception('Please specify either app or 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)
-            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_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()
+            self.__init_app_server()
+            self.__start_stub()
+            self.__execute_tests()
         except Exception as e:
             print(f"Error: {e}")
             raise e
@@ -127,5 +134,5 @@ class Specmatic:
             if self.app_server is not None:
                 self.app_server.stop()
                 self.app_server.reset_app_config()
-            if stub is not None:
-                stub.stop()
+            if self.stub is not None:
+                self.stub.stop()

{specmatic-0.9.0 → 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.9.0 → specmatic-0.9.1}/specmatic/version.py

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: specmatic
-Version: 0.9.0
+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
@@ -50,9 +50,7 @@ class TestContract:
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
     .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_app(app) \
-    .with_app_host(app_host)\
-    .with_app_port(app_port)\
+    .with_wsgi_app(app, app_host, app_port) \
     .test(TestContract) \
     .run()
 `````` 
@@ -79,9 +77,7 @@ class TestContract:
     
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
-    .with_app(app) \
-    .with_app_host(app_host)\
-    .with_app_port(app_port)\
+    .with_wsgi_app(app, app_host, app_port) \
     .test(TestContract) \
     .run()
 ``````                        
@@ -89,7 +85,7 @@ Specmatic() \
 ## ASGI Apps
 
 #### To run contract tests with a stub for an asgi app (like sanic):
-- If you are using an asgi app like sanic, fastapi, use the ``````with_app_module`````` function and pass it a string in the 'module:app' format.
+- 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
@@ -98,9 +94,7 @@ class TestContract:
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
     .with_stub(stub_host, stub_port, [expectation_json_file]) \
-    .with_app_module('main:app') \
-    .with_app_host(app_host) \
-    .with_app_port(app_port) \
+    .with_asgi_app('main:app', app_host, app_port) \
     .test(TestContract) \
     .run()
 ``````
@@ -115,15 +109,14 @@ class TestContract:
 Specmatic() \
     .with_project_root(PROJECT_ROOT) \
     .with_stub(stub_host, stub_port, [expectation_json_file], ['--strict']) \
-    .with_app(app) \
-    .with_app_port(app_port) \
+    .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.