RepoAuditor 0.4.0__tar.gz → 0.4.2__tar.gz

{repoauditor-0.4.0 → repoauditor-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.4.0
+Version: 0.4.2
 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.4.0 → repoauditor-0.4.2}/docs/DEVELOPMENT.md

@@ -107,7 +107,7 @@ Please follow the steps below to complete the configuration.
   - Enable `Require status checks to pass`.
     - Enable `Require branches to be up to date before merging`.
     - Set the `CI+CD Workflow / Validate (ubuntu-latest, 3.12)` or an equivalent check.
-  - Disable `Block force pushes`.
+  - Enable `Block force pushes`.
   - Be sure to hit `Save changes` at the end.
 
 ### Development Activities

{repoauditor-0.4.0 → repoauditor-0.4.2}/src/RepoAuditor/Plugins/CommunityStandards/Impl/ExistsRequirementImpl.py

@@ -30,6 +30,7 @@ class ExistsRequirementImpl(Requirement):
         resolution: str,
         rationale: str,
         *,
+        enabled_by_default: bool = True,
         dynamic_arg_name: str = "unrequired",
         requires_explicit_include: bool = False,
     ) -> None:
@@ -41,7 +42,8 @@ class ExistsRequirementImpl(Requirement):
             possible_locations (Sequence[str]): List of potential paths in the repo to check if `filename` exists.
             resolution (str): Message on how to resolve the requirement in case of an error.
             rationale (str): Rationale message on why this requirement is needed.
-            dynamic_arg_name (str, optional): Name of the runtime argument (e.g. from command line) to this requirement.Defaults to "unrequired", which if enabled causes the requirement to be skipped.
+            enabled_by_default (bool): Flag which indicates if the required file should be present in the repository by default. Defaults to True.
+            dynamic_arg_name (str, optional): Name of the runtime argument (e.g. from command line) to this requirement. Defaults to "unrequired", which if enabled causes the requirement to check if file is not present.
             requires_explicit_include (bool, optional): Flag checking if this requirement needs to be explicitly included in the invocation. Defaults to False.
 
         """
@@ -56,8 +58,8 @@ class ExistsRequirementImpl(Requirement):
 
         self.dynamic_arg_name = dynamic_arg_name
         self.filename = filename
-
         self.possible_locations = possible_locations
+        self.enabled_by_default = enabled_by_default
 
     # ----------------------------------------------------------------------
     @override
@@ -68,7 +70,7 @@ class ExistsRequirementImpl(Requirement):
                 bool,
                 typer.Option(
                     False,
-                    help=f"Disable requirement that the file {self.filename} exists.",
+                    help=f"{'Disable' if self.enabled_by_default else 'Enable'} requirement that the file {self.filename} exists.{' Needs to be explicitly included.' if self.requires_explicit_include else ''}",
                 ),
             ),
         }
@@ -80,8 +82,14 @@ class ExistsRequirementImpl(Requirement):
         query_data: dict[str, Any],
         requirement_args: dict[str, Any],
     ) -> Requirement.EvaluateImplResult:
-        # Check if dynamic argument is `not unrequired`.
-        if not requirement_args.get(self.dynamic_arg_name, False):
+        # Flag to check if required file exists
+        check_exists: bool = self.enabled_by_default
+
+        # Check if the dynamic argument is provided, which toggles the check flag
+        if requirement_args.get(self.dynamic_arg_name, False):
+            check_exists = not check_exists
+
+        if check_exists:
             for location in self.possible_locations:
                 # Get full file path in temporary repo directory and check if it exists
                 # This checks both upper case and lower case variants
@@ -107,5 +115,5 @@ class ExistsRequirementImpl(Requirement):
                 provide_rationale=True,
             )
 
-        # Requirement flag not set so DoesNotApply
+        # Requirement not enabled, so DoesNotApply
         return Requirement.EvaluateImplResult(EvaluateResult.DoesNotApply, None)

{repoauditor-0.4.0 → repoauditor-0.4.2}/src/RepoAuditor/Plugins/GitHub/RulesetQuery.py

@@ -11,8 +11,8 @@ from typing import Any, Optional
 from dbrownell_Common.Types import override
 
 from RepoAuditor.Impl.ParallelSequentialProcessor import ExecutionStyle
-from RepoAuditor.Plugins.GitHub.RulesetRequirements.AllowMainlineForcePushes import (
-    AllowMainlineForcePushesRule,
+from RepoAuditor.Plugins.GitHub.RulesetRequirements.BlockMainlineForcePushes import (
+    BlockMainlineForcePushesRule,
 )
 from RepoAuditor.Plugins.GitHub.RulesetRequirements.DismissStalePullRequestApprovals import (
     DismissStalePullRequestApprovalsRule,
@@ -68,7 +68,7 @@ class RulesetQuery(Query):
                 RequireStatusChecksToPassRule(),
                 RequireUpToDateBranchesRule(),
                 EnsureStatusChecksRule(),
-                AllowMainlineForcePushesRule(),
+                BlockMainlineForcePushesRule(),
                 RequireCodeScanningResultsRule(),
             ],
         )

repoauditor-0.4.0/src/RepoAuditor/Plugins/GitHub/RulesetRequirements/AllowMainlineForcePushes.py → repoauditor-0.4.2/src/RepoAuditor/Plugins/GitHub/RulesetRequirements/BlockMainlineForcePushes.py

@@ -4,21 +4,21 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the AllowMainlineForcePushesRule requirement."""
+"""Contains the BlockMainlineForcePushesRule requirement."""
 
 import textwrap
 
 from RepoAuditor.Plugins.GitHub.Impl.EnableRulesetRequirementImpl import EnableRulesetRequirementImpl
 
 
