fix: Remotes: handle _remotes via GitRemote

Author: tony

libvcs/git.py

@@ -130,6 +130,7 @@ class RemoteDict(TypedDict):
     push_url: str
 
 
+GitRepoRemoteDict = Dict[str, GitRemote]
 FullRemoteDict = Dict[str, RemoteDict]
 RemotesArgs = Union[None, FullRemoteDict, Dict[str, str]]
 
@@ -192,26 +193,27 @@ def __init__(
         if "tls_verify" not in kwargs:
             self.tls_verify = False
 
-        self._remotes: Union[FullRemoteDict, None]
+        self._remotes: GitRepoRemoteDict
 
         if remotes is None:
-            self._remotes: FullRemoteDict = {
-                "origin": {"fetch_url": url, "push_url": url}
+            self._remotes: GitRepoRemoteDict = {
+                "origin": GitRemote(name="origin", fetch_url=url, push_url=url)
             }
         elif isinstance(remotes, dict):
-            self._remotes: FullRemoteDict = remotes
+            self._remotes = {}
             for remote_name, url in remotes.items():
                 if isinstance(url, str):
-                    remotes[remote_name] = {
-                        "fetch_url": url,
-                        "push_url": url,
-                    }
+                    self._remotes[remote_name] = GitRemote(
+                        name=remote_name,
+                        fetch_url=url,
+                        push_url=url,
+                    )
 
         BaseRepo.__init__(self, url, repo_dir, *args, **kwargs)
         self.url = (
-            self._remotes.get("origin")["fetch_url"]
-            if self._remotes.get("origin")
-            else next(iter(self._remotes.items()))[1]["fetch_url"]
+            self._remotes.get("origin").fetch_url
+            if "origin" in self._remotes
+            else next(iter(self._remotes.items()))[1].fetch_url
         )
 
     @classmethod
@@ -231,32 +233,42 @@ def get_revision(self):
     def set_remotes(self, overwrite: bool = False):
         remotes = self._remotes
         if isinstance(remotes, dict):
-            for remote_name, url in remotes.items():
+            for remote_name, git_remote in remotes.items():
+
                 existing_remote = self.remote(remote_name)
-                if isinstance(url, dict) and "fetch_url" in url:
+                if isinstance(git_remote, GitRemote):
                     if (
                         not existing_remote
-                        or existing_remote.fetch_url != url["fetch_url"]
+                        or existing_remote.fetch_url != git_remote.fetch_url
                     ):
                         self.set_remote(
-                            name=remote_name, url=url["fetch_url"], overwrite=overwrite
+                            name=remote_name,
+                            url=git_remote.fetch_url,
+                            overwrite=overwrite,
                         )
                         # refresh if we're setting it, so push can be checked
                         existing_remote = self.remote(remote_name)
-                    if "push_url" in url:
+                    if git_remote.push_url:
                         if (
                             not existing_remote
-                            or existing_remote.push_url != url["push_url"]
+                            or existing_remote.push_url != git_remote.push_url
                         ):
                             self.set_remote(
                                 name=remote_name,
-                                url=url["push_url"],
+                                url=git_remote.push_url,
                                 push=True,
                                 overwrite=overwrite,
                             )
                 else:
-                    if not existing_remote or existing_remote.fetch_url != url:
-                        self.set_remote(name=remote_name, url=url, overwrite=overwrite)
+                    if (
+                        not existing_remote
+                        or existing_remote.fetch_url != git_remote.fetch_url
+                    ):
+                        self.set_remote(
+                            name=remote_name,
+                            url=git_remote.fetch_url,
+                            overwrite=overwrite,
+                        )
 
     def obtain(self, *args, **kwargs):
         """Retrieve the repository, clone if doesn't exist."""

tests/test_git.py

@@ -313,11 +313,25 @@ def test_remotes(
                 },
             },
             lambda git_remote, **kwargs: {
-                "second_remote": f"file://{git_remote}",
+                "second_remote": GitRemote(
+                    **{
+                        "name": "second_remote",
+                        "fetch_url": f"file://{git_remote}",
+                        "push_url": f"file://{git_remote}",
+                    }
+                )
             },
             lambda git_remote, **kwargs: {
-                "origin": f"file://{git_remote}",
-                "second_remote": f"file://{git_remote}",
+                "origin": GitRemote(
+                    name="origin",
+                    push_url=f"file://{git_remote}",
+                    fetch_url=f"file://{git_remote}",
+                ),
+                "second_remote": GitRemote(
+                    name="second_remote",
+                    push_url=f"file://{git_remote}",
+                    fetch_url=f"file://{git_remote}",
+                ),
             },
         ],
         [
@@ -327,13 +341,48 @@ def test_remotes(
                 "repo_dir": repos_path / repo_name,
                 "remotes": {
                     "origin": f"file://{git_remote}",
+                    # accepts short-hand form since it's inputted in the constructor
+                    "second_remote": f"file://{git_remote}",
                 },
             },
+            lambda git_remote, **kwargs: {},
             lambda git_remote, **kwargs: {
-                "origin": "https://github.com/vcs-python/libvcs",
+                "origin": GitRemote(
+                    name="origin",
+                    push_url=f"file://{git_remote}",
+                    fetch_url=f"file://{git_remote}",
+                ),
+                "second_remote": GitRemote(
+                    name="second_remote",
+                    push_url=f"file://{git_remote}",
+                    fetch_url=f"file://{git_remote}",
+                ),
+            },
+        ],
+        [
+            GitRepo,
+            lambda git_remote, repos_path, repo_name, **kwargs: {
+                "url": f"file://{git_remote}",
+                "repo_dir": repos_path / repo_name,
+                "remotes": {
+                    "origin": f"file://{git_remote}",
+                },
+            },
+            lambda git_remote, **kwargs: {
+                "origin": GitRemote(
+                    **{
+                        "name": "second_remote",
+                        "fetch_url": "https://github.com/vcs-python/libvcs",
+                        "push_url": "https://github.com/vcs-python/libvcs",
+                    }
+                )
             },
             lambda git_remote, **kwargs: {
-                "origin": "https://github.com/vcs-python/libvcs",
+                "origin": GitRemote(
+                    name="origin",
+                    push_url="https://github.com/vcs-python/libvcs",
+                    fetch_url="https://github.com/vcs-python/libvcs",
+                ),
             },
         ],
     ],
@@ -353,17 +402,13 @@ def test_remotes_update_repo(
     git_repo: GitRepo = constructor(**lazy_constructor_options(**locals()))
     git_repo.obtain()
 
-    git_repo._remotes = lazy_remote_dict(**locals())
+    git_repo._remotes |= lazy_remote_dict(**locals())
     git_repo.update_repo(set_remotes=True)
 
     expected = lazy_remote_expected(**locals())
     assert len(expected.keys()) > 0
     for expected_remote_name, expected_remote_url in expected.items():
-        assert (
-            expected_remote_name,
-            expected_remote_url,
-            expected_remote_url,
-        ) == git_repo.remote(expected_remote_name)
+        assert expected_remote_url == git_repo.remote(expected_remote_name)
 
 
 def test_git_get_url_and_rev_from_pip_url():