ScriptUnitTestRunner and tests

src/spiffworkflow_backend/services/script_unit_test_runner.py

@@ -0,0 +1,33 @@
+"""Process_instance_processor."""
+from dataclasses import dataclass
+from typing import Any
+from SpiffWorkflow import Task as SpiffTask  # type: ignore
+
+from spiffworkflow_backend.services.process_instance_processor import CustomBpmnScriptEngine
+
+PythonScriptContext = dict[str, Any]
+
+
+@dataclass
+class ScriptUnitTestResult:
+    """ScriptUnitTestResult."""
+    result: bool
+    context: PythonScriptContext
+
+
+class ScriptUnitTestRunner:
+    """ScriptUnitTestRunner."""
+
+    _script_engine = CustomBpmnScriptEngine()
+
+    @classmethod
+    def run_task(
+            cls, task: SpiffTask, script: str, input_context: PythonScriptContext, expected_output_context: PythonScriptContext
+    ) -> ScriptUnitTestResult:
+        """Run_task."""
+        task.data = input_context
+        cls._script_engine.execute(task, script)
+
+        result_as_boolean = task.data == expected_output_context
+        script_unit_test_result = ScriptUnitTestResult(result=result_as_boolean, context=task.data)
+        return script_unit_test_result

tests/spiffworkflow_backend/unit/test_process_instance_processor.py

@@ -0,0 +1,15 @@
+"""Test_process_instance_processor."""
+from flask.app import Flask
+from spiffworkflow_backend.services.process_instance_processor import ProcessInstanceProcessor
+
+
+# it's not totally obvious we want to keep this test/file
+def test_script_engine_takes_data_and_returns_expected_results(
+    app: Flask,
+    with_db_and_bpmn_file_cleanup: None,
+) -> None:
+    """Test_script_engine_takes_data_and_returns_expected_results."""
+    script_engine = ProcessInstanceProcessor._script_engine
+
+    result = script_engine._evaluate('a', {"a": 1})
+    assert result == 1

tests/spiffworkflow_backend/unit/test_script_unit_test_runner.py

@@ -0,0 +1,63 @@
+"""Test Permissions."""
+
+from flask.app import Flask
+from spiffworkflow_backend.services.process_instance_processor import ProcessInstanceProcessor
+from spiffworkflow_backend.services.script_unit_test_runner import PythonScriptContext, ScriptUnitTestRunner
+from tests.spiffworkflow_backend.helpers.base_test import BaseTest
+from tests.spiffworkflow_backend.helpers.test_data import load_test_spec
+
+
+class TestScriptUnitTestRunner(BaseTest):
+    """TestScriptUnitTestRunner."""
+
+    def test_takes_data_and_returns_expected_result(self,
+                                                    app: Flask,
+                                                    with_db_and_bpmn_file_cleanup: None,
+                                                    ) -> None:
+        """Test_takes_data_and_returns_expected_result."""
+        process_group_id = "test_logging_spiff_logger"
+        process_model_id = "simple_script"
+        process_model = load_test_spec(process_model_id, process_group_id=process_group_id)
+        process_instance = self.create_process_instance_from_process_model(
+            process_model
+        )
+        processor = ProcessInstanceProcessor(process_instance)
+        task = processor.get_task_by_bpmn_identifier('Activity_RunScript')
+
+        input_context: PythonScriptContext = {"a": 1}
+        expected_output_context: PythonScriptContext = {"a": 2}
+        script = "a = 2"
+
+        unit_test_result = ScriptUnitTestRunner.run_task(task, script, input_context, expected_output_context)
+
+        assert unit_test_result.result
+        assert unit_test_result.context == {"a": 2}
+
+        # result = script_engine._evaluate('a', {"a": 1})
+        # assert result == 1
+
+        # result = script_engine._execute('a = 1', {})
+        # assert result == 1
+
+    def test_fails_when_expected_output_does_not_match_actual_output(self,
+                                                                     app: Flask,
+                                                                     with_db_and_bpmn_file_cleanup: None,
+                                                                     ) -> None:
+        """Test_fails_when_expected_output_does_not_match_actual_output."""
+        process_group_id = "test_logging_spiff_logger"
+        process_model_id = "simple_script"
+        process_model = load_test_spec(process_model_id, process_group_id=process_group_id)
+        process_instance = self.create_process_instance_from_process_model(
+            process_model
+        )
+        processor = ProcessInstanceProcessor(process_instance)
+        task = processor.get_task_by_bpmn_identifier('Activity_RunScript')
+
+        input_context: PythonScriptContext = {"a": 1}
+        expected_output_context: PythonScriptContext = {"a": 2, "b": 3}
+        script = "a = 2"
+
+        unit_test_result = ScriptUnitTestRunner.run_task(task, script, input_context, expected_output_context)
+
+        assert unit_test_result.result is not True
+        assert unit_test_result.context == {"a": 2}