-class AllowMainlineForcePushesRule(EnableRulesetRequirementImpl):
-    """Requirement for rule to allow force pushes to the matching branch."""
+class BlockMainlineForcePushesRule(EnableRulesetRequirementImpl):
+    """Requirement for rule to block force pushes to the mainline branch."""
 
     def __init__(self) -> None:
         super().__init__(
-            name="AllowMainlineForcePushesRule",
-            enabled_by_default=False,
-            dynamic_arg_name="yes",
+            name="BlockMainlineForcePushesRule",
+            enabled_by_default=True,
+            dynamic_arg_name="no",
             github_ruleset_type="non_fast_forward",
             github_ruleset_value="Block force pushes",
             get_configuration_value_func=self._GetValue,
@@ -34,7 +34,7 @@ class AllowMainlineForcePushesRule(EnableRulesetRequirementImpl):
 
                 Reasons to Override this Default
                 --------------------------------
-                <unknown>
+                - If the repository only has a single developer or if is private.
                 """,
             ),
         )

{repoauditor-0.4.0 → repoauditor-0.4.2}/src/RepoAuditor/Plugins/ScientificSoftware/Requirements/Citation.py

@@ -37,7 +37,7 @@ class Citation(ExistsRequirementImpl):
                 "citations.bib",
                 "citation.md",
                 "citations.md",
-                # R packages are located in the `inst` directory
+                # Citations for R packages are located in the `inst` directory
                 "inst/CITATION",
             ],
             resolution=textwrap.dedent(
@@ -59,5 +59,4 @@ class Citation(ExistsRequirementImpl):
                 https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files
                 """
             ),
-            dynamic_arg_name="unrequired",
         )

{repoauditor-0.4.0 → repoauditor-0.4.2}/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.4.0"
+__version__ = "0.4.2"

{repoauditor-0.4.0 → repoauditor-0.4.2}/tests/EntryPoint_UnitTest.py

@@ -8,13 +8,12 @@
 
 import pytest
 import typer
-
 from dbrownell_Common.TestHelpers.StreamTestHelpers import InitializeStreamCapabilities
 from dbrownell_Common.TyperEx import TypeDefinitionItem  # type: ignore [import-untyped]
 from typer.testing import CliRunner
 
 from RepoAuditor import __version__
-from RepoAuditor.EntryPoint import app, TypeInfoToString
+from RepoAuditor.EntryPoint import TypeInfoToString, app
 
 from .Plugins.utilities import GetGithubUrl
 

{repoauditor-0.4.0 → repoauditor-0.4.2}/tests/ExecuteModules_UnitTest.py

@@ -9,23 +9,20 @@
 import sys
 import textwrap
 import time
