RepoAuditor 0.2.75__tar.gz → 0.2.77__tar.gz

{repoauditor-0.2.75 → repoauditor-0.2.77}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.75
+Version: 0.2.77
 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.75 → repoauditor-0.2.77}/src/RepoAuditor/Display.py

@@ -7,7 +7,7 @@
 """Contains functionality to display the results of executing modules."""
 
 import textwrap
-from typing import Optional
+from typing import IO, Optional
 
 from dbrownell_Common import TextwrapEx  # type: ignore[import-untyped]
 from dbrownell_Common.Streams.DoneManager import DoneManager  # type: ignore[import-untyped]
@@ -128,8 +128,22 @@ def DisplayResults(
     display_resolution: bool,
     display_rationale: bool,
     panel_width: Optional[int] = None,
+    file: Optional[IO[str]] = None,
 ) -> None:
-    """Display the results of executing the modules."""
+    """Display the results of executing the modules.
+
+    Args:
+        dm (DoneManager): Manager of all the tasks that need to be executed.
+        all_results (list[list[Module.EvaluateInfo]]): List of results of executing each module.
+        display_resolution (bool): Flag indicating if the resolution steps should be displayed in the output.
+        display_rationale (bool): Flag indicating if the rationale for the error should be displayed in the output.
+        panel_width (Optional[int], optional): The width of the output panel. Defaults to None.
+        file (Optional[IO[str]], optional): File to write to, or None for stdout. Defaults to None.
+
+    Raises:
+        RuntimeError: Exception if printing or writing to file encounters any issue.
+
+    """
     for results in all_results:
         assert results
         module = results[0].module
@@ -173,4 +187,5 @@ def DisplayResults(
                 title=results[0].module.name,
                 width=panel_width,
             ),
+            file=file,
         )

{repoauditor-0.2.75 → repoauditor-0.2.77}/src/RepoAuditor/EntryPoint.py

@@ -6,10 +6,12 @@
 # ----------------------------------------------------------------------
 """Audits a repository against a set of requirements."""
 
+import contextlib
 import os
 import sys
 import textwrap
 import traceback
+from pathlib import Path
 from typing import Annotated, Optional
 
 import pluggy
@@ -91,11 +93,7 @@ def TypeInfoToString(
         python_type = type_info
         parameter_info = None
 
-    return "    {arg_name:<50} {type_description:<7} {help}".format(
-        arg_name=arg_name,
-        type_description=python_type.__name__,
-        help="" if parameter_info is None else parameter_info.help,
-    )
+    return f"    {arg_name:<50} {python_type.__name__:<7} {parameter_info.help if parameter_info else ''}"
 
 
 # ----------------------------------------------------------------------
@@ -265,6 +263,13 @@ def EntryPoint(  # noqa: PLR0913  # pragma: no cover
             help="Write verbose information to the terminal.",
         ),
     ] = False,
