gdrive: add tests for the gdrive_user_credentials_file relative path

Author: shcheklein

dvc/remote/gdrive.py

@@ -179,8 +179,12 @@ def _validate_config(self):
                     )
                 )
 
+    # Helper to determine where will it read credentials from.
+    # Mostly useful for tests, exception messages, etc
+    # Returns either env variable name if it's set or actual path to the
+    # credentials file
     @cached_property
-    def _credentials_location(self):
+    def credentials_location(self):
         if os.getenv(GDriveRemote.GDRIVE_CREDENTIALS_DATA):
             return GDriveRemote.GDRIVE_CREDENTIALS_DATA
         if os.path.exists(self._gdrive_user_credentials_path):
@@ -274,7 +278,7 @@ def _drive(self):
         # a lot of different errors - broken credentials file, refresh token
         # expired, flow failed, etc.
         except Exception as exc:
-            raise GDriveAuthError(self._credentials_location) from exc
+            raise GDriveAuthError(self.credentials_location) from exc
         finally:
             if os.getenv(GDriveRemote.GDRIVE_CREDENTIALS_DATA):
                 os.remove(self._gdrive_user_credentials_path)

tests/func/remote/test_gdrive.py

@@ -0,0 +1,56 @@
+import os
+import posixpath
+
+import configobj
+
+from dvc.compat import fspath
+from dvc.main import main
+from dvc.remote import GDriveRemote
+from dvc.repo import Repo
+
+
+def test_relative_user_credentials_file_config_setting(tmp_dir, dvc):
+    # CI sets it to test GDrive, here we want to test the work with file system
+    # based, regular credentials
+    if os.getenv(GDriveRemote.GDRIVE_CREDENTIALS_DATA):
+        del os.environ[GDriveRemote.GDRIVE_CREDENTIALS_DATA]
+
+    credentials = os.path.join("secrets", "credentials.json")
+
+    # GDriveRemote.credentials_location helper checks for file existence,
+    # create the file
+    tmp_dir.gen(credentials, "{'token': 'test'}")
+
+    remote_name = "gdrive"
+    assert (
+        main(["remote", "add", "-d", remote_name, "gdrive://root/test"]) == 0
+    )
+    assert (
+        main(
+            [
+                "remote",
+                "modify",
+                remote_name,
+                "gdrive_user_credentials_file",
+                credentials,
+            ]
+        )
+        == 0
+    )
+
+    # We need to load repo again to test updates to the config
+    str_path = fspath(tmp_dir)
+    repo = Repo(str_path)
+
+    # Check that in config we got the path relative to the config file itself
+    # Also, we store posix path even on Windows
+    config = configobj.ConfigObj(repo.config.files["repo"])
+    assert config['remote "{}"'.format(remote_name)][
+        "gdrive_user_credentials_file"
+    ] == posixpath.join("..", "secrets", "credentials.json")
+
+    # Check that in the remote itself we got an absolute path
+    remote = repo.cloud.get_remote(remote_name)
+    assert os.path.normpath(remote.credentials_location) == os.path.join(
+        str_path, credentials
+    )