-
 from typing import cast
 
 import pytest
-
-from dbrownell_Common.Types import override
 from dbrownell_Common.TestHelpers.StreamTestHelpers import (
     GenerateDoneManagerAndContent,
     InitializeStreamCapabilities,
 )
+from dbrownell_Common.Types import override
 
 from RepoAuditor.Display import *
 from RepoAuditor.ExecuteModules import *
 from RepoAuditor.Module import *
 from RepoAuditor.Requirement import *
 
-
 # ----------------------------------------------------------------------
 pytest.fixture(InitializeStreamCapabilities(), scope="session", autouse=True)
 

{repoauditor-0.4.0 → repoauditor-0.4.2}/tests/Plugins/GitHubEnterprise_EndToEndTest.py

@@ -538,9 +538,9 @@ class TestRulesets:
         assert result.exit_code == -1, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
-    def test_AllowMainlineForcePushesRule(self, pat_args, snapshot):
-        """Test for requirement `Block force pushes to the specified branch` is enabled in the ruleset for the `main` branch."""
-        result = CliRunner().invoke(app, pat_args + ["--GitHub-AllowMainlineForcePushesRule"])
+    def test_NoBlockMainlineForcePushesRule(self, pat_args, snapshot):
+        """Test for requirement `Block force pushes to the specified branch` is disabled in the ruleset for the `main` branch."""
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-no-BlockMainlineForcePushesRule"])
 
         # Since the repo ruleset has the requirement disabled,
         # we should get an error.

repoauditor-0.4.0/tests/Plugins/GitHubModule/RulesetRequirements/AllowMainlineForcePushesRule_UnitTest.py → repoauditor-0.4.2/tests/Plugins/GitHubModule/RulesetRequirements/BlockMainlineForcePushesRule_UnitTest.py

