RepoAuditor 0.2.51__tar.gz → 0.2.53__tar.gz

{repoauditor-0.2.51 → repoauditor-0.2.53}/.github/workflows/EndToEnd.yml

@@ -1,5 +1,5 @@
 name: "End To End Tests"
-run-name: EndToEnd ${{ github.run_number }} [${{ github.actor }}] on ${{ github.ref_name }}
+run-name: EndToEnd ${{ github.run_number }} on ${{ github.ref_name }}
 
 on:
   schedule:
@@ -38,6 +38,11 @@ jobs:
         run: |
           echo ${{ secrets.TESTING_GITHUB_PAT }} > tests/Plugins/github_pat.txt
 
+      # Create PAT file for Enterprise GitHub server, in this case github.gatech.edu.
+      - name: Create github_gatech_pat.txt
+        run: |
+          echo ${{ secrets.TESTING_GITHUB_GATECH_PAT }} > tests/Plugins/github_gatech_pat.txt
+
       - name: Environment Variables
         shell: bash
         run: |

{repoauditor-0.2.51 → repoauditor-0.2.53}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.51
+Version: 0.2.53
 Summary: Add your description here
 Project-URL: Homepage, https://github.com/gt-sse-center/RepoAuditor
 Project-URL: Documentation, https://github.com/gt-sse-center/RepoAuditor

{repoauditor-0.2.51 → repoauditor-0.2.53}/src/RepoAuditor/Plugins/GitHubCommunityStandards/Impl/ExistsRequirementImpl.py

@@ -19,20 +19,32 @@ from RepoAuditor.Requirement import EvaluateResult, ExecutionStyle, Requirement
 
 # ----------------------------------------------------------------------
 class ExistsRequirementImpl(Requirement):
-    """Object that implements check if a file exists."""
+    """Requirement which implements check if a file exists."""
 
     # ----------------------------------------------------------------------
     def __init__(
         self,
         name: str,
-        dynamic_arg_name: str,
         github_file: str,
         possible_locations: Sequence[str],
         resolution: str,
         rationale: str,
         *,
+        dynamic_arg_name: str = "unrequired",
         requires_explicit_include: bool = False,
     ) -> None:
+        """Construct.
+
+        Args:
+            name (str): The name of the requirement. Used for unique identification.
+            github_file (str): The name of the file in the GitHub repository being checked for.
+            possible_locations (Sequence[str]): List of potential paths in the repo to check if `github_file` exists.
+            resolution (str): Message on how to resolve the requirement in case of an error.
+            rationale (str): Rationale message on why this requirement is needed.
+            dynamic_arg_name (str, optional): Name of the runtime argument (e.g. from command line) to this requirement.Defaults to "unrequired", which if enabled causes the requirement to be skipped.
+            requires_explicit_include (bool, optional): Flag checking if this requirement needs to be explicitly included in the invocation. Defaults to False.
+
+        """
         super().__init__(
             name,
             f"Validates that {github_file} file exists.",
@@ -56,7 +68,7 @@ class ExistsRequirementImpl(Requirement):
                 bool,
                 typer.Option(
                     False,
-                    help=f"Ensures that the file {self.github_file} exists.",
+                    help=f"Disable requirement that the file {self.github_file} exists.",
                 ),
             ),
         }
@@ -68,7 +80,8 @@ class ExistsRequirementImpl(Requirement):
         query_data: dict[str, Any],
         requirement_args: dict[str, Any],
     ) -> Requirement.EvaluateImplResult:
-        if requirement_args[self.dynamic_arg_name]:
+        # Check if `dynamic_arg_name` is `not unrequired`.
+        if not requirement_args[self.dynamic_arg_name]:
             for location in self.possible_locations:
                 # Get full file path in temporary repo directory and check if it exists
                 # This checks both upper case and lower case variants

{repoauditor-0.2.51 → repoauditor-0.2.53}/src/RepoAuditor/Plugins/GitHubCommunityStandards/Requirements/CodeOfConduct.py

