RepoAuditor 0.2.20__tar.gz → 0.2.21__tar.gz

{repoauditor-0.2.20 → repoauditor-0.2.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.20
+Version: 0.2.21
 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.21/src/RepoAuditor/Plugins/GitHub/Module.py

@@ -0,0 +1,33 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Contains the GitHubModule object."""
+
+from RepoAuditor.Module import ExecutionStyle
+from RepoAuditor.Plugins.GitHubBase.Module import GitHubBaseModule
+
+from .ClassicBranchProtectionQuery import ClassicBranchProtectionQuery
+from .DefaultBranchQuery import DefaultBranchQuery
+from .StandardQuery import StandardQuery
+
+
+# ----------------------------------------------------------------------
+class GitHubModule(GitHubBaseModule):
+    """Module for validating GitHub repository configuration settings."""
+
+    # ----------------------------------------------------------------------
+    def __init__(self) -> None:
+        super().__init__(
+            "GitHub",
+            "Validates GitHub configuration settings.",
+            ExecutionStyle.Parallel,
+            [
+                StandardQuery(),
+                DefaultBranchQuery(),
+                ClassicBranchProtectionQuery(),
+            ],
+            requires_explicit_include=True,
+        )

{repoauditor-0.2.20/src/RepoAuditor/Plugins/GitHub → repoauditor-0.2.21/src/RepoAuditor/Plugins/GitHubBase}/Module.py

@@ -1,158 +1,144 @@
-# -------------------------------------------------------------------------------
-# |
-# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
-# |  Distributed under the MIT License.
-# |
-# -------------------------------------------------------------------------------
-"""Contains the GitHubModule object."""
-
-from pathlib import Path
-from typing import Any, Optional
-from urllib.parse import urlparse
-
-import requests
-import typer
-
-from dbrownell_Common.TyperEx import TypeDefinitionItemType  # type: ignore[import-untyped]
-from dbrownell_Common.Types import override  # type: ignore[import-untyped]
-
-from RepoAuditor.Module import ExecutionStyle, Module
-
-from .ClassicBranchProtectionQuery import ClassicBranchProtectionQuery
-from .DefaultBranchQuery import DefaultBranchQuery
-from .StandardQuery import StandardQuery
-
-
-# ----------------------------------------------------------------------
-class GitHubModule(Module):
-    """Module for validating GitHub repository configuration settings."""
-
-    # ----------------------------------------------------------------------
-    def __init__(self) -> None:
-        super().__init__(
-            "GitHub",
-            "Validates GitHub configuration settings.",
-            ExecutionStyle.Parallel,
-            [
-                StandardQuery(),
-                DefaultBranchQuery(),
-                ClassicBranchProtectionQuery(),
-            ],
-            requires_explicit_include=True,
-        )
-
-    # ----------------------------------------------------------------------
-    @override
-    def GetDynamicArgDefinitions(self) -> dict[str, TypeDefinitionItemType]:
-        """Get the definitions for the arguments to this requirement."""
-        return {
-            "url": (
-                str,
-                typer.Option(
-                    ...,
-                    help="[REQUIRED] Github URL (e.g. https://github.com/gt-sse-center/RepoAuditor)",
-                ),
-            ),
-            "pat": (
-                str,
-                typer.Option(
-                    None,
-                    help="GitHub Personal Access Token (PAT) or path to a local file containing the PAT.",
-                ),
-            ),
-            "branch": (
-                str,
-                typer.Option(
-                    None,
-                    help="Branch to evaluate. The default branch will be used if not specified.",
-                ),
-            ),
-        }
-
-    # ----------------------------------------------------------------------
-    @override
-    def GenerateInitialData(self, dynamic_args: dict[str, Any]) -> Optional[dict[str, Any]]:
-        """Generate the initial data to be used in the `dynamic_args`, such as session info, etc."""
-        # Create a GitHub API session
-        dynamic_args["session"] = _GitHubSession(dynamic_args["url"], dynamic_args.get("pat"))
-
-        return dynamic_args
-
-
-# ----------------------------------------------------------------------
-# |
-# |  Private Types
-# |
-# ----------------------------------------------------------------------
-class _GitHubSession(requests.Session):
-    """Session used to communicate with GitHub APIs."""
-
-    # ----------------------------------------------------------------------
-    def __init__(
-        self,
-        github_url: str,
-        github_pat: Optional[str],
-        *args,
-        **kwargs,
-    ) -> None:
-        super().__init__(*args, **kwargs)
-
-        self.headers.update(
-            {
-                "X-GitHub-Api-Version": "2022-11-28",
-                "Accept": "application/vnd.github+json",
-            },
-        )
-
-        if github_pat:
-            potential_file = Path(github_pat)
-
-            if potential_file.is_file():
-                with potential_file.open("r") as f:
-                    github_pat = f.read().strip()
-
-            self.headers["Authorization"] = f"Bearer {github_pat}"
-
-        github_url = github_url.removesuffix("/")
-
-        url_parts = urlparse(github_url)
-        path_parts = url_parts.path.split("/")
-
-        if len(path_parts) != 3:
-            msg = f"'{github_url}' is not a valid GitHub repository URL."
-            raise ValueError(msg)
-
-        _, username, repo = path_parts
-
-        if url_parts.netloc.lower() in ["github.com", "www.github.com"]:
-            api_url = f"https://api.github.com/repos/{username}/{repo}"
-            is_enterprise = False
-        else:
-            api_url = f"{url_parts.scheme}://{url_parts.netloc}/api/v3/orgs/{username}/repos/{repo}"
-            is_enterprise = True
-
-        self.github_url = github_url
-        self.github_pat = github_pat
-        self.github_username = username
-        self.github_repository = repo
-        self.api_url = api_url
-        self.is_enterprise = is_enterprise
-        self.has_pat = bool(github_pat)
-
-    # ----------------------------------------------------------------------
-    def request(
-        self,
-        method: str,
-        url: str,
-        *args,
-        **kwargs,
-    ) -> requests.Response:
-        if url and not url.startswith("/"):
-            url = f"/{url}"
-
-        return super().request(
-            method,
-            f"{self.api_url}{url}",
-            *args,
-            **kwargs,
-        )
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Contains the GitHubBaseModule object."""
+
+from pathlib import Path
+from typing import Any, Optional
+from urllib.parse import urlparse
+
+import requests
+import typer
+
+from dbrownell_Common.TyperEx import TypeDefinitionItemType  # type: ignore[import-untyped]
+from dbrownell_Common.Types import override  # type: ignore[import-untyped]
+
+from RepoAuditor.Module import Module
+
+
+# ----------------------------------------------------------------------
+class GitHubBaseModule(Module):
+    """Module for common GitHub settings which can be inherited by various GitHub plugins."""
+
+    # ----------------------------------------------------------------------
+    # The __init__ method is inherited from the Module class
+    # and does not need to be overriden.
+
+    # ----------------------------------------------------------------------
+    @override
+    def GetDynamicArgDefinitions(self) -> dict[str, TypeDefinitionItemType]:
+        """Get the definitions for the arguments to this requirement."""
+        return {
+            "url": (
+                str,
+                typer.Option(
+                    ...,
+                    help="[REQUIRED] Github URL (e.g. https://github.com/gt-sse-center/RepoAuditor)",
+                ),
+            ),
+            "pat": (
+                str,
+                typer.Option(
+                    None,
+                    help="GitHub Personal Access Token (PAT) or path to a local file containing the PAT.",
+                ),
+            ),
+            "branch": (
+                str,
+                typer.Option(
+                    None,
+                    help="Branch to evaluate. The default branch will be used if not specified.",
+                ),
+            ),
+        }
+
+    # ----------------------------------------------------------------------
+    @override
+    def GenerateInitialData(self, dynamic_args: dict[str, Any]) -> Optional[dict[str, Any]]:
+        """Generate the initial data to be used in the `dynamic_args`, such as session info, etc."""
+        # Create a GitHub API session
+        dynamic_args["session"] = _GitHubSession(dynamic_args["url"], dynamic_args.get("pat"))
+
+        return dynamic_args
+
+
+# ----------------------------------------------------------------------
+# |
+# |  Private Types
+# |
+# ----------------------------------------------------------------------
+class _GitHubSession(requests.Session):
+    """Session used to communicate with GitHub APIs."""
+
+    # ----------------------------------------------------------------------
+    def __init__(
+        self,
+        github_url: str,
+        github_pat: Optional[str],
+        *args,
+        **kwargs,
+    ) -> None:
+        super().__init__(*args, **kwargs)
+
+        self.headers.update(
+            {
+                "X-GitHub-Api-Version": "2022-11-28",
+                "Accept": "application/vnd.github+json",
+            },
+        )
+
+        if github_pat:
+            potential_file = Path(github_pat)
+
+            if potential_file.is_file():
+                with potential_file.open("r") as f:
+                    github_pat = f.read().strip()
+
+            self.headers["Authorization"] = f"Bearer {github_pat}"
+
+        github_url = github_url.removesuffix("/")
+
+        url_parts = urlparse(github_url)
+        path_parts = url_parts.path.split("/")
+
+        if len(path_parts) != 3:
+            msg = f"'{github_url}' is not a valid GitHub repository URL."
+            raise ValueError(msg)
+
+        _, username, repo = path_parts
+
+        if url_parts.netloc.lower() in ["github.com", "www.github.com"]:
+            api_url = f"https://api.github.com/repos/{username}/{repo}"
+            is_enterprise = False
+        else:
+            api_url = f"{url_parts.scheme}://{url_parts.netloc}/api/v3/orgs/{username}/repos/{repo}"
+            is_enterprise = True
+
+        self.github_url = github_url
+        self.github_pat = github_pat
+        self.github_username = username
+        self.github_repository = repo
+        self.api_url = api_url
+        self.is_enterprise = is_enterprise
+        self.has_pat = bool(github_pat)
+
+    # ----------------------------------------------------------------------
+    def request(
+        self,
+        method: str,
+        url: str,
+        *args,
+        **kwargs,
+    ) -> requests.Response:
+        if url and not url.startswith("/"):
+            url = f"/{url}"
+
+        return super().request(
+            method,
+            f"{self.api_url}{url}",
+            *args,
+            **kwargs,
+        )

{repoauditor-0.2.20 → repoauditor-0.2.21}/src/RepoAuditor/Plugins/GitHubCustomization/Module.py

@@ -6,13 +6,14 @@
 # -------------------------------------------------------------------------------
 """Contains the GitHubCustomizationModule object."""
 
-from typing import Any, Optional
-from RepoAuditor.Module import ExecutionStyle, Module
-from dbrownell_Common.TyperEx import TypeDefinitionItemType
+from typing import Any
 from dbrownell_Common.Types import override
 
+from RepoAuditor.Module import ExecutionStyle
+from RepoAuditor.Plugins.GitHubBase.Module import GitHubBaseModule
 
-class GitHubCustomizationModule(Module):
+
+class GitHubCustomizationModule(GitHubBaseModule):
     """Module that validates GitHub repository customization files."""
 
     def __init__(self) -> None:
@@ -24,18 +25,6 @@ class GitHubCustomizationModule(Module):
             requires_explicit_include=False,
         )
 
