RepoAuditor 0.2.50__tar.gz → 0.2.52__tar.gz

{repoauditor-0.2.50 → repoauditor-0.2.52}/.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_PAT }} > tests/Plugins/github_gatech_pat.txt
+
       - name: Environment Variables
         shell: bash
         run: |

{repoauditor-0.2.50 → repoauditor-0.2.52}/.gitignore

@@ -19,5 +19,6 @@ src/RepoAuditor.egg-info/**
 minisign_key.pri
 
 tests/Plugins/github_pat.txt
+tests/Plugins/github_gatech_pat.txt
 .DS_Store
 post_generation_instructions.html

{repoauditor-0.2.50 → repoauditor-0.2.52}/DEVELOPMENT.md

@@ -17,6 +17,7 @@
 | 2. Install [uv](https://github.com/astral-sh/uv). | `curl -LsSf https://astral.sh/uv/install.sh \| sh` on macOS and Linux or <br/>`powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 \| iex"` on Windows | https://docs.astral.sh |
 | 3. Install dependencies. | `uv sync` | https://docs.astral.sh/uv/concepts/projects/sync |
 | 4. Install [pre-commit](https://pre-commit.com/) hooks | `uv run pre-commit install` | https://pre-commit.com/#1-install-pre-commit |
+| 5. If you wish to test against an enterprise server, add a remote named `enterprise` with the corresponding URL | E.g. `git remote add enterprise git@github.gatech.edu:sse-center/RepoAuditor.git` | |
 
 ## Development Activities
 

{repoauditor-0.2.50 → repoauditor-0.2.52}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.50
+Version: 0.2.52
 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.50 → repoauditor-0.2.52}/src/RepoAuditor/Plugins/GitHub/Impl/EnableRequirementImpl.py

@@ -81,6 +81,15 @@ class EnableRequirementImpl(Requirement):
     ) -> Requirement.EvaluateImplResult:
         result = self.get_configuration_value_func(query_data)
         if result is None:
+            if query_data["session"].is_enterprise:
+                return Requirement.EvaluateImplResult(
+                    EvaluateResult.DoesNotApply,
+                    (
+                        "Please verify with your enterprise administrator "
+                        f"that {self.github_settings_value} is enabled."
+                    ),
+                )
+
             if self.missing_value_is_warning:
                 return CreateIncompleteDataResult()
 

{repoauditor-0.2.50 → repoauditor-0.2.52}/src/RepoAuditor/Plugins/GitHubBase/Module.py

@@ -114,7 +114,7 @@ class _GitHubSession(requests.Session):
             api_url = f"https://api.github.com/repos/{username}/{repo}"
             is_enterprise = False
         else:
-            api_url = f"{url_parts.scheme}://{url_parts.netloc}/api/v3/orgs/{username}/repos/{repo}"
+            api_url = f"{url_parts.scheme}://{url_parts.netloc}/api/v3/repos/{username}/{repo}"
             is_enterprise = True
 
         self.github_url = github_url

{repoauditor-0.2.50 → repoauditor-0.2.52}/src/RepoAuditor/Plugins/GitHubCommunityStandards/Requirements/CodeOfConduct.py

@@ -21,8 +21,11 @@ class CodeOfConduct(ExistsRequirementImpl):
             "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.50 → repoauditor-0.2.52}/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.50"
+__version__ = "0.2.52"

{repoauditor-0.2.50 → repoauditor-0.2.52}/tests/Plugins/GitHubCommunityStandards_EndToEndTest.py

@@ -57,6 +57,31 @@ 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-CodeOfConduct-exists"],
+        )
+
+        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-CodeOfConduct-exists"],
+        )
+
+        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(

repoauditor-0.2.52/tests/Plugins/GitHubEnterprise_EndToEndTest.py

@@ -0,0 +1,378 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""End-to-end tests for the plugins on an enterprise URL"""
+
+import urllib
+from pathlib import Path
+
+import pytest
+from dbrownell_Common.TestHelpers.StreamTestHelpers import (
+    InitializeStreamCapabilities,
+)
+from typer.testing import CliRunner
+from utilities import CheckPATFileExists, GetGithubUrl, ScrubDurationGithuburlAndSpaces
+
+from RepoAuditor.EntryPoint import app
+
+# ----------------------------------------------------------------------
+pytest.fixture(InitializeStreamCapabilities(), scope="session", autouse=True)
+
+
+# ----------------------------------------------------------------------
+@pytest.fixture
+def args() -> list[str]:
+    return [
+        "--include",
+        "GitHub",
+        "--GitHub-url",
+        GetGithubUrl("enterprise"),
+        # Currently GitHub Enterprise does not support GitHub hosted runners.
+        # As a result, no status checks show up to select and this will always fail.
+        "--GitHub-EnsureStatusChecks-disable",
+    ]
+
+
+# ----------------------------------------------------------------------
+@pytest.fixture
+def pat_args(args) -> list[str]:
+    _github_pat_filename = (Path(__file__).parent / "github_gatech_pat.txt").resolve()
+    parsed = urllib.parse.urlparse(GetGithubUrl("enterprise"))
+    parsed = parsed._replace(path="")
+    CheckPATFileExists(_github_pat_filename, github_url=parsed.geturl())
+
+    with _github_pat_filename.open() as f:
+        pat_value = f.read().strip()
+
+    return args + ["--GitHub-pat", pat_value]
+
+
+# ----------------------------------------------------------------------
+def test_Successful(pat_args, snapshot):
+    """Test if RepoAuditor runs successfully with default options."""
+    result = CliRunner().invoke(app, pat_args)
+
+    assert result.exit_code == 0, result.output
+    assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+
+# ----------------------------------------------------------------------
+class TestStandard:
+    # ----------------------------------------------------------------------
+    def test_NoAutoMerge(self, pat_args, snapshot):
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-AutoMerge-false"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_NoDeleteHeadBranches(self, pat_args, snapshot):
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-DeleteHeadBranches-false"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    @pytest.mark.skip(reason="Not enabled by Enterprise Administrator")
+    def test_NoDependabotSecurityUpdates(self, pat_args, snapshot):
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-DependabotSecurityUpdates-false"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_NoMergeCommit(self, pat_args, snapshot):
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-MergeCommit-false"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_YesRebaseMergeCommit(self, pat_args, snapshot):
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-RebaseMergeCommit-true"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    @pytest.mark.skip(reason="Not enabled by Enterprise Administrator")
+    def test_NoSecretScanning(self, pat_args, snapshot):
+        """Test is secret scanning is not disabled."""
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-SecretScanning-false"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    @pytest.mark.skip(reason="Not enabled by Enterprise Administrator")
+    def test_NoSecretScanningPushProtection(self, pat_args, snapshot):
+        """Test is secret scanning push protection is not disabled."""
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-SecretScanningPushProtection-false"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_YesSquashCommitMerge(self, pat_args, snapshot):
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-SquashCommitMerge-true"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_YesSuggestUpdatingPullRequestBranches(self, pat_args, snapshot):
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-SuggestUpdatingPullRequestBranches-true"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_YesSupportDiscussions(self, pat_args, snapshot):
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-SupportDiscussions-true"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_NoSupportIssues(self, pat_args, snapshot):
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-SupportIssues-false"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_NoSupportProjects(self, pat_args, snapshot):
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-SupportProjects-false"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_NoSupportWikis(self, pat_args, snapshot):
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-SupportWikis-false"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_YesTemplateRepository(self, pat_args, snapshot):
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-TemplateRepository-true"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_NoWebCommitSignoff(self, pat_args, snapshot):
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-WebCommitSignoff-false"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_DefaultBranchValue(self, pat_args, snapshot):
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-DefaultBranch-value", "not_main"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_LicenseValue(self, pat_args, snapshot):
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-License-value", "Not the MIT License"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_MergeCommitMessageValue(self, pat_args, snapshot):
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHub-MergeCommitMessage-value",
+                "This is not a valid merge commit message",
+            ],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_PrivateValue(self, pat_args, snapshot):
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHub-Private-true"],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_SquashMergeCommitMessageValue(self, pat_args, snapshot):
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHub-SquashMergeCommitMessage-value",
+                "This is not a valid squash merge commit message",
+            ],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_Protected(self, pat_args, snapshot):
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHub-Protected-false"],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+
+# ----------------------------------------------------------------------
+class TestClassic:
+    # ----------------------------------------------------------------------
+    def test_AllowDeletions(self, pat_args, snapshot):
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHub-AllowDeletions-true"],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_AllowForcePush(self, pat_args, snapshot):
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHub-AllowMainlineForcePushes-true"],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_DismissStalePullRequestApprovals(self, pat_args, snapshot):
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHub-DismissStalePullRequestApprovals-false"],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_DoNotAllowBypassSettings(self, pat_args, snapshot):
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHub-DoNotAllowBypassSettings-false"],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    @pytest.mark.skip(reason="GitHub hosted runners not available on Enterprise")
+    def test_EnsureStatusChecks(self, pat_args):
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHub-EnsureStatusChecks-disable", "--verbose"],
+        )
+
+        assert result.exit_code == 0, result.output
+        assert "[DoesNotApply] EnsureStatusChecks" in result.stdout
+
+    # ----------------------------------------------------------------------
+    def test_RequireApprovalMostRecentPush(self, pat_args, snapshot):
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHub-RequireApprovalMostRecentPush-false"],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_RequireApprovals(self, pat_args, snapshot):
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHub-RequireApprovals-value", "2"],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_RequireCodeOwnerReview(self, pat_args, snapshot):
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHub-RequireCodeOwnerReview-true"],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_RequireConversationResolution(self, pat_args, snapshot):
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHub-RequireConversationResolution-false"],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_RequireLinearHistory(self, pat_args, snapshot):
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHub-RequireLinearHistory-true"],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_RequirePullRequests(self, pat_args, snapshot):
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHub-RequirePullRequests-false"],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_RequireSignedCommits(self, pat_args, snapshot):
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHub-RequireSignedCommits-false"],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_RequireStatusChecksToPass(self, pat_args, snapshot):
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHub-RequireStatusChecksToPass-false"],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    # ----------------------------------------------------------------------
+    def test_RequireUpToDateBranches(self, pat_args, snapshot):
+        result = CliRunner().invoke(
+            app,
+            pat_args + ["--GitHub-RequireUpToDateBranches-false"],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot

{repoauditor-0.2.50 → repoauditor-0.2.52}/tests/Plugins/GitHubModule/fixtures.py

@@ -19,4 +19,5 @@ def session():
     s = _GithubSession_()
     s.github_url = "https://github.com/gt-sse-center/RepoAuditor"
     s.pat = "dummy_github_pat.txt"
+    s.is_enterprise = False
     return s