@@ -17,12 +17,14 @@ class CodeOfConduct(ExistsRequirementImpl):
     def __init__(self) -> None:
         super().__init__(
             "CodeOfConduct",
-            "exists",
             "CODE_OF_CONDUCT",
             [
                 ".github/CODE_OF_CONDUCT",
+                ".github/CODE_OF_CONDUCT.md",
                 "docs/CODE_OF_CONDUCT",
+                "docs/CODE_OF_CONDUCT.md",
                 "CODE_OF_CONDUCT",
+                "CODE_OF_CONDUCT.md",
             ],
             textwrap.dedent(
                 """\

{repoauditor-0.2.51 → repoauditor-0.2.53}/src/RepoAuditor/Plugins/GitHubCommunityStandards/Requirements/CodeOwners.py

@@ -17,7 +17,6 @@ class CodeOwners(ExistsRequirementImpl):
     def __init__(self) -> None:
         super().__init__(
             "CodeOwners",
-            "exists",
             "CODEOWNERS",
             [
                 ".github/CODEOWNERS",

{repoauditor-0.2.51 → repoauditor-0.2.53}/src/RepoAuditor/Plugins/GitHubCommunityStandards/Requirements/Contributing.py

@@ -17,7 +17,6 @@ class Contributing(ExistsRequirementImpl):
     def __init__(self) -> None:
         super().__init__(
             "Contributing",
-            "exists",
             "CONTRIBUTING",
             [
                 ".github/CONTRIBUTING.md",

{repoauditor-0.2.51 → repoauditor-0.2.53}/src/RepoAuditor/Plugins/GitHubCommunityStandards/Requirements/IssueTemplates.py

@@ -15,7 +15,6 @@ class IssueTemplates(ExistsRequirementImpl):
     def __init__(self) -> None:
         super().__init__(
             "IssueTemplates",
-            "exists",
             "ISSUE_TEMPLATES",
             [
                 ".github/ISSUE_TEMPLATE.md",

{repoauditor-0.2.51 → repoauditor-0.2.53}/src/RepoAuditor/Plugins/GitHubCommunityStandards/Requirements/LicenseFile.py

@@ -19,7 +19,6 @@ class LicenseFile(ExistsRequirementImpl):
     def __init__(self) -> None:
         super().__init__(
             "LicenseFile",
-            "exists",
             "LICENSE",
             [
                 "LICENSE",

{repoauditor-0.2.51 → repoauditor-0.2.53}/src/RepoAuditor/Plugins/GitHubCommunityStandards/Requirements/PullRequestTemplates.py

@@ -15,7 +15,6 @@ class PullRequestTemplate(ExistsRequirementImpl):
     def __init__(self) -> None:
         super().__init__(
             "PullRequestTemplate",
-            "exists",
             "PULL_REQUESTS_TEMPLATE",
             [
                 ".github/PULL_REQUEST_TEMPLATE.md",

{repoauditor-0.2.51 → repoauditor-0.2.53}/src/RepoAuditor/Plugins/GitHubCommunityStandards/Requirements/ReadMe.py

@@ -17,7 +17,6 @@ class ReadMe(ExistsRequirementImpl):
     def __init__(self) -> None:
         super().__init__(
             "ReadMe",
-            "exists",
             "README",
             [
                 "README.md",

{repoauditor-0.2.51 → repoauditor-0.2.53}/src/RepoAuditor/Plugins/GitHubCommunityStandards/Requirements/SecurityPolicy.py

@@ -17,7 +17,6 @@ class SecurityPolicy(ExistsRequirementImpl):
     def __init__(self) -> None:
         super().__init__(
             "SecurityPolicy",
-            "exists",
             "SECURITY",
             [
                 ".github/SECURITY.md",

{repoauditor-0.2.51 → repoauditor-0.2.53}/src/RepoAuditor/__init__.py

@@ -2,4 +2,4 @@ APP_NAME = "RepoAuditor"
 
 # Note that the default value below will be used until the value
 # here is explicitly updated by the Continuous Integration system.
-__version__ = "0.2.51"
+__version__ = "0.2.53"

{repoauditor-0.2.51 → repoauditor-0.2.53}/tests/Plugins/GitHubCommunityStandards/ExistsRequirementImpl_UnitTest.py

@@ -23,7 +23,6 @@ class TestExistsRequirementImpl:
         """Test the requirement implementation constructor."""
         requirement = ExistsRequirementImpl(
             name="Exists Some Value",
-            dynamic_arg_name="exists",
             github_file="README.md",
             possible_locations=[
                 "README.md",
@@ -37,7 +36,6 @@ class TestExistsRequirementImpl:
         """Test disabled requirement."""
         requirement = ExistsRequirementImpl(
             name="Exists Some Value",
-            dynamic_arg_name="exists",
             github_file="README.md",
             possible_locations=[
                 "README.md",
@@ -47,7 +45,7 @@ class TestExistsRequirementImpl:
         )
 
         query_data = {}
-        requirement_args = {"exists": False}
+        requirement_args = {"unrequired": True}
         result = requirement.Evaluate(query_data, requirement_args)
         assert result.result == EvaluateResult.DoesNotApply
 
@@ -55,7 +53,6 @@ class TestExistsRequirementImpl:
         """Test for when file is not found."""
         requirement = ExistsRequirementImpl(
             name="Exists Some Value",
-            dynamic_arg_name="exists",
             github_file="README.md",
             possible_locations=[
                 "MEREAD.md",
@@ -65,7 +62,7 @@ class TestExistsRequirementImpl:
         )
 
         query_data = {"repo_dir": MockDirectory()}
-        requirement_args = {"exists": True}
+        requirement_args = {"unrequired": False}
         result = requirement.Evaluate(query_data, requirement_args)
         assert result.result == EvaluateResult.Error
         assert "No README.md file found" in result.context
@@ -74,7 +71,6 @@ class TestExistsRequirementImpl:
         """Test for when file is found as is."""
         requirement = ExistsRequirementImpl(
             name="Exists Some Value",
-            dynamic_arg_name="exists",
             github_file="README.md",
             possible_locations=[
                 "README.md",
@@ -88,7 +84,7 @@ class TestExistsRequirementImpl:
             f.write("temp file in temp directory")
 
         query_data = {"repo_dir": tempdir}
-        requirement_args = {"exists": True}
+        requirement_args = {"unrequired": False}
         result = requirement.Evaluate(query_data, requirement_args)
         assert result.result == EvaluateResult.Success
         assert "README.md found in repository" in result.context
@@ -97,7 +93,6 @@ class TestExistsRequirementImpl:
         """Test if provided path is directory."""
         requirement = ExistsRequirementImpl(
             name="Exists Some Value",
-            dynamic_arg_name="exists",
             github_file="README.md",
             possible_locations=[
                 "docs",
@@ -115,7 +110,7 @@ class TestExistsRequirementImpl:
             f.write("temp file in temp directory")
 
         query_data = {"repo_dir": tempdir}
-        requirement_args = {"exists": True}
+        requirement_args = {"unrequired": False}
         result = requirement.Evaluate(query_data, requirement_args)
         assert result.result == EvaluateResult.Success
         assert "File found in docs directory of the repository" in result.context

repoauditor-0.2.53/tests/Plugins/GitHubCommunityStandards_EndToEndTest.py

@@ -0,0 +1,343 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""End-to-end tests for the GitHubCommunityStandards plugin."""
+
+import shutil
+from pathlib import Path
+from tempfile import TemporaryDirectory
+from unittest.mock import patch
+
+import pytest
+from dbrownell_Common.TestHelpers.StreamTestHelpers import (
+    InitializeStreamCapabilities,
+)
+from git import Repo
+from typer.testing import CliRunner
+from utilities import CheckPATFileExists, GetGithubUrl, ScrubDurationGithuburlAndSpaces
+
+from RepoAuditor.EntryPoint import app
+from RepoAuditor.Plugins.GitHubCommunityStandards.CommunityStandardsQuery import CommunityStandardsQuery
+
+# ----------------------------------------------------------------------
+pytest.fixture(InitializeStreamCapabilities(), scope="session", autouse=True)
+
+
+def GetDataFunctional(path_to_delete: str, is_directory=False):
+    """A functional which returns a modified GetData method which
+    deletes the specified path in the cloned repo.
+    """
+
+    def GetData(self, module_data):
+        # Clone the GitHub repository to a temp directory
+        github_url = module_data["url"]
+        branch = module_data.get("branch", "main")
+        temp_repo_dir = TemporaryDirectory()
+        Repo.clone_from(github_url, temp_repo_dir.name, branch=branch)
+
+        path = Path(temp_repo_dir.name) / path_to_delete
+
+        if is_directory:
+            shutil.rmtree(path)
+        else:
+            path.unlink()
+
+        # Record the path and the temp directory for later cleanup
+        module_data["repo_dir"] = temp_repo_dir
+        return module_data
+
+    return GetData
+
+
+# ----------------------------------------------------------------------
+class TestCommunityStandards:
+    """End-to-end tests for community standards files in a GitHub repository."""
+
+    # ----------------------------------------------------------------------
+    def test_CodeOfConduct(self, pat_args, snapshot):
+        """Test if a CODE_OF_CONDUCT file exists in the repository."""
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCommunityStandards-CodeOwners-unrequired",
+                "--GitHubCommunityStandards-Contributing-unrequired",
+                "--GitHubCommunityStandards-IssueTemplates-unrequired",
+                "--GitHubCommunityStandards-LicenseFile-unrequired",
+                "--GitHubCommunityStandards-PullRequestTemplate-unrequired",
+                "--GitHubCommunityStandards-ReadMe-unrequired",
+                "--GitHubCommunityStandards-SecurityPolicy-unrequired",
+            ],
+        )
+
+        assert result.exit_code == 0, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    @patch.object(
+        CommunityStandardsQuery,
+        "GetData",
+        GetDataFunctional("CODE_OF_CONDUCT.md"),
+    )
+    def test_NoCodeOfConduct(self, pat_args, snapshot):
+        """Test if a CODE_OF_CONDUCT file does not exist in the repository."""
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCommunityStandards-CodeOwners-unrequired",
+                "--GitHubCommunityStandards-Contributing-unrequired",
+                "--GitHubCommunityStandards-IssueTemplates-unrequired",
+                "--GitHubCommunityStandards-LicenseFile-unrequired",
+                "--GitHubCommunityStandards-PullRequestTemplate-unrequired",
+                "--GitHubCommunityStandards-ReadMe-unrequired",
+                "--GitHubCommunityStandards-SecurityPolicy-unrequired",
+            ],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    def test_CodeOwners(self, pat_args, snapshot):
+        """Test if a CODEOWNERS file exists in the repository."""
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCommunityStandards-CodeOfConduct-unrequired",
+                "--GitHubCommunityStandards-Contributing-unrequired",
+                "--GitHubCommunityStandards-IssueTemplates-unrequired",
+                "--GitHubCommunityStandards-LicenseFile-unrequired",
+                "--GitHubCommunityStandards-PullRequestTemplate-unrequired",
+                "--GitHubCommunityStandards-ReadMe-unrequired",
+                "--GitHubCommunityStandards-SecurityPolicy-unrequired",
+            ],
+        )
+
+        assert result.exit_code == 0, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    @patch.object(
+        CommunityStandardsQuery,
+        "GetData",
+        GetDataFunctional(".github/CODEOWNERS"),
+    )
+    def test_NoCodeOwners(self, pat_args, snapshot):
+        """Test if a CODEOWNERS file does not exist in the repository."""
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCommunityStandards-CodeOfConduct-unrequired",
+                "--GitHubCommunityStandards-Contributing-unrequired",
+                "--GitHubCommunityStandards-IssueTemplates-unrequired",
+                "--GitHubCommunityStandards-LicenseFile-unrequired",
+                "--GitHubCommunityStandards-PullRequestTemplate-unrequired",
+                "--GitHubCommunityStandards-ReadMe-unrequired",
+                "--GitHubCommunityStandards-SecurityPolicy-unrequired",
+            ],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    def test_Contributing(self, pat_args, snapshot):
+        """Test if a CONTRIBUTING.md file exists in the repository."""
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCommunityStandards-CodeOfConduct-unrequired",
+                "--GitHubCommunityStandards-CodeOwners-unrequired",
+                "--GitHubCommunityStandards-IssueTemplates-unrequired",
+                "--GitHubCommunityStandards-LicenseFile-unrequired",
+                "--GitHubCommunityStandards-PullRequestTemplate-unrequired",
+                "--GitHubCommunityStandards-ReadMe-unrequired",
+                "--GitHubCommunityStandards-SecurityPolicy-unrequired",
+            ],
+        )
+
+        assert result.exit_code == 0, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    @patch.object(
+        CommunityStandardsQuery,
+        "GetData",
+        GetDataFunctional("CONTRIBUTING.md"),
+    )
+    def test_NoContributing(self, pat_args, snapshot):
+        """Test if a CONTRIBUTING file does not exist in the repository."""
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCommunityStandards-CodeOfConduct-unrequired",
+                "--GitHubCommunityStandards-CodeOwners-unrequired",
+                "--GitHubCommunityStandards-IssueTemplates-unrequired",
+                "--GitHubCommunityStandards-LicenseFile-unrequired",
+                "--GitHubCommunityStandards-PullRequestTemplate-unrequired",
+                "--GitHubCommunityStandards-ReadMe-unrequired",
+                "--GitHubCommunityStandards-SecurityPolicy-unrequired",
+            ],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    def test_IssueTemplate(self, pat_args, snapshot):
+        """Test if an Issue template file (e.g. ISSUE_TEMPLATE.md) exists in the repository."""
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCommunityStandards-CodeOfConduct-unrequired",
+                "--GitHubCommunityStandards-CodeOwners-unrequired",
+                "--GitHubCommunityStandards-Contributing-unrequired",
+                "--GitHubCommunityStandards-LicenseFile-unrequired",
+                "--GitHubCommunityStandards-PullRequestTemplate-unrequired",
+                "--GitHubCommunityStandards-ReadMe-unrequired",
+                "--GitHubCommunityStandards-SecurityPolicy-unrequired",
+            ],
+        )
+        assert result.exit_code == 0, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    @patch.object(
+        CommunityStandardsQuery,
+        "GetData",
+        GetDataFunctional(".github/ISSUE_TEMPLATE", True),
+    )
+    def test_NoIssueTemplate(self, pat_args, snapshot):
+        """Test if no Issue template file exists in the repository."""
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCommunityStandards-CodeOfConduct-unrequired",
+                "--GitHubCommunityStandards-CodeOwners-unrequired",
+                "--GitHubCommunityStandards-Contributing-unrequired",
+                "--GitHubCommunityStandards-LicenseFile-unrequired",
+                "--GitHubCommunityStandards-PullRequestTemplate-unrequired",
+                "--GitHubCommunityStandards-ReadMe-unrequired",
+                "--GitHubCommunityStandards-SecurityPolicy-unrequired",
+            ],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    def test_PullRequestTemplate(self, pat_args, snapshot):
+        """
+        Test if a Pull Request template file (e.g. PULL_REQUEST_TEMPLATE.md)
+        exists in the repository.
+        """
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCommunityStandards-CodeOfConduct-unrequired",
+                "--GitHubCommunityStandards-CodeOwners-unrequired",
+                "--GitHubCommunityStandards-Contributing-unrequired",
+                "--GitHubCommunityStandards-IssueTemplates-unrequired",
+                "--GitHubCommunityStandards-LicenseFile-unrequired",
+                "--GitHubCommunityStandards-ReadMe-unrequired",
+                "--GitHubCommunityStandards-SecurityPolicy-unrequired",
+            ],
+        )
+
+        assert result.exit_code == 0, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    @patch.object(
+        CommunityStandardsQuery,
+        "GetData",
+        GetDataFunctional(".github/pull_request_template.md"),
+    )
+    def test_NoPullRequestTemplate(self, pat_args, snapshot):
+        """Test if no Pull Request template file exists in the repository."""
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCommunityStandards-CodeOfConduct-unrequired",
+                "--GitHubCommunityStandards-CodeOwners-unrequired",
+                "--GitHubCommunityStandards-Contributing-unrequired",
+                "--GitHubCommunityStandards-IssueTemplates-unrequired",
+                "--GitHubCommunityStandards-LicenseFile-unrequired",
+                "--GitHubCommunityStandards-ReadMe-unrequired",
+                "--GitHubCommunityStandards-SecurityPolicy-unrequired",
+            ],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    def test_SecurityPolicy(self, pat_args, snapshot):
+        """Test if a Security policy file (e.g. SECURITY.md) exists in the repository."""
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCommunityStandards-CodeOfConduct-unrequired",
+                "--GitHubCommunityStandards-CodeOwners-unrequired",
+                "--GitHubCommunityStandards-Contributing-unrequired",
+                "--GitHubCommunityStandards-IssueTemplates-unrequired",
+                "--GitHubCommunityStandards-LicenseFile-unrequired",
+                "--GitHubCommunityStandards-PullRequestTemplate-unrequired",
+                "--GitHubCommunityStandards-ReadMe-unrequired",
+            ],
+        )
+
+        assert result.exit_code == 0, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    @patch.object(
+        CommunityStandardsQuery,
+        "GetData",
+        GetDataFunctional("SECURITY.md"),
+    )
+    def test_NoSecurityPolicy(self, pat_args, snapshot):
+        """Test if no Security policy file exists in the repository."""
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCommunityStandards-CodeOfConduct-unrequired",
+                "--GitHubCommunityStandards-CodeOwners-unrequired",
+                "--GitHubCommunityStandards-Contributing-unrequired",
+                "--GitHubCommunityStandards-IssueTemplates-unrequired",
+                "--GitHubCommunityStandards-LicenseFile-unrequired",
+                "--GitHubCommunityStandards-PullRequestTemplate-unrequired",
+                "--GitHubCommunityStandards-ReadMe-unrequired",
+            ],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+
+# ----------------------------------------------------------------------
+# ----------------------------------------------------------------------
+# ----------------------------------------------------------------------
+@pytest.fixture
+def args() -> list[str]:
+    return [
+        "--include",
+        "GitHubCommunityStandards",
+        "--GitHubCommunityStandards-url",
+        GetGithubUrl(),
+    ]
+
+
+# ----------------------------------------------------------------------
+@pytest.fixture
+def pat_args(args) -> list[str]:
+    _github_pat_filename = (Path(__file__).parent / "github_pat.txt").resolve()
+    CheckPATFileExists(_github_pat_filename)
+
+    with _github_pat_filename.open() as f:
+        pat_value = f.read().strip()
+
+    return args + ["--GitHubCommunityStandards-pat", pat_value]