refactor:CheckResultIDs

Author: RSam-NI

nisystemlink/clients/testmonitor/utilities/_dataframe_utilities.py

@@ -12,8 +12,9 @@ def convert_results_to_dataframe(
 
     Args:
         results: The list of results to be included in the dataframe.
-        set_id_as_index: If true, result id will be set as index for the dataframe.
-                         If false, index will not be set.
+        set_id_as_index: If true, and each result has id, result id will be set
+                         as index for the dataframe.
+                         Else, index will not be set.
                          Default value is false.
 
     Returns:
@@ -24,13 +25,15 @@ def convert_results_to_dataframe(
             - status: Split into status.status_type and status.status_name columns.
             - Properties: All the properties will be split into separate columns. For example,
             properties.property1, properties.property2, etc.
+        Result ID will be set as index for the dataframe is set_id_as_index is true and
+        each result has an ID.
     """
     results_dict = [result.dict(exclude_none=True) for result in results]
     normalized_dataframe = pd.json_normalize(results_dict, sep=".")
     normalized_dataframe = __format_results_columns(
         results_dataframe=normalized_dataframe
     )
-    if set_id_as_index:
+    if set_id_as_index and all([result.id for result in results]):
         normalized_dataframe = normalized_dataframe.set_index("id")
 
     return normalized_dataframe

tests/testmonitor/test_testmonitor_dataframe_utilities.py

@@ -65,7 +65,7 @@ def results() -> List[Result]:
                 2018, 5, 7, 18, 58, 5, 219692, tzinfo=datetime.timezone.utc
             ),
             program_name="My Program Name",
-            id=uuid.uuid1().hex,
+            # id=uuid.uuid1().hex,
             file_ids=[uuid.uuid1().hex],
             status_type_summary={StatusType.PASSED: 0, StatusType.FAILED: 1},
             workspace=uuid.uuid1().hex,
@@ -139,6 +139,7 @@ def test__convert_results_with_specific_fields_to_dataframe__returns_results_dat
     def test__convert_results_to_dataframe_with_id_index__returns_results_dataframe_with_id_index(
         self, results
     ):
+        results = results[:2]
         expected_results_dataframe = self.get_expected_results_dataframe(
             results=results
         )
@@ -152,7 +153,7 @@ def test__convert_results_to_dataframe_with_id_index__returns_results_dataframe_
 
         assert not results_dataframe.empty
         assert isinstance(results_dataframe, pd.DataFrame)
-        assert len(results_dataframe) == 3
+        assert len(results_dataframe) == 2
         assert len(results_dataframe.columns.tolist()) == 19
         assert results_index == expected_result_index
         pd.testing.assert_frame_equal(
@@ -169,6 +170,38 @@ def test__convert_results_to_dataframe_with_id_index__returns_results_dataframe_
         assert results_dataframe["keywords"].dtype == "object"
         assert isinstance(results_dataframe["keywords"].iloc[0], List)
 
+    def test__convert_results_to_dataframe_with_id_index_without_id_value__returns_results_dataframe_default_index(
+        self, results
+    ):
+        expected_results_dataframe = self.get_expected_results_dataframe(
+            results=results
+        )
+        expected_result_index = [0, 1, 2]
+
+        results_dataframe = convert_results_to_dataframe(
+            results=results, set_id_as_index=True
+        )
+        results_index = results_dataframe.index.to_list()
+
+        assert not results_dataframe.empty
+        assert isinstance(results_dataframe, pd.DataFrame)
+        assert len(results_dataframe) == 3
+        assert len(results_dataframe.columns.tolist()) == 20
+        assert results_index == expected_result_index
+        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 results_dataframe["started_at"].dtype == "datetime64[ns, UTC]"
+        assert results_dataframe["updated_at"].dtype == "datetime64[ns, UTC]"
+        assert results_dataframe["file_ids"].dtype == "object"
+        assert isinstance(results_dataframe["file_ids"].iloc[0], List)
+        assert results_dataframe["data_table_ids"].dtype == "object"
+        assert isinstance(results_dataframe["data_table_ids"].iloc[0], List)
+        assert results_dataframe["keywords"].dtype == "object"
+        assert isinstance(results_dataframe["keywords"].iloc[0], List)
+
     def test__convert_results_to_dataframe_with_no_results__returns_empty_dataframe(
         self,
     ):