feat(repository): add new check repository_default_branch_status_checks_required (#6204)

Co-authored-by: MrCloudSec <hello@mistercloudsec.com>

prowler/CHANGELOG.md

@@ -14,6 +14,7 @@ All notable changes to the **Prowler SDK** are documented in this file.
 - Add `repository_default_branch_requires_linear_history` check for GitHub provider. [(#6162)](https://github.com/prowler-cloud/prowler/pull/6162)
 - Add `repository_default_branch_disallows_force_push` check for GitHub provider. [(#6197)](https://github.com/prowler-cloud/prowler/pull/6197)
 - Add `repository_default_branch_deletion_disabled` check for GitHub provider. [(#6200)](https://github.com/prowler-cloud/prowler/pull/6200)
+- Add `repository_default_branch_status_checks_required` check for GitHub provider. [(#6204)](https://github.com/prowler-cloud/prowler/pull/6204)
 - Add `organization_members_mfa_required` check for GitHub provider. [(#6304)](https://github.com/prowler-cloud/prowler/pull/6304)
 - Add GitHub provider documentation and CIS v1.0.0 compliance. [(#6116)](https://github.com/prowler-cloud/prowler/pull/6116)
 

prowler/providers/github/services/repository/repository_default_branch_status_checks_required/repository_default_branch_status_checks_required.metadata.json

@@ -0,0 +1,30 @@
+{
+  "Provider": "github",
+  "CheckID": "repository_default_branch_status_checks_required",
+  "CheckTitle": "Check if repository enforces status checks to pass",
+  "CheckType": [],
+  "ServiceName": "repository",
+  "SubServiceName": "",
+  "ResourceIdTemplate": "",
+  "Severity": "high",
+  "ResourceType": "GithubRepository",
+  "Description": "Ensure that the repository enforces status checks to pass before merging code into the main branch.",
+  "Risk": "Merging code without requiring all checks to pass increases the risk of introducing bugs, vulnerabilities, or unstable changes into the codebase. This can compromise the quality, security, and functionality of the application.",
+  "RelatedUrl": "https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-status-checks-before-merging",
+  "Remediation": {
+    "Code": {
+      "CLI": "",
+      "NativeIaC": "",
+      "Other": "",
+      "Terraform": ""
+    },
+    "Recommendation": {
+      "Text": "Require all predefined status checks to pass successfully before allowing code changes to be merged. This ensures that all quality, stability, and security conditions are met, reducing the likelihood of errors or vulnerabilities being introduced into the project.",
+      "Url": "https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule"
+    }
+  },
+  "Categories": [],
+  "DependsOn": [],
+  "RelatedTo": [],
+  "Notes": ""
+}

prowler/providers/github/services/repository/repository_default_branch_status_checks_required/repository_default_branch_status_checks_required.py

@@ -0,0 +1,42 @@
+from typing import List
+
+from prowler.lib.check.models import Check, CheckReportGithub
+from prowler.providers.github.services.repository.repository_client import (
+    repository_client,
+)
+
+
+class repository_default_branch_status_checks_required(Check):
+    """Check if a repository enforces status checks.
+
+    This class verifies whether each repository enforces status checks.
+    """
+
+    def execute(self) -> List[CheckReportGithub]:
+        """Execute the Github Repository
+
+        Iterates over all repositories and checks if they enforce status checks.
+
+        Returns:
+            List[CheckReportGithub]: A list of reports for each repository.
+        """
+        findings = []
+        for repo in repository_client.repositories.values():
+            if repo.status_checks is not None:
+                report = CheckReportGithub(
+                    self.metadata(), resource=repo, repository=repo.name
+                )
+                report.status = "FAIL"
+                report.status_extended = (
+                    f"Repository {repo.name} does not enforce status checks."
+                )
+
+                if repo.status_checks:
+                    report.status = "PASS"
+                    report.status_extended = (
+                        f"Repository {repo.name} does enforce status checks."
+                    )
+
+                findings.append(report)
+
+        return findings

prowler/providers/github/services/repository/repository_service.py

@@ -36,6 +36,7 @@ class Repository(GithubService):
                     required_linear_history = False
                     allow_force_pushes = True
                     branch_deletion = True
+                    status_checks = False
                     try:
                         branch = repo.get_branch(default_branch)
                         if branch.protected:
@@ -54,6 +55,9 @@ class Repository(GithubService):
                                 )
                                 allow_force_pushes = protection.allow_force_pushes
                                 branch_deletion = protection.allow_deletions
+                                status_checks = (
+                                    protection.required_status_checks is not None
+                                )
                                 branch_protection = True
                     except Exception as error:
                         # If the branch is not found, it is not protected
@@ -69,6 +73,7 @@ class Repository(GithubService):
                             required_linear_history = None
                             allow_force_pushes = None
                             branch_deletion = None
+                            status_checks = None
                             logger.error(
                                 f"{error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}"
                             )
@@ -85,6 +90,7 @@ class Repository(GithubService):
                         required_linear_history=required_linear_history,
                         allow_force_pushes=allow_force_pushes,
                         default_branch_deletion=branch_deletion,
+                        status_checks=status_checks,
                         default_branch_protection=branch_protection,
                     )
 
@@ -109,4 +115,5 @@ class Repo(BaseModel):
     required_linear_history: Optional[bool]
     allow_force_pushes: Optional[bool]
     default_branch_deletion: Optional[bool]
+    status_checks: Optional[bool]
     approval_count: Optional[int]

tests/providers/github/services/repository/repository_default_branch_status_checks_required/repository_default_branch_status_checks_required_test.py

@@ -0,0 +1,110 @@
+from unittest import mock
+
+from prowler.providers.github.services.repository.repository_service import Repo
+from tests.providers.github.github_fixtures import set_mocked_github_provider
+
+
+class Test_repository_default_branch_status_checks_required_test:
+    def test_no_repositories(self):
+        repository_client = mock.MagicMock
+        repository_client.repositories = {}
+
+        with (
+            mock.patch(
+                "prowler.providers.common.provider.Provider.get_global_provider",
+                return_value=set_mocked_github_provider(),
+            ),
+            mock.patch(
+                "prowler.providers.github.services.repository.repository_default_branch_status_checks_required.repository_default_branch_status_checks_required.repository_client",
+                new=repository_client,
+            ),
+        ):
+            from prowler.providers.github.services.repository.repository_default_branch_status_checks_required.repository_default_branch_status_checks_required import (
+                repository_default_branch_status_checks_required,
+            )
+
+            check = repository_default_branch_status_checks_required()
+            result = check.execute()
+            assert len(result) == 0
+
+    def test_enforce_status_checks_disabled(self):
+        repository_client = mock.MagicMock
+        repo_name = "repo1"
+        default_branch = "main"
+        repository_client.repositories = {
+            1: Repo(
+                id=1,
+                name=repo_name,
+                full_name="account-name/repo1",
+                default_branch=default_branch,
+                status_checks=False,
+                private=False,
+                securitymd=False,
+            ),
+        }
+
+        with (
+            mock.patch(
+                "prowler.providers.common.provider.Provider.get_global_provider",
+                return_value=set_mocked_github_provider(),
+            ),
+            mock.patch(
+                "prowler.providers.github.services.repository.repository_default_branch_status_checks_required.repository_default_branch_status_checks_required.repository_client",
+                new=repository_client,
+            ),
+        ):
+            from prowler.providers.github.services.repository.repository_default_branch_status_checks_required.repository_default_branch_status_checks_required import (
+                repository_default_branch_status_checks_required,
+            )
+
+            check = repository_default_branch_status_checks_required()
+            result = check.execute()
+            assert len(result) == 1
+            assert result[0].resource_id == 1
+            assert result[0].resource_name == "repo1"
+            assert result[0].status == "FAIL"
+            assert (
+                result[0].status_extended
+                == f"Repository {repo_name} does not enforce status checks."
+            )
+
+    def test_enforce_status_checks_enabled(self):
+        repository_client = mock.MagicMock
+        repo_name = "repo1"
+        default_branch = "main"
+        repository_client.repositories = {
+            1: Repo(
+                id=1,
+                name=repo_name,
+                full_name="account-name/repo1",
+                private=False,
+                default_branch=default_branch,
+                status_checks=True,
+                securitymd=True,
+            ),
+        }
+
+        with (
+            mock.patch(
+                "prowler.providers.common.provider.Provider.get_global_provider",
+                return_value=set_mocked_github_provider(),
+            ),
+            mock.patch(
+                "prowler.providers.github.services.repository.repository_default_branch_status_checks_required.repository_default_branch_status_checks_required.repository_client",
+                new=repository_client,
+            ),
+        ):
+            from prowler.providers.github.services.repository.repository_default_branch_status_checks_required.repository_default_branch_status_checks_required import (
+                repository_default_branch_status_checks_required,
+            )
+
+            check = repository_default_branch_status_checks_required()
+            result = check.execute()
+            assert len(result) == 1
+            assert result[0].resource_id == 1
+            assert result[0].resource_name == "repo1"
+            assert result[0].status == "PASS"
+            assert (
+                result[0].status_extended
+                == f"Repository {repo_name} does enforce status checks."
+            )

tests/providers/github/services/repository/repository_service_test.py

@@ -21,6 +21,7 @@ def mock_list_repositories(_):
             required_linear_history=True,
             allow_force_pushes=True,
             default_branch_deletion=True,
+            status_checks=True,
             approval_count=2,
         ),
     }
@@ -51,4 +52,5 @@ class Test_Repository_Service:
         assert repository_service.repositories[1].require_pull_request
         assert repository_service.repositories[1].allow_force_pushes
         assert repository_service.repositories[1].default_branch_deletion
+        assert repository_service.repositories[1].status_checks
         assert repository_service.repositories[1].approval_count == 2