prowler/tests/providers/aws/services/dlm/dlm_service_test.py

import botocore
from mock import patch

from prowler.providers.aws.services.dlm.dlm_service import DLM, LifecyclePolicy
from tests.providers.aws.utils import (
    AWS_ACCOUNT_NUMBER,
    AWS_REGION_US_EAST_1,
    set_mocked_aws_provider,
)

LIFECYCLE_POLICY_ID = "policy-XXXXXXXXXXXX"

# Mocking Access Analyzer Calls
make_api_call = botocore.client.BaseClient._make_api_call


def mock_make_api_call(self, operation_name, kwargs):
    """
    As you can see the operation_name has the list_analyzers snake_case form but
    we are using the ListAnalyzers form.
    Rationale -> https://github.com/boto/botocore/blob/develop/botocore/client.py#L810:L816

    We have to mock every AWS API call using Boto3
    """
    if operation_name == "GetLifecyclePolicies":
        return {
            "Policies": [
                {
                    "PolicyId": "policy-XXXXXXXXXXXX",
                    "Description": "test",
                    "State": "ENABLED",
                    "Tags": {"environment": "dev"},
                    "PolicyType": "EBS_SNAPSHOT_MANAGEMENT",
                }
            ]
        }
    if operation_name == "DescribeSnapshots":
        return {"Snapshots": [{"SnapshotId": "snap-1234567890abcdef0"}]}

    return make_api_call(self, operation_name, kwargs)


def mock_generate_regional_clients(provider, service):
    regional_client = provider._session.current_session.client(
        service, region_name=AWS_REGION_US_EAST_1
    )
    regional_client.region = AWS_REGION_US_EAST_1
    return {AWS_REGION_US_EAST_1: regional_client}


def mock_generate_regional_clients_without_ec2(provider, service):
    if service == "ec2":
        return None

    return mock_generate_regional_clients(provider, service)


@patch(
    "prowler.providers.aws.aws_provider.AwsProvider.generate_regional_clients",
    new=mock_generate_regional_clients,
)
# Patch every AWS call using Boto3
@patch("botocore.client.BaseClient._make_api_call", new=mock_make_api_call)
class Test_DLM_Service:
    # Test DLM Service
    def test_service(self):
        aws_provider = set_mocked_aws_provider()
        dlm = DLM(aws_provider)
        assert dlm.service == "dlm"

    # Test DLM Client
    def test_client(self):
        aws_provider = set_mocked_aws_provider()
        dlm = DLM(aws_provider)
        assert dlm.client.__class__.__name__ == "DLM"

    # Test DLM Session
    def test__get_session__(self):
        aws_provider = set_mocked_aws_provider()
        dlm = DLM(aws_provider)
        assert dlm.session.__class__.__name__ == "Session"

    # Test DLM Session
    def test_audited_account(self):
        aws_provider = set_mocked_aws_provider()
        dlm = DLM(aws_provider)
        assert dlm.audited_account == AWS_ACCOUNT_NUMBER

    # Test DLM Get DLM Contacts
    def test_get_lifecycle_policies(self):
        # DLM client for this test class
        aws_provider = set_mocked_aws_provider()
        dlm = DLM(aws_provider)
        assert dlm.lifecycle_policies == {
            AWS_REGION_US_EAST_1: {
                LIFECYCLE_POLICY_ID: LifecyclePolicy(
                    id=LIFECYCLE_POLICY_ID,
                    state="ENABLED",
                    tags={"environment": "dev"},
                    type="EBS_SNAPSHOT_MANAGEMENT",
                )
            }
        }

    def test_get_regions_with_snapshots(self):
        aws_provider = set_mocked_aws_provider()
        dlm = DLM(aws_provider)
        assert dlm.regions_with_snapshots == {AWS_REGION_US_EAST_1: True}


@patch(
    "prowler.providers.aws.aws_provider.AwsProvider.generate_regional_clients",
    new=mock_generate_regional_clients_without_ec2,
)
@patch("botocore.client.BaseClient._make_api_call", new=mock_make_api_call)
class Test_DLM_Service_Without_EC2_Regional_Clients:
    def test_service_handles_missing_ec2_regional_clients(self):
        aws_provider = set_mocked_aws_provider()
        dlm = DLM(aws_provider)

        assert dlm.regions_with_snapshots == {}


class FakeEC2RegionalClient:
    def __init__(self, responses):
        self.region = AWS_REGION_US_EAST_1
        self.requests = []
        self.responses = list(responses)

    def describe_snapshots(self, **kwargs):
        self.requests.append(kwargs)
        return self.responses.pop(0)


class Test_DLM_Regions_With_Snapshots:
    def test_get_regions_without_snapshots(self):
        dlm = DLM.__new__(DLM)
        dlm.regions_with_snapshots = {}
        regional_client = FakeEC2RegionalClient([{"Snapshots": []}])

        dlm._get_regions_with_snapshots(regional_client)

        assert dlm.regions_with_snapshots == {AWS_REGION_US_EAST_1: False}
        assert regional_client.requests == [{"OwnerIds": ["self"], "MaxResults": 5}]

    def test_get_regions_with_snapshots_after_pagination(self):
        dlm = DLM.__new__(DLM)
        dlm.regions_with_snapshots = {}
        regional_client = FakeEC2RegionalClient(
            [
                {"Snapshots": [], "NextToken": "next-page"},
                {"Snapshots": [{"SnapshotId": "snap-1234567890abcdef0"}]},
            ]
        )

        dlm._get_regions_with_snapshots(regional_client)

        assert dlm.regions_with_snapshots == {AWS_REGION_US_EAST_1: True}
        assert regional_client.requests == [
            {"OwnerIds": ["self"], "MaxResults": 5},
            {"OwnerIds": ["self"], "MaxResults": 5, "NextToken": "next-page"},
        ]