RepoAuditor 0.2.28__tar.gz → 0.2.30__tar.gz

{repoauditor-0.2.28 → repoauditor-0.2.30}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.28
+Version: 0.2.30
 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.28 → repoauditor-0.2.30}/pyproject.toml

@@ -131,7 +131,7 @@ select = [
     "D",
     "F",
     "PGH",
-    # "PL", # 11
+    "PL",
     "UP",
     "FURB",
     "RUF",

{repoauditor-0.2.28 → repoauditor-0.2.30}/src/RepoAuditor/CommandLineProcessor.py

@@ -152,15 +152,17 @@ class CommandLineProcessor:
         # Now we process the definitions to get the dynamic arguments
         dynamic_args: dict[str, dict[str, Any]] = {}
 
+        num_acceptable_dynamic_args_parts = 2
+
         for key, value in get_dynamic_args_func(dynamic_arg_definitions).items():
             parts = key.split(argument_separator)
-            assert len(parts) >= 2
+            assert len(parts) >= num_acceptable_dynamic_args_parts
 
             if parts[0] not in module_map:
                 msg = f"'{parts[0]}' is not a recognized module name."
                 raise ValueError(msg)
 
-            if len(parts) == 2:
+            if len(parts) == num_acceptable_dynamic_args_parts:
                 dynamic_args.setdefault(parts[0], {})[parts[1]] = value
             else:
                 dynamic_args.setdefault(parts[0], {}).setdefault(None, {}).setdefault(  # type: ignore[call-overload]

{repoauditor-0.2.28 → repoauditor-0.2.30}/src/RepoAuditor/EntryPoint.py

@@ -182,7 +182,7 @@ def _VersionCallback(value: bool) -> None:  # noqa: FBT001
     epilog=_HelpEpilog(),
     no_args_is_help=False,
 )
-def EntryPoint(
+def EntryPoint(  # noqa: PLR0913
     ctx: typer.Context,
     version: Annotated[  # noqa: ARG001, FBT002
         bool,

{repoauditor-0.2.28 → repoauditor-0.2.30}/src/RepoAuditor/Impl/ParallelSequentialProcessor.py

@@ -37,9 +37,9 @@ def ParallelSequentialProcessor(
 ) -> list[OutputType]:
     """Process a list of items in parallel and/or sequentially."""
     if dm is None:
-        with DoneManager.Create(StreamDecorator(None), "", line_prefix="") as dm:
+        with DoneManager.Create(StreamDecorator(None), "", line_prefix="") as _dm:
             return _Impl(
-                dm,
+                _dm,
                 items,
                 calculate_result_func,
                 max_num_threads,

{repoauditor-0.2.28 → repoauditor-0.2.30}/src/RepoAuditor/Module.py

@@ -182,6 +182,9 @@ class Module(ABC):
                 if evaluate_info.result == EvaluateResult.Warning:
                     return_code = 1
 
+            # Cleanup any resources created during the query
+            query.Cleanup(query_data)
+
             return (
                 return_code,
                 [

{repoauditor-0.2.28 → repoauditor-0.2.30}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionQuery.py

@@ -61,6 +61,7 @@ RESPONSE:
 
 from typing import Any, Optional
 
+import requests
 from dbrownell_Common.Types import override  # type: ignore[import-untyped]
 
 from RepoAuditor.Query import ExecutionStyle, Query
@@ -149,7 +150,7 @@ class ClassicBranchProtectionQuery(Query):
         # and then see if rule sets are in use if the classic information is not found.
         response = module_data["session"].get(f"/branches/{module_data['branch']}/protection")
 
-        if response.status_code == 404:
+        if response.status_code == requests.codes.NOT_FOUND:
             # Does this branch use rule sets?
             ruleset_response = module_data["session"].get(f"rules/branches/{module_data['branch']}")
 

{repoauditor-0.2.28 → repoauditor-0.2.30}/src/RepoAuditor/Plugins/GitHub/Impl/EnableRequirementImpl.py

@@ -24,7 +24,7 @@ class EnableRequirementImpl(Requirement):
     """Object that implements settings that can be enabled/disabled."""
 
     # ----------------------------------------------------------------------
-    def __init__(
+    def __init__(  # noqa: PLR0913
         self,
         name: str,
         default_value: bool,  # noqa: FBT001

{repoauditor-0.2.28 → repoauditor-0.2.30}/src/RepoAuditor/Plugins/GitHub/StandardQueryRequirements/Impl/StandardEnableRequirementImpl.py

@@ -19,7 +19,7 @@ class StandardEnableRequirementImpl(EnableRequirementImpl):
     """Implementation of requirement for standard enables of GitHub settings."""
 
     # ----------------------------------------------------------------------
-    def __init__(
+    def __init__(  # noqa: PLR0913
         self,
         name: str,
         default_value: bool,  # noqa: FBT001

{repoauditor-0.2.28 → repoauditor-0.2.30}/src/RepoAuditor/Plugins/GitHubBase/Module.py

@@ -104,7 +104,8 @@ class _GitHubSession(requests.Session):
         url_parts = urlparse(github_url)
         path_parts = url_parts.path.split("/")
 
-        if len(path_parts) != 3:
+        # The URL should be of the form <github_server>/<username>/<repo>
+        if len(path_parts) != 3:  # noqa: PLR2004
             msg = f"'{github_url}' is not a valid GitHub repository URL."
             raise ValueError(msg)
 

{repoauditor-0.2.28 → repoauditor-0.2.30}/src/RepoAuditor/Plugins/GitHubCustomization/CustomizationQuery.py

@@ -7,6 +7,8 @@
 """Contains the CustomizationQuery object."""
 
 from typing import Any, Optional
+from tempfile import TemporaryDirectory
+from git import Repo
 
 from dbrownell_Common.Types import override  # type: ignore[import-untyped]
 
@@ -40,12 +42,22 @@ class CustomizationQuery(Query):
         self,
         module_data: dict[str, Any],
     ) -> Optional[dict[str, Any]]:
-        """Get the data from an API session."""
-        response = module_data["session"].get("")
+        """Get the repo data."""
 
-        response.raise_for_status()
-        response = response.json()
+        # Clone the GitHub repository to a temp directory
+        github_url = module_data["url"]
+        branch = module_data.get("branch", "main")
+        temp_repo_dir = TemporaryDirectory()
+        Repo.clone_from(github_url, temp_repo_dir.name, branch=branch)
 
-        module_data["standard"] = response
+        # Record the path and the temp directory for later cleanup
+        module_data["repo_dir"] = temp_repo_dir
 
         return module_data
+
+    @override
+    def Cleanup(self, module_data: dict[str, Any]) -> None:
+        """Clean up the cloned repository."""
+        repo_dir = module_data["repo_dir"]
+        repo_dir.cleanup()
+        del module_data

{repoauditor-0.2.28 → repoauditor-0.2.30}/src/RepoAuditor/Plugins/GitHubCustomization/Impl/ExistsRequirementImpl.py

@@ -6,6 +6,7 @@
 # -------------------------------------------------------------------------------
 """Contains the ExistsRequirementImpl object."""
 
+from pathlib import Path
 from typing import Any
 from collections.abc import Sequence
 
@@ -69,28 +70,23 @@ class ExistsRequirementImpl(Requirement):
     ) -> Requirement.EvaluateImplResult:
         if requirement_args[self.dynamic_arg_name]:
             for location in self.possible_locations:
-                # Query for file location
-                response = query_data["session"].get(f"contents/{location}")
+                # Get full file path in temporary repo directory and check if it exists
+                # This checks both upper case and lower case variants
+                full_file_path = Path(query_data["repo_dir"].name) / Path(location)
 
-                # If location is found, response will have status code 200
-                if response.status_code == 200:
-                    response_json = response.json()
-                    # If response is a list, we have a directory
-                    if isinstance(response_json, list):
-                        for file in response_json:
-                            # Check if there are any template files (.md or .yml)
-                            if ".md" in file["path"] or ".yml" in file["path"]:
-                                return Requirement.EvaluateImplResult(
-                                    EvaluateResult.Success,
-                                    f"File {self.github_file} found in directory {location}",
-                                )
-
-                    # If response is a dict, we have a single file
-                    elif isinstance(response_json, dict):
+                if full_file_path.exists():
+                    # If full_file_path is a directory, check if it isn't empty
+                    if full_file_path.is_dir() and any(full_file_path.iterdir()):
                         return Requirement.EvaluateImplResult(
-                            EvaluateResult.Success, f"File {self.github_file} found at {location}"
+                            EvaluateResult.Success,
+                            f"File found in {self.github_file} directory of the repository",
                         )
 
+                    return Requirement.EvaluateImplResult(
+                        EvaluateResult.Success,
+                        f"{self.github_file} found in repository",
+                    )
+
             return Requirement.EvaluateImplResult(
                 EvaluateResult.Error,
                 f"No {self.github_file} file found.",

{repoauditor-0.2.28 → repoauditor-0.2.30}/src/RepoAuditor/Plugins/GitHubCustomization/Module.py

@@ -6,9 +6,6 @@
 # -------------------------------------------------------------------------------
 """Contains the GitHubCustomizationModule object."""
 
-from typing import Any
-from dbrownell_Common.Types import override
-
 from RepoAuditor.Module import ExecutionStyle
 from RepoAuditor.Plugins.GitHubBase.Module import GitHubBaseModule
 from RepoAuditor.Plugins.GitHubCustomization.CustomizationQuery import CustomizationQuery
@@ -27,8 +24,3 @@ class GitHubCustomizationModule(GitHubBaseModule):
             ],
             requires_explicit_include=True,
         )
-
-    @override
-    def Cleanup(self, dynamic_args: dict[str, Any]) -> None:
-        """Clean up any resources created during execution."""
-        # No resources to clean up in the minimal implementation

{repoauditor-0.2.28 → repoauditor-0.2.30}/src/RepoAuditor/Plugins/GitHubCustomization/Requirements/CodeOwners.py

@@ -20,14 +20,9 @@ class CodeOwners(ExistsRequirementImpl):
             "exists",
             "CODEOWNERS",
             [
-                # Upper case variants
                 ".github/CODEOWNERS",
                 "docs/CODEOWNERS",
                 "CODEOWNERS",
-                # Lower case variants
-                ".github/codeowners",
-                "docs/codeowners",
-                "codeowners",
             ],
             textwrap.dedent(
                 """\

{repoauditor-0.2.28 → repoauditor-0.2.30}/src/RepoAuditor/Plugins/GitHubCustomization/Requirements/Contributing.py

@@ -20,14 +20,9 @@ class Contributing(ExistsRequirementImpl):
             "exists",
             "CONTRIBUTING",
             [
-                # Upper case variants
                 ".github/CONTRIBUTING.md",
                 "docs/CONTRIBUTING.md",
                 "CONTRIBUTING.md",
-                # Lower case variants
-                ".github/contributing.md",
-                "docs/contributing.md",
-                "contributing.md",
             ],
             textwrap.dedent(
                 """\

{repoauditor-0.2.28 → repoauditor-0.2.30}/src/RepoAuditor/Plugins/GitHubCustomization/Requirements/IssueTemplates.py

@@ -21,12 +21,8 @@ class IssueTemplates(ExistsRequirementImpl):
                 ".github/ISSUE_TEMPLATE.md",
                 "docs/ISSUE_TEMPLATE.md",
                 "ISSUE_TEMPLATE.md",
-                "docs/issue_template.md",
-                ".github/issue_template.md",
-                "issue_template.md",
                 # Directories
                 ".github/ISSUE_TEMPLATE",
-                ".github/issue_template",
             ],
             "Add issue templates to your repository in the .github/ISSUE_TEMPLATE directory.",
             "Issue templates help contributors create high-quality issues by providing a structured format.",

{repoauditor-0.2.28 → repoauditor-0.2.30}/src/RepoAuditor/Plugins/GitHubCustomization/Requirements/PullRequestTemplates.py

@@ -18,17 +18,11 @@ class PullRequestTemplate(ExistsRequirementImpl):
             "exists",
             "PULL_REQUESTS_TEMPLATE",
             [
-                # Upper case variants
                 ".github/PULL_REQUEST_TEMPLATE.md",
                 "docs/PULL_REQUEST_TEMPLATE.md",
                 "PULL_REQUEST_TEMPLATE.md",
-                # Lower case variants
-                ".github/pull_request_template.md",
-                "docs/pull_request_template.md",
-                "pull_request_template.md",
                 # Directory with multiple templates
                 ".github/PULL_REQUEST_TEMPLATE",
-                ".github/pull_request_template",
             ],
             "Create a pull request template file in one of these locations: .github/PULL_REQUEST_TEMPLATE.md, .github/pull_request_template.md, docs/PULL_REQUEST_TEMPLATE.md, or PULL_REQUEST_TEMPLATE.md",
             "Pull request templates help standardize code contributions and expedite the review process by ensuring consistent PR format.",

{repoauditor-0.2.28 → repoauditor-0.2.30}/src/RepoAuditor/Plugins/GitHubCustomization/Requirements/SecurityPolicy.py

@@ -20,14 +20,9 @@ class SecurityPolicy(ExistsRequirementImpl):
             "exists",
             "SECURITY",
             [
-                # Upper case variants
                 ".github/SECURITY.md",
                 "docs/SECURITY.md",
                 "SECURITY.md",
-                # Lower case variants
-                ".github/security.md",
-                "docs/security.md",
-                "security.md",
             ],
             textwrap.dedent(
                 """\

{repoauditor-0.2.28 → repoauditor-0.2.30}/src/RepoAuditor/Plugins/GitHubRulesets/Impl/EnableRulesetRequirementImpl.py

@@ -20,7 +20,7 @@ class EnableRulesetRequirementImpl(EnableRequirementImpl):
     """Object that implements ruleset settings that can be enabled/disabled."""
 
     # ----------------------------------------------------------------------
-    def __init__(
+    def __init__(  # noqa: PLR0913
         self,
         name: str,
         default_value: bool,  # noqa: FBT001

{repoauditor-0.2.28 → repoauditor-0.2.30}/src/RepoAuditor/Query.py

@@ -129,6 +129,14 @@ class Query(ABC):
             max_num_threads=max_num_threads,
         )
 
+    # ----------------------------------------------------------------------
+    def Cleanup(
+        self,
+        module_data: dict[str, Any],
+    ) -> None:
+        """Clean up any resources created during execution."""
+        del module_data
+
 
 # ----------------------------------------------------------------------
 class StatusInfo:

{repoauditor-0.2.28 → repoauditor-0.2.30}/src/RepoAuditor/__init__.py

@@ -3,4 +3,4 @@ APP_NAME = "RepoAuditor"
 # Note that this value will be overwritten by calls to `python ../../Build.py update_version` based
 # on changes observed in the git repository. The default value below will be used until the value
 # here is explicitly updated by the Continuous Integration system.
-__version__ = "0.2.28"
+__version__ = "0.2.30"

{repoauditor-0.2.28 → repoauditor-0.2.30}/tests/Plugins/GitHubCustomization_EndToEndTest.py

@@ -36,11 +36,18 @@ class TestCustomization:
 
     def test_NoCodeOwners(self, pat_args, snapshot):
         """Test if a CODEOWNERS file does not exist in the repository."""
-        # TODO: How to test if CodeOwners file doesn't exist without updating repo?
-        result = CliRunner().invoke(app, pat_args)
-
-        assert result.exit_code == 0, result.output
-        # assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCustomization-CodeOwners-exists",
+                "--GitHubCustomization-branch",
+                "test-GitHubCustomization",
+            ],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
     def test_Contributing(self, pat_args, snapshot):
         """Test if a CONTRIBUTING.md file exists in the repository."""
@@ -49,6 +56,21 @@ class TestCustomization:
         assert result.exit_code == 0, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
+    def test_NoContributing(self, pat_args, snapshot):
+        """Test if a CONTRIBUTING file does not exist in the repository."""
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCustomization-Contributing-exists",
+                "--GitHubCustomization-branch",
+                "test-GitHubCustomization",
+            ],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
     def test_IssueTemplate(self, pat_args, snapshot):
         """Test if an Issue template file (e.g. ISSUE_TEMPLATE.md) exists in the repository."""
         result = CliRunner().invoke(app, pat_args + ["--GitHubCustomization-IssueTemplates-exists"])
@@ -56,6 +78,21 @@ class TestCustomization:
         assert result.exit_code == 0, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
+    def test_NoIssueTemplate(self, pat_args, snapshot):
+        """Test if no Issue template file exists in the repository."""
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCustomization-IssueTemplates-exists",
+                "--GitHubCustomization-branch",
+                "test-GitHubCustomization",
+            ],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
     def test_PullRequestTemplate(self, pat_args, snapshot):
         """Test if a Pull Request template file (e.g. PULL_REQUEST_TEMPLATE.md) exists in the repository."""
         result = CliRunner().invoke(app, pat_args + ["--GitHubCustomization-PullRequestTemplate-exists"])
@@ -63,6 +100,21 @@ class TestCustomization:
         assert result.exit_code == 0, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
+    def test_NoPullRequestTemplate(self, pat_args, snapshot):
+        """Test if no Pull Request template file exists in the repository."""
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCustomization-PullRequestTemplate-exists",
+                "--GitHubCustomization-branch",
+                "test-GitHubCustomization",
+            ],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
     def test_SecurityPolicy(self, pat_args, snapshot):
         """Test if a Security policy file (e.g. SECURITY.md) exists in the repository."""
         result = CliRunner().invoke(app, pat_args + ["--GitHubCustomization-SecurityPolicy-exists"])
@@ -70,6 +122,21 @@ class TestCustomization:
         assert result.exit_code == 0, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
+    def test_NoSecurityPolicy(self, pat_args, snapshot):
+        """Test if no Security policy file exists in the repository."""
+        result = CliRunner().invoke(
+            app,
+            pat_args
+            + [
+                "--GitHubCustomization-SecurityPolicy-exists",
+                "--GitHubCustomization-branch",
+                "test-GitHubCustomization",
+            ],
+        )
+
+        assert result.exit_code == -1, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
 
 # ----------------------------------------------------------------------
 # ----------------------------------------------------------------------