utf-queue-client 1.18.0a0__tar.gz → 1.19.0__tar.gz

{utf_queue_client-1.18.0a0 → utf_queue_client-1.19.0}/.idea/.gitignore

@@ -11,5 +11,3 @@ dataSources/
 # Editor-based HTTP Client requests
 /httpRequests/
 
-# GitHub Copilot persisted chat sessions
-/copilot/chatSessions

{utf_queue_client-1.18.0a0 → utf_queue_client-1.19.0}/.idea/utf_queue_client_python.iml

@@ -2,11 +2,9 @@
 <module type="PYTHON_MODULE" version="4">
   <component name="NewModuleRootManager">
     <content url="file://$MODULE_DIR$">
-      <excludeFolder url="file://$MODULE_DIR$/.idea/copilot/chatSessions" />
       <excludeFolder url="file://$MODULE_DIR$/venv" />
-      <excludeFolder url="file://$MODULE_DIR$/venv2" />
     </content>
-    <orderEntry type="jdk" jdkName="Python 3.13 (utf_queue_client_python)" jdkType="Python SDK" />
+    <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
   </component>
   <component name="PyDocumentationSettings">

{utf_queue_client-1.18.0a0 → utf_queue_client-1.19.0}/Jenkinsfile

@@ -25,7 +25,6 @@ pipeline {
         TEST_RESULTS_DIR = 'test/test_results'
         OTEL_EXPORTER_OTLP_ENDPOINT = "https://otel-collector-http.silabs.net"
         OTEL_EXPORTER_OTLP_PROTOCOL = "http/protobuf"
-        OTEL_EXPORTER_OTLP_CERTIFICATE = "/usr/share/ca-certificates/vault/vault-ca-prod.crt"
         UTF_QUEUE_VIRTUAL_HOST = "testing"
         OTEL_SERVICE_NAME = "utf-queue-client-tests"
         PYENV_VERSION = "3.9"
@@ -122,11 +121,11 @@ pipeline {
                            python3 -m venv venv
                         fi
                         . venv/bin/activate
-                        pip3 install wheel && pip3 install -r test-requirements.txt
+                        pip3 install wheel && pip3 install -r test-requirements.txt build
                         rm -rf build
                         rm -rf dist
                         rm -rf utf_queue_client.egg-info
-                        python3 setup.py sdist bdist_wheel
+                        python3 -m build
 
                         twine upload dist/*
                     '''

{utf_queue_client-1.18.0a0 → utf_queue_client-1.19.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: utf-queue-client
-Version: 1.18.0a0
+Version: 1.19.0
 Summary: No description provided
 Author-email: Joe Savage <joe.savage@silabs.com>
 Keywords: UTF

{utf_queue_client-1.18.0a0 → utf_queue_client-1.19.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "utf-queue-client"
-version = "1.18.0a0"
+version = "1.19.0"
 description = "No description provided"
 authors = [
     { name = "Joe Savage", email = "joe.savage@silabs.com" }

{utf_queue_client-1.18.0a0 → utf_queue_client-1.19.0}/sonar-project.properties

@@ -2,7 +2,7 @@ sonar.projectKey=utf:queue-client-python
 sonar.projectName=utf-queue-client-python
 sonar.sources=utf_queue_client
 sonar.tests=./test
-sonar.exclusions=utf_queue_client/models/schemas/utf_queue_models/models/java/**
+sonar.exclusions=utf_queue_client/models/schemas/utf_queue_models/models/**
 sonar.coverage.exclusions=test/**
 sonar.python.coverage.reportPaths=test/test_results/coverage.xml
 sonar.python.xunit.reportPath=test/test_results/junit*.xml

{utf_queue_client-1.18.0a0 → utf_queue_client-1.19.0}/test/Dockerfile.script_test

@@ -1,4 +1,4 @@
-from python:3.6
+FROM python:3.8
 
 RUN apt update && apt install -y curl
 WORKDIR /usr/local/share/ca-certificates

{utf_queue_client-1.18.0a0 → utf_queue_client-1.19.0}/test/conftest.py

@@ -7,7 +7,6 @@ from urllib import parse
 
 import ndjson
 import pytest
-import requests
 from otel_extensions_pytest import TelemetryOptions, instrumented_fixture
 from stopwatch import Stopwatch
 
@@ -19,6 +18,9 @@ from utf_queue_client.models import (
 )
 from utf_queue_client.models.schemas.utf_queue_models.models.python.generated_models import (
     TestRailResult,
+    XrayImportTestExecution,
+    XrayInfo,
+    XrayTestExecUpdate,
 )
 
 pytest_plugins = ("otel_extensions",)
@@ -35,24 +37,6 @@ def pytest_addoption(parser, pluginmanager):
     if options.OTEL_EXPORTER_OTLP_ENDPOINT is None:
         options.OTEL_EXPORTER_OTLP_ENDPOINT = "https://otel-collector-http.silabs.net/"
         options.OTEL_EXPORTER_OTLP_PROTOCOL = "http/protobuf"
-        cert_bundle = os.path.join(os.path.dirname(__file__), "silabs-net.pem")
-        options.OTEL_EXPORTER_OTLP_CERTIFICATE = cert_bundle
-        if not os.path.exists(cert_bundle):
-            with open(cert_bundle, "wb") as bundle:
-                r = requests.get(
-                    "https://vault.dev.silabs.net:443/v1/pki/ca/pem", verify=False
-                )
-                cert_file = os.path.join(os.path.dirname(__file__), "vault-ca-dev.crt")
-                with open(cert_file, "wb") as f:
-                    f.write(r.content)
-                    bundle.write(r.content + b"\n")
-                r = requests.get(
-                    "https://vault.silabs.net:443/v1/pki/ca/pem", verify=False
-                )
-                cert_file = os.path.join(os.path.dirname(__file__), "vault-ca.crt")
-                with open(cert_file, "wb") as f:
-                    f.write(r.content)
-                    bundle.write(r.content)
 
 
 @pytest.fixture()
@@ -157,6 +141,25 @@ def test_rail_add_test_result():
     )
 
 
+@pytest.fixture()
+def xray_import_test_execution_data():
+    yield XrayImportTestExecution(
+        test_execution_key="DUMMY_EXEC",
+        add_tests_to_plan=True,
+        info=XrayInfo(project="DUMMY", test_plan_key="DUMMY_PLAN"),
+        tests=[
+            XrayTestExecUpdate(
+                comment="",
+                executed_by="test",
+                finish="2025-02-11T07:39:25+00:00",
+                start="2025-02-11T07:39:23+00:00",
+                status="PASS",
+                test_key="TC1234567890",
+            )
+        ],
+    )
+
+
 @pytest.fixture()
 def data_lake_tenant_key():
     return "dummy_key"

{utf_queue_client-1.18.0a0 → utf_queue_client-1.19.0}/test/test_amqp_connections.py

@@ -37,7 +37,7 @@ def test_producer(queue_server, username, password):
     params = pika.URLParameters(p.url)
     logger.info(f"stack timeout: {params.stack_timeout}")
     begin = time.time()
-    for _ in range(0, 10):
+    for _ in range(0, 3):
         logger.info(f"{queue_server}: declaring queue...")
         start = time.time()
         p.queue_declare("default", durable=True)

{utf_queue_client-1.18.0a0 → utf_queue_client-1.19.0}/test/test_models.py

@@ -112,14 +112,18 @@ def test_deserialize_queue_message_v1(artifact_upload_request):
         _ = ArtifactUploadRequest(payload)
 
 
-def test_deserialize_queue_message_v2(artifact_upload_request):
+@pytest.mark.parametrize("messageId", [None, "12345678910"])
+def test_deserialize_queue_message_v2(artifact_upload_request, messageId):
     message = {
         "payload": artifact_upload_request.as_dict(),
         "recordType": "ARTIFACT_UPLOAD_REQUEST",
         "tenantKey": "12345678",
         "recordTimestamp": "2022-03-10T18:50:05Z",
     }
+    if messageId:
+        message["messageId"] = messageId
     queue_message = QueueMessage(message)
+    assert queue_message.messageId == messageId
     if queue_message.recordType == "ARTIFACT_UPLOAD_REQUEST":
         payload = queue_message.payload.as_dict()
         _ = ArtifactUploadRequest(payload)

utf_queue_client-1.19.0/test/test_xray_data_producer.py

@@ -0,0 +1,65 @@
+from unittest.mock import MagicMock
+
+import pytest
+
+from utf_queue_client.clients.xray_data_producer import (
+    DummyXrayDataProducer,
+    LocalXrayDataProducer,
+    XrayDataProducer,
+    XrayDataProducerFactory,
+)
+
+
+def test_xray_data_producer_empty_url():
+    with pytest.raises(RuntimeError):
+        _ = XrayDataProducer()
+
+
+def test_xray_data_producer_create_connect_error(mocker):
+    mock_class = mocker.patch(
+        "utf_queue_client.clients.xray_data_producer.LocalXrayDataProducer"
+    )
+    mock_instance = MagicMock()
+    mock_class.return_value = mock_instance
+    mock_class.side_effect = ConnectionError("failing for test")
+    with pytest.raises(ConnectionError):
+        _ = XrayDataProducerFactory.create_producer()
+
+
+def test_dummy_producer(xray_import_test_execution_data):
+    producer = DummyXrayDataProducer()
+    producer.publish_test_execution(xray_import_test_execution_data)
+
+
+def test_local_xray_producer(xray_import_test_execution_data, 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 = LocalXrayDataProducer()
+    producer.producer_app_id = "DUMMY"
+    producer.publish_test_execution(xray_import_test_execution_data)
+    assert mock_producer_publish.called
+    kwargs = mock_producer_publish.call_args.kwargs
+    payload = kwargs.get("payload")
+    assert payload.get("recordSubType") == "IMPORT_TEST_EXECUTION"
+    assert payload.get("tenantKey") == "DUMMY"
+    payload_data = payload.get("payload")
+    assert payload_data.get("test_execution_key") == "DUMMY_EXEC"
+    assert payload_data.get("add_tests_to_plan") is True
+    assert payload_data.get("info").get("project") == "DUMMY"
+    assert payload_data.get("info").get("test_plan_key") == "DUMMY_PLAN"
+    assert len(payload_data.get("tests")) == 1
+    test = payload_data.get("tests")[0]
+    assert test.get("comment") == ""
+    assert test.get("executed_by") == "test"
+    assert test.get("finish") == "2025-02-11T07:39:25+00:00"
+    assert test.get("start") == "2025-02-11T07:39:23+00:00"
+    assert test.get("status") == "PASS"
+    assert test.get("test_key") == "TC1234567890"

utf_queue_client-1.19.0/tools/build_dist.bat

@@ -0,0 +1,14 @@
+setlocal
+call %~dp0setup_venv.bat
+
+pushd ..
+
+rd /s /q build
+rd /s /q dist
+rd /s /q utf_queue_client.egg-info
+
+pip install wheel
+pip install -r test-requirements.txt --index-url https://artifactory.silabs.net/artifactory/api/pypi/infrasw-python-virtual/simple
+python -m build
+
+popd

{utf_queue_client-1.18.0a0 → utf_queue_client-1.19.0}/utf_queue_client/clients/data_lake_data_producer.py

@@ -6,6 +6,7 @@ from datetime import datetime
 from io import BytesIO
 from socket import gethostname
 from typing import List, Optional, Tuple, Union
+from uuid import uuid4
 
 import ndjson
 from otel_extensions import instrumented
@@ -89,6 +90,7 @@ class DataLakeDataProducer:
             recordType="DATALAKE_DATA",
             tenantKey=self.tenant_key,
             recordTimestamp=datetime.now().isoformat(),
+            messageId=str(uuid4()),
         )
         self.__client.publish(
             exchange="",

{utf_queue_client-1.18.0a0 → utf_queue_client-1.19.0}/utf_queue_client/clients/http_producer.py

@@ -187,7 +187,7 @@ class CompositeHTTPProducer(Loggable):
         for index, producer in enumerate(self.producers):
             if index:
                 self.logger.warning(
-                    f"Failed to execute queue_declare for host {self.producers[index-1].hostname}, retrying with {producer.hostname}..."
+                    f"Failed to execute queue_declare for host {self.producers[index - 1].hostname}, retrying with {producer.hostname}..."
                 )
             try:
                 return producer.queue_declare(queue, **kwargs)
@@ -200,7 +200,7 @@ class CompositeHTTPProducer(Loggable):
         for index, producer in enumerate(self.producers):
             if index:
                 self.logger.warning(
-                    f"Failed to execute publish for host {self.producers[index-1].hostname}, retrying with {producer.hostname}..."
+                    f"Failed to execute publish for host {self.producers[index - 1].hostname}, retrying with {producer.hostname}..."
                 )
             try:
                 return producer.publish(exchange, routing_key, payload, persistent)

{utf_queue_client-1.18.0a0 → utf_queue_client-1.19.0}/utf_queue_client/clients/opentelemetry_data_producer.py

@@ -2,6 +2,7 @@ import base64
 from datetime import datetime
 from socket import gethostname
 from typing import Optional
+from uuid import uuid4
 
 from ..models import QueueMessage, TelemetryData
 from .base_producer import BlockingProducer
@@ -34,6 +35,7 @@ class OpenTelemetryDataProducer:
             recordType="OPENTELEMETRY_DATA",
             tenantKey=self.producer_app_id,
             recordTimestamp=datetime.now().isoformat(),
+            messageId=str(uuid4()),
         )
         self.__client.publish(
             exchange="",

{utf_queue_client-1.18.0a0 → utf_queue_client-1.19.0}/utf_queue_client/clients/sqa_test_result_producer.py

@@ -4,6 +4,7 @@ from abc import ABC, abstractmethod
 from datetime import datetime
 from socket import gethostname
 from typing import Optional
+from uuid import uuid4
 
 from otel_extensions import instrumented
 
@@ -75,6 +76,7 @@ class SqaTestResultProducer(BaseSqaTestResultProducer):
             recordSubType="TEST_RESULT",
             tenantKey=self.producer_app_id,
             recordTimestamp=datetime.now().isoformat(),
+            messageId=str(uuid4()),
         )
         self._publish_message(queue_message)
 
@@ -86,6 +88,7 @@ class SqaTestResultProducer(BaseSqaTestResultProducer):
             recordSubType=subtype,
             tenantKey=self.producer_app_id,
             recordTimestamp=datetime.now().isoformat(),
+            messageId=str(uuid4()),
         )
         self._publish_message(queue_message)
 
@@ -108,6 +111,7 @@ class SqaTestResultProducer(BaseSqaTestResultProducer):
             recordSubType="BUILD_RESULT",
             tenantKey=self.producer_app_id,
             recordTimestamp=datetime.now().isoformat(),
+            messageId=str(uuid4()),
         )
         self._publish_message(queue_message)
 

{utf_queue_client-1.18.0a0 → utf_queue_client-1.19.0}/utf_queue_client/clients/test_rail_data_producer.py

@@ -3,6 +3,7 @@ from abc import ABC, abstractmethod
 from datetime import datetime
 from socket import gethostname
 from typing import Optional
+from uuid import uuid4
 
 from otel_extensions import instrumented
 
@@ -50,6 +51,7 @@ class TestRailDataProducer(BaseTestRailDataProducer):
             recordSubType="TEST_RESULT",
             tenantKey=self.producer_app_id,
             recordTimestamp=datetime.now().isoformat(),
+            messageId=str(uuid4()),
         )
         self.__producer_client.publish(
             exchange="",

{utf_queue_client-1.18.0a0 → utf_queue_client-1.19.0}/utf_queue_client/clients/ubai_artifact_upload_request_producer.py

@@ -4,6 +4,7 @@ import os.path
 from datetime import datetime
 from socket import gethostname
 from typing import Optional
+from uuid import uuid4
 
 from otel_extensions import instrumented
 from ubai_client.apis import ArtifactApi
@@ -68,6 +69,7 @@ class UbaiArtifactUploadRequestProducer:
             recordType="ARTIFACT_UPLOAD_REQUEST",
             tenantKey=self.producer_app_id,
             recordTimestamp=datetime.now().isoformat(),
+            messageId=str(uuid4()),
         )
 
         self.__client.publish(

utf_queue_client-1.19.0/utf_queue_client/clients/xray_data_producer.py

@@ -0,0 +1,95 @@
+import os
+from abc import ABC, abstractmethod
+from datetime import datetime
+from socket import gethostname
+from typing import Optional
+
+from otel_extensions import instrumented
+
+from ..models import QueueMessage, XrayImportTestExecution
+from . import Loggable
+from .base_producer import BlockingProducer as AMQPBlockingProducer
+from .base_producer import ConnectionError
+from .http_producer import CompositeHTTPProducer
+
+__all__ = [
+    "XrayDataProducer",
+    "LocalXrayDataProducer",
+    "ConnectionError",
+    "XrayDataProducerFactory",
+]
+
+
+class BaseXrayDataProducer(ABC):
+    @abstractmethod
+    def publish_test_execution(self, import_test_exec: dict):
+        """publish a test execution object"""
+
+
+class XrayDataProducer(BaseXrayDataProducer):
+    RECORD_TYPE = "XRAY_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_test_execution(self, import_test_exec: XrayImportTestExecution):
+        queue_message = QueueMessage(
+            payload=import_test_exec,
+            recordType=self.RECORD_TYPE,
+            recordSubType="IMPORT_TEST_EXECUTION",
+            tenantKey=self.producer_app_id,
+            recordTimestamp=datetime.now().isoformat(),
+        )
+        self.__producer_client.publish(
+            exchange="",
+            routing_key=self.queue_name,
+            payload=queue_message.as_dict(),
+            persistent=True,
+        )
+
+
+class DummyXrayDataProducer(BaseXrayDataProducer):
+    def publish_test_execution(self, import_test_exec: XrayImportTestExecution):
+        # noqa
+        pass
+
+
+class LocalXrayDataProducer(XrayDataProducer):
+    def __init__(self):
+        super().__init__(
+            "amqp://guest:guest@localhost:5672/%2f",
+            os.environ.get(
+                "UTF_PRODUCER_APP_ID", f"LocalXrayDataProducer at {gethostname()}"
+            ),
+        )
+
+
+class XrayDataProducerFactory(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 XrayDataProducer(
+                    url=queue_server_url,
+                    producer_app_id=os.environ.get("UTF_PRODUCER_APP_ID"),
+                    producer_class=CompositeHTTPProducer,
+                )
+            else:
+                return LocalXrayDataProducer()
+        except ConnectionError as e:
+            cls.logger.warning(f"Unable to connect to queue server: {repr(e)}")
+            if raise_on_connection_error:
+                raise
+            return DummyXrayDataProducer()

{utf_queue_client-1.18.0a0 → utf_queue_client-1.19.0}/utf_queue_client/models/schemas/utf_queue_models/models/python/generated_models.py

@@ -18,6 +18,14 @@ if IS_PYDANTIC_V1:
     from .generated_models_pydantic_v1 import ExceptionEvent
     from .generated_models_pydantic_v1 import TestRailResult
     from .generated_models_pydantic_v1 import TestResultCustomProps
+    from .generated_models_pydantic_v1 import XrayInfo
+    from .generated_models_pydantic_v1 import XrayStep
+    from .generated_models_pydantic_v1 import XrayParameter
+    from .generated_models_pydantic_v1 import XrayCustomField
+    from .generated_models_pydantic_v1 import XrayIteration
+    from .generated_models_pydantic_v1 import XrayTestInfo
+    from .generated_models_pydantic_v1 import XrayTestExecUpdate
+    from .generated_models_pydantic_v1 import XrayImportTestExecution
 else:
     from .generated_models_pydantic_v2 import QueueMessage
     from .generated_models_pydantic_v2 import QueueMessageV1
@@ -34,6 +42,14 @@ else:
     from .generated_models_pydantic_v2 import ExceptionEvent
     from .generated_models_pydantic_v2 import TestRailResult
     from .generated_models_pydantic_v2 import TestResultCustomProps
+    from .generated_models_pydantic_v2 import XrayInfo
+    from .generated_models_pydantic_v2 import XrayStep
+    from .generated_models_pydantic_v2 import XrayParameter
+    from .generated_models_pydantic_v2 import XrayCustomField
+    from .generated_models_pydantic_v2 import XrayIteration
+    from .generated_models_pydantic_v2 import XrayTestInfo
+    from .generated_models_pydantic_v2 import XrayTestExecUpdate
+    from .generated_models_pydantic_v2 import XrayImportTestExecution
 
 __all__ = [
     "QueueMessage",
@@ -51,4 +67,12 @@ __all__ = [
     "ExceptionEvent",
     "TestRailResult",
     "TestResultCustomProps",
+    "XrayInfo",
+    "XrayStep",
+    "XrayParameter",
+    "XrayCustomField",
+    "XrayIteration",
+    "XrayTestInfo",
+    "XrayTestExecUpdate",
+    "XrayImportTestExecution",
 ]

{utf_queue_client-1.18.0a0 → utf_queue_client-1.19.0}/utf_queue_client/models/schemas/utf_queue_models/models/python/generated_models_pydantic_v1.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  queue_message.json
-#   timestamp: 2025-01-20T20:20:05+00:00
+#   timestamp: 2025-03-05T15:14:50+00:00
 
 from __future__ import annotations
 
@@ -223,6 +223,76 @@ class TestResultCustomProps(BaseModel):
         extra = Extra.allow
 
 
+class XrayInfo(BaseModel):
+    project: Optional[str] = None
+    summary: Optional[str] = None
+    description: Optional[str] = None
+    version: Optional[str] = None
+    revision: Optional[str] = None
+    user: Optional[str] = None
+    start_date: Optional[str] = None
+    finish_date: Optional[str] = None
+    test_plan_key: Optional[str] = None
+    test_environments: Optional[List[str]] = None
+
+
+class XrayStep(BaseModel):
+    action: str
+    data: str
+    result: str
+
+
+class XrayParameter(BaseModel):
+    name: str
+    value: str
+
+
+class XrayCustomField(BaseModel):
+    name: str
+    id: Optional[int] = None
+    value: str
+
+
+class XrayIteration(BaseModel):
+    name: Optional[str] = None
+    id: Optional[int] = None
+    parameters: List[XrayParameter]
+    status: Literal["ABORTED", "EXECUTING", "FAIL", "PASS", "TODO"]
+
+
+class XrayTestInfo(BaseModel):
+    project_key: str
+    summary: Optional[str] = None
+    description: Optional[str] = None
+    test_type: Optional[str] = None
+    requirement_keys: Optional[List[str]] = None
+    labels: Optional[List[str]] = None
+    steps: Optional[List[XrayStep]] = None
+
+
+class XrayTestExecUpdate(BaseModel):
+    test_key: str
+    status: Literal["ABORTED", "EXECUTING", "FAIL", "PASS", "TODO"]
+    test_info: Optional[XrayTestInfo] = None
+    test_version: Optional[str] = None
+    start: Optional[str] = None
+    finish: Optional[str] = None
+    comment: Optional[str] = None
+    executed_by: Optional[str] = None
+    assignee: Optional[str] = None
+    steps: Optional[List[XrayStep]] = None
+    iterations: Optional[List[XrayIteration]] = None
+    custom_fields: Optional[List[XrayCustomField]] = None
+
+
+class XrayImportTestExecution(BaseModel):
+    test_execution_key: str
+    tests: List[XrayTestExecUpdate]
+    test_map_field_name: Optional[str] = None
+    info: Optional[XrayInfo] = None
+    add_tests_to_plan: Optional[bool] = None
+
+
 class QueueMessage(BaseModel):
     recordType: Literal[
         "ARTIFACT_UPLOAD_REQUEST",
@@ -232,9 +302,16 @@ class QueueMessage(BaseModel):
         "OPENTELEMETRY_DATA",
         "TEST_RAIL_EVENT",
         "UTF_TEST_EVENT",
+        "XRAY_EVENT",
     ] = Field(..., description="Type of record")
     recordSubType: Optional[
-        Literal["BUILD_RESULT", "SESSION_START", "SESSION_STOP", "TEST_RESULT"]
+        Literal[
+            "BUILD_RESULT",
+            "IMPORT_TEST_EXECUTION",
+            "SESSION_START",
+            "SESSION_STOP",
+            "TEST_RESULT",
+        ]
     ] = Field(
         None,
         description="Subtype of record. Not all types have a subtype, but it is required when they have one.",
@@ -251,6 +328,7 @@ class QueueMessage(BaseModel):
         ...,
         description="Record Payload.\nThis is flexible to allow different fields for different record types and DB tables",
     )
+    messageId: Optional[str] = Field(None, description="Unique client-generated UUID")
 
 
 class QueueMessageV1(BaseModel):