specmatic 2.0.0__tar.gz → 2.0.1__tar.gz

{specmatic-2.0.0/specmatic.egg-info → specmatic-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: specmatic
-Version: 2.0.0
+Version: 2.0.1
 Summary: A Python module for using the Specmatic Library.
 Home-page: https://github.com/znsio/specmatic-python-extensions
 Author: Specmatic Builders
@@ -15,7 +15,7 @@ Requires-Dist: flask>=2.2.5
 Requires-Dist: sanic>=22.12.0
 
 # Specmatic Python
-This is a Python library to run [Specmatic](https://specmatic.in).
+This is a Python library to run [Specmatic](https://specmatic.io).
 Specmatic is a contract driven development tool that allows us to turn OpenAPI contracts into executable specifications.
 <br/>Click below to learn more about Specmatic and Contract Driven Development<br/><br/>
 [![Specmatic - Contract Driven Development](https://img.youtube.com/vi/3HPgpvd8MGg/0.jpg)](https://www.youtube.com/watch?v=3HPgpvd8MGg "Specmatic - Contract Driven Development")
@@ -27,8 +27,8 @@ Specmatic is a contract driven development tool that allows us to turn OpenAPI c
 
 #### Running Contract Tests
 A contract test validates an open api specification against a running api service.  
-The open api specification can be present either locally or in a [Central Contract Repository](https://specmatic.in/documentation/central_contract_repository.html)  
-[Click here](https://specmatic.in/documentation/contract_tests.html) to learn more about contract tests.  
+The open api specification can be present either locally or in a [Central Contract Repository](https://specmatic.io/documentation/central_contract_repository.html)  
+[Click here](https://specmatic.io/documentation/contract_tests.html) to learn more about contract tests.  
 
 #### How to use
 - Create a file called test_contract.py in your test folder.  
@@ -82,12 +82,12 @@ pytest.main()
 - In this, we are passing:
   - an instance of your wsgi 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.
+  - You would need a [specmatic config](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.   
     If they are not supplied, the stub will be started on a random available port on 127.0.0.1.    
-    [Click here](https://specmatic.in/documentation/service_virtualization_tutorial.html) to learn more about stubbing/service virtualization.
+    [Click here](https://specmatic.io/documentation/service_virtualization_tutorial.html) to learn more about stubbing/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.

{specmatic-2.0.0 → specmatic-2.0.1}/README.md

@@ -1,5 +1,5 @@
 # Specmatic Python
-This is a Python library to run [Specmatic](https://specmatic.in).
+This is a Python library to run [Specmatic](https://specmatic.io).
 Specmatic is a contract driven development tool that allows us to turn OpenAPI contracts into executable specifications.
 <br/>Click below to learn more about Specmatic and Contract Driven Development<br/><br/>
 [![Specmatic - Contract Driven Development](https://img.youtube.com/vi/3HPgpvd8MGg/0.jpg)](https://www.youtube.com/watch?v=3HPgpvd8MGg "Specmatic - Contract Driven Development")
@@ -11,8 +11,8 @@ Specmatic is a contract driven development tool that allows us to turn OpenAPI c
 
 #### Running Contract Tests
 A contract test validates an open api specification against a running api service.  
-The open api specification can be present either locally or in a [Central Contract Repository](https://specmatic.in/documentation/central_contract_repository.html)  
-[Click here](https://specmatic.in/documentation/contract_tests.html) to learn more about contract tests.  
+The open api specification can be present either locally or in a [Central Contract Repository](https://specmatic.io/documentation/central_contract_repository.html)  
+[Click here](https://specmatic.io/documentation/contract_tests.html) to learn more about contract tests.  
 
 #### How to use
 - Create a file called test_contract.py in your test folder.  
@@ -66,12 +66,12 @@ pytest.main()
 - In this, we are passing:
   - an instance of your wsgi 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.
+  - You would need a [specmatic config](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.   
     If they are not supplied, the stub will be started on a random available port on 127.0.0.1.    
-    [Click here](https://specmatic.in/documentation/service_virtualization_tutorial.html) to learn more about stubbing/service virtualization.
+    [Click here](https://specmatic.io/documentation/service_virtualization_tutorial.html) to learn more about stubbing/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.

{specmatic-2.0.0 → specmatic-2.0.1}/specmatic/core/decorators.py

@@ -12,10 +12,10 @@ 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,
-                   specmatic_json_file: str = ''):
+                   specmatic_config_file_path: str = ''):
     def decorator(cls):
         try:
-            cls.stub = SpecmaticStub(host, port, project_root, specmatic_json_file)
+            cls.stub = SpecmaticStub(host, port, project_root, specmatic_config_file_path)
             cls.stub.set_expectations(expectations)
         except Exception as e:
             if hasattr(cls, 'stub'):
@@ -31,7 +31,7 @@ def specmatic_stub(host: str = '127.0.0.1', port: int = 0, project_root: str = '
 
 def specmatic_contract_test(host: str = '127.0.0,1', port: int = 0,
                                               project_root: str = '',
-                                              specmatic_json_file: str = '', args=None, appRouteAdapter: AppRouteAdapter=None,):
+                                              specmatic_config_file_path: str = '', args=None, appRouteAdapter: AppRouteAdapter=None,):
     def decorator(cls):
         try:
             test_host = host
@@ -47,7 +47,7 @@ def specmatic_contract_test(host: str = '127.0.0,1', port: int = 0,
                 cls.coverage_server.start()
                 endpoints_api = cls.coverage_server.endpoints_api
 
-            SpecmaticTest(test_host, test_port, project_root, specmatic_json_file, args,
+            SpecmaticTest(test_host, test_port, project_root, specmatic_config_file_path, args,
                           endpoints_api).run()
 
             if issubclass(cls, unittest.TestCase):

{specmatic-2.0.0 → specmatic-2.0.1}/specmatic/core/specmatic.py

@@ -37,7 +37,7 @@ class Specmatic:
         self.test_args = None
 
         self.project_root = ''
-        self.specmatic_json_file_path = ''
+        self.specmatic_config_file_path = ''
 
         self.run_stub = False
         self.run_app = False
@@ -50,8 +50,8 @@ class Specmatic:
         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
+    def with_specmatic_config_file_path(self, specmatic_config_file_path):
+        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):
@@ -138,7 +138,7 @@ class Specmatic:
 
     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 = SpecmaticStub(self.stub_host, self.stub_port, self.project_root, self.specmatic_config_file_path,
                                       self.stub_args)
             self.stub.set_expectations(self.expectations)
             if self.app_server is not None:
@@ -157,7 +157,7 @@ class Specmatic:
                     self.endpoints_api = self.coverage_server.endpoints_api
 
             SpecmaticTest(self.test_host, self.test_port, self.project_root,
-                          self.specmatic_json_file_path, self.test_args, self.endpoints_api).run()
+                          self.specmatic_config_file_path, self.test_args, self.endpoints_api).run()
 
             if issubclass(self.test_class, unittest.TestCase):
                 print("Injecting unittest methods")

{specmatic-2.0.0 → specmatic-2.0.1}/specmatic/core/specmatic_base.py

@@ -3,22 +3,15 @@ import os
 
 class SpecmaticBase:
     def __init__(self, host: str = '127.0.0.1', port: int = 0, project_root: str = '',
-                 specmatic_json_file_path: str = '', args=None, endpoints_api=""):
-        self.specmatic_json_file_path = None
+                 specmatic_config_file_path: str = '', args=None, endpoints_api=""):
         self.contract_file_paths = None
-        self.project_root = None
         self.project_root = project_root
         self.host = host
         self.port = port
-        self.specmatic_json_file_path = specmatic_json_file_path
+        self.specmatic_config_file_path = specmatic_config_file_path
         self.args = [] if args is None else args
         self.endpoints_api = endpoints_api
 
-    def validate_mandatory_fields(self):
-        if self.project_root == '' and self.specmatic_json_file_path == '':
-            raise Exception(
-                'Please specify either of the following parameters: project_root, specmatic_json_file_path')
-
     def create_command_array(self, mode: str, junit_dir_path=""):
         jar_path = os.path.dirname(os.path.realpath(__file__)) + "/specmatic.jar"
         cmd = ["java"]
@@ -31,10 +24,9 @@ class SpecmaticBase:
         cmd.append(jar_path)
         cmd.append(mode)
 
-        if self.specmatic_json_file_path != '':
-            cmd.append("--config=" + self.specmatic_json_file_path)
-        else:
-            cmd.append("--config=" + self.project_root + "/specmatic.json")
+        if self.specmatic_config_file_path != '':
+            cmd.append("--config=" + self.specmatic_config_file_path)
+            
         cmd += ['--host=' + self.host]
         if self.port != 0:
             cmd += ["--port=" + str(self.port)]

{specmatic-2.0.0 → specmatic-2.0.1}/specmatic/core/specmatic_stub.py

@@ -13,8 +13,8 @@ from specmatic.core.specmatic_base import SpecmaticBase
 class SpecmaticStub(SpecmaticBase):
 
     def __init__(self, host: str = '127.0.0.1', port: int = 0, project_root: str = '',
-                 specmatic_json_file_path: str = '', args=None):
-        super().__init__(host, port, project_root, specmatic_json_file_path, args)
+                 specmatic_config_file_path: str = '', args=None):
+        super().__init__(host, port, project_root, specmatic_config_file_path, args)
         self.__stub_started_event = None
         self.__process = None
         self.__stub_running_success_message = 'Stub server is running on '
@@ -115,5 +115,4 @@ class SpecmaticStub(SpecmaticBase):
             self.__stub_started_event.set()
 
     def __create_stub_process_command(self):
-        self.validate_mandatory_fields()
         return self.create_command_array('stub')

{specmatic-2.0.0 → specmatic-2.0.1}/specmatic/core/specmatic_test.py

@@ -8,8 +8,8 @@ from specmatic.utils import get_junit_report_dir_path
 
 class SpecmaticTest(SpecmaticBase):
     def __init__(self, host: str = "127.0.0.1", port: int = 5000, project_root: str = '',
-                 specmatic_json_file_path: str = '', args=None, endpoints_api: str = ''):
-        super().__init__(host, port, project_root, specmatic_json_file_path, args, endpoints_api)
+                 specmatic_config_file_path: str = '', args=None, endpoints_api: str = ''):
+        super().__init__(host, port, project_root, specmatic_config_file_path, args, endpoints_api)
 
     def run(self):
         self._delete_existing_report_if_exists()
@@ -21,7 +21,6 @@ class SpecmaticTest(SpecmaticBase):
             shutil.rmtree(junit_report_dir_path)
 
     def _execute_tests(self):
-        self.validate_mandatory_fields()
         cmd = self.create_command_array('test', get_junit_report_dir_path())
         print("command array:")
         print(cmd)

specmatic-2.0.1/specmatic/version.py

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

{specmatic-2.0.0 → specmatic-2.0.1/specmatic.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: specmatic
-Version: 2.0.0
+Version: 2.0.1
 Summary: A Python module for using the Specmatic Library.
 Home-page: https://github.com/znsio/specmatic-python-extensions
 Author: Specmatic Builders
@@ -15,7 +15,7 @@ Requires-Dist: flask>=2.2.5
 Requires-Dist: sanic>=22.12.0
 
 # Specmatic Python
-This is a Python library to run [Specmatic](https://specmatic.in).
+This is a Python library to run [Specmatic](https://specmatic.io).
 Specmatic is a contract driven development tool that allows us to turn OpenAPI contracts into executable specifications.
 <br/>Click below to learn more about Specmatic and Contract Driven Development<br/><br/>
 [![Specmatic - Contract Driven Development](https://img.youtube.com/vi/3HPgpvd8MGg/0.jpg)](https://www.youtube.com/watch?v=3HPgpvd8MGg "Specmatic - Contract Driven Development")
@@ -27,8 +27,8 @@ Specmatic is a contract driven development tool that allows us to turn OpenAPI c
 
 #### Running Contract Tests
 A contract test validates an open api specification against a running api service.  
-The open api specification can be present either locally or in a [Central Contract Repository](https://specmatic.in/documentation/central_contract_repository.html)  
-[Click here](https://specmatic.in/documentation/contract_tests.html) to learn more about contract tests.  
+The open api specification can be present either locally or in a [Central Contract Repository](https://specmatic.io/documentation/central_contract_repository.html)  
+[Click here](https://specmatic.io/documentation/contract_tests.html) to learn more about contract tests.  
 
 #### How to use
 - Create a file called test_contract.py in your test folder.  
@@ -82,12 +82,12 @@ pytest.main()
 - In this, we are passing:
   - an instance of your wsgi 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.
+  - You would need a [specmatic config](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.   
     If they are not supplied, the stub will be started on a random available port on 127.0.0.1.    
-    [Click here](https://specmatic.in/documentation/service_virtualization_tutorial.html) to learn more about stubbing/service virtualization.
+    [Click here](https://specmatic.io/documentation/service_virtualization_tutorial.html) to learn more about stubbing/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.

specmatic-2.0.0/specmatic/version.py

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