Add initial example for service to service communication

Author: gecage952

examples/4_service_to_service/__init__.py

@@ -0,0 +1,78 @@
+"""First Service for example. Sends a message to service two and emits an event for the client."""
+
+import logging
+
+from intersect_sdk import (
+    HierarchyConfig,
+    IntersectBaseCapabilityImplementation,
+    IntersectDirectMessageParams,
+    IntersectEventDefinition,
+    IntersectService,
+    IntersectServiceConfig,
+    default_intersect_lifecycle_loop,
+    intersect_event,
+    intersect_message,
+    intersect_status,
+)
+
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+
+
+class ExampleServiceOneCapabilityImplementation(IntersectBaseCapabilityImplementation):
+    """Service One Capability."""
+
+    @intersect_status()
+    def status(self) -> str:
+        """Basic status function which returns a hard-coded string."""
+        return 'Up'
+
+    @intersect_message()
+    def pass_text_to_service_2(self, text: str) -> None:
+        """Takes in a string parameter and sends it to service 2."""
+        logger.info('maing it to service one')
+        msg_to_send = IntersectDirectMessageParams(
+            destination='example-organization.example-facility.example-system.example-subsystem.service-two',
+            operation='ServiceTwo.test_service',
+            payload=text,
+        )
+
+        # Send intersect message to another service
+        self.intersect_sdk_call_service(msg_to_send, self.service_2_handler)
+
+    @intersect_event(events={'response_event': IntersectEventDefinition(event_type=str)})
+    def service_2_handler(self, msg: str) -> None:
+        """Handles response from service two and emites the response as an event for the client."""
+        logger.info('maing it to right before emitting event')
+        self.intersect_sdk_emit_event('response_event', f'Received Response from Service 2: {msg}')
+
+
+if __name__ == '__main__':
+    from_config_file = {
+        'brokers': [
+            {
+                'username': 'intersect_username',
+                'password': 'intersect_password',
+                'port': 1883,
+                'protocol': 'mqtt3.1.1',
+            },
+        ],
+    }
+    config = IntersectServiceConfig(
+        hierarchy=HierarchyConfig(
+            organization='example-organization',
+            facility='example-facility',
+            system='example-system',
+            subsystem='example-subsystem',
+            service='service-one',
+        ),
+        status_interval=30.0,
+        **from_config_file,
+    )
+    capability = ExampleServiceOneCapabilityImplementation()
+    capability.capability_name = 'ServiceOne'
+    service = IntersectService([capability], config)
+    logger.info('Starting service one, use Ctrl+C to exit.')
+    default_intersect_lifecycle_loop(
+        service,
+    )

examples/4_service_to_service/example_1_service.py

@@ -0,0 +1,62 @@
+"""Second Service for example."""
+
+import logging
+
+from intersect_sdk import (
+    HierarchyConfig,
+    IntersectBaseCapabilityImplementation,
+    IntersectService,
+    IntersectServiceConfig,
+    default_intersect_lifecycle_loop,
+    intersect_message,
+    intersect_status,
+)
+
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+
+
+class ExampleServiceTwoCapabilityImplementation(IntersectBaseCapabilityImplementation):
+    """Service Two Capability."""
+
+    @intersect_status()
+    def status(self) -> str:
+        """Basic status function which returns a hard-coded string."""
+        return 'Up'
+
+    @intersect_message
+    def test_service(self, text: str) -> str:
+        """Returns the text given along with acknowledgement."""
+        logger.info('Making it to service 2')
+        return f'Acknowledging service one text -> {text}'
+
+
+if __name__ == '__main__':
+    from_config_file = {
+        'brokers': [
+            {
+                'username': 'intersect_username',
+                'password': 'intersect_password',
+                'port': 1883,
+                'protocol': 'mqtt3.1.1',
+            },
+        ],
+    }
+    config = IntersectServiceConfig(
+        hierarchy=HierarchyConfig(
+            organization='example-organization',
+            facility='example-facility',
+            system='example-system',
+            subsystem='example-subsystem',
+            service='service-two',
+        ),
+        status_interval=30.0,
+        **from_config_file,
+    )
+    capability = ExampleServiceTwoCapabilityImplementation()
+    capability.capability_name = 'ServiceTwo'
+    service = IntersectService([capability], config)
+    logger.info('Starting service two, use Ctrl+C to exit.')
+    default_intersect_lifecycle_loop(
+        service,
+    )

