update tests for storage providers sneaking in data.

Author: carl-adams-planet

tests/test_planet_auth/unit/auth/auth_clients/oidc/test_oidc_request_authenticator.py

@@ -73,6 +73,18 @@ def setUp(self):
         self.tmp_dir = tempfile.TemporaryDirectory()
         self.tmp_dir_path = pathlib.Path(self.tmp_dir.name)
 
+    @staticmethod
+    def _filter_spdata(data: dict) -> dict:
+        # Storage providers are known to add "__" keys for their own use.
+        # These should not be considered part of the general data.
+        filtered_data = {
+            k: v
+            for k, v in data.items()
+            # if k not in [_SOPSAwareFilesystemObjectStorageProvider._STORAGE_TYPE_KEY]
+            if not (isinstance(k, str) and k.startswith("__"))
+        }
+        return filtered_data
+
     def under_test_happy_path(self):
         credential_path = self.tmp_dir_path / "refreshing_oidc_authenticator_test_token__with_refresh.json"
         test_credential = self.mock_auth_login_and_command_initialize(
@@ -485,7 +497,7 @@ def test_side_band_update_credential_data(self):
         # It should not be necessary to simulate an API call for everything to be set
         current_credential_data = under_test._credential.data()
         self.assertNotEqual(current_credential_data, initial_credential_data)
-        self.assertEqual(current_credential_data, sideband_credential.data())
+        self.assertEqual(self._filter_spdata(current_credential_data), sideband_credential.data())
         self.assertEqual(under_test._token_body, sideband_credential.access_token())
         self.assertNotEqual(0, under_test._refresh_at)
         self.assertNotEqual(0, under_test._credential._load_time)

tests/test_planet_auth/unit/auth/test_storage_utils_file_backed_json_object.py

@@ -88,6 +88,18 @@ def setUp(self):
         # This seems to help.
         os.environ["TZ"] = "UTC"
 
+    @staticmethod
+    def _filter_spdata(data: dict) -> dict:
+        # Storage providers are known to add "__" keys for their own use.
+        # These should not be considered part of the general data.
+        filtered_data = {
+            k: v
+            for k, v in data.items()
+            # if k not in [_SOPSAwareFilesystemObjectStorageProvider._STORAGE_TYPE_KEY]
+            if not (isinstance(k, str) and k.startswith("__"))
+        }
+        return filtered_data
+
     def test_set_data_asserts_valid(self):
         under_test = Credential(data=None, file_path=None)
         with self.assertRaises(FileBackedJsonObjectException):
@@ -129,14 +141,14 @@ def test_load_and_failed_reload(self):
         # Load works when we have a valid file
         under_test.set_path(tdata_resource_file_path("keys/base_test_credential.json"))
         under_test.load()
-        self.assertEqual({"test_key": "test_value"}, under_test.data())
+        self.assertEqual({"test_key": "test_value"}, self._filter_spdata(under_test.data()))
 
         # A subsequent failed load should throw, but leave the data unchanged.
         under_test.set_path(tdata_resource_file_path("keys/FILE_DOES_NOT_EXIST.json"))
         with self.assertRaises(FileNotFoundError):
             under_test.load()
 
-        self.assertEqual({"test_key": "test_value"}, under_test.data())
+        self.assertEqual({"test_key": "test_value"}, self._filter_spdata(under_test.data()))
 
     def test_load_file_not_found(self):
         under_test = Credential(data=None, file_path=tdata_resource_file_path("keys/FILE_DOES_NOT_EXIST.json"))
@@ -166,7 +178,7 @@ def test_lazy_load(self):
         under_test = Credential(data=None, file_path=tdata_resource_file_path("keys/base_test_credential.json"))
         self.assertIsNone(under_test.data())
         under_test.lazy_load()
-        self.assertEqual({"test_key": "test_value"}, under_test.data())
+        self.assertEqual({"test_key": "test_value"}, self._filter_spdata(under_test.data()))
 
         # if the path is invalid, it should error.
         under_test = Credential(data=None, file_path=tdata_resource_file_path("keys/FILE_DOES_NOT_EXIST.json"))
@@ -204,7 +216,7 @@ def test_lazy_reload_initial_load_behavior(self):
         under_test = Credential(data=None, file_path=tdata_resource_file_path("keys/base_test_credential.json"))
         self.assertIsNone(under_test.data())
         under_test.lazy_reload()
-        self.assertEqual({"test_key": "test_value"}, under_test.data())
+        self.assertEqual({"test_key": "test_value"}, self._filter_spdata(under_test.data()))
 
         # if the path is invalid, it should error.
         under_test = Credential(data=None, file_path=tdata_resource_file_path("keys/FILE_DOES_NOT_EXIST.json"))
@@ -299,7 +311,7 @@ def test_save(self):
         under_test.save()
         test_reader = Credential(data=None, file_path=test_path)
         test_reader.load()
-        self.assertEqual(test_data, test_reader.data())
+        self.assertEqual(test_data, self._filter_spdata(test_reader.data()))
 
     def test_getters_setters(self):
         test_path = pathlib.Path("/test/test_credential.json")