RepoAuditor 0.2.83__tar.gz → 0.3.0__tar.gz

{repoauditor-0.2.83 → repoauditor-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.83
+Version: 0.3.0
 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.3.0/docs/config_file.md

@@ -0,0 +1,52 @@
+# Configuration File
+
+`RepoAuditor` accepts both a set of flags as well as a configuration YAML file.
+
+The configuration (or config) file can make usage easier by recording preferences as well as facilitating sharing of enforced requirements within an organization.
+We have provided a sample configuration file called [default_config.yaml](https://github.com/gt-sse-center/RepoAuditor/blob/main/default_config.yaml), which can be used as:
+
+```sh
+uvx RepoAuditor --config default_config.yaml
+```
+
+## Key Differences
+
+There are some differences between the flags used in the CLI and the options provided in the config file.
+
+### Multiple Values
+
+For example, to include multiple module on the CLI, the user would use the `--include` multiple times.
+
+```sh
+uvx RepoAuditor --include CommunityStandards --include GitHub
+```
+
+However, since the config file accepts a list of values, the corresponding option is `includes` (which is plural).
+
+```yaml
+includes: ["GitHub", "CommunityStandards"]
+```
+
+This is similarly the case for `--exclude` on the CLI and `excludes` in the config file.
+
+### Boolean Flags
+
+On the CLI, the existence of a boolean flag, e.g. `--GitHub-Description-allow-empty` is sufficient to indicate that we want this setting to be enabled.
+
+However since YAML files expect key-value pairs, in the config file, you will have to specify the same flag as:
+
+```yaml
+GitHub-Description-allow-empty: true
+```
+
+Similarly for the case where we wish to check a setting is turned off, we specify e.g. `--GitHub-no-MergeCommit` on the CLI, but in the config file, it would be
+
+```yaml
+GitHub-no-MergeCommit: true
+```
+
+Remember, to deactive a check, we have to add the `Module-Requirement` to the `excludes` list,
+
+```yaml
+excludes: ["GitHub-MergeCommit"]
+```

{repoauditor-0.2.83 → repoauditor-0.3.0}/mkdocs.yml

@@ -10,6 +10,11 @@ nav:
   - Troubleshooting: troubleshooting.md
 theme:
   name: material
+  palette:
+    scheme: slate
+    primary: teal
+    accent: lime
+
 
 # Extensions to render emojis
 markdown_extensions:

{repoauditor-0.2.83 → repoauditor-0.3.0}/src/RepoAuditor/Plugins/CommunityStandards/Requirements/LicenseFile.py

@@ -14,7 +14,7 @@ from RepoAuditor.Plugins.CommunityStandards.Impl.ExistsRequirementImpl import (
 
 
 class LicenseFile(ExistsRequirementImpl):
-    """Validates that a CODE_OF_CONDUCT file is configured."""
+    """Validates that a file with licensing information is present."""
 
     def __init__(self) -> None:
         super().__init__(

{repoauditor-0.2.83 → repoauditor-0.3.0}/src/RepoAuditor/Plugins/GitHub/DefaultBranchRequirements/Protected.py

@@ -76,7 +76,7 @@ class Protected(Requirement):
     ) -> Requirement.EvaluateImplResult:
         is_protected = query_data["default_branch_data"].get("protected", None)
         if is_protected is None:
-            return CreateIncompleteDataResult()
+            return CreateIncompleteDataResult(query_data["pat"] is not None)
 
         if requirement_args["no"]:
             expected_value = False

repoauditor-0.3.0/src/RepoAuditor/Plugins/GitHub/Impl/Common.py

@@ -0,0 +1,34 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Contains common functionality that is used across different components."""
+
+from RepoAuditor.Requirement import EvaluateResult, Requirement
+
+
+# ----------------------------------------------------------------------
+def CreateIncompleteDataResult(pat_value_exists: bool) -> Requirement.EvaluateImplResult:  # noqa: FBT001
+    """Create an incomplete data result.
+
+    Checks if the PAT value is `None` to generate additional message info.
+
+    Args:
+        pat_value_exists (bool): The value of the Personal Access Token.
+
+    Returns:
+        Requirement.EvaluateImplResult: A warning result notifying the user of an incomplete result.
+
+    """
+    error_message = "Incomplete data was encountered."
+    if pat_value_exists:
+        error_message += "\nPlease update the permissions of the GitHub PAT."
+    else:
+        error_message += "\nGitHub PAT was not provided. Please provide the PAT."
+
+    return Requirement.EvaluateImplResult(
+        EvaluateResult.Warning,
+        error_message,
+    )

{repoauditor-0.2.83 → repoauditor-0.3.0}/src/RepoAuditor/Plugins/GitHub/Impl/EnableRequirementImpl.py

@@ -103,7 +103,7 @@ class EnableRequirementImpl(Requirement):
                 )
 
             if self.missing_value_is_warning:
-                return CreateIncompleteDataResult()
+                return CreateIncompleteDataResult(query_data["pat"] is not None)
 
             return Requirement.EvaluateImplResult(EvaluateResult.DoesNotApply, None)
 

{repoauditor-0.2.83 → repoauditor-0.3.0}/src/RepoAuditor/Plugins/GitHub/Impl/ValueRequirementImpl.py

@@ -90,7 +90,7 @@ class ValueRequirementImpl(Requirement):
         result = self.get_configuration_value_func(query_data)
         if result is None:
             if self.missing_value_is_warning:
-                return CreateIncompleteDataResult()
+                return CreateIncompleteDataResult(query_data["pat"] is not None)
 
             return Requirement.EvaluateImplResult(EvaluateResult.DoesNotApply, None)
 

{repoauditor-0.2.83 → repoauditor-0.3.0}/src/RepoAuditor/Plugins/GitHub/StandardRequirements/Private.py

@@ -77,7 +77,7 @@ class Private(Requirement):
         result = query_data["standard"].get("private", None)
 
         if result is None:
-            return CreateIncompleteDataResult()
+            return CreateIncompleteDataResult(query_data["pat"] is not None)
 
         if result != expect_private:
             return Requirement.EvaluateImplResult(

{repoauditor-0.2.83 → repoauditor-0.3.0}/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.83"
+__version__ = "0.3.0"

repoauditor-0.2.83/tests/Plugins/CommunityStandards/GitHubCommunityStandards_UnitTest.py → repoauditor-0.3.0/tests/Plugins/CommunityStandards/CommunityStandards_UnitTest.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Unit tests for the GitHub Community Standards Plugin"""
+"""Unit tests for the Community Standards Plugin"""
 
 import sys
 from pathlib import Path

{repoauditor-0.2.83 → repoauditor-0.3.0}/tests/Plugins/CommunityStandards_EndToEndTest.py

@@ -165,7 +165,7 @@ class TestCommunityStandards:
     @patch.object(
         CommunityStandardsQuery,
         "GetData",
-        GetDataFunctional("CONTRIBUTING.md"),
+        GetDataFunctional("docs/CONTRIBUTING.md"),
     )
     def test_NoContributing(self, pat_args, snapshot):
         """Test if a CONTRIBUTING file does not exist in the repository."""

{repoauditor-0.2.83 → repoauditor-0.3.0}/tests/Plugins/GitHubModule/ClassicBranchProtectionRequirements/DismissStalePullRequestApprovals_UnitTest.py

@@ -14,19 +14,6 @@ from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.DismissStale
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture(name="query_data")
-def query_data_fixture(session):
-    return {
-        "session": session,
-        "branch": "main",
-        "branch_protection_data": {
-            "required_pull_request_reviews": {
-                "dismiss_stale_reviews": True,
-            },
-        },
-    }
-
-
 @pytest.fixture(name="requirement")
 def requirement_fixture():
     return DismissStalePullRequestApprovals()

{repoauditor-0.2.83 → repoauditor-0.3.0}/tests/Plugins/GitHubModule/ClassicBranchProtectionRequirements/EnsureStatusChecks_UnitTest.py

@@ -14,19 +14,6 @@ from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.EnsureStatus
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture(name="query_data")
-def query_data_fixture(session):
-    return {
-        "session": session,
-        "branch": "main",
-        "branch_protection_data": {
-            "required_status_checks": {
-                "checks": ["check1", "check2"],
-            },
-        },
-    }
-
-
 @pytest.fixture(name="requirement")
 def requirement_fixture():
     return EnsureStatusChecks()

{repoauditor-0.2.83 → repoauditor-0.3.0}/tests/Plugins/GitHubModule/ClassicBranchProtectionRequirements/RequireApprovalMostRecentPush_UnitTest.py

@@ -14,19 +14,6 @@ from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.RequireAppro
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture(name="query_data")
-def query_data_fixture(session):
-    return {
-        "session": session,
-        "branch": "main",
-        "branch_protection_data": {
-            "required_pull_request_reviews": {
-                "require_last_push_approval": True,
-            },
-        },
-    }
-
-
 @pytest.fixture(name="requirement")
 def requirement_fixture():
     return RequireApprovalMostRecentPush()

{repoauditor-0.2.83 → repoauditor-0.3.0}/tests/Plugins/GitHubModule/ClassicBranchProtectionRequirements/RequireApprovals_UnitTest.py

@@ -12,19 +12,6 @@ from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.RequireAppro
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture(name="query_data")
-def query_data_fixture(session):
-    return {
-        "session": session,
-        "branch": "main",
-        "branch_protection_data": {
-            "required_pull_request_reviews": {
-                "required_approving_review_count": "1",
-            },
-        },
-    }
-
-
 @pytest.fixture(name="requirement")
 def requirement_fixture():
     return RequireApprovals()

{repoauditor-0.2.83 → repoauditor-0.3.0}/tests/Plugins/GitHubModule/ClassicBranchProtectionRequirements/RequireCodeOwnerReview_UnitTest.py

@@ -14,19 +14,6 @@ from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.RequireCodeO
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture(name="query_data")
-def query_data_fixture(session):
-    return {
-        "session": session,
-        "branch": "main",
-        "branch_protection_data": {
-            "required_pull_request_reviews": {
-                "require_code_owner_reviews": False,
-            },
-        },
-    }
-
-
 @pytest.fixture(name="requirement")
 def requirement_fixture():
     return RequireCodeOwnerReview()

{repoauditor-0.2.83 → repoauditor-0.3.0}/tests/Plugins/GitHubModule/ClassicBranchProtectionRequirements/RequireUpToDateBranches_UnitTest.py

@@ -14,20 +14,6 @@ from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.RequireUpToD
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture(name="query_data")
-def query_data_fixture(session):
-    """Sample query data fixture."""
-    return {
-        "session": session,
-        "branch": "main",
-        "branch_protection_data": {
-            "required_status_checks": {
-                "strict": False,
-            },
-        },
-    }
-
-
 @pytest.fixture(name="requirement")
 def requirement_fixture():
     """RequireUpToDateBranches requirement fixture."""

{repoauditor-0.2.83/tests/Plugins/GitHubModule/DefaultBranchQueryRequirements → repoauditor-0.3.0/tests/Plugins/GitHubModule/DefaultBranchRequirements}/Protected_UnitTest.py

@@ -12,16 +12,6 @@ from RepoAuditor.Plugins.GitHub.DefaultBranchRequirements.Protected import Prote
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture(name="query_data")
-def query_data_fixture(session):
-    return {
-        "session": session,
-        "default_branch_data": {
-            "protected": True,
-        },
-    }
-
-
 @pytest.fixture(name="requirement")
 def requirement_fixture():
     return Protected()

repoauditor-0.3.0/tests/Plugins/GitHubModule/RulesetRequirements/AllowMainlineForcePushesRule_UnitTest.py

@@ -0,0 +1,53 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Unit tests for AllowMainlineForcePushesRule.py"""
+
+from RepoAuditor.Plugins.GitHub.RulesetRequirements.AllowMainlineForcePushes import (
+    AllowMainlineForcePushesRule,
+)
+from RepoAuditor.Requirement import EvaluateResult
+
+from . import create_rule
+
+
+class TestAllowMainlineForcePushesRule:
+    """Unit tests for the AllowMainlineForcePushesRule requirement."""
+
+    def test_Enabled(self, query_data):
+        """Test if the rule is enabled on the main branch."""
+        requirement = AllowMainlineForcePushesRule()
+
+        query_data["rules"].append(
+            create_rule(
+                name="main",
+                rule_type="non_fast_forward",
+                ruleset_name="main",
+                parameters={},
+            )
+        )
+
+        result = requirement.Evaluate(query_data, {"yes": True})
+        assert result.result == EvaluateResult.Success
+        assert f"{requirement.github_settings_value} is enabled" in result.context
+
+    def test_Disabled(self, query_data):
+        """Test if the rule is disabled by not providing the appropriate rule within the ruleset."""
+        requirement = AllowMainlineForcePushesRule()
+
+        query_data["rules"].append(
+            create_rule(
+                name="Random Rule",
+                # Wrong rule type
+                rule_type="push_request",
+                ruleset_name="main",
+                parameters={},
+            )
+        )
+
+        result = requirement.Evaluate(query_data, {"yes": True})
+        assert result.result == EvaluateResult.Error
+        assert f"No active branch ruleset with {requirement.github_settings_value} found" in result.context

repoauditor-0.3.0/tests/Plugins/GitHubModule/RulesetRequirements/DismissStalePullRequestApprovalsRule_UnitTest.py

@@ -0,0 +1,73 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Unit tests for DismissStalePullRequestApprovalsRule.py"""
+
+from RepoAuditor.Plugins.GitHub.RulesetRequirements.DismissStalePullRequestApprovals import (
+    DismissStalePullRequestApprovalsRule,
+)
+from RepoAuditor.Requirement import EvaluateResult
+
+from . import create_rule
+
+
+class TestDismissStalePullRequestApprovalsRule:
+    """Unit tests for the DismissStalePullRequestApprovalsRule requirement."""
+
+    def test_Enabled(self, query_data):
+        """Test if the rule is enabled on the main branch."""
+        requirement = DismissStalePullRequestApprovalsRule()
+
+        query_data["rules"].append(
+            create_rule(
+                name="PR Rules",
+                rule_type="pull_request",
+                ruleset_name="main",
+                parameters={"dismiss_stale_reviews_on_push": True},
+            )
+        )
+
+        result = requirement.Evaluate(query_data, {"no": False})
+        assert result.result == EvaluateResult.Success
+        assert f"{requirement.github_settings_value} is enabled" in result.context
+
+    def test_Disabled(self, query_data):
+        """Test if the required rule is disabled on the main branch
+        by providing the value as false.
+        """
+        requirement = DismissStalePullRequestApprovalsRule()
+
+        query_data["rules"].append(
+            create_rule(
+                name="PR Rules",
+                # Wrong rule type
+                rule_type="pull_request",
+                ruleset_name="main",
+                parameters={"dismiss_stale_reviews_on_push": False},
+            )
+        )
+
+        result = requirement.Evaluate(query_data, {"no": False})
+        assert result.result == EvaluateResult.Error
+
+    def test_WrongRuleType(self, query_data):
+        """Test if the required rule is disabled on the main branch
+        by providing the wrong rule type.
+        """
+        requirement = DismissStalePullRequestApprovalsRule()
+
+        query_data["rules"].append(
+            create_rule(
+                name="Inactive PR Rules",
+                # Wrong rule type
+                rule_type="push_request",
+                ruleset_name="Ruleset Main",
+                parameters={},
+            )
+        )
+
+        result = requirement.Evaluate(query_data, {"no": False})
+        assert result.result == EvaluateResult.Error

repoauditor-0.3.0/tests/Plugins/GitHubModule/RulesetRequirements/EnsureStatusChecksRule_UnitTest.py

@@ -0,0 +1,73 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Unit tests for EnsureStatusChecksRule.py"""
+
+from RepoAuditor.Plugins.GitHub.RulesetRequirements.EnsureStatusChecks import EnsureStatusChecksRule
+from RepoAuditor.Requirement import EvaluateResult
+
+from . import create_rule
+
+
+class TestEnsureStatusChecksRule:
+    """Unit tests for the EnsureStatusChecksRule requirement."""
+
+    def test_Enabled(self, query_data):
+        """Test if the rule is enabled on the main branch."""
+        requirement = EnsureStatusChecksRule()
+
+        query_data["rules"].append(
+            create_rule(
+                name="main",
+                rule_type="required_status_checks",
+                ruleset_name="main",
+                parameters={
+                    "required_status_checks": [
+                        "CI+CD",
+                        "Additional Check",
+                    ]
+                },
+            )
+        )
+
+        result = requirement.Evaluate(query_data, {"no": False})
+        assert result.result == EvaluateResult.Success
+        assert f"{requirement.github_settings_value} is enabled" in result.context
+
+    def test_NoStatusChecks(self, query_data):
+        """Test if the rule is enabled but no status checks are provided."""
+        requirement = EnsureStatusChecksRule()
+
+        query_data["rules"].append(
+            create_rule(
+                name="main",
+                rule_type="required_status_checks",
+                ruleset_name="main",
+                parameters={"required_status_checks": []},
+            )
+        )
+
+        result = requirement.Evaluate(query_data, {"no": False})
+        assert result.result == EvaluateResult.Error
+        assert f"No active branch ruleset with {requirement.github_settings_value} found" in result.context
+
+    def test_Disabled(self, query_data):
+        """Test if the rule is disabled by not providing the appropriate rule within the ruleset."""
+        requirement = EnsureStatusChecksRule()
+
+        query_data["rules"].append(
+            create_rule(
+                name="Random Rule",
+                # Wrong rule type
+                rule_type="pull_request",
+                ruleset_name="main",
+                parameters={},
+            )
+        )
+
+        result = requirement.Evaluate(query_data, {"no": False})
+        assert result.result == EvaluateResult.Error
+        assert f"No active branch ruleset with {requirement.github_settings_value} found" in result.context

repoauditor-0.3.0/tests/Plugins/GitHubModule/RulesetRequirements/RequireApprovalMostRecentPushRule_UnitTest.py

@@ -0,0 +1,73 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Unit tests for RequireApprovalMostRecentPushRule.py"""
+
+from RepoAuditor.Plugins.GitHub.RulesetRequirements.RequireApprovalMostRecentPush import (
+    RequireApprovalMostRecentPushRule,
+)
+from RepoAuditor.Requirement import EvaluateResult
+
+from . import create_rule
+
+
+class TestRequireApprovalMostRecentPushRule:
+    """Unit tests for the RequireApprovalMostRecentPushRule requirement."""
+
+    def test_Enabled(self, query_data):
+        """Test if the rule is enabled on the main branch."""
+        requirement = RequireApprovalMostRecentPushRule()
+
+        query_data["rules"].append(
+            create_rule(
+                name="PR Rules",
+                rule_type="pull_request",
+                ruleset_name="main",
+                parameters={"require_last_push_approval": True},
+            )
+        )
+
+        result = requirement.Evaluate(query_data, {"no": False})
+        assert result.result == EvaluateResult.Success
+        assert f"{requirement.github_settings_value} is enabled" in result.context
+
+    def test_Disabled(self, query_data):
+        """Test if the required rule is disabled on the main branch
+        by providing the value as false.
+        """
+        requirement = RequireApprovalMostRecentPushRule()
+
+        query_data["rules"].append(
+            create_rule(
+                name="PR Rules",
+                # Wrong rule type
+                rule_type="pull_request",
+                ruleset_name="main",
+                parameters={"require_last_push_approval": False},
+            )
+        )
+
+        result = requirement.Evaluate(query_data, {"no": False})
+        assert result.result == EvaluateResult.Error
+
+    def test_WrongRuleType(self, query_data):
+        """Test if the required rule is disabled on the main branch
+        by providing the wrong rule type.
+        """
+        requirement = RequireApprovalMostRecentPushRule()
+
+        query_data["rules"].append(
+            create_rule(
+                name="Inactive PR Rules",
+                # Wrong rule type
+                rule_type="push_request",
+                ruleset_name="Ruleset Main",
+                parameters={},
+            )
+        )
+
+        result = requirement.Evaluate(query_data, {"no": False})
+        assert result.result == EvaluateResult.Error