Small fixes to dev-env script

Author: daniel-anya

coverage_comment/activity.py

@@ -22,7 +22,15 @@ def find_activity(
     if event_name == "workflow_run":
         return "post_comment"
 
-    if (event_name == "push" and is_default_branch) or (event_name == "pull_request" and event_action == "merged" and is_default_branch) or event_name == "schedule":
+    if (
+        (event_name == "push" and is_default_branch)
+        or (
+            event_name == "pull_request"
+            and event_action == "merged"
+            and is_default_branch
+        )
+        or event_name == "schedule"
+    ):
         return "save_coverage_data_files"
 
     if event_name not in {"pull_request", "push"}:

coverage_comment/github.py

@@ -46,6 +46,7 @@ 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.
@@ -61,15 +62,15 @@ def extract_github_host(api_url: str) -> str:
     try:
         parsed_url = urlparse(api_url)
         scheme = parsed_url.scheme
-        netloc = parsed_url.netloc # This includes the domain and potentially the port
+        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'
+        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:'):
+        elif netloc.startswith("api.github.com:"):
             # Remove 'api.' prefix but keep the port
-            host_domain = netloc.replace('api.', '', 1)
+            host_domain = netloc.replace("api.", "", 1)
         # General case for GitHub Enterprise (netloc is already the host:port)
         else:
             host_domain = netloc
@@ -82,6 +83,7 @@ def extract_github_host(api_url: str) -> str:
         log.error(f"Error parsing URL {api_url}: {e}")
         return ""
 
+
 def download_artifact(
     github: github_client.GitHub,
     repository: str,

coverage_comment/main.py

@@ -1,10 +1,10 @@
 from __future__ import annotations
 
 import functools
+import json
 import logging
 import os
 import sys
-import json
 
 import httpx
 
@@ -74,7 +74,7 @@ def action(
     event_action = None
 
     if event_path and os.path.exists(event_path):
-        with open(event_path, "r") as event_file:
+        with open(event_path) as event_file:
             event_payload = json.load(event_file)
         is_merged_pr_action = event_payload.get("pull_request", {}).get("merged", False)
         if is_merged_pr_action:

coverage_comment/storage.py

@@ -155,7 +155,9 @@ def get_raw_file_url(
     # seconds.
 
 
-def get_repo_file_url(github_host: str, 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,
@@ -177,4 +179,3 @@ def get_html_report_url(github_host: str, repository: str, branch: str) -> str:
     if github_host.endswith("github.com"):
         return f"https://htmlpreview.github.io/?{readme_url}"
     return readme_url
-

dev-env

@@ -47,7 +47,7 @@ function create-repo(){
     repo_dirname=$(basename ${GITHUB_REPOSITORY})
     mv "${repo_dirname}/"{*,.*} .
     rmdir "${repo_dirname}"
-    git pull --ff-only origin master
+    git pull --ff-only origin main
 }
 
 function delete-repo(){
@@ -142,7 +142,7 @@ function help(){
     echo "  coverage_comment" >&2
     echo "      Launch the action locally (no argument)" >&2
     echo "  pytest" >&2
-    echo "      Launch the the tests on the example repo (generates the coverage data that the action uses)" >&2
+    echo "      Launch the tests on the example repo (generates the coverage data that the action uses)" >&2
     echo "" >&2
 
     echo "Change configuration:" >&2

tests/unit/test_activity.py

@@ -19,7 +19,9 @@
 )
 def test_find_activity(event_name, event_action, is_default_branch, expected_activity):
     result = activity.find_activity(
-        event_name=event_name, event_action=event_action, is_default_branch=is_default_branch
+        event_name=event_name,
+        event_action=event_action,
+        is_default_branch=is_default_branch,
     )
     assert result == expected_activity
 

tests/unit/test_storage.py

@@ -157,8 +157,16 @@ def test_get_datafile_contents(gh, session):
     "github_host, is_public, expected",
     [
         ("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"),
+        (
+            "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(github_host, is_public, expected):
@@ -177,17 +185,32 @@ def test_get_raw_file_url(github_host, is_public, expected):
     [
         ("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/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"),
+        (
+            "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(github_host, path, expected):
-    result = storage.get_repo_file_url(github_host=github_host, repository="foo/bar", branch="baz", path=path)
+    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",
     [
@@ -196,17 +219,28 @@ def test_get_repo_file_url(github_host, path, expected):
     ],
 )
 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")
+    result = storage.get_repo_file_url(
+        github_host=github_host, repository="foo/bar", branch="baz"
+    )
 
     assert result == f"{github_host}/foo/bar/tree/baz"
 
+
 @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"),
+        (
+            "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")
+    result = storage.get_html_report_url(
+        github_host=github_host, repository="foo/bar", branch="baz"
+    )
     assert result == expected