NPI-4460 add baseline for SP3 offline sat removal and fix function to avoid modifying passed reference before returning

Author: treefern

gnssanalysis/gn_io/sp3.py

@@ -407,17 +407,17 @@ def remove_offline_sats(sp3_df: _pd.DataFrame, df_friendly_name: str = "") -> _p
     offline_sats = sp3_df[mask_either].index.get_level_values(1).unique()
 
     # Using that list of offline / partially offline sats, remove all entries for those sats from the SP3 DataFrame:
-    sp3_df = sp3_df.drop(offline_sats, level=1, errors="ignore")
+    sp3_df_cleaned = sp3_df.drop(offline_sats, level=1, errors="ignore")
 
     if len(offline_sats) > 0:
         # Update the internal representation of the SP3 header to match the change
-        remove_svs_from_header(sp3_df, offline_sats.values)
+        remove_svs_from_header(sp3_df_cleaned, offline_sats.values)
         logger.info(
             f"Dropped offline / nodata sats from {df_friendly_name} SP3 DataFrame (including header): {offline_sats.values}"
         )
     else:
         logger.info(f"No offline / nodata sats detected to be dropped from {df_friendly_name} SP3 DataFrame")
-    return sp3_df
+    return sp3_df_cleaned
 
 
 def filter_by_svs(

tests/test_sp3.py

@@ -4,6 +4,7 @@
 
 import numpy as np
 import pandas as pd
+from pandas import DataFrame
 
 from gnssanalysis.filenames import convert_nominal_span, determine_properties_from_filename
 import gnssanalysis.gn_io.sp3 as sp3
@@ -1309,7 +1310,10 @@ def test_sp3_offline_sat_removal_standalone(self):
         self.assertTrue(UnitTestBaseliner.verify(objects_to_verify), "Hash verification should pass")
 
     def test_sp3_offline_sat_removal(self):
+        objects_to_verify: list = []
+
         sp3_df = sp3.read_sp3(offline_sat_test_data, pOnly=False, strict_mode=STRICT_OFF)
+        objects_to_verify.append(sp3_df)
 
         # Confirm starting state of content
         self.assertEqual(
@@ -1328,26 +1332,39 @@ def test_sp3_offline_sat_removal(self):
             sp3_df.attrs["HEADER"].HEAD.SV_COUNT_STATED, "3", "Header should have 2 SVs before removing offline"
         )
 
+        df_snapshot = DataFrame(sp3_df)
         # Now make the changes - this should also update the header
-        sp3_df = sp3.remove_offline_sats(sp3_df)
+        sp3_df_cleaned = sp3.remove_offline_sats(sp3_df)
+        objects_to_verify.append(sp3_df_cleaned)
+        # Ensure the source DF did NOT get modified...
+        df_snapshot_after = DataFrame(sp3_df)
+        self.assertTrue(
+            df_snapshot.equals(df_snapshot_after),
+            "Original DF should not be modified by function that returns a new copy",
+        )
 
         # Check contents
         self.assertEqual(
-            sp3_df.index.get_level_values(1).unique().array.tolist(),
+            sp3_df_cleaned.index.get_level_values(1).unique().array.tolist(),
             ["G02", "G03"],
             "Should be two SVs after removing offline ones",
         )
 
         # Check header
         self.assertEqual(
-            sp3_df.attrs["HEADER"].SV_INFO.index.array.tolist(),
+            sp3_df_cleaned.attrs["HEADER"].SV_INFO.index.array.tolist(),
             ["G02", "G03"],
             "Should be two SVs in parsed header after removing offline ones",
         )
         self.assertEqual(
-            sp3_df.attrs["HEADER"].HEAD.SV_COUNT_STATED, "2", "Header should have 2 SVs after removing offline"
+            sp3_df_cleaned.attrs["HEADER"].HEAD.SV_COUNT_STATED, "2", "Header should have 2 SVs after removing offline"
         )
 
+        # UnitTestBaseliner.mode = "baseline"
+        # UnitTestBaseliner.create_baseline(objects_to_verify)  # DO NOT commit this line un-commented.
+
+        self.assertTrue(UnitTestBaseliner.verify(objects_to_verify), "Hash verification should pass")
+
     # sp3_test_data_truncated_cod_final is input_data2
     def test_filter_by_svs(self):
         sp3_df = sp3.read_sp3(input_data2, pOnly=False)

tests/unittest_baselines/TestSP3/test_sp3_offline_sat_removal.pickledlist

@@ -0,0 +1 @@
+79d5e639e0f76f7d83825e43a862f907fecf7d28cb606ee25621aeb951e7ee5f