Adds additional support for GitHub Enterprise in coverage artifacts

Adds support for figuring out a github host from the `GITHUB_BASE_URL` config and using this value in generated coverage artifacts rather than hardcoding them to "github.com"

Author: daniel-anya

coverage_comment/github.py

@@ -6,6 +6,7 @@
 import pathlib
 import sys
 import zipfile
+from urllib.parse import urlparse
 
 from coverage_comment import github_client, log
 
@@ -45,6 +46,41 @@ def get_repository_info(
         default_branch=response.default_branch, visibility=response.visibility
     )
 
+def extract_github_host(api_url: str) -> str:
+    """
+    Extracts the base GitHub web host URL from a GitHub API URL.
+
+    Args:
+      api_url: The GitHub API URL (e.g., 'https://api.github.com/...',
+               'https://my-ghe.company.com/api/v3/...').
+
+    Returns:
+      The base GitHub web host URL (e.g., 'https://github.com',
+      'https://my-ghe.company.com').
+    """
+    try:
+        parsed_url = urlparse(api_url)
+        scheme = parsed_url.scheme
+        netloc = parsed_url.netloc # This includes the domain and potentially the port
+
+        # Special case for GitHub.com API
+        if netloc == 'api.github.com':
+            host_domain = 'github.com'
+        # Special case for GitHub.com with port (less common but good practice)
+        elif netloc.startswith('api.github.com:'):
+            # Remove 'api.' prefix but keep the port
+            host_domain = netloc.replace('api.', '', 1)
+        # General case for GitHub Enterprise (netloc is already the host:port)
+        else:
+            host_domain = netloc
+
+        # Reconstruct the host URL
+        host_url = f"{scheme}://{host_domain}"
+
+        return host_url
+    except Exception as e:
+        log.error(f"Error parsing URL {api_url}: {e}")
+        return ""
 
 def download_artifact(
     github: github_client.GitHub,

coverage_comment/main.py

@@ -201,6 +201,7 @@ def process_pr(
             max_files=config.MAX_FILES_IN_COMMENT,
             minimum_green=config.MINIMUM_GREEN,
             minimum_orange=config.MINIMUM_ORANGE,
+            github_host=github.extract_github_host(config.GITHUB_BASE_URL),
             repo_name=config.GITHUB_REPOSITORY,
             pr_number=config.GITHUB_PR_NUMBER,
             base_template=template.read_template_file("comment.md.j2"),
@@ -220,6 +221,7 @@ def process_pr(
             max_files=None,
             minimum_green=config.MINIMUM_GREEN,
             minimum_orange=config.MINIMUM_ORANGE,
+            github_host=github.extract_github_host(config.GITHUB_BASE_URL),
             repo_name=config.GITHUB_REPOSITORY,
             pr_number=config.GITHUB_PR_NUMBER,
             base_template=template.read_template_file("comment.md.j2"),
@@ -411,17 +413,21 @@ def save_coverage_data_files(
         github_step_summary=config.GITHUB_STEP_SUMMARY,
     )
 
+    github_host = github.extract_github_host(config.GITHUB_BASE_URL)
     url_getter = functools.partial(
         storage.get_raw_file_url,
+        github_host=github_host,
         is_public=is_public,
         repository=config.GITHUB_REPOSITORY,
         branch=config.FINAL_COVERAGE_DATA_BRANCH,
     )
     readme_url = storage.get_repo_file_url(
+        github_host=github_host,
         branch=config.FINAL_COVERAGE_DATA_BRANCH,
         repository=config.GITHUB_REPOSITORY,
     )
     html_report_url = storage.get_html_report_url(
+        github_host=github_host,
         branch=config.FINAL_COVERAGE_DATA_BRANCH,
         repository=config.GITHUB_REPOSITORY,
     )

coverage_comment/storage.py

@@ -132,16 +132,17 @@ def get_datafile_contents(
 
 
 def get_raw_file_url(
+    github_host: str,
     repository: str,
     branch: str,
     path: pathlib.Path,
     is_public: bool,
 ):
-    if not is_public:
-        # If the repository is private, then the real links to raw.githubusercontents.com
-        # will be short-lived. In this case, it's better to keep an URL that will
-        # redirect to the correct URL just when asked.
-        return f"https://github.com/{repository}/raw/{branch}/{path}"
+    if (not is_public) or (not github_host.endswith("github.com")):
+        # If the repository is private or hosted on a github enterprise instance,
+        # then the real links to raw.githubusercontents.com will be short-lived.
+        # In this case, it's better to keep an URL that will  redirect to the correct URL just when asked.
+        return f"{github_host}/{repository}/raw/{branch}/{path}"
 
     # Otherwise, we can access the file directly. (shields.io doesn't like the
     # github.com domain)
@@ -154,7 +155,7 @@ def get_raw_file_url(
     # seconds.
 
 
-def get_repo_file_url(repository: str, branch: str, path: str = "/") -> str:
+def get_repo_file_url(github_host: str, repository: str, branch: str, path: str = "/") -> str:
     """
     Computes the GitHub Web UI URL for a given path:
     If the path is empty or ends with a slash, it will be interpreted as a folder,
@@ -166,11 +167,14 @@ def get_repo_file_url(repository: str, branch: str, path: str = "/") -> str:
     # See test_get_repo_file_url for precise specifications
     path = "/" + path.lstrip("/")
     part = "tree" if path.endswith("/") else "blob"
-    return f"https://github.com/{repository}/{part}/{branch}{path}".rstrip("/")
+    return f"{github_host}/{repository}/{part}/{branch}{path}".rstrip("/")
 
 
-def get_html_report_url(repository: str, branch: str) -> str:
+def get_html_report_url(github_host: str, repository: str, branch: str) -> str:
     readme_url = get_repo_file_url(
-        repository=repository, branch=branch, path="/htmlcov/index.html"
+        github_host, repository=repository, branch=branch, path="/htmlcov/index.html"
     )
-    return f"https://htmlpreview.github.io/?{readme_url}"
+    if github_host.endswith("github.com"):
+        return f"https://htmlpreview.github.io/?{readme_url}"
+    return readme_url
+

coverage_comment/template.py

@@ -130,6 +130,7 @@ def get_comment_markdown(
     count_files: int,
     minimum_green: decimal.Decimal,
     minimum_orange: decimal.Decimal,
+    github_host: str,
     repo_name: str,
     pr_number: int,
     base_template: str,
@@ -148,7 +149,7 @@ def get_comment_markdown(
     env.filters["pluralize"] = pluralize
     env.filters["compact"] = compact
     env.filters["file_url"] = functools.partial(
-        get_file_url, repo_name=repo_name, pr_number=pr_number
+        get_file_url, github_host=github_host, repo_name=repo_name, pr_number=pr_number
     )
     env.filters["get_badge_color"] = functools.partial(
         badge.get_badge_color,
@@ -304,11 +305,12 @@ def get_file_url(
     filename: pathlib.Path,
     lines: tuple[int, int] | None = None,
     *,
+    github_host: str,
     repo_name: str,
     pr_number: int,
 ) -> str:
     # To link to a file in a PR, GitHub uses the link to the file overview combined with a SHA256 hash of the file path
-    s = f"https://github.com/{repo_name}/pull/{pr_number}/files#diff-{hashlib.sha256(str(filename).encode('utf-8')).hexdigest()}"
+    s = f"{github_host}/{repo_name}/pull/{pr_number}/files#diff-{hashlib.sha256(str(filename).encode('utf-8')).hexdigest()}"
 
     if lines is not None:
         # R stands for Right side of the diff. But since we generate these links for new code we only need the right side.

tests/unit/test_storage.py

@@ -154,14 +154,16 @@ def test_get_datafile_contents(gh, session):
 
 
 @pytest.mark.parametrize(
-    "is_public, expected",
+    "github_host, is_public, expected",
     [
-        (False, "https://github.com/foo/bar/raw/baz/qux"),
-        (True, "https://raw.githubusercontent.com/foo/bar/baz/qux"),
+        ("https://github.com", False, "https://github.com/foo/bar/raw/baz/qux"),
+        ("https://github.com", True, "https://raw.githubusercontent.com/foo/bar/baz/qux"),
+        ("https://github.mycompany.com", True, "https://github.mycompany.com/foo/bar/raw/baz/qux"),
     ],
 )
-def test_get_raw_file_url(is_public, expected):
+def test_get_raw_file_url(github_host, is_public, expected):
     result = storage.get_raw_file_url(
+        github_host=github_host,
         repository="foo/bar",
         branch="baz",
         path=pathlib.Path("qux"),
@@ -171,29 +173,40 @@ def test_get_raw_file_url(is_public, expected):
 
 
 @pytest.mark.parametrize(
-    "path, expected",
+    "github_host, path, expected",
     [
-        ("", "https://github.com/foo/bar/tree/baz"),
-        ("/", "https://github.com/foo/bar/tree/baz"),
-        ("qux", "https://github.com/foo/bar/blob/baz/qux"),  # blob
-        ("qux/", "https://github.com/foo/bar/tree/baz/qux"),
-        ("/qux", "https://github.com/foo/bar/blob/baz/qux"),  # blob
-        ("/qux/", "https://github.com/foo/bar/tree/baz/qux"),
+        ("https://github.com", "", "https://github.com/foo/bar/tree/baz"),
+        ("https://github.com", "/", "https://github.com/foo/bar/tree/baz"),
+        ("https://github.com", "qux", "https://github.com/foo/bar/blob/baz/qux"),  # blob
+        ("https://github.com", "qux/", "https://github.com/foo/bar/tree/baz/qux"),
+        ("https://github.mycompany.com", "/qux", "https://github.mycompany.com/foo/bar/blob/baz/qux"),  # blob
+        ("https://github.mycompany.com", "/qux/", "https://github.mycompany.com/foo/bar/tree/baz/qux"),
     ],
 )
-def test_get_repo_file_url(path, expected):
-    result = storage.get_repo_file_url(repository="foo/bar", branch="baz", path=path)
+def test_get_repo_file_url(github_host, path, expected):
+    result = storage.get_repo_file_url(github_host=github_host, repository="foo/bar", branch="baz", path=path)
 
     assert result == expected
 
+@pytest.mark.parametrize(
+    "github_host",
+    [
+        "https://github.com",
+        "https://github.mycompany.com",
+    ],
+)
+def test_get_repo_file_url__no_path(github_host):
+    result = storage.get_repo_file_url(github_host=github_host, repository="foo/bar", branch="baz")
 
-def test_get_repo_file_url__no_path():
-    result = storage.get_repo_file_url(repository="foo/bar", branch="baz")
-
-    assert result == "https://github.com/foo/bar/tree/baz"
-
+    assert result == f"{github_host}/foo/bar/tree/baz"
 
-def test_get_html_report_url():
-    result = storage.get_html_report_url(repository="foo/bar", branch="baz")
-    expected = "https://htmlpreview.github.io/?https://github.com/foo/bar/blob/baz/htmlcov/index.html"
+@pytest.mark.parametrize(
+    "github_host, expected",
+    [
+        ("https://github.com", "https://htmlpreview.github.io/?https://github.com/foo/bar/blob/baz/htmlcov/index.html"),
+        ("https://github.mycompany.com", "https://github.mycompany.com/foo/bar/blob/baz/htmlcov/index.html"),
+    ],
+)
+def test_get_html_report_url(github_host, expected):
+    result = storage.get_html_report_url(github_host=github_host, repository="foo/bar", branch="baz")
     assert result == expected

tests/unit/test_template.py

@@ -27,6 +27,7 @@ def test_get_comment_markdown(coverage_obj, diff_coverage_obj):
             minimum_green=decimal.Decimal("100"),
             minimum_orange=decimal.Decimal("70"),
             marker="<!-- foo -->",
+            github_host="https://github.com",
             repo_name="org/repo",
             pr_number=1,
             base_template="""
@@ -66,6 +67,7 @@ def test_template(coverage_obj, diff_coverage_obj):
         files=files,
         count_files=total,
         max_files=25,
+        github_host="https://github.com",
         repo_name="org/repo",
         pr_number=5,
         base_template=template.read_template_file("comment.md.j2"),
@@ -195,6 +197,7 @@ def test_template_full(make_coverage, make_coverage_and_diff):
         minimum_green=decimal.Decimal("100"),
         minimum_orange=decimal.Decimal("70"),
         marker="<!-- foo -->",
+        github_host="https://github.com",
         repo_name="org/repo",
         pr_number=12,
         base_template=template.read_template_file("comment.md.j2"),
@@ -257,6 +260,7 @@ def test_template__no_previous(coverage_obj_no_branch, diff_coverage_obj):
         minimum_green=decimal.Decimal("100"),
         minimum_orange=decimal.Decimal("70"),
         marker="<!-- foo -->",
+        github_host="https://github.com",
         repo_name="org/repo",
         pr_number=3,
         base_template=template.read_template_file("comment.md.j2"),
@@ -309,6 +313,7 @@ def test_template__max_files(coverage_obj_more_files, diff_coverage_obj_more_fil
         previous_coverage_rate=decimal.Decimal("0.92"),
         minimum_green=decimal.Decimal("79"),
         minimum_orange=decimal.Decimal("40"),
+        github_host="https://github.com",
         repo_name="org/repo",
         pr_number=5,
         max_files=1,
@@ -340,6 +345,7 @@ def test_template__no_max_files(coverage_obj_more_files, diff_coverage_obj_more_
         previous_coverage_rate=decimal.Decimal("0.92"),
         minimum_green=decimal.Decimal("79"),
         minimum_orange=decimal.Decimal("40"),
+        github_host="https://github.com",
         repo_name="org/repo",
         pr_number=5,
         max_files=None,
@@ -374,6 +380,7 @@ def test_template__no_files(coverage_obj, diff_coverage_obj_more_files):
         previous_coverage_rate=decimal.Decimal("0.92"),
         minimum_green=decimal.Decimal("79"),
         minimum_orange=decimal.Decimal("40"),
+        github_host="https://github.com",
         repo_name="org/repo",
         pr_number=5,
         max_files=25,
@@ -412,6 +419,7 @@ def test_template__no_marker(coverage_obj, diff_coverage_obj):
             previous_coverage_rate=decimal.Decimal("0.92"),
             minimum_green=decimal.Decimal("100"),
             minimum_orange=decimal.Decimal("70"),
+            github_host="https://github.com",
             repo_name="org/repo",
             pr_number=1,
             base_template=template.read_template_file("comment.md.j2"),
@@ -432,6 +440,7 @@ def test_template__broken_template(coverage_obj, diff_coverage_obj):
             previous_coverage_rate=decimal.Decimal("0.92"),
             minimum_green=decimal.Decimal("100"),
             minimum_orange=decimal.Decimal("70"),
+            github_host="https://github.com",
             repo_name="org/repo",
             pr_number=1,
             base_template=template.read_template_file("comment.md.j2"),
@@ -496,6 +505,7 @@ def test_get_file_url(filepath, lines, expected):
     result = template.get_file_url(
         filename=filepath,
         lines=lines,
+        github_host="https://github.com",
         repo_name="py-cov-action/python-coverage-comment-action",
         pr_number=33,
     )