@@ -4,22 +4,22 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Unit tests for AllowMainlineForcePushesRule.py"""
+"""Unit tests for BlockMainlineForcePushesRule.py"""
 
-from RepoAuditor.Plugins.GitHub.RulesetRequirements.AllowMainlineForcePushes import (
-    AllowMainlineForcePushesRule,
+from RepoAuditor.Plugins.GitHub.RulesetRequirements.BlockMainlineForcePushes import (
+    BlockMainlineForcePushesRule,
 )
 from RepoAuditor.Requirement import EvaluateResult
 
 from . import create_rule
 
 
-class TestAllowMainlineForcePushesRule:
-    """Unit tests for the AllowMainlineForcePushesRule requirement."""
+class TestBlockMainlineForcePushesRule:
+    """Unit tests for the BlockMainlineForcePushesRule requirement."""
 
     def test_Enabled(self, query_data):
         """Test if the rule is enabled on the main branch."""
-        requirement = AllowMainlineForcePushesRule()
+        requirement = BlockMainlineForcePushesRule()
 
         query_data["rules"].append(
             create_rule(
@@ -36,7 +36,7 @@ class TestAllowMainlineForcePushesRule:
 
     def test_Disabled(self, query_data):
         """Test if the rule is disabled by not providing the appropriate rule within the ruleset."""
-        requirement = AllowMainlineForcePushesRule()
+        requirement = BlockMainlineForcePushesRule()
 
         query_data["rules"].append(
             create_rule(

{repoauditor-0.4.0 → repoauditor-0.4.2}/tests/Plugins/GitHubModule/RulesetRequirements/RequireUpToDateBranchesRule_UnitTest.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Unit tests for AllowMainlineForcePushesRule.py"""
+"""Unit tests for RequireUpToDateBranchesRule.py"""
 
 from RepoAuditor.Plugins.GitHub.RulesetRequirements.RequireUpToDateBranches import (
     RequireUpToDateBranchesRule,

{repoauditor-0.4.0 → repoauditor-0.4.2}/tests/Plugins/GitHub_EndToEndTest.py

@@ -568,9 +568,9 @@ class TestRulesets:
         assert result.exit_code == -1, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
-    def test_AllowMainlineForcePushesRule(self, pat_args, snapshot):
-        """Test for requirement `Block force pushes to the specified branch` is enabled in the ruleset for the `main` branch."""
-        result = CliRunner().invoke(app, pat_args + ["--GitHub-AllowMainlineForcePushesRule"])
+    def test_NoBlockMainlineForcePushesRule(self, pat_args, snapshot):
+        """Test for requirement `Block force pushes to the specified branch` is disabled in the ruleset for the `main` branch."""
+        result = CliRunner().invoke(app, pat_args + ["--GitHub-no-BlockMainlineForcePushesRule"])
 
         # Since the repo ruleset has the requirement disabled,
         # we should get an error.

{repoauditor-0.4.0 → repoauditor-0.4.2}/tests/Plugins/ScientificSoftware_EndToEndTest.py

@@ -24,11 +24,11 @@ class TestScientificSoftware:
     """End-to-end tests for files in a GitHub repository which implements scientific software."""
 
     # ----------------------------------------------------------------------
-    def test_NoCitation(self, pat_args, snapshot):
+    def test_NoCitation(self, args, snapshot):
         """Test if no CITATION file exists in the repository."""
         result = CliRunner().invoke(
             app,
-            pat_args,
+            args,
         )
 
         assert result.exit_code == -1, result.output

{repoauditor-0.4.0 → repoauditor-0.4.2}/tests/Plugins/__snapshots__/GitHubEnterprise_EndToEndTest.ambr

@@ -712,7 +712,24 @@
   
   '''
 # ---
-# name: TestRulesets.test_AllowMainlineForcePushesRule
+# name: TestRulesets.test_Default
+  '''
+  Processing 1 module...
+    Processing 'GitHub' (1 of 1)...
+  
+  
+  
+  
+    DONE! (-1, <scrubbed duration>)
+  DONE! (-1, <scrubbed duration>)
+  ERROR: 'branch'
+  
+  Results: DONE! (-1, <scrubbed duration>)
+  
+  
+  '''
+# ---
+# name: TestRulesets.test_DismissStalePullRequestApprovalsRule
   '''
   Processing 1 module...
     Processing 'GitHub' (1 of 1)...
@@ -734,18 +751,21 @@
   │ Errors:         1 (1.89%)                                                                                            │
   │ Skipped:        5 (9.43%)                                                                                            │
   │                                                                                                                      │
-  │ ╭─ [Error] AllowMainlineForcePushesRule ───────────────────────────────────────────────────────────────────────────╮ │
+  │ ╭─ [Error] DismissStalePullRequestApprovalsRule ───────────────────────────────────────────────────────────────────╮ │
   │ │                                                                                                                  │ │
-  │ │ Validates that 'Block force pushes' is set to True.                                                              │ │
+  │ │ Validates that 'Require a pull request before merging -> Dismiss stale pull request approvals when new commits   │ │
+  │ │ are pushed' is set to False.                                                                                     │ │
   │ │                                                                                                                  │ │
-  │ │ ERROR: No active branch ruleset with 'Block force pushes' found                                                  │ │
+  │ │ ERROR: 'Require a pull request before merging -> Dismiss stale pull request approvals when new commits are       │ │
+  │ │ pushed' rule active in ruleset 'main'. It should be set to False.                                                │ │
   │ │                                                                                                                  │ │
   │ │ Resolution                                                                                                       │ │
   │ │ ----------                                                                                                       │ │
   │ │   1) Visit '<scrubbed-github-url>'.                                                                              │ │
   │ │   2) Find or create a ruleset on the branch 'main'.                                                              │ │
-  │ │   3) Go to 'Block force pushes'.                                                                                 │ │
-  │ │   4) Enable the rule.                                                                                            │ │
+  │ │   3) Go to 'Require a pull request before merging -> Dismiss stale pull request approvals when new commits are   │ │
+  │ │ pushed'.                                                                                                         │ │
+  │ │   4) Disable the rule.                                                                                           │ │
   │ │                                                                                                                  │ │
   │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
   │ ╭─ Metrics ────────────────────────────────────────────────────────────────────────────────────────────────────────╮ │
