RepoAuditor 0.2.73__tar.gz → 0.2.76__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.73
+Version: 0.2.76
 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.73 → repoauditor-0.2.76}/src/RepoAuditor/Plugins/CommunityStandards/Impl/ExistsRequirementImpl.py

@@ -80,8 +80,8 @@ class ExistsRequirementImpl(Requirement):
         query_data: dict[str, Any],
         requirement_args: dict[str, Any],
     ) -> Requirement.EvaluateImplResult:
-        # Check if `dynamic_arg_name` is `not unrequired`.
-        if not requirement_args[self.dynamic_arg_name]:
+        # Check if dynamic argument is `not unrequired`.
+        if not requirement_args.get(self.dynamic_arg_name, False):
             for location in self.possible_locations:
                 # Get full file path in temporary repo directory and check if it exists
                 # This checks both upper case and lower case variants

{repoauditor-0.2.73 → repoauditor-0.2.76}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/EnsureStatusChecks.py

@@ -24,7 +24,7 @@ class EnsureStatusChecks(Requirement):
     def __init__(self) -> None:
         super().__init__(
             "EnsureStatusChecks",
-            "Ensure that status checks have been enabled for the branch.",
+            "Ensure that status checks have been enabled for the '{branch}' branch.",
             ExecutionStyle.Parallel,
             textwrap.dedent(
                 """\

{repoauditor-0.2.73 → repoauditor-0.2.76}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/Impl/ClassicValueRequirementImpl.py

@@ -40,11 +40,11 @@ class ClassicValueRequirementImpl(ValueRequirementImpl):
 
             resolution = textwrap.dedent(
                 f"""\
-                1) Visit '{{session.github_url}}/settings/branches'
-                2) Locate the 'Branch protection rules' section
-                3) Click the 'Edit' button next to the branch '{{branch}}'
-                4) Locate the '{github_settings_section}' section
-                5) Ensure that {github_settings_value_display} is {{__expected_value}}
+                1) Visit '{{session.github_url}}/settings/branches'.
+                2) Locate the 'Branch protection rules' section.
+                3) Click the 'Edit' button next to the branch '{{branch}}'.
+                4) Locate the '{github_settings_section}' section.
+                5) Ensure that {github_settings_value_display} is '{{__expected_value}}'.
                 """,
             )
 

{repoauditor-0.2.73 → repoauditor-0.2.76}/src/RepoAuditor/Plugins/GitHub/Impl/EnableRequirementImpl.py

@@ -44,7 +44,7 @@ class EnableRequirementImpl(Requirement):
 
         super().__init__(
             name,
-            f"Validates that {subject} is set to the expected value.",
+            f"Validates that {subject} is set to {{__expected_value}}.",
             ExecutionStyle.Parallel,
             resolution,
             rationale,
@@ -79,6 +79,17 @@ class EnableRequirementImpl(Requirement):
         query_data: dict[str, Any],
         requirement_args: dict[str, Any],
     ) -> Requirement.EvaluateImplResult:
+        expected_value = self.enabled_by_default
+
+        # The value of the dynamic arg doesn't matter as much as whether it was provided
+        if requirement_args.get(self.dynamic_arg_name, False):
+            expected_value = not expected_value
+            provide_rationale = False
+        else:
+            provide_rationale = True
+
+        query_data["__expected_value"] = expected_value
+
         result = self.get_configuration_value_func(query_data)
         if result is None:
             if query_data["session"].is_enterprise:
@@ -95,14 +106,6 @@ class EnableRequirementImpl(Requirement):
 
             return Requirement.EvaluateImplResult(EvaluateResult.DoesNotApply, None)
 
-        expected_value = self.enabled_by_default
-
-        if requirement_args[self.dynamic_arg_name]:
-            expected_value = not expected_value
-            provide_rationale = False
-        else:
-            provide_rationale = True
-
         if result != expected_value:
             query_data["__checked_desc"] = self.unset_set_terminology[int(expected_value)]
 

{repoauditor-0.2.73 → repoauditor-0.2.76}/src/RepoAuditor/Plugins/GitHub/Impl/EnableRulesetRequirementImpl.py

@@ -61,13 +61,15 @@ class EnableRulesetRequirementImpl(EnableRequirementImpl):
     ) -> Requirement.EvaluateImplResult:
         expected_rule_enabled = self.enabled_by_default
 
-        if requirement_args[self.dynamic_arg_name]:
+        # The value of the dynamic arg doesn't matter as much as whether it was provided
+        if requirement_args.get(self.dynamic_arg_name, False):
             expected_rule_enabled = not expected_rule_enabled
             provide_rationale = False
         else:
             provide_rationale = True
 
-        query_data["__expected_value"] = "Enable" if expected_rule_enabled else "Disable"
+        query_data["__expected_value"] = expected_rule_enabled
+        query_data["__enabled_str"] = "Enable" if expected_rule_enabled else "Disable"
 
         # Get the rules for the specified branch
         rules = query_data.get("rules", [])

{repoauditor-0.2.73 → repoauditor-0.2.76}/src/RepoAuditor/Plugins/GitHub/Impl/ValueRequirementImpl.py

@@ -51,7 +51,7 @@ class ValueRequirementImpl(Requirement):
 
         super().__init__(
             name,
-            f"Validates that {subject} is set to the expected value.",
+            f"Validates that {subject} is set to '{{__expected_value}}'.",
             ExecutionStyle.Parallel,
             resolution,
             rationale,
@@ -84,6 +84,9 @@ class ValueRequirementImpl(Requirement):
         query_data: dict[str, Any],
         requirement_args: dict[str, Any],
     ) -> Requirement.EvaluateImplResult:
+        expected_value = requirement_args.get("value", self.default_value)
+        query_data["__expected_value"] = f"{expected_value}"
+
         result = self.get_configuration_value_func(query_data)
         if result is None:
             if self.missing_value_is_warning:
@@ -91,7 +94,6 @@ class ValueRequirementImpl(Requirement):
 
             return Requirement.EvaluateImplResult(EvaluateResult.DoesNotApply, None)
 
-        expected_value = requirement_args["value"]
         is_default_expected_value = expected_value == self.default_value
 
         if isinstance(result, DoesNotApplyResult):
@@ -106,8 +108,6 @@ class ValueRequirementImpl(Requirement):
         result = str(result)
 
         if result != expected_value:
-            query_data["__expected_value"] = f"'{expected_value}'"
-
             return Requirement.EvaluateImplResult(
                 EvaluateResult.Error,
                 f"{self.github_value} must be set to '{expected_value}' (it is currently set to '{result}').",

{repoauditor-0.2.73 → repoauditor-0.2.76}/src/RepoAuditor/Plugins/GitHub/RulesetRequirements/RequirePullRequests.py

@@ -20,6 +20,6 @@ class RequirePullRequests(EnableRulesetRequirementImpl):
             github_ruleset_type="pull_request",
             github_ruleset_value="Require a pull request before merging",
             get_configuration_value_func=lambda rule: rule.get("type", "") == "pull_request",
-            resolution="{__expected_value} pull request rule in repository rulesets",
+            resolution="{__enabled_str} pull request rule in repository rulesets",
             rationale="Pull request reviews help maintain code quality and collaboration",
         )

{repoauditor-0.2.73 → repoauditor-0.2.76}/src/RepoAuditor/Plugins/GitHub/RulesetRequirements/RequireSignedCommits.py

@@ -20,6 +20,6 @@ class RequireSignedCommits(EnableRulesetRequirementImpl):
             github_ruleset_type="required_signatures",
             github_ruleset_value="Require signed commits",
             get_configuration_value_func=lambda rule: rule.get("type", "") == "required_signatures",
-            resolution="Enable commit signing requirement in repository rulesets",
+            resolution="{__enabled_str} commit signing requirement in repository rulesets",
             rationale="Signed commits ensure commit authenticity",
         )

{repoauditor-0.2.73 → repoauditor-0.2.76}/src/RepoAuditor/Plugins/GitHub/RulesetRequirements/RequireStatusChecks.py

@@ -20,6 +20,6 @@ class RequireStatusChecks(EnableRulesetRequirementImpl):
             github_ruleset_type="required_status_checks",
             github_ruleset_value="Require status checks to pass",
             get_configuration_value_func=lambda rule: rule.get("type", "") == "required_status_checks",
-            resolution="Configure required status checks in repository rulesets",
+            resolution="{__enabled_str} required status checks in repository rulesets",
             rationale="Status checks ensure code quality and compatibility",
         )

{repoauditor-0.2.73 → repoauditor-0.2.76}/src/RepoAuditor/Plugins/GitHub/StandardRequirements/DefaultBranch.py

@@ -24,7 +24,7 @@ class DefaultBranch(StandardValueRequirementImpl):
             "main",
             "settings",
             "Default Branch",
-            None,
+            "Default Branch",
             lambda data: data["standard"].get("default_branch", None),
             textwrap.dedent(
                 """\

