Merge pull request #59 from dl1998/50-remove-redundant-values-from-th…

…e-status-file Remove redundant fields from status file
dl1998 · Jan 19, 2025 · a6bbfd8 · a6bbfd8
2 parents 6918317 + aa52d6c
commit a6bbfd8
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 27 deletions.
diff --git a/src/workflows_manager/workflow.py b/src/workflows_manager/workflow.py
@@ -133,12 +133,18 @@ def to_dict(self) -> List[Dict]:
                 'name': step.path.name,
                 'status': step.status.value,
                 'parameters': step.parameters,
-                'stdout': step.stdout,
-                'stderr': step.stderr,
                 'error': str(step.error) if step.error else None,
-                'return_value': step.return_value,
-                'children': children,
             }
+            if step.path.type == StepType.NORMAL:
+                data.update({
+                    'stdout': step.stdout,
+                    'stderr': step.stderr,
+                    'return_value': step.return_value,
+                })
+            elif step.path.type in (StepType.WORKFLOW, StepType.PARALLEL):
+                data.update({
+                    'children': children,
+                })
             dictionary_steps.append(data)
             step = step.next_step
         return dictionary_steps

diff --git a/tests/workflows_manager/unit_tests/actions/conftest.py b/tests/workflows_manager/unit_tests/actions/conftest.py
@@ -91,7 +91,6 @@ def test_expected_status() -> Dict:
                     {
                         'children': [
                             {
-                                'children': None,
                                 'error': None,
                                 'name': 'Normal Step',
                                 'parameters': {
@@ -111,28 +110,21 @@ def test_expected_status() -> Dict:
                         'error': None,
                         'name': 'Parallel Step',
                         'parameters': None,
-                        'return_value': None,
                         'status': 'success',
-                        'stderr': None,
-                        'stdout': None,
                         'type': 'parallel'
                     }
                 ],
                 'error': None,
                 'name': 'Workflow Step',
                 'parameters': None,
-                'return_value': None,
                 'status': 'success',
-                'stderr': None,
-                'stdout': None,
                 'type': 'workflow'
             },
             {
                 'children': [
                     {
                         'children': [
                             {
-                                'children': None,
                                 'error': 'error message',
                                 'name': 'Normal Step',
                                 'parameters': {
@@ -152,20 +144,14 @@ def test_expected_status() -> Dict:
                         'error': 'error message',
                         'name': 'Parallel Step',
                         'parameters': None,
-                        'return_value': None,
                         'status': 'failed',
-                        'stderr': None,
-                        'stdout': None,
                         'type': 'parallel'
                     }
                 ],
                 'error': 'error message',
                 'name': 'Another Workflow Step',
                 'parameters': None,
-                'return_value': None,
                 'status': 'failed',
-                'stderr': None,
-                'stdout': None,
                 'type': 'workflow',
             }
         ]

diff --git a/tests/workflows_manager/unit_tests/actions/test_runner.py b/tests/workflows_manager/unit_tests/actions/test_runner.py
@@ -43,7 +43,6 @@ def test_run_error_missing_parameters(self, mock_file_open, mock_dump,
         expected_error = 'Missing the following required parameters: [\'integer\']'
         expected_status = 'failed'
         expected_step = {
-            'children': None,
             'error': expected_error,
             'name': 'Normal Step',
             'parameters': None,

diff --git a/tests/workflows_manager/unit_tests/test_workflow.py b/tests/workflows_manager/unit_tests/test_workflow.py
@@ -46,10 +46,7 @@ def steps_information_dictionary():
             'name': 'workflow_step',
             'status': StepStatus.RUNNING.value,
             'parameters': None,
-            'stdout': None,
-            'stderr': None,
             'error': None,
-            'return_value': None,
             'children': [
                 {
                     'type': StepType.NORMAL.value,
@@ -60,17 +57,13 @@ def steps_information_dictionary():
                     'stderr': None,
                     'error': None,
                     'return_value': None,
-                    'children': None,
                 },
                 {
                     'type': StepType.PARALLEL.value,
                     'name': 'parallel_step',
                     'status': StepStatus.SUCCESS.value,
                     'parameters': None,
-                    'stdout': None,
-                    'stderr': None,
                     'error': None,
-                    'return_value': None,
                     'children': [
                         {
                             'type': StepType.NORMAL.value,
@@ -81,7 +74,6 @@ def steps_information_dictionary():
                             'stderr': None,
                             'error': None,
                             'return_value': None,
-                            'children': None,
                         }
                     ]
                 }