@@ -765,24 +785,7 @@
   
   '''
 # ---
-# name: TestRulesets.test_Default
-  '''
-  Processing 1 module...
-    Processing 'GitHub' (1 of 1)...
-  
-  
-  
-  
-    DONE! (-1, <scrubbed duration>)
-  DONE! (-1, <scrubbed duration>)
-  ERROR: 'branch'
-  
-  Results: DONE! (-1, <scrubbed duration>)
-  
-  
-  '''
-# ---
-# name: TestRulesets.test_DismissStalePullRequestApprovalsRule
+# name: TestRulesets.test_NoBlockMainlineForcePushesRule
   '''
   Processing 1 module...
     Processing 'GitHub' (1 of 1)...
@@ -804,20 +807,17 @@
   │ Errors:         1 (1.89%)                                                                                            │
   │ Skipped:        5 (9.43%)                                                                                            │
   │                                                                                                                      │
-  │ ╭─ [Error] DismissStalePullRequestApprovalsRule ───────────────────────────────────────────────────────────────────╮ │
+  │ ╭─ [Error] BlockMainlineForcePushesRule ───────────────────────────────────────────────────────────────────────────╮ │
   │ │                                                                                                                  │ │
-  │ │ Validates that 'Require a pull request before merging -> Dismiss stale pull request approvals when new commits   │ │
-  │ │ are pushed' is set to False.                                                                                     │ │
+  │ │ Validates that 'Block force pushes' is set to False.                                                             │ │
   │ │                                                                                                                  │ │
-  │ │ ERROR: 'Require a pull request before merging -> Dismiss stale pull request approvals when new commits are       │ │
-  │ │ pushed' rule active in ruleset 'main'. It should be set to False.                                                │ │
+  │ │ ERROR: 'Block force pushes' rule active in ruleset 'main'. It should be set to False.                            │ │
   │ │                                                                                                                  │ │
   │ │ Resolution                                                                                                       │ │
   │ │ ----------                                                                                                       │ │
   │ │   1) Visit '<scrubbed-github-url>'.                                                                              │ │
   │ │   2) Find or create a ruleset on the branch 'main'.                                                              │ │
-  │ │   3) Go to 'Require a pull request before merging -> Dismiss stale pull request approvals when new commits are   │ │
-  │ │ pushed'.                                                                                                         │ │
+  │ │   3) Go to 'Block force pushes'.                                                                                 │ │
   │ │   4) Disable the rule.                                                                                           │ │
   │ │                                                                                                                  │ │
   │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │

{repoauditor-0.4.0 → repoauditor-0.4.2}/tests/Plugins/__snapshots__/GitHub_EndToEndTest.ambr

@@ -712,7 +712,24 @@
   
   '''
 # ---
-# name: TestRulesets.test_AllowMainlineForcePushesRule
+# name: TestRulesets.test_Default
+  '''
+  Processing 1 module...
+    Processing 'GitHub' (1 of 1)...
+  
+  
+  
+  
+    DONE! (-1, <scrubbed duration>)
+  DONE! (-1, <scrubbed duration>)
+  ERROR: 'branch'
+  
+  Results: DONE! (-1, <scrubbed duration>)
+  
+  
+  '''
+# ---
+# name: TestRulesets.test_DismissStalePullRequestApprovalsRule
   '''
   Processing 1 module...
     Processing 'GitHub' (1 of 1)...
@@ -734,18 +751,21 @@
   │ Errors:         1 (1.89%)                                                                                            │
   │ Skipped:        1 (1.89%)                                                                                            │
   │                                                                                                                      │
-  │ ╭─ [Error] AllowMainlineForcePushesRule ───────────────────────────────────────────────────────────────────────────╮ │
+  │ ╭─ [Error] DismissStalePullRequestApprovalsRule ───────────────────────────────────────────────────────────────────╮ │
   │ │                                                                                                                  │ │
-  │ │ Validates that 'Block force pushes' is set to True.                                                              │ │
+  │ │ Validates that 'Require a pull request before merging -> Dismiss stale pull request approvals when new commits   │ │
+  │ │ are pushed' is set to False.                                                                                     │ │
   │ │                                                                                                                  │ │
-  │ │ ERROR: No active branch ruleset with 'Block force pushes' found                                                  │ │
+  │ │ ERROR: 'Require a pull request before merging -> Dismiss stale pull request approvals when new commits are       │ │
+  │ │ pushed' rule active in ruleset 'main'. It should be set to False.                                                │ │
   │ │                                                                                                                  │ │
   │ │ Resolution                                                                                                       │ │
   │ │ ----------                                                                                                       │ │
   │ │   1) Visit '<scrubbed-github-url>'.                                                                              │ │
   │ │   2) Find or create a ruleset on the branch 'main'.                                                              │ │
