refactor(tests): move InteractionDefinition in own module

The `__init__` was getting a bit too cluttered, so I have refactored the
entire `InteractionDefinition` class into its own module. I have also
refacted the nested classes to stand alone now.

A minor refactor was also made to avoid assigning custom attributes to
the `Flask` app, and some changes were made to the provider
initialisation to avoid passing a redundant `self.app` in a method call.

Signed-off-by: JP-Ellis <[email protected]>

Author: JP-Ellis

tests/v3/compatibility_suite/test_v1_consumer.py

@@ -6,10 +6,7 @@
 
 from pytest_bdd import given, parsers, scenario
 
-from tests.v3.compatibility_suite.util import (
-    InteractionDefinition,
-    parse_markdown_table,
-)
+from tests.v3.compatibility_suite.util import parse_markdown_table
 from tests.v3.compatibility_suite.util.consumer import (
     a_response_is_returned,
     request_n_is_made_to_the_mock_server,
@@ -34,6 +31,9 @@
     the_pact_test_is_done,
     the_payload_will_contain_the_json_document,
 )
+from tests.v3.compatibility_suite.util.interaction_definition import (
+    InteractionDefinition,
+)
 
 logger = logging.getLogger(__name__)
 
@@ -320,7 +320,7 @@ def the_following_http_interactions_have_been_defined(
     # Parse the table into a more useful format
     interactions: dict[int, InteractionDefinition] = {}
     for row in content:
-        interactions[int(row["No"])] = InteractionDefinition(**row)
+        interactions[int(row["No"])] = InteractionDefinition(**row)  # type: ignore[arg-type]
     return interactions
 
 

tests/v3/compatibility_suite/test_v1_provider.py

@@ -10,9 +10,9 @@
 import pytest
 from pytest_bdd import given, parsers, scenario
 
-from tests.v3.compatibility_suite.util import (
+from tests.v3.compatibility_suite.util import parse_markdown_table
+from tests.v3.compatibility_suite.util.interaction_definition import (
     InteractionDefinition,
-    parse_markdown_table,
 )
 from tests.v3.compatibility_suite.util.provider import (
     a_failed_verification_result_will_be_published_back,
@@ -407,7 +407,7 @@ def the_following_http_interactions_have_been_defined(
     # Parse the table into a more useful format
     interactions: dict[int, InteractionDefinition] = {}
     for row in content:
-        interactions[int(row["No"])] = InteractionDefinition(**row)
+        interactions[int(row["No"])] = InteractionDefinition(**row)  # type: ignore[arg-type]
     return interactions
 
 

tests/v3/compatibility_suite/test_v2_consumer.py

@@ -6,10 +6,7 @@
 
 from pytest_bdd import given, parsers, scenario
 
-from tests.v3.compatibility_suite.util import (
-    InteractionDefinition,
-    parse_markdown_table,
-)
+from tests.v3.compatibility_suite.util import parse_markdown_table
 from tests.v3.compatibility_suite.util.consumer import (
     a_response_is_returned,
     request_n_is_made_to_the_mock_server,
@@ -35,6 +32,9 @@
     the_pact_test_is_done,
     the_payload_will_contain_the_json_document,
 )
+from tests.v3.compatibility_suite.util.interaction_definition import (
+    InteractionDefinition,
+)
 
 logger = logging.getLogger(__name__)
 
@@ -196,7 +196,7 @@ def the_following_http_interactions_have_been_defined(
     # Parse the table into a more useful format
     interactions: dict[int, InteractionDefinition] = {}
     for row in table:
-        interactions[int(row["No"])] = InteractionDefinition(**row)
+        interactions[int(row["No"])] = InteractionDefinition(**row)  # type: ignore[arg-type]
 
     return interactions
 

tests/v3/compatibility_suite/test_v2_provider.py

@@ -10,9 +10,9 @@
 import pytest
 from pytest_bdd import given, parsers, scenario
 
-from tests.v3.compatibility_suite.util import (
+from tests.v3.compatibility_suite.util import parse_markdown_table
+from tests.v3.compatibility_suite.util.interaction_definition import (
     InteractionDefinition,
-    parse_markdown_table,
 )
 from tests.v3.compatibility_suite.util.provider import (
     a_pact_file_for_interaction_is_to_be_verified,
@@ -125,7 +125,7 @@ def the_following_http_interactions_have_been_defined(
     # Parse the table into a more useful format
     interactions: dict[int, InteractionDefinition] = {}
     for row in content:
-        interactions[int(row["No"])] = InteractionDefinition(**row)
+        interactions[int(row["No"])] = InteractionDefinition(**row)  # type: ignore[arg-type]
     return interactions
 
 

tests/v3/compatibility_suite/test_v3_message_producer.py

@@ -18,10 +18,13 @@
 
 from pact.v3.pact import Pact
 from tests.v3.compatibility_suite.util import (
-    InteractionDefinition,
     parse_horizontal_markdown_table,
     parse_markdown_table,
 )
+from tests.v3.compatibility_suite.util.interaction_definition import (
+    InteractionDefinition,
+    InteractionState,
+)
 from tests.v3.compatibility_suite.util.provider import (
     a_provider_is_started_that_can_generate_the_message,
     a_provider_state_callback_is_configured,
@@ -229,7 +232,7 @@ def a_pact_file_for_is_to_be_verified_with_the_following(
     interaction_definition = InteractionDefinition(
         type="Async",
         description=name,
-        **table,
+        **table,  # type: ignore[arg-type]
     )
     interaction_definition.add_to_pact(pact, name)
     (temp_dir / "pacts").mkdir(exist_ok=True, parents=True)
@@ -284,16 +287,14 @@ def a_pact_file_for_is_to_be_verified_with_provider_state(
         description=name,
         body=fixture,
     )
-    interaction_definition.states = [InteractionDefinition.State(provider_state)]
+    interaction_definition.states = [InteractionState(provider_state)]
     interaction_definition.add_to_pact(pact, name)
     (temp_dir / "pacts").mkdir(exist_ok=True, parents=True)
     pact.write_file(temp_dir / "pacts")
     verifier.add_source(temp_dir / "pacts")
     with (temp_dir / "provider_states").open("w") as f:
         logger.debug("Writing provider state to %s", temp_dir / "provider_states")
-        json.dump(
-            [s.as_dict() for s in [InteractionDefinition.State(provider_state)]], f
-        )
+        json.dump([s.as_dict() for s in [InteractionState(provider_state)]], f)
 
 
 @given(

tests/v3/compatibility_suite/test_v3_provider.py

@@ -10,9 +10,9 @@
 import pytest
 from pytest_bdd import given, parsers, scenario
 
-from tests.v3.compatibility_suite.util import (
+from tests.v3.compatibility_suite.util import parse_markdown_table
+from tests.v3.compatibility_suite.util.interaction_definition import (
     InteractionDefinition,
-    parse_markdown_table,
 )
 from tests.v3.compatibility_suite.util.provider import (
     a_pact_file_for_interaction_is_to_be_verified_with_a_provider_states_defined,
@@ -100,7 +100,7 @@ def the_following_http_interactions_have_been_defined(
     # Parse the table into a more useful format
     interactions: dict[int, InteractionDefinition] = {}
     for row in content:
-        interactions[int(row["No"])] = InteractionDefinition(**row)
+        interactions[int(row["No"])] = InteractionDefinition(**row)  # type: ignore[arg-type]
     return interactions
 
 

tests/v3/compatibility_suite/test_v4_provider.py

@@ -10,9 +10,9 @@
 import pytest
 from pytest_bdd import given, parsers, scenario
 
-from tests.v3.compatibility_suite.util import (
+from tests.v3.compatibility_suite.util import parse_markdown_table
+from tests.v3.compatibility_suite.util.interaction_definition import (
     InteractionDefinition,
-    parse_markdown_table,
 )
 from tests.v3.compatibility_suite.util.provider import (
     a_pact_file_for_interaction_is_to_be_verified,
@@ -104,7 +104,7 @@ def the_following_http_interactions_have_been_defined(
     # Parse the table into a more useful format
     interactions: dict[int, InteractionDefinition] = {}
     for row in content:
-        interactions[int(row["No"])] = InteractionDefinition(**row)
+        interactions[int(row["No"])] = InteractionDefinition(**row)  # type: ignore[arg-type]
     return interactions