Merge pull request openSUSE#1968 from dcermak/add-get_host_repo_owner_number

feat: add new function PullRequest.get_host_owner_repo_number

Author: dmach

osc/gitea_api/pr.py

@@ -37,19 +37,31 @@ def split_id(cls, pr_id: str) -> Tuple[str, str, int]:
         return match.group(1), match.group(2), int(match.group(3))
 
     @staticmethod
-    def get_owner_repo_number(url: str) -> Tuple[str, str, int]:
+    def get_host_owner_repo_number(url: str) -> Tuple[str, str, str, int]:
         """
         Parse pull request URL such as http(s)://example.com:<port>/<owner>/<repo>/pulls/<number>
-        and return (owner, repo, number) tuple.
+        and return (host, owner, repo, number) tuple.
+
+        The host is returned as the full base URL (scheme://netloc), e.g., "https://example.com:3000".
         """
         import urllib.parse
 
         parsed_url = urllib.parse.urlparse(url)
+        host = f"{parsed_url.scheme}://{parsed_url.netloc}"
         path = parsed_url.path
         owner, repo, pulls, number = path.strip("/").split("/")
         if pulls not in ("pulls", "issues"):
             raise ValueError(f"URL doesn't point to a pull request or an issue: {url}")
-        return owner, repo, int(number)
+        return host, owner, repo, int(number)
+
+    @staticmethod
+    def get_owner_repo_number(url: str) -> Tuple[str, str, int]:
+        """
+        Parse pull request URL such as http(s)://example.com:<port>/<owner>/<repo>/pulls/<number>
+        and return (owner, repo, number) tuple.
+        """
+        _, owner, repo, number = PullRequest.get_host_owner_repo_number(url)
+        return owner, repo, number
 
     def parse_pr_references(self) -> List[Tuple[str, str, int]]:
         refs = re.findall(r"^PR: *(.*)$", self.body, re.M)

tests/test_gitea_api_pr.py

@@ -112,5 +112,57 @@ def test_object_issue(self):
         self.assertEqual(obj.head_ssh_url, None)
 
 
+class TestGiteaApiPullRequestUrlParsing(unittest.TestCase):
+    def test_get_host_owner_repo_number_https_with_port(self):
+        url = "https://git.example.com:3000/owner/repo/pulls/123"
+        host, owner, repo, number = PullRequest.get_host_owner_repo_number(url)
+        self.assertEqual(host, "https://git.example.com:3000")
+        self.assertEqual(owner, "owner")
+        self.assertEqual(repo, "repo")
+        self.assertEqual(number, 123)
+
+        self.assertTupleEqual(
+            PullRequest.get_owner_repo_number(url),
+            (owner, repo, number),
+        )
+
+    def test_get_host_owner_repo_number_https_without_port(self):
+        url = "https://git.example.com/owner/repo/pulls/456"
+        host, owner, repo, number = PullRequest.get_host_owner_repo_number(url)
+        self.assertEqual(host, "https://git.example.com")
+        self.assertEqual(owner, "owner")
+        self.assertEqual(repo, "repo")
+        self.assertEqual(number, 456)
+
+        self.assertTupleEqual(
+            PullRequest.get_owner_repo_number(url),
+            (owner, repo, number),
+        )
+
+    def test_get_host_owner_repo_number_issues_endpoint(self):
+        url = "https://git.example.com/owner/repo/issues/100"
+        host, owner, repo, number = PullRequest.get_host_owner_repo_number(url)
+        self.assertEqual(host, "https://git.example.com")
+        self.assertEqual(owner, "owner")
+        self.assertEqual(repo, "repo")
+        self.assertEqual(number, 100)
+
+        self.assertTupleEqual(
+            PullRequest.get_owner_repo_number(url),
+            (owner, repo, number),
+        )
+
+    def test_get_host_owner_repo_number_invalid_endpoint(self):
+        url = "https://git.example.com/owner/repo/commits/abc123"
+        with self.assertRaises(ValueError) as context:
+            PullRequest.get_host_owner_repo_number(url)
+        self.assertIn("doesn't point to a pull request or an issue", str(context.exception))
+
+    def test_get_host_owner_repo_number_invalid_format(self):
+        url = "https://git.example.com/owner/repo"
+        with self.assertRaises(ValueError):
+            PullRequest.get_host_owner_repo_number(url)
+
+
 if __name__ == "__main__":
     unittest.main()