-  │ │   3) Go to 'Block force pushes'.                                                                                 │ │
-  │ │   4) Enable the rule.                                                                                            │ │
+  │ │   3) Go to 'Require a pull request before merging -> Dismiss stale pull request approvals when new commits are   │ │
+  │ │ pushed'.                                                                                                         │ │
+  │ │   4) Disable the rule.                                                                                           │ │
   │ │                                                                                                                  │ │
   │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
   │ ╭─ Metrics ────────────────────────────────────────────────────────────────────────────────────────────────────────╮ │
@@ -765,24 +785,7 @@
   
   '''
 # ---
-# name: TestRulesets.test_Default
-  '''
-  Processing 1 module...
-    Processing 'GitHub' (1 of 1)...
-  
-  
-  
-  
-    DONE! (-1, <scrubbed duration>)
-  DONE! (-1, <scrubbed duration>)
-  ERROR: 'branch'
-  
-  Results: DONE! (-1, <scrubbed duration>)
-  
-  
-  '''
-# ---
-# name: TestRulesets.test_DismissStalePullRequestApprovalsRule
+# name: TestRulesets.test_EnsureStatusChecksRule
   '''
   Processing 1 module...
     Processing 'GitHub' (1 of 1)...
@@ -804,21 +807,21 @@
   │ Errors:         1 (1.89%)                                                                                            │
   │ Skipped:        1 (1.89%)                                                                                            │
   │                                                                                                                      │
-  │ ╭─ [Error] DismissStalePullRequestApprovalsRule ───────────────────────────────────────────────────────────────────╮ │
+  │ ╭─ [Error] EnsureStatusChecksRule ─────────────────────────────────────────────────────────────────────────────────╮ │
   │ │                                                                                                                  │ │
-  │ │ Validates that 'Require a pull request before merging -> Dismiss stale pull request approvals when new commits   │ │
-  │ │ are pushed' is set to False.                                                                                     │ │
+  │ │ Validates that 'Require status checks to pass -> Status checks that are required' is set to False.               │ │
   │ │                                                                                                                  │ │
-  │ │ ERROR: 'Require a pull request before merging -> Dismiss stale pull request approvals when new commits are       │ │
-  │ │ pushed' rule active in ruleset 'main'. It should be set to False.                                                │ │
+  │ │ ERROR: 'Require status checks to pass -> Status checks that are required' rule active in ruleset 'main'. It      │ │
+  │ │ should be set to False.                                                                                          │ │
   │ │                                                                                                                  │ │
   │ │ Resolution                                                                                                       │ │
   │ │ ----------                                                                                                       │ │
   │ │   1) Visit '<scrubbed-github-url>'.                                                                              │ │
   │ │   2) Find or create a ruleset on the branch 'main'.                                                              │ │
-  │ │   3) Go to 'Require a pull request before merging -> Dismiss stale pull request approvals when new commits are   │ │
-  │ │ pushed'.                                                                                                         │ │
-  │ │   4) Disable the rule.                                                                                           │ │
+  │ │   3) Go to ''Require status checks to pass -> Status checks that are required''.                                 │ │
+  │ │   4) Click on '+ Add checks'.                                                                                    │ │
+  │ │   5) Type the name of the check to enforce.                                                                      │ │
+  │ │   6) Select status checks that must pass before merging.                                                         │ │
   │ │                                                                                                                  │ │
   │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
   │ ╭─ Metrics ────────────────────────────────────────────────────────────────────────────────────────────────────────╮ │
@@ -838,7 +841,7 @@
   
   '''
 # ---
-# name: TestRulesets.test_EnsureStatusChecksRule
+# name: TestRulesets.test_NoBlockMainlineForcePushesRule
   '''
   Processing 1 module...
     Processing 'GitHub' (1 of 1)...
@@ -860,21 +863,18 @@
   │ Errors:         1 (1.89%)                                                                                            │
   │ Skipped:        1 (1.89%)                                                                                            │
   │                                                                                                                      │
