RepoAuditor 0.2.76__tar.gz → 0.2.77__tar.gz

{repoauditor-0.2.76 → repoauditor-0.2.77}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.76
+Version: 0.2.77
 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.76 → repoauditor-0.2.77}/src/RepoAuditor/Display.py

@@ -7,7 +7,7 @@
 """Contains functionality to display the results of executing modules."""
 
 import textwrap
-from typing import Optional
+from typing import IO, Optional
 
 from dbrownell_Common import TextwrapEx  # type: ignore[import-untyped]
 from dbrownell_Common.Streams.DoneManager import DoneManager  # type: ignore[import-untyped]
@@ -128,8 +128,22 @@ def DisplayResults(
     display_resolution: bool,
     display_rationale: bool,
     panel_width: Optional[int] = None,
+    file: Optional[IO[str]] = None,
 ) -> None:
-    """Display the results of executing the modules."""
+    """Display the results of executing the modules.
+
+    Args:
+        dm (DoneManager): Manager of all the tasks that need to be executed.
+        all_results (list[list[Module.EvaluateInfo]]): List of results of executing each module.
+        display_resolution (bool): Flag indicating if the resolution steps should be displayed in the output.
+        display_rationale (bool): Flag indicating if the rationale for the error should be displayed in the output.
+        panel_width (Optional[int], optional): The width of the output panel. Defaults to None.
+        file (Optional[IO[str]], optional): File to write to, or None for stdout. Defaults to None.
+
+    Raises:
+        RuntimeError: Exception if printing or writing to file encounters any issue.
+
+    """
     for results in all_results:
         assert results
         module = results[0].module
@@ -173,4 +187,5 @@ def DisplayResults(
                 title=results[0].module.name,
                 width=panel_width,
             ),
+            file=file,
         )

{repoauditor-0.2.76 → repoauditor-0.2.77}/src/RepoAuditor/EntryPoint.py

@@ -6,10 +6,12 @@
 # ----------------------------------------------------------------------
 """Audits a repository against a set of requirements."""
 
+import contextlib
 import os
 import sys
 import textwrap
 import traceback
+from pathlib import Path
 from typing import Annotated, Optional
 
 import pluggy
@@ -91,11 +93,7 @@ def TypeInfoToString(
         python_type = type_info
         parameter_info = None
 
-    return "    {arg_name:<50} {type_description:<7} {help}".format(
-        arg_name=arg_name,
-        type_description=python_type.__name__,
-        help="" if parameter_info is None else parameter_info.help,
-    )
+    return f"    {arg_name:<50} {python_type.__name__:<7} {parameter_info.help if parameter_info else ''}"
 
 
 # ----------------------------------------------------------------------
@@ -265,6 +263,13 @@ def EntryPoint(  # noqa: PLR0913  # pragma: no cover
             help="Write verbose information to the terminal.",
         ),
     ] = False,
