RepoAuditor 0.2.37__tar.gz → 0.2.38__tar.gz

{repoauditor-0.2.37 → repoauditor-0.2.38}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.37
+Version: 0.2.38
 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.37 → repoauditor-0.2.38}/src/RepoAuditor/Plugins/GitHubCustomization/Impl/ExistsRequirementImpl.py

@@ -79,7 +79,7 @@ class ExistsRequirementImpl(Requirement):
                     if full_file_path.is_dir() and any(full_file_path.iterdir()):
                         return Requirement.EvaluateImplResult(
                             EvaluateResult.Success,
-                            f"File found in {self.github_file} directory of the repository",
+                            f"File found in {location} directory of the repository",
                         )
 
                     return Requirement.EvaluateImplResult(

{repoauditor-0.2.37 → repoauditor-0.2.38}/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.37"
+__version__ = "0.2.38"

repoauditor-0.2.38/tests/Plugins/GitHubCustomization/CutomizationQuery_UnitTest.py

@@ -0,0 +1,60 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Unit tests for CustomizationQuery.py"""
+
+import pytest
+from git import Repo
+
+from RepoAuditor.Plugins.GitHubCustomization.CustomizationQuery import CustomizationQuery, TemporaryDirectory
+
+
+def mock_clone_from(github_url, repo_dirname, branch="main"):
+    """A mocked clone_from method for the git.Repo class."""
+    pass
+
+
+class MockTemporaryDirectory:
+    """A mock class to replace tempfile.TemporaryDirectory."""
+
+    def __init__(self):
+        self.name = "test_temp_directory"
+
+    def cleanup(self):
+        """Mocked cleanup method"""
+
+
+@pytest.fixture(autouse=True)
+def patch_temp_directory(monkeypatch):
+    monkeypatch.delattr("tempfile.TemporaryDirectory")
+
+
+class TestCustomizationQuery:
+    def test_GetData(self, module_data, monkeypatch):
+        """Test the GetData method."""
+        monkeypatch.setattr(
+            TemporaryDirectory,
+            "__init__",
+            MockTemporaryDirectory.__init__,
+        )
+        monkeypatch.setattr(
+            Repo,
+            "clone_from",
+            mock_clone_from,
+        )
+
+        query = CustomizationQuery()
+        query_data = query.GetData(module_data)
+
+        assert query_data["repo_dir"].name == "test_temp_directory"
+
+    def test_Cleanup(self, module_data):
+        """Test the Cleanup method."""
+        query = CustomizationQuery()
+        module_data["repo_dir"] = MockTemporaryDirectory()
+        result = query.Cleanup(module_data)
+
+        assert result is None

repoauditor-0.2.38/tests/Plugins/GitHubCustomization/ExistsRequirementImpl_UnitTest.py

@@ -0,0 +1,121 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Unit tests for GitHub/Impl/ClassicValueRequirementImpl.py"""
+
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+from RepoAuditor.Plugins.GitHubCustomization.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+from RepoAuditor.Requirement import EvaluateResult
+
+
+class MockDirectory:
+    def __init__(self):
+        self.name = "repository"
+
+
+class TestExistsRequirementImpl:
+    def test_Constructor(self):
+        """Test the requirement implementation constructor."""
+        requirement = ExistsRequirementImpl(
+            name="Exists Some Value",
+            dynamic_arg_name="exists",
+            github_file="README.md",
+            possible_locations=[
+                "README.md",
+            ],
+            resolution="Get test to pass",
+            rationale="For testing",
+        )
+        assert requirement.github_file == "README.md"
+
+    def test_Disabled(self):
+        """Test disabled requirement."""
+        requirement = ExistsRequirementImpl(
+            name="Exists Some Value",
+            dynamic_arg_name="exists",
+            github_file="README.md",
+            possible_locations=[
+                "README.md",
+            ],
+            resolution="Get test to pass",
+            rationale="For testing",
+        )
+
+        query_data = {}
+        requirement_args = {"exists": False}
+        result = requirement.Evaluate(query_data, requirement_args)
+        assert result.result == EvaluateResult.DoesNotApply
+
+    def test_NotFound(self):
+        """Test for when file is not found."""
+        requirement = ExistsRequirementImpl(
+            name="Exists Some Value",
+            dynamic_arg_name="exists",
+            github_file="README.md",
+            possible_locations=[
+                "MEREAD.md",
+            ],
+            resolution="Get test to pass",
+            rationale="For testing",
+        )
+
+        query_data = {"repo_dir": MockDirectory()}
+        requirement_args = {"exists": True}
+        result = requirement.Evaluate(query_data, requirement_args)
+        assert result.result == EvaluateResult.Error
+        assert "No README.md file found" in result.context
+
+    def test_Found(self):
+        """Test for when file is found as is."""
+        requirement = ExistsRequirementImpl(
+            name="Exists Some Value",
+            dynamic_arg_name="exists",
+            github_file="README.md",
+            possible_locations=[
+                "README.md",
+            ],
+            resolution="Get test to pass",
+            rationale="For testing",
+        )
+
+        tempdir = TemporaryDirectory()
+        with open(Path(tempdir.name, "README.md"), "w") as f:
+            f.write("temp file in temp directory")
+
+        query_data = {"repo_dir": tempdir}
+        requirement_args = {"exists": True}
+        result = requirement.Evaluate(query_data, requirement_args)
+        assert result.result == EvaluateResult.Success
+        assert "README.md found in repository" in result.context
+
+    def test_FoundInDirectory(self):
+        """Test if provided path is directory."""
+        requirement = ExistsRequirementImpl(
+            name="Exists Some Value",
+            dynamic_arg_name="exists",
+            github_file="README.md",
+            possible_locations=[
+                "docs",
+            ],
+            resolution="Get test to pass",
+            rationale="For testing",
+        )
+
+        tempdir = TemporaryDirectory()
+        # Create "docs" directory
+        docs_dir = Path(tempdir.name) / "docs"
+        docs_dir.mkdir(parents=True)
+
+        with open(docs_dir / "README.md", "w") as f:
+            f.write("temp file in temp directory")
+
+        query_data = {"repo_dir": tempdir}
+        requirement_args = {"exists": True}
+        result = requirement.Evaluate(query_data, requirement_args)
+        assert result.result == EvaluateResult.Success
+        assert "File found in docs directory of the repository" in result.context

{repoauditor-0.2.37 → repoauditor-0.2.38}/tests/Plugins/GitHubModule/ClassicBranchProtectionQuery_UnitTest.py

@@ -6,17 +6,7 @@
 # -------------------------------------------------------------------------------
 """Unit tests for ClassicBranchProtectionQuery.py"""
 
-import pytest
-
 from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionQuery import ClassicBranchProtectionQuery
-from RepoAuditor.Plugins.GitHubBase.Module import _GitHubSession
-
-
-@pytest.fixture
-def module_data():
-    return {
-        "session": _GitHubSession("https://github.com/gt-sse-center/RepoAuditor", "pat"),
-    }
 
 
 def get_mock_request(

{repoauditor-0.2.37 → repoauditor-0.2.38}/tests/Plugins/GitHubModule/DefaultBranchQuery_UnitTest.py

@@ -6,17 +6,7 @@
 # -------------------------------------------------------------------------------
 """Unit tests for DefaultBranchQuery.py"""
 
-import pytest
-
 from RepoAuditor.Plugins.GitHub.DefaultBranchQuery import DefaultBranchQuery
-from RepoAuditor.Plugins.GitHubBase.Module import _GitHubSession
-
-
-@pytest.fixture
-def module_data():
-    return {
-        "session": _GitHubSession("https://github.com/gt-sse-center/RepoAuditor", "pat"),
-    }
 
 
 def get_mock_request(

{repoauditor-0.2.37 → repoauditor-0.2.38}/tests/Plugins/GitHubModule/GitHubModule_UnitTest.py

@@ -8,8 +8,6 @@
 
 from pathlib import Path
 
-import pytest
-
 from RepoAuditor.Plugins.GitHub.Module import GitHubModule
 from RepoAuditor.Plugins.GitHubBase.Module import _GitHubSession
 

{repoauditor-0.2.37 → repoauditor-0.2.38}/tests/Plugins/GitHubModule/StandardQuery_UnitTest.py

@@ -6,17 +6,7 @@
 # -------------------------------------------------------------------------------
 """Unit tests for StandardQuery.py"""
 
-import pytest
-
 from RepoAuditor.Plugins.GitHub.StandardQuery import StandardQuery
-from RepoAuditor.Plugins.GitHubBase.Module import _GitHubSession
-
-
-@pytest.fixture
-def module_data():
-    return {
-        "session": _GitHubSession("https://github.com/gt-sse-center/RepoAuditor", "pat"),
-    }
 
 
 def get_mock_request(

repoauditor-0.2.38/tests/Plugins/GitHubRulesets/RulsesetQuery_UnitTest.py

@@ -0,0 +1,62 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Unit tests for RulesetQuery.py"""
+
+from RepoAuditor.Plugins.GitHubRulesets.RulesetQuery import RulesetQuery
+
+
+def get_mock_request(
+    status_code: int = 200,
+):
+    """A function which creates and returns a `mock_request` function."""
+
+    class MockedResponse:
+        def __init__(self, data, status_code):
+            self._data = data
+            self.status_code = status_code
+
+        def json(self):
+            return self._data
+
+        @staticmethod
+        def raise_for_status():
+            pass
+
+    def mock_request(method, url, *args, **kwargs):
+        """The function to use for monkeypatching"""
+        # remove leading /
+        if len(url) > 0 and url[0] == "/":
+            url = url[1:]
+
+        if method.lower() == "get":
+            if url == "":
+                return MockedResponse({"default_branch": "main"}, status_code)
+            elif url == "rules/branches/main":
+                return MockedResponse(
+                    [
+                        {
+                            "ruleset_id": 117,
+                        },
+                    ],
+                    status_code,
+                )
+            elif url == "rulesets/117":
+                return MockedResponse("valid-test-data", status_code)
+
+    return mock_request
+
+
+class TestRulesetQuery:
+    def test_GetData(self, module_data, monkeypatch):
+        """Test the GetData method."""
+        monkeypatch.setattr(module_data["session"], "request", get_mock_request())
+        query = RulesetQuery()
+        query_data = query.GetData(module_data)
+
+        assert len(query_data["rules"]) == 1
+        assert query_data["rules"][0]["ruleset_id"] == 117
+        assert query_data["rules"][0]["ruleset"] == "valid-test-data"

repoauditor-0.2.38/tests/Plugins/conftest.py

@@ -0,0 +1,20 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Common test fixtures for Plugins"""
+
+import pytest
+from GitHubModule.fixtures import session
+
+from RepoAuditor.Plugins.GitHubBase.Module import _GitHubSession
+
+
+@pytest.fixture
+def module_data():
+    return {
+        "session": _GitHubSession("https://github.com/gt-sse-center/RepoAuditor", "pat"),
+        "url": "https://github.com/gt-sse-center/RepoAuditor",
+    }