RepoAuditor 0.2.48__tar.gz → 0.2.50__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.48
+Version: 0.2.50
 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.48 → repoauditor-0.2.50}/default_config.yaml

@@ -1,5 +1,4 @@
-includes: ["GitHub", "GitHubCommunityStandards", "GitHubRulesets"]
+includes: ["GitHub", "GitHubCommunityStandards"]
 GitHub-url: "https://github.com/gt-sse-center/RepoAuditor"
 GitHubCommunityStandards-url: "https://github.com/gt-sse-center/RepoAuditor"
-GitHubRulesets-url: "https://github.com/gt-sse-center/RepoAuditor"
 # GitHub-pat: "PAT"

{repoauditor-0.2.48 → repoauditor-0.2.50}/pyproject.toml

@@ -41,7 +41,6 @@ repo_auditor = "RepoAuditor:EntryPoint.app"
 [project.entry-points.RepoAuditor]
 GitHubPlugin = "RepoAuditor.Plugins.GitHubPlugin"
 GitHubCommunityStandardsPlugin = "RepoAuditor.Plugins.GitHubCommunityStandardsPlugin"
-GitHubRulesetPlugin="RepoAuditor.Plugins.GitHubRulesetsPlugin"
 
 [build-system]
 requires = ["hatchling"]

{repoauditor-0.2.48/src/RepoAuditor/Plugins/GitHubRulesets → repoauditor-0.2.50/src/RepoAuditor/Plugins/GitHub}/Impl/EnableRulesetRequirementImpl.py

@@ -33,7 +33,7 @@ class EnableRulesetRequirementImpl(EnableRequirementImpl):
         subject: Optional[str] = None,
         *,
         requires_explicit_include: bool = False,
-        unset_set_terminology: tuple[str, str] = ("unchecked", "checked"),
+        unset_set_terminology: tuple[str, str] = ("disabled", "enabled"),
         missing_value_is_warning: bool = True,
     ) -> None:
         super().__init__(

{repoauditor-0.2.48 → repoauditor-0.2.50}/src/RepoAuditor/Plugins/GitHub/Module.py

@@ -9,6 +9,7 @@
 from RepoAuditor.Module import ExecutionStyle
 from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionQuery import ClassicBranchProtectionQuery
 from RepoAuditor.Plugins.GitHub.DefaultBranchQuery import DefaultBranchQuery
+from RepoAuditor.Plugins.GitHub.RulesetQuery import RulesetQuery
 from RepoAuditor.Plugins.GitHub.StandardQuery import StandardQuery
 from RepoAuditor.Plugins.GitHubBase.Module import GitHubBaseModule
 
@@ -27,6 +28,7 @@ class GitHubModule(GitHubBaseModule):
                 StandardQuery(),
                 DefaultBranchQuery(),
                 ClassicBranchProtectionQuery(),
+                RulesetQuery(),
             ],
             requires_explicit_include=True,
         )

{repoauditor-0.2.48/src/RepoAuditor/Plugins/GitHubRulesets → repoauditor-0.2.50/src/RepoAuditor/Plugins/GitHub}/RulesetQuery.py

@@ -11,9 +11,9 @@ from typing import Any, Optional
 from dbrownell_Common.Types import override
 
 from RepoAuditor.Impl.ParallelSequentialProcessor import ExecutionStyle
-from RepoAuditor.Plugins.GitHubRulesets.Requirements.RequirePullRequests import RequirePullRequests
-from RepoAuditor.Plugins.GitHubRulesets.Requirements.RequireSignedCommits import RequireSignedCommits
-from RepoAuditor.Plugins.GitHubRulesets.Requirements.RequireStatusChecks import RequireStatusChecks
+from RepoAuditor.Plugins.GitHub.RulesetRequirements.RequirePullRequests import RequirePullRequests
+from RepoAuditor.Plugins.GitHub.RulesetRequirements.RequireSignedCommits import RequireSignedCommits
+from RepoAuditor.Plugins.GitHub.RulesetRequirements.RequireStatusChecks import RequireStatusChecks
 from RepoAuditor.Query import Query
 
 

{repoauditor-0.2.48/src/RepoAuditor/Plugins/GitHubRulesets/Requirements → repoauditor-0.2.50/src/RepoAuditor/Plugins/GitHub/RulesetRequirements}/RequirePullRequests.py

@@ -6,7 +6,7 @@
 # -------------------------------------------------------------------------------
 """Contains the RequirePullRequests object."""
 
-from RepoAuditor.Plugins.GitHubRulesets.Impl.EnableRulesetRequirementImpl import EnableRulesetRequirementImpl
+from RepoAuditor.Plugins.GitHub.Impl.EnableRulesetRequirementImpl import EnableRulesetRequirementImpl
 
 
 class RequirePullRequests(EnableRulesetRequirementImpl):

