RepoAuditor 0.2.53__tar.gz → 0.2.55__tar.gz

{repoauditor-0.2.53 → repoauditor-0.2.55}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.53
+Version: 0.2.55
 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.53 → repoauditor-0.2.55}/src/RepoAuditor/Plugins/GitHubCommunityStandards/CommunityStandardsQuery.py

@@ -8,6 +8,7 @@
 
 from tempfile import TemporaryDirectory
 from typing import Any, Optional
+from urllib.parse import urlparse
 
 from dbrownell_Common.Types import override  # type: ignore[import-untyped]
 
@@ -50,15 +51,33 @@ class CommunityStandardsQuery(Query):
         """Get the repo data."""
 
         # Clone the GitHub repository to a temp directory
-        github_url = module_data["url"]
         branch = module_data.get("branch", "main")
         temp_repo_dir = TemporaryDirectory()
+        github_url = module_data["url"]
+
+        # Add PAT to GitHub URL, if present
+        github_pat = module_data.get("pat")
+        if github_pat:
+            url = urlparse(github_url)
+            github_url = f"https://{github_pat}@{url.netloc}{url.path}"
 
         # Import git.Repo here so that it is only imported
         # if the GitHubCommunityStandards plugin is requested.
         from git import Repo
 
-        Repo.clone_from(github_url, temp_repo_dir.name, branch=branch)
+        try:
+            Repo.clone_from(github_url, temp_repo_dir.name, branch=branch)
+        except Exception as e:
+            error_msg = f"""
+            An error occurred while attempting to clone the target repository.
+            If you are auditing a private repository, {
+                "please ensure your PAT has access to the repository."
+                if github_pat
+                else "please provide a PAT with access to the repository."
+            }
+            Error: {e}
+            """
+            raise RuntimeError(error_msg) from e
 
         # Record the path and the temp directory for later cleanup
         module_data["repo_dir"] = temp_repo_dir

{repoauditor-0.2.53 → repoauditor-0.2.55}/src/RepoAuditor/Plugins/GitHubCommunityStandards/Requirements/CodeOfConduct.py

@@ -21,10 +21,13 @@ class CodeOfConduct(ExistsRequirementImpl):
             [
                 ".github/CODE_OF_CONDUCT",
                 ".github/CODE_OF_CONDUCT.md",
+                ".github/CODE_OF_CONDUCT.rst",
                 "docs/CODE_OF_CONDUCT",
                 "docs/CODE_OF_CONDUCT.md",
+                "docs/CODE_OF_CONDUCT.rst",
                 "CODE_OF_CONDUCT",
                 "CODE_OF_CONDUCT.md",
+                "CODE_OF_CONDUCT.rst",
             ],
             textwrap.dedent(
                 """\

{repoauditor-0.2.53 → repoauditor-0.2.55}/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.53"
+__version__ = "0.2.55"

repoauditor-0.2.55/tests/Plugins/GitHubCommunityStandards/CommunityStandardsQuery_UnitTest.py

@@ -0,0 +1,125 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Unit tests for CommunityStandardsQuery.py"""
+
+import pytest
+from git import Repo
+
+from RepoAuditor.Plugins.GitHubCommunityStandards.CommunityStandardsQuery import (
+    CommunityStandardsQuery,
+    TemporaryDirectory,
+)
+
+
+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 TestCommunityStandardsQuery:
+    def test_GetData(self, module_data, monkeypatch):
+        """Test the GetData method."""
+        monkeypatch.setattr(
+            TemporaryDirectory,
+            "__init__",
+            MockTemporaryDirectory.__init__,
+        )
+
+        def mock_clone_from(github_url, repo_dirname, branch="main"):
+            """A mocked clone_from method for the git.Repo class."""
+            pass
+
+        monkeypatch.setattr(
+            Repo,
+            "clone_from",
+            mock_clone_from,
+        )
+
+        query = CommunityStandardsQuery()
+        query_data = query.GetData(module_data)
+
+        assert query_data["repo_dir"].name == "test_temp_directory"
+
+    def test_GetData_adds_pat(self, module_data, monkeypatch):
+        """Test the GetData method adds PAT to URL"""
+        github_pat = "pat-123"
+        github_url = "https://github.com/owner/repo"
+        expected_url = "https://pat-123@github.com/owner/repo"
+        module_data["url"] = github_url
+        module_data["pat"] = github_pat
+
+        monkeypatch.setattr(
+            TemporaryDirectory,
+            "__init__",
+            MockTemporaryDirectory.__init__,
+        )
+
+        def mock_clone_from(github_url, repo_dirname, branch="main"):
+            assert github_url == expected_url
+
+        monkeypatch.setattr(Repo, "clone_from", mock_clone_from)
+
+        query = CommunityStandardsQuery()
+        _ = query.GetData(module_data)
+
+    def test_GetData_does_not_add_pat(self, module_data, monkeypatch):
+        """Test the GetData method preserves the URL when no PAT is provided"""
+        github_url = "https://github.com/owner/repo"
+        expected_url = "https://github.com/owner/repo"
+        module_data["url"] = github_url
+
+        monkeypatch.setattr(
+            TemporaryDirectory,
+            "__init__",
+            MockTemporaryDirectory.__init__,
+        )
+
+        def mock_clone_from(github_url, repo_dirname, branch="main"):
+            assert github_url == expected_url
+
+        monkeypatch.setattr(Repo, "clone_from", mock_clone_from)
+
+        query = CommunityStandardsQuery()
+        _ = query.GetData(module_data)
+
+    def test_GetData_handles_gitpython_errors(self, module_data, monkeypatch):
+        """Test the GetData method handles errors raised by the gitpyhon module"""
+        gitpython_error_msg = "error cloning repository"
+
+        monkeypatch.setattr(
+            TemporaryDirectory,
+            "__init__",
+            MockTemporaryDirectory.__init__,
+        )
+
+        def mock_clone_from(github_url, repo_dirname, branch="main"):
+            raise Exception(gitpython_error_msg)
+
+        monkeypatch.setattr(Repo, "clone_from", mock_clone_from)
+
+        query = CommunityStandardsQuery()
+        with pytest.raises(RuntimeError) as e_info:
+            _ = query.GetData(module_data)
+        assert gitpython_error_msg in str(e_info)
+
+    def test_Cleanup(self, module_data):
+        """Test the Cleanup method."""
+        query = CommunityStandardsQuery()
+        module_data["repo_dir"] = MockTemporaryDirectory()
+        result = query.Cleanup(module_data)
+
+        assert result is None

repoauditor-0.2.53/tests/Plugins/GitHubCommunityStandards/CommunityStandardsQuery_UnitTest.py

@@ -1,63 +0,0 @@
-# -------------------------------------------------------------------------------
-# |
-# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
-# |  Distributed under the MIT License.
-# |
-# -------------------------------------------------------------------------------
-"""Unit tests for CommunityStandardsQuery.py"""
-
-import pytest
-from git import Repo
-
-from RepoAuditor.Plugins.GitHubCommunityStandards.CommunityStandardsQuery import (
-    CommunityStandardsQuery,
-    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 TestCommunityStandardsQuery:
-    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 = CommunityStandardsQuery()
-        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 = CommunityStandardsQuery()
-        module_data["repo_dir"] = MockTemporaryDirectory()
-        result = query.Cleanup(module_data)
-
-        assert result is None