deltafi 2.28.0__tar.gz → 2.29.0__tar.gz

{deltafi-2.28.0 → deltafi-2.29.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: deltafi
-Version: 2.28.0
+Version: 2.29.0
 Summary: SDK for DeltaFi plugins and actions
 License: Apache License, Version 2.0
 Keywords: deltafi

{deltafi-2.28.0 → deltafi-2.29.0}/deltafi/plugin.py

@@ -392,6 +392,7 @@ class Plugin(object):
             'start': start_time,
             'stop': stop_time,
             'type': result.result_type,
+            'messages': [message.json() for message in result.messages],
             'metrics': [metric.json() for metric in result.metrics]
         }
         if result.result_key is not None:

{deltafi-2.28.0 → deltafi-2.29.0}/deltafi/result.py

@@ -19,10 +19,10 @@
 import abc
 import uuid
 from enum import Enum
-from typing import NamedTuple
 
 from deltafi.domain import Content, Context
 from deltafi.metric import Metric
+from deltafi.resultmessage import LogMessage
 
 
 class Result:
@@ -31,6 +31,7 @@ class Result:
     def __init__(self, result_key, result_type, context):
         self.result_key = result_key
         self.result_type = result_type
+        self.messages = []
         self.metrics = []
         self.context = context
 
@@ -42,6 +43,18 @@ class Result:
         self.metrics.append(metric)
         return self
 
+    def log_info(self, message: str):
+        self.messages.append(LogMessage.info(self.context.action_name, message))
+        return self
+
+    def log_warning(self, message: str):
+        self.messages.append(LogMessage.warning(self.context.action_name, message))
+        return self
+
+    def log_error(self, message: str):
+        self.messages.append(LogMessage.error(self.context.action_name, message))
+        return self
+
 
 class EgressResult(Result):
     def __init__(self, context: Context):
@@ -63,6 +76,7 @@ class ErrorResult(Result):
         return self
 
     def response(self):
