RepoAuditor 0.2.23__tar.gz → 0.2.24__tar.gz

{repoauditor-0.2.23 → repoauditor-0.2.24}/.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.24}/.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.24/.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.24}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.23
+Version: 0.2.24
 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.24}/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.24}/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.24}/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.24}/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.24}/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.24}/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.24}/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.24}/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.24}/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.24}/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.23 → repoauditor-0.2.24}/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.23"
+__version__ = "0.2.24"

{repoauditor-0.2.23 → repoauditor-0.2.24}/tests/Plugins/GitHub_EndToEndTest.py

@@ -21,10 +21,6 @@ from RepoAuditor.EntryPoint import app
 
 from utilities import ScrubDurationGithuburlAndSpaces, GetGithubUrl, CheckPATFileExists
 
-# ----------------------------------------------------------------------
-_github_pat_filename = (Path(__file__).parent / "github_pat.txt").resolve()
-CheckPATFileExists(_github_pat_filename)
-
 # ----------------------------------------------------------------------
 pytest.fixture(InitializeStreamCapabilities(), scope="session", autouse=True)
 
@@ -391,6 +387,9 @@ def args() -> list[str]:
 # ----------------------------------------------------------------------
 @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()