RepoAuditor 0.2.23__tar.gz → 0.2.25__tar.gz

{repoauditor-0.2.23 → repoauditor-0.2.25}/.github/workflows/CICD.yml

@@ -36,4 +36,3 @@ jobs:
       MINISIGN_PRIVATE_KEY: ${{ secrets.MINISIGN_PRIVATE_KEY }}
       PYPI_PUBLISH_TOKEN: ${{ secrets.PYPI_PUBLISH_TOKEN }}
       COVERAGE_BADGE_GIST_TOKEN: ${{ secrets.COVERAGE_BADGE_GIST_TOKEN }}
-      TESTING_GITHUB_PAT: ${{ secrets.TESTING_GITHUB_PAT }}

{repoauditor-0.2.23 → repoauditor-0.2.25}/.github/workflows/CICD_impl.yml

@@ -41,10 +41,6 @@ on:
         required: false
         description: "Token used to access the Gist used to store coverage badge information. Code coverage information will not be persisted if this value is missing."
 
-      TESTING_GITHUB_PAT:
-        required: true
-        description: "GitHub PAT used by tests to access the repository. This value is required."
-
 jobs:
   # ----------------------------------------------------------------------
   validate:
@@ -70,30 +66,11 @@ jobs:
           python-version: ${{ matrix.python_version }}
           enable-cache: true
 
-      # Ensure that the github PAT is available for the tests
-      - name: Create github_pat.txt
-        run: |
-          echo ${{ secrets.TESTING_GITHUB_PAT }} > tests/Plugins/github_pat.txt
-
-      - name: Environment Variables (!Windows)
-        shell: bash
-        if: ${{ ! startsWith(matrix.os, 'windows') }}
-        run: |
-          echo "GITHUB_CI_OPERATING_SYSTEM=${{ matrix.os }}" >> $GITHUB_ENV
-          echo "GITHUB_CI_PYTHON_VERSION=${{ matrix.python_version }}" >> $GITHUB_ENV
-
-      - name: Environment Variables (Windows)
-        shell: cmd
-        if: ${{ startsWith(matrix.os, 'windows') }}
-        run: |
-          echo GITHUB_CI_OPERATING_SYSTEM=${{ matrix.os }} >> %GITHUB_ENV%
-          echo GITHUB_CI_PYTHON_VERSION=${{ matrix.python_version }} >> %GITHUB_ENV%
-
       - name: Run pre-commit scripts
         run: uv run pre-commit run --verbose
 
       - name: Validate Tests
-        run: uv run pytest
+        run: uv run pytest -k 'not EndToEndTest' --cov-fail-under=80.0
         env:
           COVERAGE_FILE: .coverage.${{ matrix.os }}.${{ matrix.python_version }}
 

repoauditor-0.2.25/.github/workflows/EndToEnd.yml

@@ -0,0 +1,48 @@
+name: "End To End Tests"
+run-name: EndToEnd ${{ github.run_number }} [${{ github.actor }}] on ${{ github.ref_name }}
+
+on:
+  schedule:
+    - cron: '0 * * * *' # Once every hour
+  workflow_dispatch:
+
+jobs:
+  validate:
+    strategy:
+      fail-fast: false
+
+      matrix:
+        # Since the system under test here is the GitHub API, it is sufficient to test using only a single OS.
+        os: ["ubuntu-latest"]
+        # Similar to OS, we only test the lowest and highest supported versions.
+        python_version: ["3.10", "3.13"]
+
+    name: Validate
+    runs-on: ${{ matrix.os }}
+
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and python
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python_version }}
+          enable-cache: true
+
+      # Ensure that the github PAT is available for the tests
+      # GitHub PAT used by tests to access the repository.
+      - name: Create github_pat.txt
+        run: |
+          echo ${{ secrets.TESTING_GITHUB_PAT }} > tests/Plugins/github_pat.txt
+
+      - name: Environment Variables
+        shell: bash
+        run: |
+          echo "GITHUB_CI_OPERATING_SYSTEM=${{ matrix.os }}" >> $GITHUB_ENV
+          echo "GITHUB_CI_PYTHON_VERSION=${{ matrix.python_version }}" >> $GITHUB_ENV
+
+      - name: Validate Tests
+        run: uv run pytest -k EndToEndTest --no-cov

{repoauditor-0.2.23 → repoauditor-0.2.25}/PKG-INFO

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

