feat: add the option to add an error to an ActivityResult (#155)

* feat: add the option to add an error to an ActivityResult

* docs: clarify requirements for development

* test: add unit test for a failed ActivityResult

---------

Co-authored-by: Marvin Schenkel <marvin.schenkel@nn-group.com>

Author: MarvinSchenkel

DEVELOPMENT.md

@@ -6,6 +6,14 @@
 
 * poetry == 1.6.1
 
+### Installing the project
+
+Make sure to create a virtual environment and install the requirements by running:
+`poetry install --with dev`
+
+Build the .NET project:
+`dotnet build`
+
 ### Pre-Commit Hooks
 
 We use pre-commit hooks to ensure that the code is formatted correctly and that the code is linted before committing.

src/data_factory_testing_framework/_pythonnet/data_factory_testing_framework_expressions_evaluator.py

@@ -42,6 +42,7 @@ def evaluate(expression: str, state: PipelineRunState) -> Union[str, int, float,
                     "body": {
                         "output": activity.output,
                         "status": activity.status,
+                        "error": activity.error,
                     }
                 }
             }

src/data_factory_testing_framework/state/_activity_result.py

@@ -9,17 +9,20 @@ def __init__(
         activity_name: str,
         status: Optional[DependencyCondition] = None,
         output: Optional[Any] = None,  # noqa: ANN401
+        error: Optional[Any] = None,  # noqa: ANN401
     ) -> None:
         """Represents the result of an activity.
 
         Args:
             activity_name: Name of the activity.
             status: Status of the activity.
             output: Output of the activity. (e.g. { "count": 1 } for activity('activityName').output.count)
+            error: Error of the activity. (e.g. { "code": "ErrorCode", "message": "ErrorMessage" } for activity('activityName').Error)
         """
         self.activity_name = activity_name
         self.status = status if status is not None else DependencyCondition.SUCCEEDED
         self.output = output
+        self.error = error
 
     def __getitem__(self, item: str) -> Any:  # noqa: ANN401
         return getattr(self, item)

tests/unit/functions/test_data_factory_testing_framework_expression_evaluator.py

@@ -390,6 +390,21 @@
             "value1",
             id="activity_reference_with_nested_property_and_string_reference",
         ),
+        p(
+            "@activity('Error activity').Error.message",
+            PipelineRunState(
+                activity_results=[
+                    ActivityResult(
+                        activity_name="Error activity",
+                        status=DependencyCondition.FAILED,
+                        error={"message": "Oh no, something went wrong"},
+                    )
+                ],
+            ),
+            "@activity('Error activity').Error.message",
+            "Oh no, something went wrong",
+            id="activity_reference_with_error_message",
+        ),
     ],
 )
 def test_evaluate(