+    output: Annotated[
+        Optional[str],
+        typer.Option(
+            "--output",
+            help="File name to save the output to.",
+        ),
+    ] = None,
     debug: Annotated[  # noqa: FBT002
         bool,
         typer.Option(
@@ -320,13 +325,19 @@ def EntryPoint(  # noqa: PLR0913  # pragma: no cover
                 # in which case default to None
                 panel_width = None
 
-            DisplayResults(
-                dm,
-                all_results,
-                display_resolution=not no_resolution,
-                display_rationale=not no_rationale,
-                panel_width=panel_width,
-            )
+            # Since `output` can be None, we use the nullcontext manager to represent None
+            with (
+                Path.open(output, mode="w+", encoding="UTF-8") if output else contextlib.nullcontext() as file
+            ):
+                DisplayResults(
+                    dm,
+                    all_results,
+                    display_resolution=not no_resolution,
+                    display_rationale=not no_rationale,
+                    panel_width=panel_width,
+                    file=file,
+                )
+
         except Exception as ex:
             error = traceback.format_exc() if dm.is_debug else str(ex)
             dm.WriteError(error)

{repoauditor-0.2.75 → repoauditor-0.2.77}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionQuery.py

@@ -115,20 +115,20 @@ class ClassicBranchProtectionQuery(Query):
             "ClassicBranchProtectionQuery",
             ExecutionStyle.Parallel,
             [
-                AllowDeletions(),
-                AllowMainlineForcePushes(),
-                DismissStalePullRequestApprovals(),
-                DoNotAllowBypassSettings(),
-                EnsureStatusChecks(),
-                RequireApprovalMostRecentPush(),
+                RequirePullRequests(),
                 RequireApprovals(),
+                DismissStalePullRequestApprovals(),
                 RequireCodeOwnerReview(),
-                RequireConversationResolution(),
-                RequireLinearHistory(),
-                RequirePullRequests(),
-                RequireSignedCommits(),
+                RequireApprovalMostRecentPush(),
                 RequireStatusChecksToPass(),
                 RequireUpToDateBranches(),
+                EnsureStatusChecks(),
+                RequireConversationResolution(),
+                RequireSignedCommits(),
+                RequireLinearHistory(),
+                DoNotAllowBypassSettings(),
+                AllowDeletions(),
+                AllowMainlineForcePushes(),
             ],
         )
 

{repoauditor-0.2.75 → repoauditor-0.2.77}/src/RepoAuditor/Plugins/GitHub/StandardQuery.py

@@ -212,27 +212,33 @@ class StandardQuery(Query):
             "StandardQuery",
             ExecutionStyle.Parallel,
             [
-                AutoMerge(),
-                DefaultBranch(),
-                DeleteHeadBranches(),
+                # metadata
                 Description(),
-                DependabotSecurityUpdates(),
                 License(),
+                # settings page
+                TemplateRepository(),
+                WebCommitSignoff(),
+                DefaultBranch(),
+                # settings page (Features)
+                SupportWikis(),
+                SupportIssues(),
+                SupportDiscussions(),
+                SupportProjects(),
+                # settings page (Pull Requests)
                 MergeCommit(),
                 MergeCommitMessage(),
-                Private(),
-                RebaseMergeCommit(),
-                SecretScanning(),
-                SecretScanningPushProtection(),
                 SquashCommitMerge(),
                 SquashMergeCommitMessage(),
+                RebaseMergeCommit(),
                 SuggestUpdatingPullRequestBranches(),
-                SupportDiscussions(),
-                SupportIssues(),
-                SupportProjects(),
-                SupportWikis(),
-                TemplateRepository(),
-                WebCommitSignoff(),
+                AutoMerge(),
+                DeleteHeadBranches(),
+                # settings page (Danger Zone)
+                Private(),
+                # settings/security_analysis
+                DependabotSecurityUpdates(),
+                SecretScanning(),
+                SecretScanningPushProtection(),
             ],
         )
 

{repoauditor-0.2.75 → repoauditor-0.2.77}/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.75"
+__version__ = "0.2.77"

{repoauditor-0.2.75 → repoauditor-0.2.77}/tests/Plugins/CommunityStandards/CommunityStandardsQuery_UnitTest.py

@@ -27,10 +27,15 @@ class MockTemporaryDirectory:
 
 @pytest.fixture(autouse=True)
 def patch_temp_directory(monkeypatch):
+    """Prevent creation of TemporaryDirectory within GetData calls,
+    so we don't need to perform cleanup.
+    """
     monkeypatch.delattr("tempfile.TemporaryDirectory")
 
 
 class TestCommunityStandardsQuery:
+    """Tests for CommunityStandardsQuery class."""
+
     def test_GetData(self, module_data, monkeypatch):
         """Test the GetData method."""
         monkeypatch.setattr(
@@ -41,7 +46,6 @@ class TestCommunityStandardsQuery:
 
         def mock_clone_from(github_url, repo_dirname, branch="main"):
             """A mocked clone_from method for the git.Repo class."""
-            pass
 
         monkeypatch.setattr(
             Repo,

{repoauditor-0.2.75 → repoauditor-0.2.77}/tests/Plugins/CommunityStandards_EndToEndTest.py

@@ -321,8 +321,8 @@ class TestCommunityStandards:
 # ----------------------------------------------------------------------
 # ----------------------------------------------------------------------
 # ----------------------------------------------------------------------
-@pytest.fixture
-def args() -> list[str]:
+@pytest.fixture(name="args")
+def args_fixture() -> list[str]:
     return [
         "--include",
         "CommunityStandards",
@@ -332,8 +332,8 @@ def args() -> list[str]:
 
 
 # ----------------------------------------------------------------------
-@pytest.fixture
-def pat_args(args) -> list[str]:
+@pytest.fixture(name="pat_args")
+def pat_args_fixture(args) -> list[str]:
     github_pat_filename = (Path(__file__).parent / "github_pat.txt").resolve()
     CheckPATFileExists(github_pat_filename)
 

{repoauditor-0.2.75 → repoauditor-0.2.77}/tests/Plugins/GitHubEnterprise_EndToEndTest.py

@@ -23,8 +23,8 @@ pytest.fixture(InitializeStreamCapabilities(), scope="session", autouse=True)
 
 
 # ----------------------------------------------------------------------
-@pytest.fixture
-def args() -> list[str]:
+@pytest.fixture(name="args")
+def args_fixture() -> list[str]:
     return [
         "--include",
         "GitHub",
@@ -37,8 +37,8 @@ def args() -> list[str]:
 
 
 # ----------------------------------------------------------------------
-@pytest.fixture
-def pat_args(args) -> list[str]:
+@pytest.fixture(name="pat_args")
+def pat_args_fixture(args) -> list[str]:
     github_pat_filename = (Path(__file__).parent / "github_gatech_pat.txt").resolve()
     parsed = urllib.parse.urlparse(GetGithubUrl("enterprise"))
     parsed = parsed._replace(path="")

{repoauditor-0.2.75 → repoauditor-0.2.77}/tests/Plugins/GitHubModule/ClassicBranchProtectionRequirements/DismissStalePullRequestApprovals_UnitTest.py

@@ -14,8 +14,8 @@ from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.DismissStale
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
     return {
         "session": session,
         "branch": "main",
@@ -27,12 +27,14 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
     return DismissStalePullRequestApprovals()
 
 
 class TestDismissStalePullRequestApprovals:
+    """Tests for the DismissStalePullRequestApprovals requirement class."""
+
     def test_required_pull_request_reviews_missing(self, requirement, query_data):
         """Test when `required_pull_request_reviews` is missing."""
         query_data["branch_protection_data"] = {}

{repoauditor-0.2.75 → repoauditor-0.2.77}/tests/Plugins/GitHubModule/ClassicBranchProtectionRequirements/EnsureStatusChecks_UnitTest.py

@@ -14,8 +14,8 @@ from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.EnsureStatus
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
     return {
         "session": session,
         "branch": "main",
@@ -27,12 +27,14 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
     return EnsureStatusChecks()
 
 
 class TestEnsureStatusChecks:
+    """Tests for the EnsureStatusChecks requirement class."""
+
     def test_disabled(self, requirement, query_data):
         """Test disabled requirement"""
         requirement_args = {"disabled": True}

{repoauditor-0.2.75 → repoauditor-0.2.77}/tests/Plugins/GitHubModule/ClassicBranchProtectionRequirements/RequireApprovalMostRecentPush_UnitTest.py

@@ -14,8 +14,8 @@ from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.RequireAppro
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
     return {
         "session": session,
         "branch": "main",
@@ -27,12 +27,14 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
     return RequireApprovalMostRecentPush()
 
 
 class TestRequireApprovalMostRecentPush:
+    """Tests for the RequireApprovalMostRecentPush requirement class."""
+
     def test_required_pull_request_reviews_missing(self, requirement, query_data):
         """Test when `required_pull_request_reviews` is missing"""
         query_data["branch_protection_data"] = {}

{repoauditor-0.2.75 → repoauditor-0.2.77}/tests/Plugins/GitHubModule/ClassicBranchProtectionRequirements/RequireApprovals_UnitTest.py

@@ -12,8 +12,8 @@ from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.RequireAppro
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
     return {
         "session": session,
         "branch": "main",
@@ -25,12 +25,14 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
     return RequireApprovals()
 
 
 class TestRequireApprovals:
+    """Tests for the RequireApprovals requirement class."""
+
     def test_required_pull_request_reviews_missing(self, requirement, query_data):
         """Test when `required_pull_request_reviews` is missing"""
         query_data["branch_protection_data"] = {}

{repoauditor-0.2.75 → repoauditor-0.2.77}/tests/Plugins/GitHubModule/ClassicBranchProtectionRequirements/RequireCodeOwnerReview_UnitTest.py

@@ -14,8 +14,8 @@ from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.RequireCodeO
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
     return {
         "session": session,
         "branch": "main",
@@ -27,12 +27,14 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
     return RequireCodeOwnerReview()
 
 
 class TestRequireCodeOwnerReview:
+    """Tests for the RequireCodeOwnerReview requirement class."""
+
     def test_required_pull_request_reviews_missing(self, requirement, query_data):
         """Test when `required_pull_request_reviews` is missing"""
         query_data["branch_protection_data"] = {}

{repoauditor-0.2.75 → repoauditor-0.2.77}/tests/Plugins/GitHubModule/ClassicBranchProtectionRequirements/RequireUpToDateBranches_UnitTest.py

@@ -1,3 +1,11 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Unit tests for RequireUpToDateBranches."""
+
 import pytest
 
 from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.RequireUpToDateBranches import (
@@ -6,8 +14,9 @@ from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.RequireUpToD
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
+    """Sample query data fixture."""
     return {
         "session": session,
         "branch": "main",
@@ -19,12 +28,15 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
+    """RequireUpToDateBranches requirement fixture."""
     return RequireUpToDateBranches()
 
 
 class TestRequireUpToDateBranches:
+    """Tests for RequireUpToDateBranches requirement."""
+
     def test_required_status_checks_missing(self, requirement, query_data):
         """Test when `required_status_checks` is missing"""
         query_data["branch_protection_data"] = {}

{repoauditor-0.2.75 → repoauditor-0.2.77}/tests/Plugins/GitHubModule/DefaultBranchQueryRequirements/Protected_UnitTest.py

@@ -12,8 +12,8 @@ from RepoAuditor.Plugins.GitHub.DefaultBranchRequirements.Protected import Prote
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
     return {
         "session": session,
         "default_branch_data": {
@@ -22,12 +22,14 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
     return Protected()
 
 
 class TestProtected:
+    """Tests for the Protected requirement class."""
+
     def test_Incomplete(self, requirement, query_data):
         """Test for incomplete result"""
         query_data["default_branch_data"] = {}

{repoauditor-0.2.75 → repoauditor-0.2.77}/tests/Plugins/GitHubModule/GitHubSession_UnitTest.py

@@ -14,8 +14,8 @@ import requests
 from RepoAuditor.Plugins.GitHubBase.Module import _GitHubSession
 
 
-@pytest.fixture
-def github_pat(fs):
+@pytest.fixture(name="github_pat")
+def github_pat_fixture(fs):
     """Fixture for GitHub PAT file, which creates a fake PAT file and returns the path."""
     pat_path = Path(__file__).parent / "dummy_github_pat.txt"
     fs.create_file(pat_path, contents="github_path_abcdefghijklmnop")

{repoauditor-0.2.75 → repoauditor-0.2.77}/tests/Plugins/GitHubModule/StandardQueryRequirements/DependabotSecurityUpdates_UnitTest.py

@@ -14,8 +14,8 @@ from RepoAuditor.Plugins.GitHub.StandardRequirements.DependabotSecurityUpdates i
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
     return {
         "session": session,
         "standard": {
@@ -28,12 +28,14 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
     return DependabotSecurityUpdates()
 
 
 class TestDependabotSecurityUpdates:
+    """Tests for the DependabotSecurityUpdates requirement class."""
+
     def test_security_and_analysis_missing(self, requirement, query_data):
         """Test if `security_and_analysis` is missing"""
         query_data["standard"] = {}

{repoauditor-0.2.75 → repoauditor-0.2.77}/tests/Plugins/GitHubModule/StandardQueryRequirements/Description_UnitTest.py

@@ -12,8 +12,8 @@ from RepoAuditor.Plugins.GitHub.StandardRequirements.Description import Descript
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
     return {
         "session": session,
         "standard": {
@@ -22,13 +22,13 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
     return Description()
 
 
 class TestDescription:
-    """Unit tests for the Description requirement."""
+    """Tests for the Description requirement class."""
 
     def test_description_missing(self, requirement, query_data):
         """Test if `description` is missing.

{repoauditor-0.2.75 → repoauditor-0.2.77}/tests/Plugins/GitHubModule/StandardQueryRequirements/License_UnitTest.py

@@ -12,8 +12,8 @@ from RepoAuditor.Plugins.GitHub.StandardRequirements.License import License
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
     return {
         "session": session,
         "standard": {
@@ -24,12 +24,14 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
     return License()
 
 
 class TestLicense:
+    """Tests for the License requirement class."""
+
     def test_license_missing(self, requirement, query_data):
         """Check if no "license" key in query_data
         We should get a `IncompleteDataResult`.

{repoauditor-0.2.75 → repoauditor-0.2.77}/tests/Plugins/GitHubModule/StandardQueryRequirements/MergeCommitMessage_UnitTest.py

@@ -12,8 +12,8 @@ from RepoAuditor.Plugins.GitHub.StandardRequirements.MergeCommitMessage import M
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
     return {
         "session": session,
         "standard": {
@@ -23,12 +23,14 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
     return MergeCommitMessage()
 
 
 class TestMergeCommitMessage:
+    """Tests for the MergeCommitMessage requirement class."""
+
     def test_allow_merge_commit_missing(self, requirement, query_data):
         """Test if `allow_merge_commit` is missing"""
         query_data["standard"] = {}

{repoauditor-0.2.75 → repoauditor-0.2.77}/tests/Plugins/GitHubModule/StandardQueryRequirements/Private_UnitTest.py

@@ -12,8 +12,8 @@ from RepoAuditor.Plugins.GitHub.StandardRequirements.Private import Private
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
     return {
         "session": session,
         "standard": {
@@ -22,12 +22,14 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
     return Private()
 
 
 class TestPrivate:
+    """Tests for the Private requirement class."""
+
     def test_private_missing(self, requirement, query_data):
         """Test if `private` is missing"""
         query_data["standard"] = {}

{repoauditor-0.2.75 → repoauditor-0.2.77}/tests/Plugins/GitHubModule/StandardQueryRequirements/SecretScanningPushProtection_UnitTest.py

@@ -14,8 +14,8 @@ from RepoAuditor.Plugins.GitHub.StandardRequirements.SecretScanningPushProtectio
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
     return {
         "session": session,
         "standard": {
@@ -28,12 +28,14 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
     return SecretScanningPushProtection()
 
 
 class TestSecretScanningPushProtection:
+    """Tests for the SecretScanningPushProtection requirement class."""
+
     def test_security_and_analysis_missing(self, requirement, query_data):
         """Test if `security_and_analysis` is missing"""
         query_data["standard"] = {}