@@ -83,7 +83,7 @@ select = [
     "ASYNC",
     "S",
     "BLE",
-    # "FBT", # 44
+    "FBT",
     "B",
     "A",
     "COM",
@@ -148,6 +148,7 @@ ignore = [
     "D107", # Missing docstring in `__init__` method
     "D202", # No blank lines allowed after function docstring
     "E501", # Line too long
+    "FBT003", # Boolean positional argument in function call
     "I001", # Import block is un-sorted or un-formatted
     "N802", # Function name `xxx` should be lowercase
     "N999", # Invalid module name

{repoauditor-0.2.23 → repoauditor-0.2.25}/src/RepoAuditor/Display.py

@@ -21,8 +21,8 @@ from .Module import EvaluateResult, Module
 def GetInternalPanelContent(
     dm: DoneManager,
     results: list[Module.EvaluateInfo],
-    display_resolution: bool,
-    display_rationale: bool,
+    display_resolution: bool,  # noqa: FBT001
+    display_rationale: bool,  # noqa: FBT001
     num_success: int,
     num_warning: int,
     num_error: int,

{repoauditor-0.2.23 → repoauditor-0.2.25}/src/RepoAuditor/EntryPoint.py

@@ -168,7 +168,7 @@ def _HelpEpilog() -> str:
 
 
 # ----------------------------------------------------------------------
-def _VersionCallback(value: bool) -> None:
+def _VersionCallback(value: bool) -> None:  # noqa: FBT001
     if value:
         sys.stdout.write(f"RepoAuditor v{__version__}\n")
         raise typer.Exit()
@@ -184,7 +184,7 @@ def _VersionCallback(value: bool) -> None:
 )
 def EntryPoint(
     ctx: typer.Context,
-    version: Annotated[  # noqa: ARG001
+    version: Annotated[  # noqa: ARG001, FBT002
         bool,
         typer.Option(
             "--version",
@@ -221,38 +221,38 @@ def EntryPoint(
             help="Name of a module whose warnings should be ignored. This value can be provided multiple times.",
         ),
     ] = None,
-    all_warnings_as_error: Annotated[
+    all_warnings_as_error: Annotated[  # noqa: FBT002
         bool, typer.Option("--all-warnings-as-error", help="Treat all warnings as errors.")
     ] = False,
-    ignore_all_warnings: Annotated[
+    ignore_all_warnings: Annotated[  # noqa: FBT002
         bool, typer.Option("--ignore-all-warnings", help="Ignore all warnings.")
     ] = False,
-    single_threaded: Annotated[
+    single_threaded: Annotated[  # noqa: FBT002
         bool,
         typer.Option("--single-threaded", help="Do not use multiple threads when evaluating requirements."),
     ] = False,
-    no_resolution: Annotated[
+    no_resolution: Annotated[  # noqa: FBT002
         bool,
         typer.Option(
             "--no-resolution",
             help="Do not display resolution information for requirements that are not successful.",
         ),
     ] = False,
-    no_rationale: Annotated[
+    no_rationale: Annotated[  # noqa: FBT002
         bool,
         typer.Option(
             "--no-rationale",
             help="Do not display rationale information for requirements that are not successful.",
         ),
     ] = False,
-    verbose: Annotated[
+    verbose: Annotated[  # noqa: FBT002
         bool,
         typer.Option(
             "--verbose",
             help="Write verbose information to the terminal.",
         ),
     ] = False,
-    debug: Annotated[
+    debug: Annotated[  # noqa: FBT002
         bool,
         typer.Option(
             "--debug",

{repoauditor-0.2.23 → repoauditor-0.2.25}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/EnsureStatusChecks.py

@@ -61,7 +61,7 @@ class EnsureStatusChecks(Requirement):
             "disable": (
                 bool,
                 typer.Option(
-                    False,
+                    default=False,
                     help="If set, status checks will not be enforced.",
                 ),
             ),

{repoauditor-0.2.23 → repoauditor-0.2.25}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/Impl/ClassicEnableRequirementImpl.py

@@ -22,7 +22,7 @@ class ClassicEnableRequirementImpl(EnableRequirementImpl):
     def __init__(
         self,
         name: str,
-        default_value: bool,
+        default_value: bool,  # noqa: FBT001
         dynamic_arg_name: str,
         github_settings_section: str,
         github_settings_value: str,

{repoauditor-0.2.23 → repoauditor-0.2.25}/src/RepoAuditor/Plugins/GitHub/DefaultBranchQueryRequirements/Protected.py

@@ -60,7 +60,7 @@ class Protected(Requirement):
             "false": (
                 bool,
                 typer.Option(
-                    False,
+                    default=False,
                     help="Allow an unprotected mainline branch.",
                 ),
             ),

{repoauditor-0.2.23 → repoauditor-0.2.25}/src/RepoAuditor/Plugins/GitHub/Impl/EnableRequirementImpl.py

@@ -27,7 +27,7 @@ class EnableRequirementImpl(Requirement):
     def __init__(
         self,
         name: str,
-        default_value: bool,
+        default_value: bool,  # noqa: FBT001
         dynamic_arg_name: str,
         github_settings_value: str,
         get_configuration_value_func: Callable[[dict[str, Any]], Optional[bool]],

{repoauditor-0.2.23 → repoauditor-0.2.25}/src/RepoAuditor/Plugins/GitHub/StandardQueryRequirements/Description.py

@@ -60,7 +60,7 @@ class Description(Requirement):
             "allow-empty": (
                 bool,
                 typer.Option(
-                    False,
+                    default=False,
                     help="Allow an empty repository description.",
                 ),
             ),

{repoauditor-0.2.23 → repoauditor-0.2.25}/src/RepoAuditor/Plugins/GitHub/StandardQueryRequirements/Impl/StandardEnableRequirementImpl.py

@@ -22,7 +22,7 @@ class StandardEnableRequirementImpl(EnableRequirementImpl):
     def __init__(
         self,
         name: str,
-        default_value: bool,
+        default_value: bool,  # noqa: FBT001
         dynamic_arg_name: str,
         github_settings_url_suffix: str,
         github_settings_section: str,

{repoauditor-0.2.23 → repoauditor-0.2.25}/src/RepoAuditor/Plugins/GitHub/StandardQueryRequirements/Private.py

@@ -59,7 +59,7 @@ class Private(Requirement):
             "true": (
                 bool,
                 typer.Option(
-                    False,
+                    default=False,
                     help="Ensures that the repository's visibility is set to private.",
                 ),
             ),

repoauditor-0.2.25/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.25/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.23 → repoauditor-0.2.25}/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.25/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.25/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.25/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.25/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.",
+        )