github: add GitHub class for basic URL and token manipulation

Author: shtrom

src/lando/main/scm/git.py

@@ -22,7 +22,7 @@
 )
 from lando.main.scm.helpers import GitPatchHelper, PatchHelper
 from lando.settings import LANDO_USER_EMAIL, LANDO_USER_NAME
-from lando.utils.github import GitHubAPI
+from lando.utils.github import GitHub
 
 from .abstract_scm import AbstractSCM
 
@@ -113,8 +113,8 @@ def push(
         if force_push:
             push_command += ["--force"]
 
-        if GitHubAPI.is_github_url(push_path):
-            push_path = GitHubAPI(push_path).authenticated_url
+        if GitHub.is_supported_url(push_path):
+            push_path = GitHub(push_path).authenticated_url
 
         push_command += [push_path]
 

src/lando/main/tests/test_git.py

@@ -8,7 +8,7 @@
 from pathlib import Path
 from textwrap import dedent
 from unittest import mock
-from unittest.mock import MagicMock
+from unittest.mock import MagicMock, PropertyMock
 
 import pytest
 
@@ -679,21 +679,35 @@ def mock_github_api_get_token(monkeypatch: pytest.MonkeyPatch):
     return mock_get_token
 
 
-def test_GitSCM_push_get_github_token(
-    git_repo: Path, mock_github_api_get_token: mock.Mock
+def mock_github_authenticated_url(monkeypatch: pytest.MonkeyPatch):
+    mock_authenticated_url = PropertyMock()
+
+    mock_authenticated_url.return_value = (
+        "ssh+git:ghs_yolo@github.com/some-org/some-repo"
+    )
+
+    monkeypatch.setattr(
+        "lando.utils.github.GitHub.authenticated_url", mock_authenticated_url
+    )
+
+    return mock_authenticated_url
+
+
+def test_GitSCM_push_github_authenticated_url(
+    git_repo: Path, mock_github_authenticated_url: mock.Mock
 ):
     scm = GitSCM(str(git_repo))
     scm._git_run = MagicMock()
 
     scm.push("https://github.com/some/repo")
 
-    assert scm._git_run.call_count == 1, "_git_run wasn't called when pushing"
+    assert scm._git_run.call_count >= 1, "_git_run wasn't called when pushing"
     assert (
-        mock_github_api_get_token.call_count == 1
-    ), "_get_github_token wasn't called when pushing to a github-like URL"
+        mock_github_authenticated_url.call_count == 1
+    ), "GitHub.authenticated_url wasn't accessed when pushing to a github-like URL"
     assert (
         "git:ghs_yolo@github.com" in scm._git_run.call_args[0][1]
-    ), "github token not found in rewritten push_path"
+    ), "GitHub authenticated_url was not found in rewritten push_path"
 
 
 @pytest.mark.parametrize(

src/lando/utils/github.py

@@ -16,27 +16,23 @@
 )
 
 
-class GitHubAPI:
-    """A simple wrapper that authenticates with and communicates with the GitHub API."""
+class GitHub:
+    """Work with authentication to GitHub repositories."""
 
-    GITHUB_BASE_URL = "https://api.github.com"
+    # NOTE: This RE takes care of removing the '.git' suffix, to provide normalised URLs.
+    GITHUB_URL_RE = re.compile(
+        f"https://{URL_USERINFO_RE.pattern}?github.com/(?P<owner>[-A-Za-z0-9]+)/(?P<repo>[^/]+)(.git)?"
+    )
 
     repo_url: str
     repo_owner: str
     repo_name: str
     userinfo: str
-    session: requests.Session
-
-    GITHUB_BASE_URL = "https://api.github.com"
-    # NOTE: This RE takes care of removing the '.git' suffix, to provide normalised URLs.
-    GITHUB_URL_RE = re.compile(
-        f"https://{URL_USERINFO_RE.pattern}?github.com/(?P<owner>[-A-Za-z0-9]+)/(?P<repo>[^/]+)(.git)?"
-    )
 
     def __init__(self, repo_url: str):
         self.repo_url = repo_url
 
-        parsed_url = self.parse_github_url(repo_url)
+        parsed_url = self.parse_url(repo_url)
 
         if parsed_url is None:
             raise ValueError(f"Cannot parse URL as GitHub repo: {repo_url}")
@@ -45,22 +41,12 @@ def __init__(self, repo_url: str):
         self.repo_name = parsed_url["repo"]
         self.userinfo = parsed_url["userinfo"]
 
-        self.session = requests.Session()
-        self.session.headers.update(
-            {
-                "Authorization": f"Bearer {self._fetch_token()}",
-                "User-Agent": settings.HTTP_USER_AGENT,
-                "Accept": "application/vnd.github+json",
-                "X-GitHub-Api-Version": "2022-11-28",
-            }
-        )
-
     @classmethod
-    def is_github_url(cls, url: str) -> bool:
-        return cls.parse_github_url(url) is not None
+    def is_supported_url(cls, url: str) -> bool:
+        return cls.parse_url(url) is not None
 
     @classmethod
-    def parse_github_url(cls, url: str) -> re.Match[str] | None:
+    def parse_url(cls, url: str) -> re.Match[str] | None:
         """Parse GitHub data from URL, or return None if not Github."""
         return re.match(cls.GITHUB_URL_RE, url)
 
@@ -112,6 +98,27 @@ def _fetch_token(self) -> str | None:
         )
         return asyncio.run(session.get_token())
 
+
+class GitHubAPI(GitHub):
+    """A simple wrapper that authenticates with and communicates with the GitHub API."""
+
+    session: requests.Session
+
+    GITHUB_BASE_URL = "https://api.github.com"
+
+    def __init__(self, repo_url: str):
+        super().__init__(repo_url)
+
+        self.session = requests.Session()
+        self.session.headers.update(
+            {
+                "Authorization": f"Bearer {self._fetch_token()}",
+                "User-Agent": settings.HTTP_USER_AGENT,
+                "Accept": "application/vnd.github+json",
+                "X-GitHub-Api-Version": "2022-11-28",
+            }
+        )
+
     def get(self, path: str, *args, **kwargs) -> dict:
         """Send a GET request to the GitHub API with given args and kwargs."""
         url = f"{self.GITHUB_BASE_URL}/{path}"