RepoAuditor 0.2.24__tar.gz → 0.2.26__tar.gz

{repoauditor-0.2.24 → repoauditor-0.2.26}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.24
+Version: 0.2.26
 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.24 → repoauditor-0.2.26}/src/RepoAuditor/Plugins/GitHub/StandardQueryRequirements/SecretScanning.py

@@ -24,12 +24,12 @@ class SecretScanning(StandardEnableRequirementImpl):
             True,
             "false",
             "settings/security_analysis",
-            "Secret scanning",
-            "Secret scanning",
+            "Secret Protection",
+            "Secret protection",
             _GetValue,
             textwrap.dedent(
                 """\
-                The default behavior is to enable secret scanning.
+                The default behavior is to enable secret protection.
 
                 Reasons for this Default
                 ------------------------

{repoauditor-0.2.24 → repoauditor-0.2.26}/src/RepoAuditor/Plugins/GitHub/StandardQueryRequirements/SecretScanningPushProtection.py

@@ -24,7 +24,7 @@ class SecretScanningPushProtection(StandardEnableRequirementImpl):
             True,
             "false",
             "settings/security_analysis",
-            "Secret scanning",
+            "Secret Protection",
             "Push protection",
             _GetValue,
             textwrap.dedent(

repoauditor-0.2.26/src/RepoAuditor/Plugins/GitHubCustomization/CustomizationQuery.py

@@ -0,0 +1,51 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Contains the CustomizationQuery object."""
+
+from typing import Any, Optional
+
+from dbrownell_Common.Types import override  # type: ignore[import-untyped]
+
+from RepoAuditor.Query import ExecutionStyle, Query
+from RepoAuditor.Plugins.GitHubCustomization.Requirements.CodeOwners import CodeOwners
+from RepoAuditor.Plugins.GitHubCustomization.Requirements.Contributing import Contributing
+from RepoAuditor.Plugins.GitHubCustomization.Requirements.IssueTemplates import IssueTemplates
+from RepoAuditor.Plugins.GitHubCustomization.Requirements.PullRequestTemplates import PullRequestTemplate
+from RepoAuditor.Plugins.GitHubCustomization.Requirements.SecurityPolicy import SecurityPolicy
+
+
+class CustomizationQuery(Query):
+    """Query with requirements that check for GitHub customization files."""
+
+    def __init__(self) -> None:
+        super().__init__(
+            "CustomizationQuery",
+            ExecutionStyle.Parallel,
+            [
+                CodeOwners(),
+                Contributing(),
+                IssueTemplates(),
+                PullRequestTemplate(),
+                SecurityPolicy(),
+            ],
+        )
+
+    # ----------------------------------------------------------------------
+    @override
+    def GetData(
+        self,
+        module_data: dict[str, Any],
+    ) -> Optional[dict[str, Any]]:
+        """Get the data from an API session."""
+        response = module_data["session"].get("")
+
+        response.raise_for_status()
+        response = response.json()
+
+        module_data["standard"] = response
+
+        return module_data

repoauditor-0.2.26/src/RepoAuditor/Plugins/GitHubCustomization/Impl/ExistsRequirementImpl.py

@@ -0,0 +1,102 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Contains the ExistsRequirementImpl object."""
+
+from typing import Any
+from collections.abc import Sequence
+
+import typer
+
+from dbrownell_Common.TyperEx import TypeDefinitionItemType  # type: ignore[import-untyped]
+from dbrownell_Common.Types import override  # type: ignore[import-untyped]
+
+from RepoAuditor.Requirement import EvaluateResult, ExecutionStyle, Requirement
+
+
+# ----------------------------------------------------------------------
+class ExistsRequirementImpl(Requirement):
+    """Object that implements check if a file exists."""
+
+    # ----------------------------------------------------------------------
+    def __init__(
+        self,
+        name: str,
+        dynamic_arg_name: str,
+        github_file: str,
+        possible_locations: Sequence[str],
+        resolution: str,
+        rationale: str,
+        *,
+        requires_explicit_include: bool = False,
+    ) -> None:
+        super().__init__(
+            name,
+            f"Validates that {github_file} file exists.",
+            ExecutionStyle.Parallel,
+            resolution,
+            rationale,
+            requires_explicit_include=requires_explicit_include,
+        )
+
+        self.dynamic_arg_name = dynamic_arg_name
+        self.github_file = github_file
+        self.possible_locations = possible_locations
+
+    # ----------------------------------------------------------------------
+    @override
+    def GetDynamicArgDefinitions(self) -> dict[str, TypeDefinitionItemType]:
+        """Get the definitions for the arguments to this requirement."""
+        return {
+            self.dynamic_arg_name: (
+                bool,
+                typer.Option(
+                    False,
+                    help=f"Ensures that the customization file {self.github_file} exists.",
+                ),
+            ),
+        }
+
+    # ----------------------------------------------------------------------
+    @override
+    def _EvaluateImpl(
+        self,
+        query_data: dict[str, Any],
+        requirement_args: dict[str, Any],
+    ) -> 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}")
+
+                # 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):
+                        return Requirement.EvaluateImplResult(
+                            EvaluateResult.Success, f"File {self.github_file} found at {location}"
+                        )
+
+            return Requirement.EvaluateImplResult(
+                EvaluateResult.Error,
+                f"No {self.github_file} file found.",
+                provide_resolution=True,
+                provide_rationale=True,
+            )
+
+        # Requirement flag not set so DoesNotApply
+        return Requirement.EvaluateImplResult(EvaluateResult.DoesNotApply, None)

{repoauditor-0.2.24 → repoauditor-0.2.26}/src/RepoAuditor/Plugins/GitHubCustomization/Module.py

@@ -11,6 +11,7 @@ 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
 
 
 class GitHubCustomizationModule(GitHubBaseModule):
@@ -21,8 +22,10 @@ class GitHubCustomizationModule(GitHubBaseModule):
             "GitHubCustomization",
             "Validates GitHub repository customization files.",
             ExecutionStyle.Parallel,
-            [],  # Empty query list for now
-            requires_explicit_include=False,
+            [
+                CustomizationQuery(),
+            ],
+            requires_explicit_include=True,
         )
 
     @override

repoauditor-0.2.26/src/RepoAuditor/Plugins/GitHubCustomization/Requirements/CodeOwners.py

@@ -0,0 +1,56 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Contains the CodeOwners requirement."""
+
+import textwrap
+
+from RepoAuditor.Plugins.GitHubCustomization.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+
+
+class CodeOwners(ExistsRequirementImpl):
+    """Validates that CODEOWNERS file is configured."""
+
+    def __init__(self) -> None:
+        super().__init__(
+            "CodeOwners",
+            "exists",
+            "CODEOWNERS",
+            [
+                # Upper case variants
+                ".github/CODEOWNERS",
+                "docs/CODEOWNERS",
+                "CODEOWNERS",
+                # Lower case variants
+                ".github/codeowners",
+                "docs/codeowners",
+                "codeowners",
+            ],
+            textwrap.dedent(
+                """\
+                1) Create a CODEOWNERS file in one of these locations:
+                   - .github/CODEOWNERS
+                   - docs/CODEOWNERS
+                   - CODEOWNERS
+
+                Example CODEOWNERS file format:
+                # Syntax example:
+                # directory/ @username
+                # *.js @username
+                # /docs/ @username @username2
+                """
+            ),
+            textwrap.dedent(
+                """\
+                CODEOWNERS files define who is responsible for code review.
+
+                Benefits:
+                - Automatic reviewer assignment
+                - Clear code ownership
+                - Streamlined review process
+                """
+            ),
+        )

repoauditor-0.2.26/src/RepoAuditor/Plugins/GitHubCustomization/Requirements/Contributing.py

@@ -0,0 +1,53 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Contains the Contributing requirement."""
+
+import textwrap
+
+from RepoAuditor.Plugins.GitHubCustomization.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+
+
+class Contributing(ExistsRequirementImpl):
+    """Validates that a contributing guide is configured."""
+
+    def __init__(self) -> None:
+        super().__init__(
+            "Contributing",
+            "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(
+                """\
+                1) Create a contributing guide in one of these locations:
+                   - .github/CONTRIBUTING.md
+                   - docs/CONTRIBUTING.md
+                   - CONTRIBUTING.md
+
+                Example template can be found at:
+                https://github.com/nayafia/contributing-template/blob/master/CONTRIBUTING-template.md
+                """
+            ),
+            textwrap.dedent(
+                """\
+                Contributing guides help new contributors understand how to participate.
+
+                Benefits:
+                - Clear contribution process
+                - Consistent code quality
+                - Better community engagement
+                """
+            ),
+        )

repoauditor-0.2.26/src/RepoAuditor/Plugins/GitHubCustomization/Requirements/IssueTemplates.py

@@ -0,0 +1,33 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Contains the IssueTemplates requirement."""
+
+from RepoAuditor.Plugins.GitHubCustomization.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+
+
+class IssueTemplates(ExistsRequirementImpl):
+    """Requirement that checks for the presence of issue templates."""
+
+    def __init__(self) -> None:
+        super().__init__(
+            "IssueTemplates",
+            "exists",
+            "ISSUE_TEMPLATES",
+            [
+                ".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.26/src/RepoAuditor/Plugins/GitHubCustomization/Requirements/PullRequestTemplates.py

@@ -0,0 +1,35 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Contains the PullRequestTemplate requirement."""
+
+from RepoAuditor.Plugins.GitHubCustomization.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+
+
+class PullRequestTemplate(ExistsRequirementImpl):
+    """Validates that a pull request template is configured."""
+
+    def __init__(self) -> None:
+        super().__init__(
+            "PullRequestTemplate",
+            "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.26/src/RepoAuditor/Plugins/GitHubCustomization/Requirements/SecurityPolicy.py

@@ -0,0 +1,53 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Contains the SecurityPolicy requirement."""
+
+import textwrap
+
+from RepoAuditor.Plugins.GitHubCustomization.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+
+
+class SecurityPolicy(ExistsRequirementImpl):
+    """Validates that a security policy is configured."""
+
+    def __init__(self) -> None:
+        super().__init__(
+            "SecurityPolicy",
+            "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(
+                """\
+                1) Create a security policy file in one of these locations:
+                   - .github/SECURITY.md
+                   - docs/SECURITY.md
+                   - SECURITY.md
+
+                Example policy can be found at:
+                https://github.com/gt-sse-center/RepoAuditor/blob/main/SECURITY.md
+                """
+            ),
+            textwrap.dedent(
+                """\
+                Security policies help users report vulnerabilities responsibly.
+
+                Benefits:
+                - Clear security reporting process
+                - Responsible disclosure guidelines
+                - Better security management
+                """
+            ),
+        )

{repoauditor-0.2.24 → repoauditor-0.2.26}/src/RepoAuditor/Plugins/GitHubCustomizationPlugin.py

@@ -10,8 +10,7 @@ import pluggy
 
 from RepoAuditor import APP_NAME
 from RepoAuditor.Module import Module
-
-from .GitHubCustomization.Module import GitHubCustomizationModule
+from RepoAuditor.Plugins.GitHubCustomization.Module import GitHubCustomizationModule
 
 
 # ----------------------------------------------------------------------

{repoauditor-0.2.24 → repoauditor-0.2.26}/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.24"
+__version__ = "0.2.26"

repoauditor-0.2.26/tests/Plugins/GitHubCustomization_EndToEndTest.py

@@ -0,0 +1,96 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""End-to-end tests for the GitHubCustomization plugin."""
+
+import pytest
+from pathlib import Path
+
+from dbrownell_Common.TestHelpers.StreamTestHelpers import (
+    InitializeStreamCapabilities,
+)
+from typer.testing import CliRunner
+
+from RepoAuditor.EntryPoint import app
+
+from utilities import ScrubDurationGithuburlAndSpaces, GetGithubUrl, CheckPATFileExists
+
+# ----------------------------------------------------------------------
+pytest.fixture(InitializeStreamCapabilities(), scope="session", autouse=True)
+
+
+# ----------------------------------------------------------------------
+class TestCustomization:
+    """End-to-end tests for customization files in a GitHub repository."""
+
+    # ----------------------------------------------------------------------
+    def test_CodeOwners(self, pat_args, snapshot):
+        """Test if a CODEOWNERS file exists in the repository."""
+        result = CliRunner().invoke(app, pat_args + ["--GitHubCustomization-CodeOwners-exists"])
+
+        assert result.exit_code == 0, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+    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
+
+    def test_Contributing(self, pat_args, snapshot):
+        """Test if a CONTRIBUTING.md file exists in the repository."""
+        result = CliRunner().invoke(app, pat_args + ["--GitHubCustomization-Contributing-exists"])
+
+        assert result.exit_code == 0, 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"])
+
+        assert result.exit_code == 0, 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"])
+
+        assert result.exit_code == 0, 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"])
+
+        assert result.exit_code == 0, result.output
+        assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
+
+
+# ----------------------------------------------------------------------
+# ----------------------------------------------------------------------
+# ----------------------------------------------------------------------
+@pytest.fixture
+def args() -> list[str]:
+    return [
+        "--include",
+        "GitHubCustomization",
+        "--GitHubCustomization-url",
+        GetGithubUrl(),
+    ]
+
+
+# ----------------------------------------------------------------------
+@pytest.fixture
+def pat_args(args) -> list[str]:
+    _github_pat_filename = (Path(__file__).parent / "github_pat.txt").resolve()
+    CheckPATFileExists(_github_pat_filename)
+
+    with _github_pat_filename.open() as f:
+        pat_value = f.read().strip()
+
+    return args + ["--GitHubCustomization-pat", pat_value]

{repoauditor-0.2.24 → repoauditor-0.2.26}/tests/Plugins/GitHubCustomization_UnitTest.py

@@ -7,8 +7,8 @@
 """Unit tests for the GitHub Customization Plugin"""
 
 import sys
-import pytest
 import pluggy
+from pathlib import Path
 
 from RepoAuditor import APP_NAME
 from RepoAuditor.Plugins.GitHubCustomizationPlugin import GetModule
@@ -54,17 +54,38 @@ def test_plugin_registration():
 
 
 # ----------------------------------------------------------------------
-def test_module_initialization():
-    """Test that the module initializes correctly."""
-    module = GetModule()
-
-    assert module is not None
-    assert module.name == "GitHubCustomization"
-    # Comment out checks that would fail with minimal implementation
-    # assert module.execution_style.name == "Parallel"
-    # assert len(module.queries) == 1
-    # assert isinstance(module.queries[0], CustomizationQuery)
-    # assert module.requires_explicit_include is False
+class TestGitHubCustomizationModule:
+    """Unit tests for the GitHubCustomizaton module."""
+
+    def test_Construct(self):
+        """Test that the module initializes correctly."""
+        module = GetModule()
+
+        assert module is not None
+        assert module.name == "GitHubCustomization"
+        # Comment out checks that would fail with minimal implementation
+        # assert module.execution_style.name == "Parallel"
+        # assert len(module.queries) == 1
+        # assert isinstance(module.queries[0], CustomizationQuery)
+        # assert module.requires_explicit_include is False
+
+    def test_GetDynamicArgDefinitions(self):
+        """Test GetDynamicArgDefinitions method."""
+        module = GetModule()
+        dynamic_args = module.GetDynamicArgDefinitions()
+        # dynamic_args should be empty dict
+        assert dynamic_args.keys() == {"url": "", "pat": "", "branch": ""}.keys()
+
+    def test_GenerateInitialData(self):
+        """Test GenerateInitialData method."""
+        dynamic_args = {
+            "url": "https://github.com/gt-sse-center/RepoAuditor",
+            "pat": Path(__file__).parent / "dummy_github_pat.txt",
+        }
+        module = GetModule()
+        updated_dynamic_args = module.GenerateInitialData(dynamic_args)
+        # Currently no change in dynamic_args
+        assert updated_dynamic_args == dynamic_args
 
 
 # ----------------------------------------------------------------------