+        self.log_error(self.error_cause + '\n' + self.error_context)
         return {
             'cause': self.error_cause,
             'context': self.error_context,
@@ -145,8 +159,8 @@ class IngressResultItem:
         return segment_names
 
     def annotate(self, key: str, value: str):
-                    self.annotations[key] = value
-                    return self
+        self.annotations[key] = value
+        return self
 
     def response(self):
         return {

deltafi-2.29.0/deltafi/resultmessage.py

@@ -0,0 +1,56 @@
+#
+#    DeltaFi - Data transformation and enrichment platform
+#
+#    Copyright 2021-2025 DeltaFi Contributors <deltafi@deltafi.org>
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+
+import time
+from enum import Enum
+from typing import NamedTuple
+
+
+class LogSeverity(Enum):
+    TRACE = "TRACE"
+    INFO = "INFO"
+    WARNING = "WARNING"
+    ERROR = "ERROR"
+    USER = "USER"
+
+
+class LogMessage(NamedTuple):
+    severity: LogSeverity
+    created: int
+    source: str
+    message: str
+
+    @classmethod
+    def info(cls, source: str, message: str):
+        return LogMessage(severity=LogSeverity.INFO, created=time.time(), source=source, message=message)
+
+    @classmethod
+    def warning(cls, source: str, message: str):
+        return LogMessage(severity=LogSeverity.WARNING, created=time.time(), source=source,
+                          message=message)
+
+    @classmethod
+    def error(cls, source: str, message: str):
+        return LogMessage(severity=LogSeverity.ERROR, created=time.time(), source=source,
+                          message=message)
+
+    def json(self):
+        return {'severity': self.severity.value,
+                'created': self.created,
+                'source': self.source,
+                'message': self.message}

{deltafi-2.28.0 → deltafi-2.29.0}/deltafi/test_kit/egress.py

@@ -50,5 +50,5 @@ class EgressActionTest(ActionTest):
         self.assert_egress_result(test_case, result)
 
     def assert_egress_result(self, test_case: EgressTestCase, result: EgressResult):
-        # Check metrics
         self.compare_metrics(test_case.expected_metrics, result.metrics)
+        self.compare_log_messages(test_case.expected_messages, result.messages)

{deltafi-2.28.0 → deltafi-2.29.0}/deltafi/test_kit/framework.py

@@ -16,6 +16,7 @@
 #    limitations under the License.
 #
 
+import re
 import uuid
 from abc import ABC
 from importlib.resources import files
@@ -25,7 +26,9 @@ from deltafi.domain import DeltaFileMessage, Event, Content, Context
 from deltafi.logger import get_logger
 from deltafi.metric import Metric
 from deltafi.result import ErrorResult, FilterResult
+from deltafi.resultmessage import LogMessage
 from deltafi.storage import Segment
+
 from .assertions import *
 from .compare_helpers import GenericCompareHelper, CompareHelper
 from .constants import *
@@ -170,10 +173,14 @@ class TestCaseBase(ABC):
         self.err_or_filt_annotations = None
         self.join_meta = data["join_meta"] if "join_meta" in data else None
         self.expected_metrics = []
+        self.expected_messages = []
 
     def add_metric(self, metric: Metric):
         self.expected_metrics.append(metric)
 
+    def add_message(self, message: LogMessage):
+        self.expected_messages.append(message)
+
     def expect_error_result(self, cause: str, context: str, annotations: Dict = None):
         """
         A Sets the expected output of the action to an Error Result
@@ -360,6 +367,24 @@ class ActionTest(ABC):
             for index, expected in enumerate(expected_metrics):
                 self.compare_one_metric(expected, results[index])
 
+    @staticmethod
+    def compare_one_message(expected: LogMessage, result: LogMessage):
+        assert_equal_short(expected.severity, result.severity, "message severity does not match")
+        # Look for regex characters:
+        if '*' in expected.message or '{' in expected.message or '^' in expected.message \
+                or '$' in expected.message:
+            match = re.search(expected.message, result.message)
+            assert match is not None, "message does not match regex"
+
+        else:
+            assert_equal_short(expected.message, result.message, "message value does not match")
+
+    def compare_log_messages(self, expected_messages: List[LogMessage], results: List[LogMessage]):
+        if len(expected_messages) > 0:
+            assert_equal_len_with_label(expected_messages, results, "invalid messages count")
+            for index, expected in enumerate(expected_messages):
+                self.compare_one_message(expected, results[index])
+
     def has_saved_content__size(self, count: int):
         assert_equal_with_label(
             count, len(self.context.saved_content), "savedContent")

{deltafi-2.28.0 → deltafi-2.29.0}/deltafi/test_kit/timed_ingress.py

@@ -19,6 +19,7 @@
 from typing import List
 
 from deltafi.result import IngressResult, IngressResultItem, IngressStatusEnum
+
 from .assertions import *
 from .framework import TestCaseBase, ActionTest, IOContent
 
@@ -43,7 +44,8 @@ class TimedIngressTestCase(TestCaseBase):
         self.status = status
         self.status_message = status_message
 
-    def add_ingress_result_item(self, content: List[IOContent], metadata: Dict, name: str = None, annotations: Dict = None):
+    def add_ingress_result_item(self, content: List[IOContent], metadata: Dict, name: str = None,
+                                annotations: Dict = None):
         if annotations is None:
             annotations = {}
         self.results.append(
@@ -80,6 +82,7 @@ class TimedIngressActionTest(ActionTest):
         assert_equal_short(test_case.execute_immediate, result.execute_immediate, "invalid execute_immediate")
         assert_equal_short(test_case.status, result.status, "invalid status")
         assert_equal_with_label(test_case.status_message, result.status_message, "invalid status_message")
+        self.compare_log_messages(test_case.expected_messages, result.messages)
 
         assert_equal_len_with_label(test_case.results, result.ingress_result_items, "item count mismatch")
         for index, ingress_item in enumerate(result.ingress_result_items):

{deltafi-2.28.0 → deltafi-2.29.0}/deltafi/test_kit/transform.py

@@ -19,6 +19,7 @@
 from typing import List
 
 from deltafi.result import TransformResult, TransformResults
+
 from .assertions import *
 from .framework import TestCaseBase, ActionTest, IOContent
 
@@ -81,8 +82,8 @@ class TransformActionTest(ActionTest):
                 assert_equal_with_label(expected["name"], child_result.delta_file_name, f"name[{index}]")
 
     def assert_transform_result(self, test_case: TransformTestCase, result: TransformResult):
-        # Check metrics
         self.compare_metrics(test_case.expected_metrics, result.metrics)
+        self.compare_log_messages(test_case.expected_messages, result.messages)
         self.compare_one_transform_result(test_case, result, 0)
 
     def compare_one_transform_result(self, test_case: TransformTestCase, result: TransformResult, index: int):

{deltafi-2.28.0 → deltafi-2.29.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "deltafi"
-version = "2.28.0"
+version = "2.29.0"
 description = "SDK for DeltaFi plugins and actions"
 authors = ["DeltaFi <deltafi@systolic.com>"]
 license = "Apache License, Version 2.0"