utf-queue-client 1.16.0__tar.gz → 1.17.0__tar.gz

{utf-queue-client-1.16.0 → utf-queue-client-1.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: utf-queue-client
-Version: 1.16.0
+Version: 1.17.0
 Summary: UNKNOWN
 Home-page: UNKNOWN
 Author: Joe Savage

{utf-queue-client-1.16.0 → utf-queue-client-1.17.0}/setup.py

@@ -6,7 +6,7 @@
 from setuptools import setup, find_packages  # noqa: H301
 
 NAME = "utf-queue-client"
-VERSION = "1.16.0"
+VERSION = "1.17.0"
 # To install the library, run the following
 #
 # python setup.py install

utf-queue-client-1.17.0/test/test_rail_data_producer_tests.py

@@ -0,0 +1,64 @@
+from unittest.mock import MagicMock
+
+from utf_queue_client.clients.test_rail_data_producer import (
+    TestRailDataProducer,
+    TestRailDataProducerFactory,
+    DummyTestRailDataProducer,
+    LocalTestRailDataProducer,
+)
+import pytest
+import os
+
+
+def test_result_producer_empty_url():
+    with pytest.raises(RuntimeError):
+        _ = TestRailDataProducer()
+
+
+@pytest.mark.parametrize("queue_consumer", [60, 120], indirect=True)
+def test_result_producer_central_queue(
+    request,
+    test_rail_add_test_result,
+    amqp_url,
+    queue_consumer,
+):
+    os.environ["UTF_PRODUCER_APP_ID"] = request.node.name
+    producer = TestRailDataProducerFactory.create_producer()
+    producer.publish_add_test_result(test_rail_add_test_result)
+    queue_consumer.expect_messages(1)
+
+
+def test_dummy_producer(test_rail_add_test_result):
+    producer = DummyTestRailDataProducer()
+    producer.publish_add_test_result(test_rail_add_test_result)
+
+
+def test_local_test_rail_producer(test_rail_add_test_result, mocker):
+    mocker.patch(
+        "utf_queue_client.clients.base_producer.BlockingProducer.__init__",
+        return_value=None,
+    )
+    mocker.patch(
+        "utf_queue_client.clients.base_producer.BlockingProducer.queue_declare"
+    )
+    mock_producer_publish = mocker.patch(
+        "utf_queue_client.clients.base_producer.BlockingProducer.publish"
+    )
+    producer = LocalTestRailDataProducer()
+    producer.producer_app_id = "DUMMY"
+    producer.publish_add_test_result(test_rail_add_test_result)
+    assert mock_producer_publish.called
+    kwargs = mock_producer_publish.call_args.kwargs
+    payload = kwargs.get("payload")
+    assert payload.get("recordType") == "TEST_RAIL_EVENT"
+    assert payload.get("recordSubType") == "TEST_RESULT"
+    assert payload.get("tenantKey") == "DUMMY"
+    payload_data = payload.get("payload")
+    assert payload_data.get("version") == "v1"
+    assert payload_data.get("comment") == "testing"
+    assert payload_data.get("status") == "pass"
+    assert payload_data.get("run_id") == 1234
+    assert payload_data.get("id") == "C123"
+    custom_props = payload_data.get("custom_props")
+    assert custom_props.get("custom_interface_type") == "gcc"
+    assert custom_props.get("custom_evk_version") == "v2"

utf-queue-client-1.17.0/utf_queue_client/clients/test_rail_data_producer.py

@@ -0,0 +1,95 @@
+import os
+from .base_producer import BlockingProducer as AMQPBlockingProducer, ConnectionError
+from .http_producer import CompositeHTTPProducer
+from ..models import TestRailResult
+from ..models import QueueMessage
+from . import Loggable
+from socket import gethostname
+from datetime import datetime
+from abc import ABC, abstractmethod
+from otel_extensions import instrumented
+from typing import Optional
+
+
+__all__ = [
+    "TestRailDataProducer",
+    "DummyTestRailDataProducer",
+    "ConnectionError",
+    "TestRailDataProducerFactory",
+]
+
+
+class BaseTestRailDataProducer(ABC):
+    @abstractmethod
+    def publish_add_test_result(self, test_result: TestRailResult):
+        """publish a test result object"""
+
+
+class TestRailDataProducer(BaseTestRailDataProducer):
+    RECORD_TYPE = "TEST_RAIL_EVENT"
+
+    def __init__(
+        self,
+        url=None,
+        producer_app_id: str = None,
+        producer_class: Optional[type] = None,
+    ):
+        if producer_class is None:
+            producer_class = AMQPBlockingProducer
+        self.queue_name = "default"
+        self.__producer_client = producer_class(url, producer_app_id)
+        self.__producer_client.queue_declare(queue=self.queue_name, durable=True)
+        self.producer_app_id = producer_app_id
+
+    @instrumented
+    def publish_add_test_result(self, test_result: TestRailResult):
+        queue_message = QueueMessage(
+            payload=test_result,
+            recordType=self.RECORD_TYPE,
+            recordSubType="TEST_RESULT",
+            tenantKey=self.producer_app_id,
+            recordTimestamp=datetime.now().isoformat(),
+        )
+        queue_message.validate_schema()
+        self.__producer_client.publish(
+            exchange="",
+            routing_key=self.queue_name,
+            payload=queue_message.as_dict(),
+            persistent=True,
+        )
+
+
+class LocalTestRailDataProducer(TestRailDataProducer):
+    def __init__(self):
+        super().__init__(
+            "amqp://guest:guest@localhost:5672/%2f",
+            os.environ.get(
+                "UTF_PRODUCER_APP_ID", f"LocalTestRailDataProducer at {gethostname()}"
+            ),
+        )
+
+
+class DummyTestRailDataProducer(BaseTestRailDataProducer):
+    def publish_add_test_result(self, test_result: TestRailResult):
+        # noqa
+        pass
+
+
+class TestRailDataProducerFactory(Loggable):
+    @classmethod
+    def create_producer(cls, raise_on_connection_error=False):
+        try:
+            queue_server_url = os.environ.get("UTF_QUEUE_SERVER_URL")
+            if queue_server_url is not None:
+                return TestRailDataProducer(
+                    url=queue_server_url,
+                    producer_app_id=os.environ.get("UTF_PRODUCER_APP_ID"),
+                    producer_class=CompositeHTTPProducer,
+                )
+            else:
+                return LocalTestRailDataProducer()
+        except ConnectionError as e:
+            cls.logger.warning(f"Unable to connect to queue server: {repr(e)}")
+            if raise_on_connection_error:
+                raise
+            return DummyTestRailDataProducer()

{utf-queue-client-1.16.0 → utf-queue-client-1.17.0}/utf_queue_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: utf-queue-client
-Version: 1.16.0
+Version: 1.17.0
 Summary: UNKNOWN
 Home-page: UNKNOWN
 Author: Joe Savage

{utf-queue-client-1.16.0 → utf-queue-client-1.17.0}/utf_queue_client.egg-info/SOURCES.txt

@@ -11,6 +11,7 @@ test/test_models.py
 test/test_opentelemetry_data_producer.py
 test/test_publish_release_info.py
 test/test_publish_test_results.py
+test/test_rail_data_producer_tests.py
 test/test_sqa_test_result_producer.py
 test/test_ubai_copy.py
 test/test_ubai_search.py
@@ -31,6 +32,7 @@ utf_queue_client/clients/data_lake_data_producer.py
 utf_queue_client/clients/http_producer.py
 utf_queue_client/clients/opentelemetry_data_producer.py
 utf_queue_client/clients/sqa_test_result_producer.py
+utf_queue_client/clients/test_rail_data_producer.py
 utf_queue_client/clients/ubai_artifact_upload_request_producer.py
 utf_queue_client/exceptions/__init__.py
 utf_queue_client/models/__init__.py