{repoauditor-0.2.73 → repoauditor-0.2.76}/src/RepoAuditor/Plugins/GitHub/StandardRequirements/Description.py

@@ -24,7 +24,7 @@ class Description(Requirement):
     def __init__(self) -> None:
         super().__init__(
             "Description",
-            "Validates a repository's description.",
+            "Validates if the repository has a description.",
             ExecutionStyle.Parallel,
             textwrap.dedent(
                 """\

{repoauditor-0.2.73 → repoauditor-0.2.76}/src/RepoAuditor/Plugins/GitHub/StandardRequirements/Impl/StandardValueRequirementImpl.py

@@ -44,9 +44,9 @@ class StandardValueRequirementImpl(
 
             resolution = textwrap.dedent(
                 f"""\
-                1) Visit '{{session.github_url}}/{github_settings_url_suffix}'
-                2) Locate the '{github_settings_section}' section
-                3) Ensure that {github_settings_value_display} is set to {{__expected_value}}
+                1) Visit '{{session.github_url}}/{github_settings_url_suffix}'.
+                2) Locate the '{github_settings_section}' section.
+                3) Ensure that {github_settings_value_display} is set to '{{__expected_value}}'.
                 """,
             )
 

{repoauditor-0.2.73 → repoauditor-0.2.76}/src/RepoAuditor/Plugins/GitHub/StandardRequirements/Private.py

@@ -25,7 +25,7 @@ class Private(Requirement):
     def __init__(self) -> None:
         super().__init__(
             "Private",
-            "Validates that the repository is set to the expected visibility.",
+            "Validates that the repository's visibility is set to '{__expected_visibility}'.",
             ExecutionStyle.Parallel,
             textwrap.dedent(
                 """\
