prowler/tests/providers/aws/services/sqs/sqs_service_test.py

from json import dumps
from unittest.mock import patch
from uuid import uuid4

import botocore
from boto3 import client
from botocore.exceptions import ClientError
from moto import mock_aws

from prowler.providers.aws.services.sqs.sqs_service import SQS
from tests.providers.aws.utils import (
    AWS_ACCOUNT_NUMBER,
    AWS_REGION_EU_WEST_1,
    set_mocked_aws_provider,
)

test_queue = "test-queue"
test_key = str(uuid4())
test_queue_arn = f"arn:aws:sqs:{AWS_REGION_EU_WEST_1}:{AWS_ACCOUNT_NUMBER}:{test_queue}"
test_policy = {
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Principal": {"AWS": "*"},
            "Action": "sqs:SendMessage",
            "Resource": test_queue_arn,
        }
    ],
}

make_api_call = botocore.client.BaseClient._make_api_call


def mock_make_api_call(self, operation_name, kwarg):
    if operation_name == "GetQueueAttributes":
        return {
            "Attributes": {"Policy": dumps(test_policy), "KmsMasterKeyId": test_key}
        }
    return make_api_call(self, operation_name, kwarg)


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


@patch("botocore.client.BaseClient._make_api_call", new=mock_make_api_call)
@patch(
    "prowler.providers.aws.aws_provider.AwsProvider.generate_regional_clients",
    new=mock_generate_regional_clients,
)
class Test_SQS_Service:
    # Test SQS Service
    def test_service(self):
        aws_provider = set_mocked_aws_provider([AWS_REGION_EU_WEST_1])
        sqs = SQS(aws_provider)
        assert sqs.service == "sqs"

    # Test SQS client
    def test_client(self):
        aws_provider = set_mocked_aws_provider([AWS_REGION_EU_WEST_1])
        sqs = SQS(aws_provider)
        for reg_client in sqs.regional_clients.values():
            assert reg_client.__class__.__name__ == "SQS"

    # Test SQS session
    def test__get_session__(self):
        aws_provider = set_mocked_aws_provider([AWS_REGION_EU_WEST_1])
        sqs = SQS(aws_provider)
        assert sqs.session.__class__.__name__ == "Session"

    @mock_aws
    # Test SQS list queues
    def test_list_queues(self):
        sqs_client = client("sqs", region_name=AWS_REGION_EU_WEST_1)
        queue = sqs_client.create_queue(QueueName=test_queue, tags={"test": "test"})
        aws_provider = set_mocked_aws_provider([AWS_REGION_EU_WEST_1])
        sqs = SQS(aws_provider)
        assert len(sqs.queues) == 1
        assert sqs.queues[0].id == queue["QueueUrl"]
        assert sqs.queues[0].name == test_queue
        assert sqs.queues[0].name == sqs.queues[0].arn.split(":")[-1]
        assert sqs.queues[0].name == sqs.queues[0].id.split("/")[-1]
        assert sqs.queues[0].arn == test_queue_arn
        assert sqs.queues[0].region == AWS_REGION_EU_WEST_1
        assert sqs.queues[0].tags == [{"test": "test"}]

    # moto does not properly mock this and is hardcoded to return 1000 queues
    # so this test currently always fails
    # @mock_aws
    # # Test SQS list queues for over 1000 queues
    # def test_list_queuespagination_over_a_thousand(self):
    #     sqs_client = client("sqs", region_name=AWS_REGION_EU_WEST_1)
    #     for i in range(0,1050):
    #         sqs_client.create_queue(QueueName=f"{test_queue}-{i}", tags={"test": "test"})
    #     aws_provider =set_mocked_aws_provider([AWS_REGION_EU_WEST_1])
    #     sqs = SQS(aws_provider)
    #     assert len(sqs.queues) > 1000

    @mock_aws
    # Test SQS list queues
    def test_get_queue_attributes(self):
        sqs_client = client("sqs", region_name=AWS_REGION_EU_WEST_1)
        queue = sqs_client.create_queue(
            QueueName=test_queue,
        )
        aws_provider = set_mocked_aws_provider([AWS_REGION_EU_WEST_1])
        sqs = SQS(aws_provider)
        assert len(sqs.queues) == 1
        assert sqs.queues[0].id == queue["QueueUrl"]
        assert sqs.queues[0].region == AWS_REGION_EU_WEST_1
        assert sqs.queues[0].policy
        assert sqs.queues[0].kms_key_id == test_key

    @mock_aws
    def test_get_queue_attributes_nonexistent_queue(self):
        aws_provider = set_mocked_aws_provider([AWS_REGION_EU_WEST_1])
        sqs_service = SQS(aws_provider)

        queue_url = f"https://sqs.{AWS_REGION_EU_WEST_1}.amazonaws.com/{AWS_ACCOUNT_NUMBER}/{test_queue}"
        sqs_service.queues = [
            type(
                "Queue",
                (),
                {
                    "id": queue_url,
                    "name": test_queue,
                    "arn": test_queue_arn,
                    "region": AWS_REGION_EU_WEST_1,
                },
            )()
        ]

        def mock_get_queue_attributes(**kwargs):
            raise ClientError(
                {
                    "Error": {
                        "Code": "AWS.SimpleQueueService.NonExistentQueue",
                        "Message": "The specified queue does not exist.",
                    }
                },
                "GetQueueAttributes",
            )

        with patch.object(
            sqs_service.regional_clients[AWS_REGION_EU_WEST_1],
            "get_queue_attributes",
            side_effect=mock_get_queue_attributes,
        ):
            sqs_service._get_queue_attributes()

        assert sqs_service.queues == []