scm.git: add support for cloning private repo (bug 2037928) r=sheehan,shtrom

- add entry to clone test repo locally
- update scm.git to use authenticated URL
- move existing path authentication functionality to reusable method

Pull request: #1138

Author: zzzeid

src/lando/main/scm/git.py

@@ -77,6 +77,13 @@ def __init__(self, path: str, default_branch: str = "main", **kwargs):
         self.default_branch = default_branch
         super().__init__(path)
 
+    @staticmethod
+    def authenticate_path_if_possible(url: str) -> str:
+        """Return authenticated URL if it is a GitHub URL."""
+        if GitHub.is_supported_url(url):
+            return GitHub(url).authenticated_url
+        return url
+
     @classmethod
     @override
     def scm_type(cls) -> SCMType:
@@ -91,9 +98,11 @@ def scm_name(cls) -> str:
 
     @override
     def clone(self, source: str):
-        """Clone a repository from a source."""
+        """Clone a repository from a source (pull_path)."""
+        pull_path = self.authenticate_path_if_possible(source)
+
         # When cloning, self.path doesn't exist yet, so we need to use another CWD.
-        self._git_run("clone", source, self.path, cwd="/")
+        self._git_run("clone", pull_path, self.path, cwd="/")
         self._git_run("checkout", self.default_branch, cwd=self.path)
         self._git_repo_config()
 
@@ -121,8 +130,7 @@ def push(
         if force_push:
             push_command += ["--force"]
 
-        if GitHub.is_supported_url(push_path):
-            push_path = GitHub(push_path).authenticated_url
+        push_path = self.authenticate_path_if_possible(push_path)
 
         push_command += [push_path]
 
@@ -466,6 +474,9 @@ def update_repo(
 
         self.clean_repo(attributes_override=attributes_override)
         # Fetch all refs at the given pull_path, and overwrite the `origin` references.
+
+        pull_path = self.authenticate_path_if_possible(pull_path)
+
         self._git_run(
             "fetch",
             "--prune",

src/lando/main/tests/test_scm_helpers.py

@@ -2,6 +2,7 @@
 import os
 from pathlib import Path
 from typing import Callable
+from unittest import mock
 
 import pytest
 
@@ -752,3 +753,23 @@ def test_strip_git_version_info_lines():
         "blah",
         "blah",
     ]
+
+
+@pytest.mark.parametrize(
+    "url,is_supported_url,result",
+    (
+        ("some_supported_url", True, "authenticated_url"),
+        ("some_unsupported_url", False, "some_unsupported_url"),
+    ),
+)
+@mock.patch("lando.main.scm.git.GitHub")
+def test_GitSCM__authenticate_path_if_possible(github, is_supported_url, url, result):
+    mock_github = mock.MagicMock()
+    type(mock_github).authenticated_url = mock.PropertyMock(return_value=result)
+    github.return_value = mock_github
+    github.is_supported_url.return_value = is_supported_url
+
+    authenticated_url = GitSCM.authenticate_path_if_possible(url)
+    assert github.is_supported_url.call_count == 1
+    github.is_supported_url.assert_called_with(url)
+    assert authenticated_url == result

src/lando/utils/management/commands/create_environment_repos.py

@@ -27,6 +27,15 @@
             "scm_type": GitSCM.scm_type(),
             "pr_enabled": True,
         },
+        {
+            "name": "git-repo-private",
+            "url": "https://github.com/mozilla-conduit/test-repo-private.git",
+            "push_path": "https://github.com/mozilla-conduit/test-repo.git",
+            "required_permission": SCM_LEVEL_1,
+            "scm_type": GitSCM.scm_type(),
+            "hooks_enabled": False,
+            "pr_enabled": True,
+        },
         {
             "name": "test-repo-git",
             "url": "http://git.test/test-repo",