{repoauditor-0.2.48/src/RepoAuditor/Plugins/GitHubRulesets/Requirements → repoauditor-0.2.50/src/RepoAuditor/Plugins/GitHub/RulesetRequirements}/RequireSignedCommits.py

@@ -6,7 +6,7 @@
 # -------------------------------------------------------------------------------
 """Contains the RequireSignedCommits object."""
 
-from RepoAuditor.Plugins.GitHubRulesets.Impl.EnableRulesetRequirementImpl import EnableRulesetRequirementImpl
+from RepoAuditor.Plugins.GitHub.Impl.EnableRulesetRequirementImpl import EnableRulesetRequirementImpl
 
 
 class RequireSignedCommits(EnableRulesetRequirementImpl):

{repoauditor-0.2.48/src/RepoAuditor/Plugins/GitHubRulesets/Requirements → repoauditor-0.2.50/src/RepoAuditor/Plugins/GitHub/RulesetRequirements}/RequireStatusChecks.py

@@ -6,7 +6,7 @@
 # -------------------------------------------------------------------------------
 """Contains the RequireStatusChecks object."""
 
-from RepoAuditor.Plugins.GitHubRulesets.Impl.EnableRulesetRequirementImpl import EnableRulesetRequirementImpl
+from RepoAuditor.Plugins.GitHub.Impl.EnableRulesetRequirementImpl import EnableRulesetRequirementImpl
 
 
 class RequireStatusChecks(EnableRulesetRequirementImpl):

{repoauditor-0.2.48 → repoauditor-0.2.50}/src/RepoAuditor/Plugins/GitHubCommunityStandards/CommunityStandardsQuery.py

@@ -15,6 +15,7 @@ from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.CodeOfConduct imp
 from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.CodeOwners import CodeOwners
 from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.Contributing import Contributing
 from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.IssueTemplates import IssueTemplates
+from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.LicenseFile import LicenseFile
 from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.PullRequestTemplates import PullRequestTemplate
 from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.ReadMe import ReadMe
 from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.SecurityPolicy import SecurityPolicy
@@ -33,6 +34,7 @@ class CommunityStandardsQuery(Query):
                 CodeOwners(),
                 Contributing(),
                 IssueTemplates(),
+                LicenseFile(),
                 PullRequestTemplate(),
                 ReadMe(),
                 SecurityPolicy(),

repoauditor-0.2.50/src/RepoAuditor/Plugins/GitHubCommunityStandards/Requirements/LicenseFile.py

