RepoAuditor 0.2.34__tar.gz → 0.2.35__tar.gz

{repoauditor-0.2.34 → repoauditor-0.2.35}/.github/workflows/CICD_impl.yml

@@ -70,7 +70,7 @@ jobs:
         run: uv run pre-commit run --verbose
 
       - name: Validate Tests
-        run: uv run pytest -k 'not EndToEndTest' --cov-fail-under=80.0
+        run: uv run pytest -k 'not EndToEndTest' --cov-fail-under=90.0
         env:
           COVERAGE_FILE: .coverage.${{ matrix.os }}.${{ matrix.python_version }}
 

{repoauditor-0.2.34 → repoauditor-0.2.35}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.34
+Version: 0.2.35
 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.34 → repoauditor-0.2.35}/src/RepoAuditor/EntryPoint.py

@@ -35,9 +35,9 @@ class NaturalOrderGrouper(TyperGroup):
     """Group commands in natural order."""
 
     # ----------------------------------------------------------------------
-    def list_commands(self, *args, **kwargs) -> list[str]:  # noqa: ARG002
+    def list_commands(self, *args, **kwargs) -> list[str]:  # noqa: ARG002  # pragma: no cover
         """Return a list of all the commands, to be sorted in a natural ordering."""
-        return self.commands.keys()
+        return list(self.commands.keys())
 
 
 # ----------------------------------------------------------------------
@@ -64,31 +64,42 @@ _all_modules = _GetModules()
 del _GetModules
 
 
+# ----------------------------------------------------------------------
+def TypeInfoToString(
+    arg_name: str,
+    type_info: TyperEx.TypeDefinitionItemType,
+) -> str:
+    """Convert type information from command line arguments to a string representation.
+
+    Args:
+        arg_name (str): The name of the command line argument.
+        type_info (TyperEx.TypeDefinitionItemType): Type information for the accepted value.
+
+    Returns:
+        str: String description of the command line argument.
+
+    """
+    if isinstance(type_info, TyperEx.TypeDefinitionItem):
+        python_type = type_info.python_type
+        parameter_info = type_info.parameter_info
+    elif isinstance(type_info, tuple):
+        python_type = type_info[0]
+        parameter_info = type_info[1]
+    else:
+        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,
+    )
+
+
 # ----------------------------------------------------------------------
 def _HelpEpilog() -> str:
     content: list[str] = []
 
-    # ----------------------------------------------------------------------
-    def TypeInfoToString(
-        arg_name: str,
-        type_info: TyperEx.TypeDefinitionItemType,
-    ) -> str:
-        if isinstance(type_info, TyperEx.TypeDefinitionItem):
-            python_type = type_info.python_type
-            parameter_info = type_info.parameter_info
-        elif isinstance(type_info, tuple):
-            python_type = type_info[0]
-            parameter_info = type_info[1]
-        else:
-            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,
-        )
-
     # ----------------------------------------------------------------------
 
     for module in _all_modules:
@@ -181,7 +192,7 @@ def _VersionCallback(value: bool) -> None:  # noqa: FBT001
     epilog=_HelpEpilog(),
     no_args_is_help=False,
 )
-def EntryPoint(  # noqa: PLR0913
+def EntryPoint(  # noqa: PLR0913  # pragma: no cover
     ctx: typer.Context,
     version: Annotated[  # noqa: ARG001, FBT002
         bool,

{repoauditor-0.2.34 → repoauditor-0.2.35}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/DismissStalePullRequestApprovals.py

@@ -54,4 +54,4 @@ def _GetValue(
     if settings is None:
         return None
 
-    return settings["dismiss_stale_reviews"]
+    return settings.get("dismiss_stale_reviews", None)

{repoauditor-0.2.34 → repoauditor-0.2.35}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequireApprovalMostRecentPush.py

@@ -53,4 +53,4 @@ def _GetValue(
     if settings is None:
         return None
 
-    return settings["require_last_push_approval"]
+    return settings.get("require_last_push_approval", None)

{repoauditor-0.2.34 → repoauditor-0.2.35}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequireApprovals.py

@@ -55,4 +55,4 @@ def _GetValue(
     if settings is None:
         return None
 
-    return settings["required_approving_review_count"]
+    return settings.get("required_approving_review_count", None)

{repoauditor-0.2.34 → repoauditor-0.2.35}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequireCodeOwnerReview.py

@@ -57,4 +57,4 @@ def _GetValue(
     if settings is None:
         return None
 
-    return settings["require_code_owner_reviews"]
+    return settings.get("require_code_owner_reviews", None)

{repoauditor-0.2.34 → repoauditor-0.2.35}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequireUpToDateBranches.py

@@ -55,4 +55,4 @@ def _GetValue(
     if settings is None:
         return None
 
-    return settings["strict"]
+    return settings.get("strict", None)

{repoauditor-0.2.34 → repoauditor-0.2.35}/src/RepoAuditor/Plugins/GitHub/StandardQueryRequirements/Description.py

@@ -73,11 +73,10 @@ class Description(Requirement):
     ) -> Requirement.EvaluateImplResult:
         standard_data = query_data["standard"]
 
-        if "description" not in standard_data:
+        result = standard_data.get("description", None)
+        if result is None:
             return CreateIncompleteDataResult()
 
-        result = standard_data["description"]
-
         expect_description = not requirement_args["allow-empty"]
 
         if expect_description and not result:

{repoauditor-0.2.34 → repoauditor-0.2.35}/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.34"
+__version__ = "0.2.35"

{repoauditor-0.2.34 → repoauditor-0.2.35}/tests/EntryPoint_UnitTest.py

@@ -7,12 +7,14 @@
 """Unit tests for EntryPoint.py"""
 
 import pytest
+import typer
 
 from dbrownell_Common.TestHelpers.StreamTestHelpers import InitializeStreamCapabilities
+from dbrownell_Common.TyperEx import TypeDefinitionItem  # type: ignore [import-untyped]
 from typer.testing import CliRunner
 
 from RepoAuditor import __version__
-from RepoAuditor.EntryPoint import app
+from RepoAuditor.EntryPoint import app, TypeInfoToString
 
 from Plugins.utilities import GetGithubUrl
 
@@ -58,3 +60,39 @@ def test_Help() -> None:
 
     assert result.exit_code == 0
     assert "Module Information" in result.output
+
+
+def test_TypeInfoToString() -> None:
+    """Test the TypeInfoToString function to ensure valid command line output."""
+    result = TypeInfoToString(
+        "test_arg",
+        (
+            bool,
+            typer.Option(
+                False,
+                help="Help text.",
+            ),
+        ),
+    )
+    expected_string = "    test_arg                                           bool    Help text."
+    assert expected_string == result
+
+    result = TypeInfoToString(
+        "test_arg",
+        TypeDefinitionItem(
+            bool,
+            typer.models.ParameterInfo(
+                default=False,
+                help="TypeDefinitionItem",
+            ),
+        ),
+    )
+    expected_string = "    test_arg                                           bool    TypeDefinitionItem"
+    assert expected_string == result
+
+    result = TypeInfoToString(
+        "test_none",
+        bool,
+    )
+    expected_string = "    test_none                                          bool    "
+    assert expected_string == result