-  │ ╭─ [Error] EnsureStatusChecksRule ─────────────────────────────────────────────────────────────────────────────────╮ │
+  │ ╭─ [Error] BlockMainlineForcePushesRule ───────────────────────────────────────────────────────────────────────────╮ │
   │ │                                                                                                                  │ │
-  │ │ Validates that 'Require status checks to pass -> Status checks that are required' is set to False.               │ │
+  │ │ Validates that 'Block force pushes' is set to False.                                                             │ │
   │ │                                                                                                                  │ │
-  │ │ ERROR: 'Require status checks to pass -> Status checks that are required' rule active in ruleset 'main'. It      │ │
-  │ │ should be set to False.                                                                                          │ │
+  │ │ ERROR: 'Block force pushes' rule active in ruleset 'main'. It should be set to False.                            │ │
   │ │                                                                                                                  │ │
   │ │ Resolution                                                                                                       │ │
   │ │ ----------                                                                                                       │ │
   │ │   1) Visit '<scrubbed-github-url>'.                                                                              │ │
   │ │   2) Find or create a ruleset on the branch 'main'.                                                              │ │
-  │ │   3) Go to ''Require status checks to pass -> Status checks that are required''.                                 │ │
-  │ │   4) Click on '+ Add checks'.                                                                                    │ │
-  │ │   5) Type the name of the check to enforce.                                                                      │ │
-  │ │   6) Select status checks that must pass before merging.                                                         │ │
+  │ │   3) Go to 'Block force pushes'.                                                                                 │ │
+  │ │   4) Disable the rule.                                                                                           │ │
   │ │                                                                                                                  │ │
   │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
   │ ╭─ Metrics ────────────────────────────────────────────────────────────────────────────────────────────────────────╮ │
@@ -3276,11 +3276,11 @@
   │ │ SUCCESS: 'Require status checks to pass -> Status checks that are required' is enabled in Ruleset 'main'         │ │
   │ │                                                                                                                  │ │
   │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
-  │ ╭─ [Success] AllowMainlineForcePushesRule ─────────────────────────────────────────────────────────────────────────╮ │
+  │ ╭─ [Success] BlockMainlineForcePushesRule ─────────────────────────────────────────────────────────────────────────╮ │
   │ │                                                                                                                  │ │
-  │ │ Validates that 'Block force pushes' is set to False.                                                             │ │
+  │ │ Validates that 'Block force pushes' is set to True.                                                              │ │
   │ │                                                                                                                  │ │
-  │ │ SUCCESS: 'Block force pushes' is disabled                                                                        │ │
+  │ │ SUCCESS: 'Block force pushes' is enabled in Ruleset 'main'                                                       │ │
   │ │                                                                                                                  │ │
   │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
   │ ╭─ [Success] RequireCodeScanningResultsRule ───────────────────────────────────────────────────────────────────────╮ │

{repoauditor-0.4.0 → repoauditor-0.4.2}/tests/Plugins/conftest.py

@@ -6,13 +6,13 @@
 # -------------------------------------------------------------------------------
 """Common test fixtures for Plugins."""
 
-from typing import Any
 from pathlib import Path
+from typing import Any
 
 import pytest
 
 # Fixtures included here so it is available for all tests
-from GitHubModule.fixtures import session_fixture, query_data_fixture  # noqa: F401
+from GitHubModule.fixtures import query_data_fixture, session_fixture  # noqa: F401
 from utilities import CheckPATFileExists, GetGithubUrl
 
 from RepoAuditor.Plugins.GitHubBase.Module import _GitHubSession

{repoauditor-0.4.0 → repoauditor-0.4.2}/tests/Query_UnitTest.py

@@ -9,7 +9,6 @@
 from unittest.mock import Mock
 
 import pytest
-
 from dbrownell_Common.Types import override
 
 from RepoAuditor.Query import *

{repoauditor-0.4.0 → repoauditor-0.4.2}/tests/Requirement_UnitTest.py

@@ -9,7 +9,6 @@
 from unittest.mock import Mock
 
 import pytest
-
 from dbrownell_Common.Types import override
 
 from RepoAuditor.Requirement import *