examples/4_service_to_service/example_2_service.py

@@ -0,0 +1,78 @@
+"""Client for service to service example.
+
+Kicks off exmaple by sending message to service one, and then
+waits for an event from service one to confirm the messages were passed between the two services properly.
+
+"""
+
+import logging
+
+from intersect_sdk import (
+    INTERSECT_JSON_VALUE,
+    IntersectClient,
+    IntersectClientCallback,
+    IntersectClientConfig,
+    IntersectDirectMessageParams,
+    default_intersect_lifecycle_loop,
+)
+
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+
+
+class SampleOrchestrator:
+    """Simply contains an event callback for events from Service One."""
+
+    def event_callback(
+        self, _source: str, _operation: str, _event_name: str, payload: INTERSECT_JSON_VALUE
+    ) -> None:
+        """This simply prints the event from Service One  to your console.
+
+        Params:
+          source: the source of the response message.
+          operation: the name of the function we called in the original message.
+          _has_error: Boolean value which represents an error.
+          payload: Value of the response from the Service.
+        """
+        logger.info('making it to event callback')
+        print(payload)
+
+
+if __name__ == '__main__':
+    from_config_file = {
+        'brokers': [
+            {
+                'username': 'intersect_username',
+                'password': 'intersect_password',
+                'port': 1883,
+                'protocol': 'mqtt3.1.1',
+            },
+        ],
+    }
+
+    # The counter will start after the initial message.
+    # If the service is already active and counting, this may do nothing.
+    initial_messages = [
+        IntersectDirectMessageParams(
+            destination='example-organization.example-facility.example-system.example-subsystem.service-one',
+            operation='ServiceOne.pass_text_to_service_2',
+            payload='Kicking off the example!',
+        )
+    ]
+    config = IntersectClientConfig(
+        initial_message_event_config=IntersectClientCallback(
+            messages_to_send=initial_messages,
+            services_to_start_listening_for_events=[
+                'example-organization.example-facility.example-system.example-subsystem.service-one'
+            ],
+        ),
+        **from_config_file,
+    )
+    orchestrator = SampleOrchestrator()
+    client = IntersectClient(
+        config=config,
+        event_callback=orchestrator.event_callback,
+    )
+    default_intersect_lifecycle_loop(
+        client,
+    )

examples/4_service_to_service/example_client.py

@@ -63,6 +63,7 @@ test = [
 test-all = "pytest tests/ --cov=src/intersect_sdk/ --cov-fail-under=80 --cov-report=html:reports/htmlcov/ --cov-report=xml:reports/coverage_report.xml --junitxml=reports/junit.xml"
 test-all-debug = "pytest tests/ --cov=src/intersect_sdk/ --cov-fail-under=80 --cov-report=html:reports/htmlcov/ --cov-report=xml:reports/coverage_report.xml --junitxml=reports/junit.xml -s"
 test-unit = "pytest tests/unit --cov=src/intersect_sdk/"
+test-e2e = "pytest tests/e2e --cov=src/intersect_sdk/"
 lint = {composite = ["lint-format", "lint-ruff", "lint-mypy"]}
 lint-format = "ruff format"
 lint-ruff = "ruff check --fix"

pyproject.toml

@@ -132,3 +132,10 @@ def test_example_3_ping_pong_events():
 
 def test_example_3_ping_pong_events_amqp():
     assert run_example_test('3_ping_pong_events_amqp') == 'ping\npong\nping\npong\n'
+
+
+def test_example_4_service_to_service():
+    assert (
+        run_example_test('4_service_to_service')
+        == 'Received Response from Service 2: Acknowledging service one text -> Kicking off the example!'
+    )