Improve error message on corrupt PrivateJsonFile

Author: soxofaan

openeo/rest/auth/config.py

@@ -26,7 +26,7 @@
     oschmod = None
 
 
-_PRIVATE_PERMS = stat.S_IRUSR | stat.S_IWUSR
+PRIVATE_PERMISSIONS = stat.S_IRUSR | stat.S_IWUSR
 
 log = logging.getLogger(__name__)
 
@@ -51,7 +51,7 @@ def assert_private_file(path: Path):
     mode = get_file_mode(path)
     if (mode & stat.S_IRWXG) or (mode & stat.S_IRWXO):
         message = "File {p} could be readable by others: mode {a:o} (expected: {e:o}).".format(
-            p=path, a=mode & (stat.S_IRWXU | stat.S_IRWXG | stat.S_IRWXO), e=_PRIVATE_PERMS
+            p=path, a=mode & (stat.S_IRWXU | stat.S_IRWXG | stat.S_IRWXO), e=PRIVATE_PERMISSIONS
         )
         if platform.system() == "Windows":
             log.info(message)
@@ -100,16 +100,19 @@ def load(self, empty_on_file_not_found=True) -> dict:
         assert_private_file(self._path)
         log.debug("Loading private JSON file {p}".format(p=self._path))
         # TODO: add file locking to avoid race conditions?
-        with self._path.open("r", encoding="utf8") as f:
-            return json.load(f)
+        try:
+            with self._path.open("r", encoding="utf8") as f:
+                return json.load(f)
+        except Exception as e:
+            raise RuntimeError(f"Failed to load {type(self).__name__} from {self._path!r}: {e!r}") from e
 
     def _write(self, data: dict):
         """Write whole data to file."""
         log.debug("Writing private JSON file {p}".format(p=self._path))
         # TODO: add file locking to avoid race conditions?
         with self._path.open("w", encoding="utf8") as f:
             json.dump(data, f, indent=2)
-        set_file_mode(self._path, mode=_PRIVATE_PERMS)
+        set_file_mode(self._path, mode=PRIVATE_PERMISSIONS)
         assert_private_file(self._path)
 
     def get(self, *keys, default=None) -> Union[dict, str, int]:

tests/rest/auth/test_config.py

@@ -12,6 +12,8 @@
     PrivateJsonFile,
     RefreshTokenStore,
     get_file_mode,
+    set_file_mode,
+    PRIVATE_PERMISSIONS,
 )
 
 
@@ -34,28 +36,26 @@ def test_provide_file_path(self, tmp_path):
         assert private.path.exists()
         assert [p.name for p in tmp_path.iterdir()] == ["my_data.secret"]
 
-    def test_permissions(self, tmp_path):
+    def test_permissions_on_create(self, tmp_path):
         private = PrivateJsonFile(tmp_path)
         assert not private.path.exists()
         private.set("foo", "bar", value=42)
         assert private.path.exists()
         st_mode = get_file_mode(private.path)
         assert st_mode & 0o777 == 0o600
 
-    def test_wrong_permissions(self, tmp_path, caplog):
-        private = PrivateJsonFile(tmp_path)
-        with private.path.open("w") as f:
+    def test_wrong_permissions_on_load(self, tmp_path, caplog):
+        path = tmp_path / "my_data.secret"
+        with path.open("w") as f:
             json.dump({"foo": "bar"}, f)
-        assert private.path.stat().st_mode & 0o077 > 0
+        assert path.stat().st_mode & 0o077 > 0
+
+        private = PrivateJsonFile(path)
 
         if platform.system() != "Windows":
-            with pytest.raises(
-                PermissionError, match="readable by others.*expected: 600"
-            ):
+            with pytest.raises(PermissionError, match="readable by others.*expected: 600"):
                 private.get("foo")
-            with pytest.raises(
-                PermissionError, match="readable by others.*expected: 600"
-            ):
+            with pytest.raises(PermissionError, match="readable by others.*expected: 600"):
                 private.set("foo", value="lol")
         else:
             regex = re.compile("readable by others.*expected: 600")
@@ -93,6 +93,18 @@ def test_remove(self, tmp_path):
         private.remove()
         assert not private.path.exists()
 
+    def test_load_corrupt_content(self, tmp_path):
+        path = tmp_path / "my_data.secret"
+        path.write_text("{\nInvalid JSON here!")
+        set_file_mode(path, mode=PRIVATE_PERMISSIONS)
+
+        private = PrivateJsonFile(path=path)
+        with pytest.raises(
+            RuntimeError, match=r"Failed to load PrivateJsonFile from .*my_data\.secret.*JSONDecodeError.*line 2"
+        ):
+            private.load()
+
+
 
 class TestAuthConfig: