reduce status to single column

Author: Priyadarshini Piramanayagam

nisystemlink/clients/testmonitor/utilities/_dataframe_utilities.py

@@ -25,7 +25,7 @@ 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 = __format_results_dictionary(results)
     normalized_dataframe = pd.json_normalize(results_dict, sep=".")
     normalized_dataframe = __format_results_columns(
         results_dataframe=normalized_dataframe
@@ -36,6 +36,29 @@ def convert_results_to_dataframe(
     return normalized_dataframe
 
 
+def __format_results_dictionary(results: List[Result]) -> List[dict]:
+    """Get list of results and modifies the status object.
+
+    Args:
+        results: List of results.
+
+    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.
+    """
+    return [
+        {
+            **(result_dict := result.dict(exclude_none=True)),
+            "status": (
+                result_dict["status"]["status_type"].value
+                if "status" in result_dict and result_dict["status"]["status_type"] != "CUSTOM"
+                else result_dict["status"]["status_name"]
+            )
+        }
+        for result in results
+    ]
+
+
 def __format_results_columns(results_dataframe: pd.DataFrame) -> pd.DataFrame:
     """Format results column to keep properties at the end.
 

tests/testmonitor/test_testmonitor_dataframe_utilities.py

@@ -57,7 +57,7 @@ def results() -> List[Result]:
             workspace=uuid.uuid1().hex,
         ),
         Result(
-            status=Status.FAILED(),
+            status=Status(status_type=StatusType.CUSTOM, status_name="custom_status"),
             started_at=datetime.datetime(
                 2018, 5, 7, 18, 58, 5, 219692, tzinfo=datetime.timezone.utc
             ),
@@ -91,8 +91,7 @@ def test__convert_results_with_all_fields_to_dataframe__returns_whole_results_da
         pd.testing.assert_frame_equal(
             results_dataframe, expected_results_dataframe, check_dtype=True
         )
-        assert results_dataframe["status.status_type"].dtype == "object"
-        assert isinstance(results_dataframe["status.status_type"].iloc[0], StatusType)
+        assert isinstance(results_dataframe["status"].iloc[0], str)
         assert results_dataframe["started_at"].dtype == "datetime64[ns, UTC]"
         assert results_dataframe["updated_at"].dtype == "datetime64[ns, UTC]"
         assert results_dataframe["file_ids"].dtype == "object"
@@ -117,8 +116,7 @@ def test__convert_results_with_specific_fields_to_dataframe__returns_results_dat
         pd.testing.assert_frame_equal(
             results_dataframe, expected_results_dataframe, check_dtype=True
         )
-        assert results_dataframe["status.status_type"].dtype == "object"
-        assert isinstance(results_dataframe["status.status_type"].iloc[0], StatusType)
+        assert isinstance(results_dataframe["status"].iloc[0], str)
         assert results_dataframe["started_at"].dtype == "datetime64[ns, UTC]"
         assert results_dataframe["updated_at"].dtype == "datetime64[ns, UTC]"
         assert results_dataframe["file_ids"].dtype == "object"
@@ -143,8 +141,7 @@ def test__convert_results_to_dataframe_with_id_index__returns_results_dataframe_
         pd.testing.assert_frame_equal(
             results_dataframe, expected_results_dataframe, check_dtype=True
         )
-        assert results_dataframe["status.status_type"].dtype == "object"
-        assert isinstance(results_dataframe["status.status_type"].iloc[0], StatusType)
+        assert isinstance(results_dataframe["status"].iloc[0], str)
         assert results_dataframe["started_at"].dtype == "datetime64[ns, UTC]"
         assert results_dataframe["updated_at"].dtype == "datetime64[ns, UTC]"
         assert results_dataframe["file_ids"].dtype == "object"
@@ -165,6 +162,10 @@ def test__convert_results_to_dataframe_with_no_results__returns_empty_dataframe(
     def __get_expected_results_dataframe(self, results: List[Result]):
         results_dict = []
         for result in results:
+            status = (
+                {f"status": result.status.status_type.value if result.status.status_type
+                    != "CUSTOM" else result.status.status_name}
+            )
             status_type_summary = (
                 {
                     f"status_type_summary.{key}": value
@@ -180,6 +181,7 @@ def __get_expected_results_dataframe(self, results: List[Result]):
             )
             results_dict.append(
                 {
+                    **status,
                     **{
                         "started_at": result.started_at,
                         "updated_at": result.updated_at,
@@ -195,12 +197,6 @@ def __get_expected_results_dataframe(self, results: List[Result]):
                         "file_ids": result.file_ids,
                         "data_table_ids": result.data_table_ids,
                         "workspace": result.workspace,
-                        "status.status_type": (
-                            result.status.status_type if result.status else None
-                        ),
-                        "status.status_name": (
-                            result.status.status_name if result.status else None
-                        ),
                     },
                     **status_type_summary,
                     **properties,