+    output: Annotated[
+        Optional[str],
+        typer.Option(
+            "--output",
+            help="File name to save the output to.",
+        ),
+    ] = None,
     debug: Annotated[  # noqa: FBT002
         bool,
         typer.Option(
@@ -320,13 +325,19 @@ def EntryPoint(  # noqa: PLR0913  # pragma: no cover
                 # in which case default to None
                 panel_width = None
 
-            DisplayResults(
-                dm,
-                all_results,
-                display_resolution=not no_resolution,
-                display_rationale=not no_rationale,
-                panel_width=panel_width,
-            )
+            # Since `output` can be None, we use the nullcontext manager to represent None
+            with (
+                Path.open(output, mode="w+", encoding="UTF-8") if output else contextlib.nullcontext() as file
+            ):
+                DisplayResults(
+                    dm,
+                    all_results,
+                    display_resolution=not no_resolution,
+                    display_rationale=not no_rationale,
+                    panel_width=panel_width,
+                    file=file,
+                )
+
         except Exception as ex:
             error = traceback.format_exc() if dm.is_debug else str(ex)
             dm.WriteError(error)

{repoauditor-0.2.76 → repoauditor-0.2.77}/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.2.76"
+__version__ = "0.2.77"

{repoauditor-0.2.76 → repoauditor-0.2.77}/tests/Plugins/GitHub_EndToEndTest.py

@@ -31,6 +31,17 @@ def test_Successful(pat_args, snapshot):
     assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
 
+# ----------------------------------------------------------------------
+def test_Successful_To_File(pat_args, tmp_path, snapshot):
+    """Test if all requirements of the GitHub plugin successfully pass and the output is written to a file."""
+    output = tmp_path / "repo_auditor_output.txt"
+    result = CliRunner().invoke(app, pat_args + ["--output", str(output), "--verbose"])
+
+    assert result.exit_code == 0, result.output
+    with open(output, mode="r") as file:
+        assert ScrubDurationGithuburlAndSpaces(file.read()) == snapshot
+
+
 # ----------------------------------------------------------------------
 def _skip_test_NoPAT():
     operating_system = os.getenv("GITHUB_CI_OPERATING_SYSTEM")

{repoauditor-0.2.76 → repoauditor-0.2.77}/tests/Plugins/__snapshots__/GitHub_EndToEndTest.ambr

@@ -2266,5 +2266,237 @@
   Results: DONE! (0, <scrubbed duration>)
   
   
+  '''
+# ---
+# name: test_Successful_To_File
+  '''
+  ╭─────────────────────────────────────────────────────── GitHub ───────────────────────────────────────────────────────╮
+  │                                                                                                                      │
+  │ Validates GitHub configuration settings.                                                                             │
+  │                                                                                                                      │
+  │                                                                                                                      │
+  │ Successful:     38 (97.44%)                                                                                          │
+  │ Warnings:       0 (0.00%)                                                                                            │
+  │ Errors:         0 (0.00%)                                                                                            │
+  │ Skipped:        1 (2.56%)                                                                                            │
+  │                                                                                                                      │
+  │ ╭─ [Success] AutoMerge ────────────────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Allow auto-merge' is set to True.                                                                │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] DefaultBranch ────────────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Default Branch' is set to 'main'.                                                                │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] DeleteHeadBranches ───────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Automatically delete head branches' is set to True.                                              │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] Description ──────────────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates if the repository has a description.                                                                   │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] DependabotSecurityUpdates ────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Dependabot security updates' is set to True.                                                     │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] License ──────────────────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'License' is set to 'MIT License'.                                                                │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] MergeCommit ──────────────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Allow merge commits' is set to True.                                                             │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] MergeCommitMessage ───────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Allow merge commits -> Default...' is set to 'BLANK'.                                            │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] Private ──────────────────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that the repository's visibility is set to 'public'.                                                   │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] RebaseMergeCommit ────────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Allow rebase merging' is set to False.                                                           │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] SecretScanning ───────────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Secret protection' is set to True.                                                               │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] SecretScanningPushProtection ─────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Push protection' is set to True.                                                                 │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] SquashCommitMerge ────────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Allow squash merging' is set to False.                                                           │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [DoesNotApply] SquashMergeCommitMessage ────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Allow squash merging -> Default...' is set to 'COMMIT_MESSAGES'.                                 │ │
+  │ │                                                                                                                  │ │
+  │ │ DOESNOTAPPLY: Squash merge commits are not enabled.                                                              │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] SuggestUpdatingPullRequestBranches ───────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Always suggest updating pull request branches' is set to False.                                  │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] SupportDiscussions ───────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that Support for Discussions is set to False.                                                          │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] SupportIssues ────────────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that Support for Issues is set to True.                                                                │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] SupportProjects ──────────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that Support for Projects is set to True.                                                              │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] SupportWikis ─────────────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that Support for Wikis is set to True.                                                                 │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] TemplateRepository ───────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Template repository' is set to False.                                                            │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] WebCommitSignoff ─────────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Require contributors to sign off on web-based commits' is set to True.                           │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] Protected ────────────────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Ensures that the mainline branch is protected.                                                                   │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] AllowDeletions ───────────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Allow deletions' is set to False.                                                                │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] AllowMainlineForcePushes ─────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Allow force pushes' is set to False.                                                             │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] DismissStalePullRequestApprovals ─────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Require a pull request before merging -> Dismiss stale pull request approvals when new commits   │ │
+  │ │ are pushed' is set to True.                                                                                      │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] DoNotAllowBypassSettings ─────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Do not allow bypassing the above settings' is set to True.                                       │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] EnsureStatusChecks ───────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Ensure that status checks have been enabled for the 'main' branch.                                               │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] RequireApprovalMostRecentPush ────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Require a pull request before merging -> Require approval of the most recent reviewable push' is │ │
+  │ │ set to True.                                                                                                     │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] RequireApprovals ─────────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Require a pull request before merging -> Require approvals' is set to '1'.                       │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] RequireCodeOwnerReview ───────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Require a pull request before merging -> Require review from Code Owners' is set to False.       │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] RequireConversationResolution ────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Require conversation resolution before merging' is set to True.                                  │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] RequireLinearHistory ─────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Require linear history' is set to False.                                                         │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] RequirePullRequests ──────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Require a pull request before merging' is set to True.                                           │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] RequireSignedCommits ─────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Require signed commits' is set to True.                                                          │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] RequireStatusChecksToPass ────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Require status checks to pass before merging' is set to True.                                    │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] RequireUpToDateBranches ──────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Require status checks to pass before merging -> Require branches to be up to date before         │ │
+  │ │ merging' is set to True.                                                                                         │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] RequireStatusChecksRule ──────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Require status checks to pass' is set to True.                                                   │ │
+  │ │                                                                                                                  │ │
+  │ │ SUCCESS: 'Require status checks to pass' is enabled in Ruleset 'Protect Main'                                    │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] RequirePullRequestsRule ──────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Require a pull request before merging' is set to True.                                           │ │
+  │ │                                                                                                                  │ │
+  │ │ SUCCESS: 'Require a pull request before merging' is enabled in Ruleset 'Protect Main'                            │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ [Success] RequireSignedCommitsRule ─────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │ Validates that 'Require signed commits' is set to True.                                                          │ │
+  │ │                                                                                                                  │ │
+  │ │ SUCCESS: 'Require signed commits' is enabled in Ruleset 'Protect Main'                                           │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │ ╭─ Metrics ────────────────────────────────────────────────────────────────────────────────────────────────────────╮ │
+  │ │                                                                                                                  │ │
+  │ │                                                                                                                  │ │
+  │ │ Successful:     38 (97.44%)                                                                                      │ │
+  │ │ Warnings:       0 (0.00%)                                                                                        │ │
+  │ │ Errors:         0 (0.00%)                                                                                        │ │
+  │ │ Skipped:        1 (2.56%)                                                                                        │ │
+  │ │                                                                                                                  │ │
+  │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
+  │                                                                                                                      │
+  ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+  
   '''
 # ---