RepoAuditor 0.2.20__tar.gz → 0.2.22__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.20
+Version: 0.2.22
 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.20 → repoauditor-0.2.22}/pyproject.toml

@@ -76,7 +76,7 @@ exclude = ["tests/**"]
 # ...however, we current experience failures in the rulesets commented out below.
 select = [
     "AIR",
-    #"ERA", # 168
+    "ERA",
     "FAST",
     "YTT",
     "ANN",

{repoauditor-0.2.20 → repoauditor-0.2.22}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionQuery.py

@@ -4,7 +4,60 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the ClassicBranchProtection object."""
+"""Contains the ClassicBranchProtection object.
+
+The API request/response has the following schema:
+
+REQUEST : https://api.github.com/repos/<username>/<repo>/branches/<branch>/protection
+RESPONSE:
+{
+    "url": <not used>,
+    "required_status_checks": { /* RequireStatusChecksToPass */
+        "url": <not used>,
+        "strict": RequireUpToDateBranches,
+        "contexts": <not used>,
+        "contexts_url": <not used>,
+        "checks": EnsureStatusChecks
+    },
+    "required_pull_request_reviews": {  /* RequirePullRequests */
+        "url": <not used>,
+        "dismiss_stale_reviews": DismissStalePullRequestApprovals,
+        "require_code_owner_reviews": RequireCodeOwnerReview,
+        "require_last_push_approval": RequireApprovalMostRecentPush,
+        "required_approving_review_count": RequireApprovals,
+        "bypass_pull_request_allowances": <not used>,
+    },
+    "required_signatures": {
+        "url": <not used>,
+        "enabled": RequireSignedCommits
+    },
+    "enforce_admins": {
+        "url": <not used>,
+        "enabled": DoNotAllowBypassSettings
+    },
+    "required_linear_history": {
+        "enabled": RequireLinearHistory
+    },
+    "allow_force_pushes": {
+        "enabled": AllowForcePushes
+    },
+    "allow_deletions": {
+        "enabled": AllowDeletions
+    },
+    "block_creations": {
+        "enabled": <not used>
+    },
+    "required_conversation_resolution": {
+        "enabled": RequireConversationResolution
+    },
+    "lock_branch": {
+        "enabled": <not used>
+    },
+    "allow_fork_syncing": {
+        "enabled": <not used>
+    }
+}
+"""
 
 from typing import Any, Optional
 
@@ -33,56 +86,6 @@ from .ClassicBranchProtectionRequirements.RequireSignedCommits import RequireSig
 from .ClassicBranchProtectionRequirements.RequireStatusChecksToPass import RequireStatusChecksToPass
 from .ClassicBranchProtectionRequirements.RequireUpToDateBranches import RequireUpToDateBranches
 
-# REQUEST : https://api.github.com/repos/<username>/<repo>/branches/<branch>/protection
-# RESPONSE:
-# {
-#     "url": <not used>,
-#     "required_status_checks": { /* RequireStatusChecksToPass */
-#         "url": <not used>,
-#         "strict": RequireUpToDateBranches,
-#         "contexts": <not used>,
-#         "contexts_url": <not used>,
-#         "checks": EnsureStatusChecks
-#     },
-#     "required_pull_request_reviews": {  /* RequirePullRequests */
-#         "url": <not used>,
-#         "dismiss_stale_reviews": DismissStalePullRequestApprovals,
-#         "require_code_owner_reviews": RequireCodeOwnerReview,
-#         "require_last_push_approval": RequireApprovalMostRecentPush,
-#         "required_approving_review_count": RequireApprovals,
-#         "bypass_pull_request_allowances": <not used>,
-#     },
-#     "required_signatures": {
-#         "url": <not used>,
-#         "enabled": RequireSignedCommits
-#     },
-#     "enforce_admins": {
-#         "url": <not used>,
-#         "enabled": DoNotAllowBypassSettings
-#     },
-#     "required_linear_history": {
-#         "enabled": RequireLinearHistory
-#     },
-#     "allow_force_pushes": {
-#         "enabled": AllowForcePushes
-#     },
-#     "allow_deletions": {
-#         "enabled": AllowDeletions
-#     },
-#     "block_creations": {
-#         "enabled": <not used>
-#     },
-#     "required_conversation_resolution": {
-#         "enabled": RequireConversationResolution
-#     },
-#     "lock_branch": {
-#         "enabled": <not used>
-#     },
-#     "allow_fork_syncing": {
-#         "enabled": <not used>
-#     }
-# }
-
 
 # ----------------------------------------------------------------------
 class ClassicBranchProtectionQuery(Query):

repoauditor-0.2.22/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.22/src/RepoAuditor/Plugins/GitHub/StandardQuery.py

@@ -0,0 +1,248 @@
+# -------------------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# -------------------------------------------------------------------------------
+"""Contains the StandardQuery object.
+
+The API request/response has the following schema:
+
+REQUEST: https://api.github.com/repos/<username>/<repo>
+RESPONSE:
+{
+    "id": <not used>,
+    "node_id": <not used>,
+    "name": <not used>",
+    "full_name": <not used>,
+    "private": Private,
+    "owner": {
+        "login": <not used>,
+        "id": <not used>,
+        "node_id": <not used>,
+        "avatar_url": <not used>,
+        "gravatar_id": <not used>,
+        "url": <not used>,
+        "html_url": <not used>,
+        "followers_url": <not used>,
+        "following_url": <not used>,
+        "gists_url": <not used>,
+        "starred_url": <not used>,
+        "subscriptions_url": <not used>,
+        "organizations_url": <not used>,
+        "repos_url": <not used>,
+        "events_url": <not used>,
+        "received_events_url": <not used>,
+        "type": <not used>,
+        "site_admin": <not used>
+    },
+    "html_url": <not used>,
+    "description": Description,
+    "fork": <not used>,
+    "url": <not used>,
+    "forks_url": <not used>,
+    "keys_url": <not used>,
+    "collaborators_url": <not used>,
+    "teams_url": <not used>,
+    "hooks_url": <not used>,
+    "issue_events_url": <not used>,
+    "events_url": <not used>,
+    "assignees_url": <not used>,
+    "branches_url": <not used>,
+    "tags_url": <not used>,
+    "blobs_url": <not used>,
+    "git_tags_url": <not used>,
+    "git_refs_url": <not used>,
+    "trees_url": <not used>,
+    "statuses_url": <not used>,
+    "languages_url": <not used>,
+    "stargazers_url": <not used>,
+    "contributors_url": <not used>,
+    "subscribers_url": <not used>,
+    "subscription_url": <not used>,
+    "commits_url": <not used>,
+    "git_commits_url": <not used>,
+    "comments_url": <not used>,
+    "issue_comment_url": <not used>,
+    "contents_url": <not used>,
+    "compare_url": <not used>,
+    "merges_url": <not used>,
+    "archive_url": <not used>,
+    "downloads_url": <not used>,
+    "issues_url": <not used>,
+    "pulls_url": <not used>,
+    "milestones_url": <not used>,
+    "notifications_url": <not used>,
+    "labels_url": <not used>,
+    "releases_url": <not used>,
+    "deployments_url": <not used>,
+    "created_at": <not used>,
+    "updated_at": <not used>,
+    "pushed_at": <not used>,
+    "git_url": <not used>,
+    "ssh_url": <not used>,
+    "clone_url": <not used>,
+    "svn_url": <not used>,
+    "homepage": <not used>,
+    "size": <not used>,
+    "stargazers_count": <not used>,
+    "watchers_count": <not used>,
+    "language": <not used>,
+    "has_issues": SupportIssues,
+    "has_projects": SupportProjects,
+    "has_downloads": <not used> (No way to set value in GitHub settings),
+    "has_wiki": SupportWikis,
+    "has_pages": <not used>,
+    "has_discussions": SupportDiscussions,
+    "forks_count": <not used>,
+    "mirror_url": <not used>,
+    "archived": <not used>,
+    "disabled": <not used>,
+    "open_issues_count": <not used>,
+    "license": {
+        "key": <not used>,
+        "name": License,
+        "spdx_id": <not used>,
+        "url": <not used>,
+        "node_id": <not used>
+    },
+    "allow_forking": <not used> (No way to set value in GitHub settings),
+    "is_template": <not used>,
+    "web_commit_signoff_required": WebCommitSignoff,
+    "topics": <not used>,
+    "visibility": Private,
+    "forks": <not used>,
+    "open_issues": <not used>,
+    "watchers": <not used>,
+    "default_branch": DefaultBranch,
+    "permissions": {
+        "admin": <not used>,
+        "maintain": <not used>,
+        "push": <not used>,
+        "triage": <not used>,
+        "pull": <not used>
+    },
+    "temp_clone_token": <not used>,
+    "allow_squash_merge": SquashMergeCommit,
+    "allow_merge_commit": MergeCommit,
+    "allow_rebase_merge": RebaseMergeCommit,
+    "allow_auto_merge": AutoMerge,
+    "delete_branch_on_merge": DeleteHeadBranches,
+    "allow_update_branch": SuggestUpdatingPullRequestBranches,
+    "use_squash_pr_title_as_default": <not used> (No way to set value in GitHub settings),
+    "squash_merge_commit_message": SquashMergeCommitMessage,
+    "squash_merge_commit_title": <not used> (No way to set value in GitHub settings),
+    "merge_commit_message": MergeCommitMessage,
+    "merge_commit_title": <not used> (No way to set value in GitHub settings),
+    "custom_properties": <not used>,
+    "organization": {
+        "login": <not used>,
+        "id": <not used>,
+        "node_id": <not used>,
+        "avatar_url": <not used>,
+        "gravatar_id": <not used>,
+        "url": <not used>,
+        "html_url": <not used>,
+        "followers_url": <not used>,
+        "following_url": <not used>,
+        "gists_url": <not used>,
+        "starred_url": <not used>,
+        "subscriptions_url": <not used>,
+        "organizations_url": <not used>,
+        "repos_url": <not used>,
+        "events_url": <not used>,
+        "received_events_url": <not used>,
+        "type": <not used>,
+        "site_admin": <not used>
+    },
+    "security_and_analysis": {
+        "secret_scanning": SecretScanning,
+        "secret_scanning_push_protection": SecretScanningPushProtection,
+        "dependabot_security_updates": DependabotSecurityUpdates,
+        "secret_scanning_validity_checks": <not used> (The functionality doesn't seem to be available in the UX yet (https://github.blog/2023-10-04-introducing-secret-scanning-validity-checks-for-major-cloud-services/))
+    },
+    "network_count": <not used>,
+    "subscribers_count": <not used>
+}
+"""
+
+from typing import Any, Optional
+
+from dbrownell_Common.Types import override  # type: ignore[import-untyped]
+
+from RepoAuditor.Query import ExecutionStyle, Query
+
+from .StandardQueryRequirements.AutoMerge import AutoMerge
+from .StandardQueryRequirements.DefaultBranch import DefaultBranch
+from .StandardQueryRequirements.DeleteHeadBranches import DeleteHeadBranches
+from .StandardQueryRequirements.Description import Description
+from .StandardQueryRequirements.DependabotSecurityUpdates import DependabotSecurityUpdates
+from .StandardQueryRequirements.License import License
+from .StandardQueryRequirements.MergeCommit import MergeCommit
+from .StandardQueryRequirements.MergeCommitMessage import MergeCommitMessage
+from .StandardQueryRequirements.Private import Private
+from .StandardQueryRequirements.RebaseMergeCommit import RebaseMergeCommit
+from .StandardQueryRequirements.SecretScanning import SecretScanning
+from .StandardQueryRequirements.SecretScanningPushProtection import SecretScanningPushProtection
+from .StandardQueryRequirements.SquashCommitMerge import SquashCommitMerge
+from .StandardQueryRequirements.SquashMergeCommitMessage import SquashMergeCommitMessage
+from .StandardQueryRequirements.SuggestUpdatingPullRequestBranches import (
+    SuggestUpdatingPullRequestBranches,
+)
+from .StandardQueryRequirements.SupportDiscussions import SupportDiscussions
+from .StandardQueryRequirements.SupportIssues import SupportIssues
+from .StandardQueryRequirements.SupportProjects import SupportProjects
+from .StandardQueryRequirements.SupportWikis import SupportWikis
+from .StandardQueryRequirements.TemplateRepository import TemplateRepository
+from .StandardQueryRequirements.WebCommitSignoff import WebCommitSignoff
+
+
+# ----------------------------------------------------------------------
+class StandardQuery(Query):
+    """Query with requirements that operate on basic GitHub repository data."""
+
+    # ----------------------------------------------------------------------
+    def __init__(self) -> None:
+        super().__init__(
+            "StandardQuery",
+            ExecutionStyle.Parallel,
+            [
+                AutoMerge(),
+                DefaultBranch(),
+                DeleteHeadBranches(),
+                Description(),
+                DependabotSecurityUpdates(),
+                License(),
+                MergeCommit(),
+                MergeCommitMessage(),
+                Private(),
+                RebaseMergeCommit(),
+                SecretScanning(),
+                SecretScanningPushProtection(),
+                SquashCommitMerge(),
+                SquashMergeCommitMessage(),
+                SuggestUpdatingPullRequestBranches(),
+                SupportDiscussions(),
+                SupportIssues(),
+                SupportProjects(),
+                SupportWikis(),
+                TemplateRepository(),
+                WebCommitSignoff(),
+            ],
+        )
+
+    # ----------------------------------------------------------------------
+    @override
+    def GetData(
+        self,
+        module_data: dict[str, Any],
+    ) -> Optional[dict[str, Any]]:
+        """Get the data from an API session."""
+        response = module_data["session"].get("")
+
+        response.raise_for_status()
+        response = response.json()
+
+        module_data["standard"] = response
+
+        return module_data