feat(DRS): New DRS Service and Checks (#2257)

Co-authored-by: Pepe Fagoaga <pepe@verica.io>
This commit is contained in:
Gabriel Soltz
2023-04-24 14:22:22 +02:00
committed by GitHub
parent 8e63fa4594
commit a87f769b85
8 changed files with 371 additions and 0 deletions

View File

@@ -0,0 +1,114 @@
from unittest import mock
from prowler.providers.aws.services.drs.drs_service import DRSservice, Job
AWS_REGION = "eu-west-1"
JOB_ARN = "arn:aws:drs:eu-west-1:123456789012:job/12345678901234567890123456789012"
class Test_drs_job_exist:
def test_drs_job_exist(self):
drs_client = mock.MagicMock
drs_client.region = AWS_REGION
drs_client.drs_services = [
DRSservice(
id="DRS",
status="ENABLED",
region=AWS_REGION,
jobs=[
Job(
arn=JOB_ARN,
id="12345678901234567890123456789012",
status="COMPLETED",
region=AWS_REGION,
tags=[{"Key": "Name", "Value": "test"}],
)
],
)
]
with mock.patch(
"prowler.providers.aws.services.drs.drs_service.DRS",
new=drs_client,
):
# Test Check
from prowler.providers.aws.services.drs.drs_job_exist.drs_job_exist import (
drs_job_exist,
)
check = drs_job_exist()
result = check.execute()
assert len(result) == 1
assert result[0].status == "PASS"
assert (
result[0].status_extended == "DRS is enabled for this region with jobs."
)
assert result[0].resource_id == "DRS"
assert result[0].resource_arn == ""
assert result[0].region == AWS_REGION
assert result[0].resource_tags == []
def test_drs_no_jobs(self):
drs_client = mock.MagicMock
drs_client.region = AWS_REGION
drs_client.drs_services = [
DRSservice(
id="DRS",
status="ENABLED",
region=AWS_REGION,
jobs=[],
)
]
with mock.patch(
"prowler.providers.aws.services.drs.drs_service.DRS",
new=drs_client,
):
# Test Check
from prowler.providers.aws.services.drs.drs_job_exist.drs_job_exist import (
drs_job_exist,
)
check = drs_job_exist()
result = check.execute()
assert len(result) == 1
assert result[0].status == "FAIL"
assert (
result[0].status_extended
== "DRS is enabled for this region without jobs."
)
assert result[0].resource_id == "DRS"
assert result[0].resource_arn == ""
assert result[0].region == AWS_REGION
assert result[0].resource_tags == []
def test_drs_disabled(self):
drs_client = mock.MagicMock
drs_client.region = AWS_REGION
drs_client.drs_services = [
DRSservice(
id="DRS",
status="DISABLED",
region=AWS_REGION,
jobs=[],
)
]
with mock.patch(
"prowler.providers.aws.services.drs.drs_service.DRS",
new=drs_client,
):
# Test Check
from prowler.providers.aws.services.drs.drs_job_exist.drs_job_exist import (
drs_job_exist,
)
check = drs_job_exist()
result = check.execute()
assert len(result) == 1
assert result[0].status == "FAIL"
assert result[0].status_extended == "DRS is not enabled for this region."
assert result[0].resource_id == "DRS"
assert result[0].resource_arn == ""
assert result[0].region == AWS_REGION
assert result[0].resource_tags == []

View File

@@ -0,0 +1,98 @@
from datetime import datetime
from unittest.mock import patch
import botocore
from boto3 import session
from prowler.providers.aws.lib.audit_info.audit_info import AWS_Audit_Info
from prowler.providers.aws.services.drs.drs_service import DRS
# Mock Test Region
AWS_REGION = "us-east-1"
# Mocking Calls
make_api_call = botocore.client.BaseClient._make_api_call
def mock_make_api_call(self, operation_name, kwargs):
"""We have to mock every AWS API call using Boto3"""
if operation_name == "DescribeJobs":
return {
"items": [
{
"arn": "arn:aws:disaster-recovery:us-east-1:123456789012:job/jobID1",
"creationDateTime": datetime(2024, 1, 1),
"endDateTime": datetime(2024, 1, 1),
"initiatedBy": "START_RECOVERY",
"jobID": "jobID1",
"participatingServers": [
{
"launchStatus": "PENDING",
"recoveryInstanceID": "i-1234567890abcdef0",
"sourceServerID": "i-1234567890abcdef0",
},
],
"status": "PENDING",
"tags": {"test_tag": "test_value"},
"type": "LAUNCH",
},
]
}
return make_api_call(self, operation_name, kwargs)
def mock_generate_regional_clients(service, audit_info):
regional_client = audit_info.audit_session.client(service, region_name=AWS_REGION)
regional_client.region = AWS_REGION
return {AWS_REGION: regional_client}
# Patch every AWS call using Boto3 and generate_regional_clients to have 1 client
@patch("botocore.client.BaseClient._make_api_call", new=mock_make_api_call)
@patch(
"prowler.providers.aws.services.drs.drs_service.generate_regional_clients",
new=mock_generate_regional_clients,
)
class Test_DRS_Service:
# Mocked Audit Info
def set_mocked_audit_info(self):
audit_info = AWS_Audit_Info(
session_config=None,
original_session=None,
audit_session=session.Session(
profile_name=None,
botocore_session=None,
),
audited_account=None,
audited_user_id=None,
audited_partition="aws",
audited_identity_arn=None,
profile=None,
profile_region=None,
credentials=None,
assumed_role_info=None,
audited_regions=None,
organizations_metadata=None,
audit_resources=None,
)
return audit_info
def test__get_client__(self):
audit_info = self.set_mocked_audit_info()
drs = DRS(audit_info)
assert drs.regional_clients[AWS_REGION].__class__.__name__ == "drs"
def test__get_service__(self):
audit_info = self.set_mocked_audit_info()
drs = DRS(audit_info)
assert drs.service == "drs"
def test__describe_jobs__(self):
audit_info = self.set_mocked_audit_info()
drs = DRS(audit_info)
assert len(drs.drs_services) == 1
assert drs.drs_services[0].id == "DRS"
assert drs.drs_services[0].region == AWS_REGION
assert drs.drs_services[0].status == "ENABLED"