@@ -71,16 +71,15 @@ class Private(Requirement):
         query_data: dict[str, Any],
         requirement_args: dict[str, Any],
     ) -> Requirement.EvaluateImplResult:
+        expect_private = requirement_args.get("enabled", False)
+        query_data["__expected_visibility"] = "private" if expect_private else "public"
+
         result = query_data["standard"].get("private", None)
 
         if result is None:
             return CreateIncompleteDataResult()
 
-        expect_private = requirement_args["enabled"]
-
         if result != expect_private:
-            query_data["__expected_visibility"] = "private" if expect_private else "public"
-
             return Requirement.EvaluateImplResult(
                 EvaluateResult.Error,
                 f"The repository's visibility must be {query_data['__expected_visibility']}.",

{repoauditor-0.2.73 → repoauditor-0.2.76}/src/RepoAuditor/Requirement.py

@@ -87,6 +87,9 @@ class Requirement(ABC):
         If `requires_explicit_include` is True, the requirement must be explicitly included on the command line.
         """
         self.name = name
+        # Use description template so we can update this description for each requirement
+        self.description_template = description
+        # Use the description as is as backup
         self.description = description
         self.style = style
 
@@ -112,6 +115,9 @@ class Requirement(ABC):
         """Evaluate the requirements given the query data and specific arguments."""
         result_info = self._EvaluateImpl(query_data, requirement_args)
 
+        # Fill in templates in description string
+        self.description = self.description_template.format(**query_data)
+
         if result_info.result == EvaluateResult.Error:
             return Requirement.EvaluateInfo(
                 result_info.result,

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

{repoauditor-0.2.73 → repoauditor-0.2.76}/tests/Plugins/CommunityStandards/CommunityStandardsQuery_UnitTest.py

@@ -27,10 +27,15 @@ class MockTemporaryDirectory:
 
 @pytest.fixture(autouse=True)
 def patch_temp_directory(monkeypatch):
+    """Prevent creation of TemporaryDirectory within GetData calls,
+    so we don't need to perform cleanup.
+    """
     monkeypatch.delattr("tempfile.TemporaryDirectory")
 
 
 class TestCommunityStandardsQuery:
+    """Tests for CommunityStandardsQuery class."""
+
     def test_GetData(self, module_data, monkeypatch):
         """Test the GetData method."""
         monkeypatch.setattr(
@@ -41,7 +46,6 @@ class TestCommunityStandardsQuery:
 
         def mock_clone_from(github_url, repo_dirname, branch="main"):
             """A mocked clone_from method for the git.Repo class."""
-            pass
 
         monkeypatch.setattr(
             Repo,

{repoauditor-0.2.73 → repoauditor-0.2.76}/tests/Plugins/CommunityStandards_EndToEndTest.py

@@ -321,8 +321,8 @@ class TestCommunityStandards:
 # ----------------------------------------------------------------------
 # ----------------------------------------------------------------------
 # ----------------------------------------------------------------------
-@pytest.fixture
-def args() -> list[str]:
+@pytest.fixture(name="args")
+def args_fixture() -> list[str]:
     return [
         "--include",
         "CommunityStandards",
@@ -332,8 +332,8 @@ def args() -> list[str]:
 
 
 # ----------------------------------------------------------------------
-@pytest.fixture
-def pat_args(args) -> list[str]:
+@pytest.fixture(name="pat_args")
+def pat_args_fixture(args) -> list[str]:
     github_pat_filename = (Path(__file__).parent / "github_pat.txt").resolve()
     CheckPATFileExists(github_pat_filename)
 

{repoauditor-0.2.73 → repoauditor-0.2.76}/tests/Plugins/GitHubEnterprise_EndToEndTest.py

@@ -23,8 +23,8 @@ pytest.fixture(InitializeStreamCapabilities(), scope="session", autouse=True)
 
 
 # ----------------------------------------------------------------------
-@pytest.fixture
-def args() -> list[str]:
+@pytest.fixture(name="args")
+def args_fixture() -> list[str]:
     return [
         "--include",
         "GitHub",
@@ -37,8 +37,8 @@ def args() -> list[str]:
 
 
 # ----------------------------------------------------------------------
-@pytest.fixture
-def pat_args(args) -> list[str]:
+@pytest.fixture(name="pat_args")
+def pat_args_fixture(args) -> list[str]:
     github_pat_filename = (Path(__file__).parent / "github_gatech_pat.txt").resolve()
     parsed = urllib.parse.urlparse(GetGithubUrl("enterprise"))
     parsed = parsed._replace(path="")

{repoauditor-0.2.73 → repoauditor-0.2.76}/tests/Plugins/GitHubModule/ClassicBranchProtectionRequirements/DismissStalePullRequestApprovals_UnitTest.py

@@ -14,8 +14,8 @@ from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.DismissStale
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
     return {
         "session": session,
         "branch": "main",
@@ -27,12 +27,14 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
     return DismissStalePullRequestApprovals()
 
 
 class TestDismissStalePullRequestApprovals:
+    """Tests for the DismissStalePullRequestApprovals requirement class."""
+
     def test_required_pull_request_reviews_missing(self, requirement, query_data):
         """Test when `required_pull_request_reviews` is missing."""
         query_data["branch_protection_data"] = {}

{repoauditor-0.2.73 → repoauditor-0.2.76}/tests/Plugins/GitHubModule/ClassicBranchProtectionRequirements/EnsureStatusChecks_UnitTest.py

@@ -14,8 +14,8 @@ from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.EnsureStatus
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
     return {
         "session": session,
         "branch": "main",
@@ -27,12 +27,14 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
     return EnsureStatusChecks()
 
 
 class TestEnsureStatusChecks:
+    """Tests for the EnsureStatusChecks requirement class."""
+
     def test_disabled(self, requirement, query_data):
         """Test disabled requirement"""
         requirement_args = {"disabled": True}

{repoauditor-0.2.73 → repoauditor-0.2.76}/tests/Plugins/GitHubModule/ClassicBranchProtectionRequirements/RequireApprovalMostRecentPush_UnitTest.py

@@ -14,8 +14,8 @@ from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.RequireAppro
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
     return {
         "session": session,
         "branch": "main",
@@ -27,12 +27,14 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
     return RequireApprovalMostRecentPush()
 
 
 class TestRequireApprovalMostRecentPush:
+    """Tests for the RequireApprovalMostRecentPush requirement class."""
+
     def test_required_pull_request_reviews_missing(self, requirement, query_data):
         """Test when `required_pull_request_reviews` is missing"""
         query_data["branch_protection_data"] = {}
@@ -59,10 +61,10 @@ class TestRequireApprovalMostRecentPush:
 
     def test_require_last_push_approval_none(self, requirement, query_data):
         """Test when `require_last_push_approval` is None"""
-        requirement_args = {}
         query_data["branch_protection_data"]["required_pull_request_reviews"][
             "require_last_push_approval"
         ] = None
+        requirement_args = {}
         result = requirement.Evaluate(query_data, requirement_args)
         assert result.result == EvaluateResult.DoesNotApply
         assert result.context is None

{repoauditor-0.2.73 → repoauditor-0.2.76}/tests/Plugins/GitHubModule/ClassicBranchProtectionRequirements/RequireApprovals_UnitTest.py

@@ -12,8 +12,8 @@ from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.RequireAppro
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
     return {
         "session": session,
         "branch": "main",
@@ -25,12 +25,14 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
     return RequireApprovals()
 
 
 class TestRequireApprovals:
+    """Tests for the RequireApprovals requirement class."""
+
     def test_required_pull_request_reviews_missing(self, requirement, query_data):
         """Test when `required_pull_request_reviews` is missing"""
         query_data["branch_protection_data"] = {}

{repoauditor-0.2.73 → repoauditor-0.2.76}/tests/Plugins/GitHubModule/ClassicBranchProtectionRequirements/RequireCodeOwnerReview_UnitTest.py

@@ -14,8 +14,8 @@ from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.RequireCodeO
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
     return {
         "session": session,
         "branch": "main",
@@ -27,12 +27,14 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
     return RequireCodeOwnerReview()
 
 
 class TestRequireCodeOwnerReview:
+    """Tests for the RequireCodeOwnerReview requirement class."""
+
     def test_required_pull_request_reviews_missing(self, requirement, query_data):
         """Test when `required_pull_request_reviews` is missing"""
         query_data["branch_protection_data"] = {}

{repoauditor-0.2.73 → repoauditor-0.2.76}/tests/Plugins/GitHubModule/ClassicBranchProtectionRequirements/RequireUpToDateBranches_UnitTest.py

@@ -1,3 +1,11 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Unit tests for RequireUpToDateBranches."""
+
 import pytest
 
 from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.RequireUpToDateBranches import (
@@ -6,8 +14,9 @@ from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.RequireUpToD
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
+    """Sample query data fixture."""
     return {
         "session": session,
         "branch": "main",
@@ -19,12 +28,15 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
+    """RequireUpToDateBranches requirement fixture."""
     return RequireUpToDateBranches()
 
 
 class TestRequireUpToDateBranches:
+    """Tests for RequireUpToDateBranches requirement."""
+
     def test_required_status_checks_missing(self, requirement, query_data):
         """Test when `required_status_checks` is missing"""
         query_data["branch_protection_data"] = {}

{repoauditor-0.2.73 → repoauditor-0.2.76}/tests/Plugins/GitHubModule/DefaultBranchQueryRequirements/Protected_UnitTest.py

@@ -12,8 +12,8 @@ from RepoAuditor.Plugins.GitHub.DefaultBranchRequirements.Protected import Prote
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
     return {
         "session": session,
         "default_branch_data": {
@@ -22,12 +22,14 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
     return Protected()
 
 
 class TestProtected:
+    """Tests for the Protected requirement class."""
+
     def test_Incomplete(self, requirement, query_data):
         """Test for incomplete result"""
         query_data["default_branch_data"] = {}

{repoauditor-0.2.73 → repoauditor-0.2.76}/tests/Plugins/GitHubModule/GitHubSession_UnitTest.py

@@ -14,8 +14,8 @@ import requests
 from RepoAuditor.Plugins.GitHubBase.Module import _GitHubSession
 
 
-@pytest.fixture
-def github_pat(fs):
+@pytest.fixture(name="github_pat")
+def github_pat_fixture(fs):
     """Fixture for GitHub PAT file, which creates a fake PAT file and returns the path."""
     pat_path = Path(__file__).parent / "dummy_github_pat.txt"
     fs.create_file(pat_path, contents="github_path_abcdefghijklmnop")

{repoauditor-0.2.73 → repoauditor-0.2.76}/tests/Plugins/GitHubModule/StandardQueryRequirements/DependabotSecurityUpdates_UnitTest.py

@@ -14,8 +14,8 @@ from RepoAuditor.Plugins.GitHub.StandardRequirements.DependabotSecurityUpdates i
 from RepoAuditor.Requirement import EvaluateResult
 
 
-@pytest.fixture
-def query_data(session):
+@pytest.fixture(name="query_data")
+def query_data_fixture(session):
     return {
         "session": session,
         "standard": {
@@ -28,37 +28,43 @@ def query_data(session):
     }
 
 
-@pytest.fixture
-def requirement():
+@pytest.fixture(name="requirement")
+def requirement_fixture():
     return DependabotSecurityUpdates()
 
 
 class TestDependabotSecurityUpdates:
+    """Tests for the DependabotSecurityUpdates requirement class."""
+
     def test_security_and_analysis_missing(self, requirement, query_data):
         """Test if `security_and_analysis` is missing"""
         query_data["standard"] = {}
-        result = requirement.Evaluate(query_data, requirement_args={})
+        requirement_args = {}
+        result = requirement.Evaluate(query_data, requirement_args)
         assert result.result == EvaluateResult.Warning
         assert "Incomplete data was encountered" in result.context
 
     def test_dependabot_security_updates_missing(self, requirement, query_data):
         """Test if `dependabot_security_updates` is missing"""
         query_data["standard"]["security_and_analysis"] = {}
-        result = requirement.Evaluate(query_data, requirement_args={})
+        requirement_args = {}
+        result = requirement.Evaluate(query_data, requirement_args)
         assert result.result == EvaluateResult.Warning
         assert "Incomplete data was encountered" in result.context
 
     def test_status_missing(self, requirement, query_data):
         """Test if `status` is missing"""
         query_data["standard"]["security_and_analysis"]["dependabot_security_updates"] = {}
-        result = requirement.Evaluate(query_data, requirement_args={})
+        requirement_args = {}
+        result = requirement.Evaluate(query_data, requirement_args)
         assert result.result == EvaluateResult.Warning
         assert "Incomplete data was encountered" in result.context
 
     def test_status_none(self, requirement, query_data):
         """Test if `status` is None"""
         query_data["standard"]["security_and_analysis"]["dependabot_security_updates"]["status"] = None
-        result = requirement.Evaluate(query_data, requirement_args={})
+        requirement_args = {}
+        result = requirement.Evaluate(query_data, requirement_args)
         assert result.result == EvaluateResult.Warning
         assert "Incomplete data was encountered" in result.context