feat(repository): add new check repository_default_branch_requires_linear_history (#6162)

Co-authored-by: MrCloudSec <hello@mistercloudsec.com>
This commit is contained in:
Hugo Pereira Brito
2025-05-14 14:37:27 +02:00
committed by GitHub
parent beb7a53efe
commit 5a9ccd60a0
11 changed files with 210 additions and 25 deletions
@@ -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_requires_linear_history_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_requires_linear_history.repository_default_branch_requires_linear_history.repository_client",
new=repository_client,
),
):
from prowler.providers.github.services.repository.repository_default_branch_requires_linear_history.repository_default_branch_requires_linear_history import (
repository_default_branch_requires_linear_history,
)
check = repository_default_branch_requires_linear_history()
result = check.execute()
assert len(result) == 0
def test_linear_history_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,
required_linear_history=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_requires_linear_history.repository_default_branch_requires_linear_history.repository_client",
new=repository_client,
),
):
from prowler.providers.github.services.repository.repository_default_branch_requires_linear_history.repository_default_branch_requires_linear_history import (
repository_default_branch_requires_linear_history,
)
check = repository_default_branch_requires_linear_history()
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 require linear history on default branch ({default_branch})."
)
def test_linear_history_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,
required_linear_history=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_requires_linear_history.repository_default_branch_requires_linear_history.repository_client",
new=repository_client,
),
):
from prowler.providers.github.services.repository.repository_default_branch_requires_linear_history.repository_default_branch_requires_linear_history import (
repository_default_branch_requires_linear_history,
)
check = repository_default_branch_requires_linear_history()
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 require linear history on default branch ({default_branch})."
)
@@ -4,7 +4,7 @@ from prowler.providers.github.services.repository.repository_service import Repo
from tests.providers.github.github_fixtures import set_mocked_github_provider
class Test_repository_code_changes_multi_approval_requirement:
class Test_repository_default_branch_requires_multiple_approvals:
def test_no_repositories(self):
repository_client = mock.MagicMock
repository_client.repositories = {}
@@ -15,15 +15,15 @@ class Test_repository_code_changes_multi_approval_requirement:
return_value=set_mocked_github_provider(),
),
mock.patch(
"prowler.providers.github.services.repository.repository_code_changes_multi_approval_requirement.repository_code_changes_multi_approval_requirement.repository_client",
"prowler.providers.github.services.repository.repository_default_branch_requires_multiple_approvals.repository_default_branch_requires_multiple_approvals.repository_client",
new=repository_client,
),
):
from prowler.providers.github.services.repository.repository_code_changes_multi_approval_requirement.repository_code_changes_multi_approval_requirement import (
repository_code_changes_multi_approval_requirement,
from prowler.providers.github.services.repository.repository_default_branch_requires_multiple_approvals.repository_default_branch_requires_multiple_approvals import (
repository_default_branch_requires_multiple_approvals,
)
check = repository_code_changes_multi_approval_requirement()
check = repository_default_branch_requires_multiple_approvals()
result = check.execute()
assert len(result) == 0
@@ -50,15 +50,15 @@ class Test_repository_code_changes_multi_approval_requirement:
return_value=set_mocked_github_provider(),
),
mock.patch(
"prowler.providers.github.services.repository.repository_code_changes_multi_approval_requirement.repository_code_changes_multi_approval_requirement.repository_client",
"prowler.providers.github.services.repository.repository_default_branch_requires_multiple_approvals.repository_default_branch_requires_multiple_approvals.repository_client",
new=repository_client,
),
):
from prowler.providers.github.services.repository.repository_code_changes_multi_approval_requirement.repository_code_changes_multi_approval_requirement import (
repository_code_changes_multi_approval_requirement,
from prowler.providers.github.services.repository.repository_default_branch_requires_multiple_approvals.repository_default_branch_requires_multiple_approvals import (
repository_default_branch_requires_multiple_approvals,
)
check = repository_code_changes_multi_approval_requirement()
check = repository_default_branch_requires_multiple_approvals()
result = check.execute()
assert len(result) == 1
assert result[0].resource_id == 1
@@ -92,15 +92,15 @@ class Test_repository_code_changes_multi_approval_requirement:
return_value=set_mocked_github_provider(),
),
mock.patch(
"prowler.providers.github.services.repository.repository_code_changes_multi_approval_requirement.repository_code_changes_multi_approval_requirement.repository_client",
"prowler.providers.github.services.repository.repository_default_branch_requires_multiple_approvals.repository_default_branch_requires_multiple_approvals.repository_client",
new=repository_client,
),
):
from prowler.providers.github.services.repository.repository_code_changes_multi_approval_requirement.repository_code_changes_multi_approval_requirement import (
repository_code_changes_multi_approval_requirement,
from prowler.providers.github.services.repository.repository_default_branch_requires_multiple_approvals.repository_default_branch_requires_multiple_approvals import (
repository_default_branch_requires_multiple_approvals,
)
check = repository_code_changes_multi_approval_requirement()
check = repository_default_branch_requires_multiple_approvals()
result = check.execute()
assert len(result) == 1
assert result[0].resource_id == 1
@@ -134,15 +134,15 @@ class Test_repository_code_changes_multi_approval_requirement:
return_value=set_mocked_github_provider(),
),
mock.patch(
"prowler.providers.github.services.repository.repository_code_changes_multi_approval_requirement.repository_code_changes_multi_approval_requirement.repository_client",
"prowler.providers.github.services.repository.repository_default_branch_requires_multiple_approvals.repository_default_branch_requires_multiple_approvals.repository_client",
new=repository_client,
),
):
from prowler.providers.github.services.repository.repository_code_changes_multi_approval_requirement.repository_code_changes_multi_approval_requirement import (
repository_code_changes_multi_approval_requirement,
from prowler.providers.github.services.repository.repository_default_branch_requires_multiple_approvals.repository_default_branch_requires_multiple_approvals import (
repository_default_branch_requires_multiple_approvals,
)
check = repository_code_changes_multi_approval_requirement()
check = repository_default_branch_requires_multiple_approvals()
result = check.execute()
assert len(result) == 1
assert result[0].resource_id == 1
@@ -18,6 +18,7 @@ def mock_list_repositories(_):
private=False,
securitymd=True,
require_pull_request=True,
required_linear_history=True,
approval_count=2,
),
}
@@ -44,5 +45,6 @@ class Test_Repository_Service:
assert repository_service.repositories[1].private is False
assert repository_service.repositories[1].default_branch == "main"
assert repository_service.repositories[1].securitymd
assert repository_service.repositories[1].required_linear_history
assert repository_service.repositories[1].require_pull_request
assert repository_service.repositories[1].approval_count == 2