-    @override
-    def GetDynamicArgDefinitions(self) -> dict[str, TypeDefinitionItemType]:
-        """Return the dynamic arguments for this module."""
-        # Return an empty dictionary as we don't have any dynamic args yet
-        return {}
-
-    @override
-    def GenerateInitialData(self, dynamic_args: dict[str, Any]) -> Optional[dict[str, Any]]:  # noqa: ARG002
-        """Generate initial data for queries to use."""
-        # Return an empty dictionary as we don't have any initial data yet
-        return {}
-
     @override
     def Cleanup(self, dynamic_args: dict[str, Any]) -> None:
         """Clean up any resources created during execution."""

{repoauditor-0.2.20 → repoauditor-0.2.21}/src/RepoAuditor/__init__.py

@@ -3,4 +3,4 @@ APP_NAME = "RepoAuditor"
 # Note that this value will be overwritten by calls to `python ../../Build.py update_version` based
 # on changes observed in the git repository. The default value below will be used until the value
 # here is explicitly updated by the Continuous Integration system.
-__version__ = "0.2.20"
+__version__ = "0.2.21"

{repoauditor-0.2.20 → repoauditor-0.2.21}/tests/Plugins/GitHubModule_UnitTest.py

@@ -11,7 +11,8 @@ from pathlib import Path
 import pytest
 from pyfakefs.fake_filesystem_unittest import TestCase as FakeFSTestCase
 
-from RepoAuditor.Plugins.GitHub.Module import GitHubModule, _GitHubSession
+from RepoAuditor.Plugins.GitHub.Module import GitHubModule
+from RepoAuditor.Plugins.GitHubBase.Module import _GitHubSession
 
 
 class TestGitHubSession(FakeFSTestCase):