fix: Error in converting results/steps to dataframe when status is none (#115)

Author: vignesh261201

nisystemlink/clients/testmonitor/utilities/_dataframe_utilities.py

@@ -41,11 +41,13 @@ def convert_results_to_dataframe(
             - Properties: All the properties will be split into separate columns. For example,
             properties.property1, properties.property2, etc.
     """
-    results_dict = [result.dict(exclude_none=True) for result in results]
-    results_dict_with_normalized_status = __normalize_results_status(results_dict)
-    normalized_dataframe = pd.json_normalize(
-        results_dict_with_normalized_status, sep="."
-    )
+    results_dict = []
+    for result in results:
+        data = result.dict(exclude_none=True)
+        __normalize_status(data)
+        results_dict.append(data)
+
+    normalized_dataframe = pd.json_normalize(results_dict, sep=".")
     normalized_dataframe = __format_results_columns(
         results_dataframe=normalized_dataframe
     )
@@ -98,26 +100,20 @@ def convert_steps_to_dataframe(
     return steps_dataframe.reindex(columns=grouped_columns, copy=False)
 
 
-def __normalize_results_status(
-    results_dict: List[Dict[str, Any]],
-) -> List[Dict[str, Any]]:
-    """Gets dictionary of results data and modifies the status object.
+def __normalize_status(
+    data: Dict[str, Any],
+) -> None:
+    """Normalizes the status object into a string.
 
     Args:
-        results: List of results.
+        data: Dictionary containing status information.
 
-    Returns:
-        A list of result fields as dictionary. If status.status_type is "CUSTOM"
-            the status field takes the value of "status_name", else value of "status_type" is used.
     """
-    for result in results_dict:
-        status = result.get("status", {})
-        if status.get("status_type") == "CUSTOM":
-            result["status"] = status["status_name"]
-        else:
-            result["status"] = status["status_type"].value
-
-    return results_dict
+    status = data.get("status", {})
+    if status.get("status_type") == "CUSTOM":
+        data["status"] = status.get("status_name", None)
+    else:
+        data["status"] = getattr(status.get("status_type", None), "value", None)
 
 
 def __format_results_columns(results_dataframe: pd.DataFrame) -> pd.DataFrame:
@@ -208,7 +204,7 @@ def __convert_steps_to_dict(
         single_step_dict = step.dict(exclude_none=True)
         __filter_invalid_measurements(single_step_dict, step, is_valid_measurement)
         __normalize_inputs_outputs(single_step_dict, step)
-        __normalize_step_status(single_step_dict)
+        __normalize_status(single_step_dict)
         steps_dict.append(single_step_dict)
     return steps_dict
 
@@ -266,24 +262,6 @@ def __normalize_inputs_outputs(
         )
 
 
-def __normalize_step_status(step_dict: Dict[str, Any]) -> None:
-    """Normalizes the step status field. If status_type is "CUSTOM",
-    then status.status_name is used, else status.status_type.value is assigned.
-
-    Args:
-        step_dict: A dictionary with step information.
-
-    Returns:
-        None: The function modifies step_dict in place with the normalized step
-    """
-    step_status = step_dict.get("status", {})
-    step_dict["status"] = (
-        step_status.get("status_name", None)
-        if step_status.get("status_type") == "CUSTOM"
-        else step_status.get("status_type", None).value
-    )
-
-
 def __explode_and_normalize(
     dataframe: pd.DataFrame, column: str, prefix: str
 ) -> pd.DataFrame:

tests/testmonitor/test_testmonitor_dataframe_utilities.py

@@ -227,6 +227,23 @@ def test__convert_results_with_specific_fields_to_dataframe__returns_results_dat
         self, results
     ):
         results = results[1:]
+        results.append(
+            Result(
+                status=None,
+                started_at=datetime.datetime(
+                    2018, 5, 7, 18, 58, 5, 219692, tzinfo=datetime.timezone.utc
+                ),
+                updated_at=datetime.datetime(
+                    2018, 5, 7, 18, 58, 5, 219692, tzinfo=datetime.timezone.utc
+                ),
+                program_name="My Program Name",
+                id=uuid.uuid1().hex,
+                file_ids=[uuid.uuid1().hex],
+                status_type_summary={StatusType.PASSED: 0, StatusType.FAILED: 1},
+                workspace=uuid.uuid1().hex,
+            )
+        )
+
         expected_results_dataframe = self.__get_expected_results_dataframe(
             results=results
         )
@@ -429,7 +446,6 @@ def test__convert_steps_to_dataframe_with_invalid_data_parameters__returns_only_
             name="step_name",
             step_id="5ffb2bf6771fa11e877838dd6",
             result_id="5ffb2bf6771fa11e877838dd8",
-            status=Status.PASSED(),
             data=StepData(
                 text="data1",
                 parameters=[Measurement(name="parameter_123", status="Passed")],