@@ -0,0 +1,49 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Contains the LicenseFile requirement."""
+
+import textwrap
+
+from RepoAuditor.Plugins.GitHubCommunityStandards.Impl.ExistsRequirementImpl import (
+    ExistsRequirementImpl,
+)
+
+
+class LicenseFile(ExistsRequirementImpl):
+    """Validates that a CODE_OF_CONDUCT file is configured."""
+
+    def __init__(self) -> None:
+        super().__init__(
+            "LicenseFile",
+            "exists",
+            "LICENSE",
+            [
+                "LICENSE",
+                "LICENSE.md",
+                "LICENSE.txt",
+                "LICENSE.rst",
+            ],
+            textwrap.dedent(
+                """\
+                1) Create a LICENSE file in in the root directory.
+
+                2) It can have any of the following extensions:
+                   - [blank] e.g. `LICENSE`
+                   - LICENSE.md
+                   - LICENSE.rst
+                   - LICENSE.txt
+                """
+            ),
+            textwrap.dedent(
+                """\
+                A software license tells others what they can and can't do with your source code.
+
+                https://choosealicense.com/ can help decide which license
+                best meets your repository's needs.
+                """
+            ),
+        )

{repoauditor-0.2.48 → repoauditor-0.2.50}/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.48"
+__version__ = "0.2.50"

{repoauditor-0.2.48/tests/Plugins/GitHubRulesets → repoauditor-0.2.50/tests/Plugins/GitHubModule}/EnableRulesetRequirementImpl_UnitTest.py

@@ -6,7 +6,7 @@
 # -------------------------------------------------------------------------------
 """Unit tests for the EnableRulesetRequirementImpl requirement implementation."""
 
-from RepoAuditor.Plugins.GitHubRulesets.Impl.EnableRulesetRequirementImpl import EnableRulesetRequirementImpl
+from RepoAuditor.Plugins.GitHub.Impl.EnableRulesetRequirementImpl import EnableRulesetRequirementImpl
 from RepoAuditor.Requirement import EvaluateResult
 
 

repoauditor-0.2.48/tests/Plugins/GitHubRulesets/GitHubRuleset_UnitTest.py → repoauditor-0.2.50/tests/Plugins/GitHubModule/RulesetRequirements_UnitTest.py

@@ -8,11 +8,11 @@
 
 from typing import Any
 
-from RepoAuditor.Plugins.GitHubRulesets.Requirements.RequirePullRequests import RequirePullRequests
-from RepoAuditor.Plugins.GitHubRulesets.Requirements.RequireSignedCommits import (
+from RepoAuditor.Plugins.GitHub.RulesetRequirements.RequirePullRequests import RequirePullRequests
+from RepoAuditor.Plugins.GitHub.RulesetRequirements.RequireSignedCommits import (
     RequireSignedCommits,
 )
-from RepoAuditor.Plugins.GitHubRulesets.Requirements.RequireStatusChecks import RequireStatusChecks
+from RepoAuditor.Plugins.GitHub.RulesetRequirements.RequireStatusChecks import RequireStatusChecks
 from RepoAuditor.Requirement import EvaluateResult
 
 

{repoauditor-0.2.48/tests/Plugins/GitHubRulesets → repoauditor-0.2.50/tests/Plugins/GitHubModule}/RulsesetQuery_UnitTest.py

@@ -6,7 +6,7 @@
 # -------------------------------------------------------------------------------
 """Unit tests for RulesetQuery.py"""
 
-from RepoAuditor.Plugins.GitHubRulesets.RulesetQuery import RulesetQuery
+from RepoAuditor.Plugins.GitHub.RulesetQuery import RulesetQuery
 
 
 def get_mock_request(

{repoauditor-0.2.48 → repoauditor-0.2.50}/tests/Plugins/GitHub_EndToEndTest.py

@@ -368,6 +368,32 @@ class TestClassic:
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
 
+# ----------------------------------------------------------------------
+class TestRulesets:
+    """End-to-end tests for rulesets in a GitHub repository."""
+
+    def test_RequireStatusChecks(self, pat_args, snapshot):
+        """Test for Status Checks not required ruleset"""
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-RequireStatusChecks-enabled"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    def test_RequirePullRequests(self, pat_args, snapshot):
+        """Test for Pull Requests required ruleset"""
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-RequirePullRequests-enabled"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    def test_RequireSignedCommits(self, pat_args, snapshot):
+        """Test for Signed Commits required ruleset"""
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-RequireSignedCommits-enabled"])
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+
 # ----------------------------------------------------------------------
 # ----------------------------------------------------------------------
 # ----------------------------------------------------------------------

{repoauditor-0.2.48 → repoauditor-0.2.50}/tests/Plugins/__snapshots__/GitHubCommunityStandards_EndToEndTest.ambr

@@ -15,10 +15,10 @@
   │                                                                                                                                                                                  │
   │ Validates GitHub repository files for Community Standards.                                                                                                                       │
   │                                                                                                                                                                                  │
-  │ Successful:     1 (14.29%)                                                                                                                                                       │
+  │ Successful:     1 (12.50%)                                                                                                                                                       │
   │ Warnings:       0 (0.00%)                                                                                                                                                        │
   │ Errors:         0 (0.00%)                                                                                                                                                        │
-  │ Skipped:        6 (85.71%)                                                                                                                                                       │
+  │ Skipped:        7 (87.50%)                                                                                                                                                       │
   │                                                                                                                                                                                  │
   │                                                                                                                                                                                  │
   ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
@@ -44,10 +44,10 @@
   │                                                                                                                                                                                  │
   │ Validates GitHub repository files for Community Standards.                                                                                                                       │
   │                                                                                                                                                                                  │
-  │ Successful:     1 (14.29%)                                                                                                                                                       │
+  │ Successful:     1 (12.50%)                                                                                                                                                       │
   │ Warnings:       0 (0.00%)                                                                                                                                                        │
   │ Errors:         0 (0.00%)                                                                                                                                                        │
-  │ Skipped:        6 (85.71%)                                                                                                                                                       │
+  │ Skipped:        7 (87.50%)                                                                                                                                                       │
   │                                                                                                                                                                                  │
   │                                                                                                                                                                                  │
   ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
@@ -73,10 +73,10 @@
   │                                                                                                                                                                                  │
   │ Validates GitHub repository files for Community Standards.                                                                                                                       │
   │                                                                                                                                                                                  │
-  │ Successful:     1 (14.29%)                                                                                                                                                       │
+  │ Successful:     1 (12.50%)                                                                                                                                                       │
   │ Warnings:       0 (0.00%)                                                                                                                                                        │
   │ Errors:         0 (0.00%)                                                                                                                                                        │
-  │ Skipped:        6 (85.71%)                                                                                                                                                       │
+  │ Skipped:        7 (87.50%)                                                                                                                                                       │
   │                                                                                                                                                                                  │
   │                                                                                                                                                                                  │
   ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
@@ -104,8 +104,8 @@
   │                                                                                                                                                                                  │
   │ Successful:     0 (0.00%)                                                                                                                                                        │
   │ Warnings:       0 (0.00%)                                                                                                                                                        │
-  │ Errors:         1 (14.29%)                                                                                                                                                       │
-  │ Skipped:        6 (85.71%)                                                                                                                                                       │
+  │ Errors:         1 (12.50%)                                                                                                                                                       │
+  │ Skipped:        7 (87.50%)                                                                                                                                                       │
   │                                                                                                                                                                                  │
   │ ╭─ [Error] CodeOwners ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ │
   │ │                                                                                                                                                                              │ │
@@ -162,8 +162,8 @@
   │                                                                                                                                                                                  │
   │ Successful:     0 (0.00%)                                                                                                                                                        │
   │ Warnings:       0 (0.00%)                                                                                                                                                        │
-  │ Errors:         1 (14.29%)                                                                                                                                                       │
-  │ Skipped:        6 (85.71%)                                                                                                                                                       │
+  │ Errors:         1 (12.50%)                                                                                                                                                       │
+  │ Skipped:        7 (87.50%)                                                                                                                                                       │
   │                                                                                                                                                                                  │
   │ ╭─ [Error] Contributing ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ │
   │ │                                                                                                                                                                              │ │
@@ -217,8 +217,8 @@
   │                                                                                                                                                                                  │
   │ Successful:     0 (0.00%)                                                                                                                                                        │
   │ Warnings:       0 (0.00%)                                                                                                                                                        │
-  │ Errors:         1 (14.29%)                                                                                                                                                       │
-  │ Skipped:        6 (85.71%)                                                                                                                                                       │
+  │ Errors:         1 (12.50%)                                                                                                                                                       │
+  │ Skipped:        7 (87.50%)                                                                                                                                                       │
   │                                                                                                                                                                                  │
   │ ╭─ [Error] IssueTemplates ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ │
   │ │                                                                                                                                                                              │ │
@@ -261,8 +261,8 @@
   │                                                                                                                                                                                  │
   │ Successful:     0 (0.00%)                                                                                                                                                        │
   │ Warnings:       0 (0.00%)                                                                                                                                                        │
-  │ Errors:         1 (14.29%)                                                                                                                                                       │
-  │ Skipped:        6 (85.71%)                                                                                                                                                       │
+  │ Errors:         1 (12.50%)                                                                                                                                                       │
+  │ Skipped:        7 (87.50%)                                                                                                                                                       │
   │                                                                                                                                                                                  │
   │ ╭─ [Error] PullRequestTemplate ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ │
   │ │                                                                                                                                                                              │ │
@@ -306,8 +306,8 @@
   │                                                                                                                                                                                  │
   │ Successful:     0 (0.00%)                                                                                                                                                        │
   │ Warnings:       0 (0.00%)                                                                                                                                                        │
-  │ Errors:         1 (14.29%)                                                                                                                                                       │
-  │ Skipped:        6 (85.71%)                                                                                                                                                       │
+  │ Errors:         1 (12.50%)                                                                                                                                                       │
+  │ Skipped:        7 (87.50%)                                                                                                                                                       │
   │                                                                                                                                                                                  │
   │ ╭─ [Error] SecurityPolicy ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ │
   │ │                                                                                                                                                                              │ │
@@ -359,10 +359,10 @@
   │                                                                                                                                                                                  │
   │ Validates GitHub repository files for Community Standards.                                                                                                                       │
   │                                                                                                                                                                                  │
-  │ Successful:     1 (14.29%)                                                                                                                                                       │
+  │ Successful:     1 (12.50%)                                                                                                                                                       │
   │ Warnings:       0 (0.00%)                                                                                                                                                        │
   │ Errors:         0 (0.00%)                                                                                                                                                        │
-  │ Skipped:        6 (85.71%)                                                                                                                                                       │
+  │ Skipped:        7 (87.50%)                                                                                                                                                       │
   │                                                                                                                                                                                  │
   │                                                                                                                                                                                  │
   ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
@@ -388,10 +388,10 @@
   │                                                                                                                                                                                  │
   │ Validates GitHub repository files for Community Standards.                                                                                                                       │
   │                                                                                                                                                                                  │
-  │ Successful:     1 (14.29%)                                                                                                                                                       │
+  │ Successful:     1 (12.50%)                                                                                                                                                       │
   │ Warnings:       0 (0.00%)                                                                                                                                                        │
   │ Errors:         0 (0.00%)                                                                                                                                                        │
-  │ Skipped:        6 (85.71%)                                                                                                                                                       │
+  │ Skipped:        7 (87.50%)                                                                                                                                                       │
   │                                                                                                                                                                                  │
   │                                                                                                                                                                                  │
   ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