specmatic 0.4.1__py3-none-any.whl → 0.5.0__py3-none-any.whl

specmatic/core/decorators.py

@@ -1,15 +1,16 @@
-from flask import Flask
+import os
+
 from specmatic.server.wsgi_server import WSGIServer
 from specmatic.core.specmatic import Specmatic
 
 
-def specmatic_stub(project_root: str, host: str, port: int, expectation_json_files=None, contract_file='', specmatic_json_file: str = ''):
+def specmatic_stub(project_root: str, host: str = '127.0.0.1', port: int = 0, expectations=None, contract_file='',
+                   specmatic_json_file: str = ''):
     def decorator(cls):
         try:
-            stub = Specmatic.create_stub(project_root, host, port, specmatic_json_file, contract_file)
-            stub.start()
+            stub = Specmatic.start_stub(project_root, host, port, specmatic_json_file, contract_file)
             cls.stub = stub
-            stub.set_expectations(expectation_json_files)
+            stub.set_expectations(expectations)
         except Exception as e:
             if hasattr(cls, 'stub'):
                 cls.stub.stop()
@@ -22,10 +23,19 @@ def specmatic_stub(project_root: str, host: str, port: int, expectation_json_fil
     return decorator
 
 
-def specmatic_contract_test(project_root: str, host: str, port: int, contract_file='', specmatic_json_file: str = ''):
+def specmatic_contract_test(project_root: str, host: str = '127.0.0,1', port: int = 0, contract_file='',
+                            specmatic_json_file: str = ''):
     def decorator(cls):
         try:
-            Specmatic.run_tests(project_root, cls, host, port, specmatic_json_file, contract_file)
+            test_host = host
+            test_port = port
+            if test_port == 0:
+                if hasattr(cls, 'app'):
+                    app = cls.app
+                    test_host = app.host
+                    test_port = app.port
+
+            Specmatic.test(project_root, cls, test_host, test_port, specmatic_json_file, contract_file)
             return cls
         except Exception as e:
             if hasattr(cls, 'stub'):
@@ -43,7 +53,7 @@ def specmatic_contract_test(project_root: str, host: str, port: int, contract_fi
     return decorator
 
 
-def start_app(app, host: str, port: int):
+def start_app(app, host: str = '127.0.0.1', port: int = 0):
     def decorator(cls):
         try:
             wsgi_app = WSGIServer(app, host, port)

specmatic/core/specmatic.py

@@ -8,18 +8,20 @@ from specmatic.utils import get_junit_report_file_path
 class Specmatic:
 
     @classmethod
-    def create_stub(cls, project_root: str, host: str, port: int, specmatic_json_file_path: str = '',
-                    contract_file_path: str = ''):
-        return SpecmaticStub(project_root, host, port, specmatic_json_file_path, contract_file_path)
+    def start_stub(cls, project_root: str, host: str = '127.0.0.1', port: int = 0, specmatic_json_file_path: str = '',
+                   contract_file_path: str = ''):
+        stub = None
+        try:
+            stub = SpecmaticStub(project_root, host, port, specmatic_json_file_path, contract_file_path)
+            return stub
+        except Exception as e:
+            stub.stop()
+            print(f"Error: {e}")
+            raise e
 
     @classmethod
-    def run_tests(cls, project_root: str, test_class, host: str, port: int, specmatic_json_file_path: str = '',
-                  contract_file_path: str = ''):
+    def test(cls, project_root: str, test_class, host: str, port: int, specmatic_json_file_path: str = '',
+             contract_file_path: str = ''):
         SpecmaticTest(project_root, host, port, contract_file_path, specmatic_json_file_path).run()
         PyTestGenerator(test_class, get_junit_report_file_path()).generate()
 
-    @classmethod
-    def run_unit_tests(cls, project_root: str, test_class, host: str, port: int, specmatic_json_file_path: str = '',
-                       contract_file_path: str = ''):
-        SpecmaticTest(project_root, host, port, contract_file_path, specmatic_json_file_path).run()
-        UnitTestGenerator(test_class, get_junit_report_file_path()).generate()

specmatic/core/specmatic_stub.py

@@ -1,16 +1,19 @@
 import json
 import os
+import re
 import subprocess
 import threading
 import traceback
 from queue import Queue
 
 import requests
+from urllib.parse import urlparse
 
 
 class SpecmaticStub:
 
-    def __init__(self, project_root:str, host: str, port: int, specmatic_json_file_path: str, contract_file_path: str):
+    def __init__(self, project_root: str, host: str = '127.0.0.1', port: int = 0, specmatic_json_file_path: str = '',
+                 contract_file_path: str = ''):
         self.__stub_started_event = None
         self.__process = None
         self.project_root = project_root
@@ -18,11 +21,11 @@ class SpecmaticStub:
         self.port = port
         self.specmatic_json_file_path = specmatic_json_file_path
         self.contract_file_path = contract_file_path
-        self.__expectation_api = f'http://{self.host}:{self.port}/_specmatic/expectations'
-        self.__stub_running_success_message = f'Stub server is running on http://{self.host}:{self.port}'
+        self.__stub_running_success_message = 'Stub server is running on '
         self.__error_queue = Queue()
+        self.__start()
 
-    def start(self):
+    def __start(self):
         try:
             self.__stub_started_event = threading.Event()
             self.__start_specmatic_stub_in_subprocess()
@@ -47,7 +50,7 @@ class SpecmaticStub:
                     headers = {
                         "Content-Type": "application/json"
                     }
-                    response = requests.post(self.__expectation_api, json=json_string, headers=headers)
+                    response = requests.post(self.__get_expectations_api_url(), json=json_string, headers=headers)
                     if response.status_code != 200:
                         self.stop()
                         raise Exception(f"{response.content} received for expectation json file: {json_string}")
@@ -57,9 +60,13 @@ class SpecmaticStub:
             print(f"Error: {e}")
             raise e
 
+    def __get_expectations_api_url(self):
+        return f'http://{self.host}:{self.port}/_specmatic/expectations'
+
     def __start_specmatic_stub_in_subprocess(self):
         stub_command = self.__create_stub_process_command()
-        print(f"\n Starting specmatic stub server on {self.host}:{self.port}")
+        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.STDOUT)
 
     def __start_reading_stub_output(self):
@@ -75,6 +82,8 @@ class SpecmaticStub:
     def __read_process_output(self):
         def signal_event_if_stub_has_started(line):
             if self.__stub_running_success_message in line:
+                if self.port == 0:
+                    self.port = line.split(self.host + ':')[1].split('.')[0]
                 self.__stub_started_event.set()
 
         def read_and_print_output_line_by_line():
@@ -108,6 +117,9 @@ class SpecmaticStub:
                 cmd.append("--config=" + self.project_root + "/specmatic.json")
         cmd += [
             '--host=' + self.host,
-            "--port=" + str(self.port)
         ]
+        if self.port != 0:
+            cmd += [
+                "--port=" + str(self.port)
+            ]
         return cmd

specmatic/server/wsgi_server.py

@@ -1,3 +1,4 @@
+import socket
 import threading
 
 from specmatic.server.wsgi_server_thread import WSGIServerThread
@@ -6,10 +7,17 @@ from specmatic.server.wsgi_server_thread import WSGIServerThread
 class WSGIServer:
     server: WSGIServerThread = None
 
-    def __init__(self, app, host: str, port: int):
+    def __init__(self, app, host: str = '127.0.0.1', port: int = 0):
         self.app = app
         self.host = host
-        self.port = port
+        self.port = self.__find_available_port() if port == 0 else port
+
+    def __find_available_port(self):
+        sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        sock.bind(('localhost', 0))
+        port = sock.getsockname()[1]
+        sock.close()
+        return port
 
     def start(self):
         self.server = WSGIServerThread(self.app, self.host, self.port)

specmatic/version.py

@@ -1,2 +1,2 @@
-__version__ = '0.4.1'
+__version__ = '0.5.0'
 __specmatic_version__ = '0.67.0'

{specmatic-0.4.1.dist-info → specmatic-0.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: specmatic
-Version: 0.4.1
+Version: 0.5.0
 Summary: A Python module for using the Specmatic Library.
 Home-page: https://github.com/znsio/specmatic-python-extensions
 Author: Specmatic Builders
@@ -74,15 +74,15 @@ Specmatic is a contract driven development tool that allows us to turn OpenAPI c
     pass
 
 
-  stub = Specmatic.create_stub(PROJECT_ROOT, stub_host, stub_port)
-  stub.start()
+  stub = Specmatic.start_stub(PROJECT_ROOT, stub_host, stub_port)
   stub.set_expectations([expectation_json_file])
 
-  app = WSGIServer(app, app_host, app_port)
-  app.start()
-  Specmatic.run_tests(PROJECT_ROOT, TestContract, app_host, app_port)
+  app_server = WSGIServer(app, app_host, app_port)
+  app_server.start()
 
-  app.stop()
+  Specmatic.test(PROJECT_ROOT, TestContract, app_host, app_port)
+
+  app_server.stop()
   stub.stop()
   
   if __name__ == '__main__':
@@ -91,14 +91,23 @@ Specmatic is a contract driven development tool that allows us to turn OpenAPI c
   
   The above code can be broken down into three parts
   - **Stub setup:**  
-     Use the ``````Specmatic.create_stub()`````` method to create a stub instance.  
-     You can set expectations on the stub by calling the ``````set_expectations()`````` method and passing a list of expectation json files.
+     Use the ``````Specmatic.start_stub()`````` method to create an start a  stub instance.  
+     You can explicitly supply the host/port to run.  
+     If no host/port is supplied, the stub will be started on http://127.0.0.1:9000  
+     You can set expectations on the stub by calling the ``````set_expectations()`````` method and passing a list of expectation json files.  
+     The stub has attributes:  ``````stub.host`````` and ``````stub.port`````` to tell us where it's running on.  
+  
   - **App Setup:**  
-    Create an instance of the ``````WSGIServer`````` class by passing it an instance of a WSGIApplication like a flask app and the host and port to run on.
-  - **Run Tests**
-    Call ``````Specmatic.run_tests()`````` by passing it your root directory, an empty Test class and the host/port on which your app is running.
-          
-        
+    Create an instance of the ``````WSGIServer`````` class by passing it an instance of a WSGIApplication like a flask app and the host and port to run on.  
+    If no host/port is supplied, then the app server will be started on a random freely available port.  
+    The app_server also has  attributes:  ``````app_server.host`````` and ``````app_server.port`````` to tell us where it's running on.  
+  
+  - **Run Tests:**  
+    Call ``````Specmatic.test()`````` by passing it your root directory, an empty Test class and the host/port on which your app server is running.  
+  - Here are some examples to demonstrate how the library can be used in different ways for WSGI apps:  
+    ``````test\test_contract.py`````` : Running specmatic test, stub and a flask app using decorators.  
+    ``````test\test_contract_using_api.py`````` : Running specmatic test, stub and a flask app using the api by explicitly defining all the hosts and ports.  
+    ``````test\test_contract_using_api_implicit.py`````` : Running specmatic test, stub and a flask app using the api without setting explicit ports anywhere .  
         
 
     

{specmatic-0.4.1.dist-info → specmatic-0.5.0.dist-info}/RECORD

@@ -1,30 +1,31 @@
 specmatic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 specmatic/utils.py,sha256=Ns3Ai5jEoP6IaZ4pWRVQUvMtbkyN7p4jj65-qptcNEQ,318
-specmatic/version.py,sha256=b9uSV_2NNzvvC5hUWYFGr363AsKnHmS7uKjdPXPjanI,55
+specmatic/version.py,sha256=UVZ_s20NIPLFY4r3RADtcCjzw968IBNTlp_h4sH68UE,55
 specmatic/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-specmatic/core/decorators.py,sha256=nwXviT7dgd4VIfD_Np1eBK4LsNwgDg-LFuaYOfx0qRA,1908
+specmatic/core/decorators.py,sha256=G4uD-7T171KNlV9vy1Hc29YSPlJpxat2BD4INF_WfgY,2201
 specmatic/core/specmatic.jar,sha256=S0FO6mbbx-7LNGI2dUiJQMEvU5YpxQptMCExW5DtiBo,87153377
-specmatic/core/specmatic.py,sha256=Q-K1DpFyGnHDBEk3yVl3ebLzRzPd4bkJ2eeimYQWyJY,1318
-specmatic/core/specmatic_stub.py,sha256=40sLpdOkVs1HrHj0rGBJZXdUD-lr4gw1_J531kof_W8,4184
+specmatic/core/specmatic.py,sha256=gN2FAWugNTJVG8sNd7YLbKWqfDVaOazuInw1dsLFX5k,1126
+specmatic/core/specmatic_stub.py,sha256=tYRTsbj8q8qWDDMml0KrluUTcMDIDNgHbg5Qsryaee0,4533
 specmatic/core/specmatic_test.py,sha256=v_8MHdL1UZ6OgfosrK-BRtTXOp470GkVyS8A6rAju4g,1634
 specmatic/generators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 specmatic/generators/pytest_generator.py,sha256=x5p_k9wD0dNhV5kvIAM3_rvrQIE2ypCuJFTkyP3Q78Q,735
 specmatic/generators/test_generator_base.py,sha256=2YiiKpsiYIeAO2l9mpivmUXf68IKveqK53BJrLk_6Wk,662
 specmatic/generators/unittest_generator.py,sha256=Vkm8BP-_rZ-tFbLwUTNc90OgQCMJ4OHd8w5mShhcFyU,713
 specmatic/server/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-specmatic/server/wsgi_server.py,sha256=5Tursi4Qd_PjfGZqcKRSJpCc1hG0Qav76fPbpCrIXYQ,474
+specmatic/server/wsgi_server.py,sha256=hebxDxEip9YSdLLwIdBnW6WZiW1vIndis5_csvfIcRI,770
 specmatic/server/wsgi_server_thread.py,sha256=DcuhN8VoGpG6Xxvie2vLYQlUXfL1nCh43q4pGg-zKpw,799
 test/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-test/test_contract.py,sha256=7AIk7tzuttjcBDTeqokjCvtxJ68M_HmdP4t2pGrccbo,608
-test/test_contract_using_api.py,sha256=pxNMKIfFi7BGM0mM3giCNPOfrcShaz5o0G3fYrrtd9w,718
+test/test_contract.py,sha256=Eog9EAeER4deCHvlekip21sKDUzAcZ3qLdU_vpPFj2w,602
+test/test_contract_using_api.py,sha256=hsSJIL6g7uXszTsvoRXFDjwo6LrGHcxstzXdQ_Q5mdw,721
+test/test_contract_using_api_implicit.py,sha256=t6p4FbpVDQj6tC_CAeDcyK4UQD0pD14PFJrG-ssFnoI,737
 test/test_contract_with_local_specs.py,sha256=5P0rhFCs0A9dRNT_jfDSC4ecsL7OakKZI44epZCKCxw,812
-test/api/__init__.py,sha256=MDUtXg97ptIlrwePzHkdU-tfeWwmHjLtJeOfQlTyCTA,252
+test/api/__init__.py,sha256=SL3gC_LcG1G1u9gAZXDxYqAz50gd7QJs59hKFE_k-7k,252
 test/api/models.py,sha256=LZhpMsdLzeBWZ2FvlbzdT3KM64PfhcWN5FeH8cYfNzA,1118
 test/api/routes.py,sha256=XXuCaH1yhNfwNFXP4_jP71EV2klj7vywaE6tl8_2SIY,202
-test/db/Orders.py,sha256=71T7Mzl8j7gLxd30aJCfFRcLtE6GQQ6sy11q860XZkc,414
-test/db/Products.py,sha256=3zBrK5Ih8pBKx5QyvNBcjOOL7z04vdtSRBc8MdZj44E,536
+test/db/Orders.py,sha256=SBhYJhcajg1OOxwaX_ZJS72H0BJhSvO4YfVMxbTQimQ,435
+test/db/Products.py,sha256=_isXcKg47DsYc8-byYU71zu9VUyGevM7vJMeDzMbqUA,569
 test/db/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-specmatic-0.4.1.dist-info/METADATA,sha256=34rFKKe1J-SgxVGfpZ-0YZTDwEw0eEJpTVd6fZvZsXo,4879
-specmatic-0.4.1.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-specmatic-0.4.1.dist-info/top_level.txt,sha256=caucaopz5jgkj72Pbo7QEzUR3jXNPuLv-m-4JHTG878,15
-specmatic-0.4.1.dist-info/RECORD,,
+specmatic-0.5.0.dist-info/METADATA,sha256=zHi2U4oaJgcri6kzsdy6i8WF9trpGOr23nyIGB50RIc,5917
+specmatic-0.5.0.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+specmatic-0.5.0.dist-info/top_level.txt,sha256=caucaopz5jgkj72Pbo7QEzUR3jXNPuLv-m-4JHTG878,15
+specmatic-0.5.0.dist-info/RECORD,,

test/api/__init__.py

@@ -5,7 +5,7 @@ from dotenv import load_dotenv
 
 load_dotenv()
 app = Flask(__name__)
-app.config["ORDER_API_HOST"] = os.getenv("ORDER_API_PORT")
-app.config["ORDER_API_PORT"] = os.getenv("ORDER_API_HOST")
+app.config["ORDER_API_HOST"] = os.getenv("ORDER_API_HOST")
+app.config["ORDER_API_PORT"] = os.getenv("ORDER_API_PORT")
 
 from test.api.routes import *

test/db/Orders.py

@@ -1,10 +1,10 @@
-import json
-
 import requests
 from test.api import app
 
+
 class Orders:
-    orders_api = f'http://{app.config["ORDER_API_HOST"]}:{app.config["ORDER_API_PORT"]}/orders'
+    def __init__(self):
+        self.orders_api = f'http://{app.config["ORDER_API_HOST"]}:{app.config["ORDER_API_PORT"]}/orders'
 
     def create(self, order):
         # Set the headers to specify that we're sending JSON data

test/db/Products.py

@@ -1,9 +1,10 @@
-import requests
 from test.api import app
+import requests
 
 
 class Products:
-    products_api = f'http://{app.config["ORDER_API_HOST"]}:{app.config["ORDER_API_PORT"]}/products'
+    def __init__(self):
+        self.products_api = f'http://{app.config["ORDER_API_HOST"]}:{app.config["ORDER_API_PORT"]}/products'
 
     def search(self, product_type: str):
         try:

test/test_contract.py

@@ -9,11 +9,12 @@ 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, app_host, app_port)
-@start_app(app, app_host, app_port)
+@specmatic_contract_test(PROJECT_ROOT)
+@start_app(app)
 @specmatic_stub(PROJECT_ROOT, stub_host, stub_port, [expectation_json_file])
 class TestContract:
     pass

test/test_contract_using_api.py

@@ -16,15 +16,15 @@ class TestContract:
     pass
 
 
-stub = Specmatic.create_stub(PROJECT_ROOT, stub_host, stub_port)
-stub.start()
+stub = Specmatic.start_stub(PROJECT_ROOT, stub_host, stub_port)
 stub.set_expectations([expectation_json_file])
 
-app = WSGIServer(app, app_host, app_port)
-app.start()
-Specmatic.run_tests(PROJECT_ROOT, TestContract, app_host, app_port)
+app_server = WSGIServer(app, app_host, app_port)
+app_server.start()
 
-app.stop()
+Specmatic.test(PROJECT_ROOT, TestContract, app_host, app_port)
+
+app_server.stop()
 stub.stop()
 
 if __name__ == '__main__':

test/test_contract_using_api_implicit.py

@@ -0,0 +1,32 @@
+import pytest
+from specmatic.core.specmatic import Specmatic
+from specmatic.server.wsgi_server import WSGIServer
+from specmatic.utils import get_project_root
+from test.api 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
+
+
+stub = Specmatic.start_stub(PROJECT_ROOT)
+stub.set_expectations([expectation_json_file])
+
+app.config['ORDER_API_HOST'] = stub.host
+app.config['ORDER_API_PORT'] = stub.port
+app_server = WSGIServer(app)
+app_server.start()
+
+Specmatic.test(PROJECT_ROOT, TestContract, app_server.host, app_server.port)
+
+app_server.stop()
+stub.stop()
+
+if __name__ == '__main__':
+    pytest.main()