feat(check): New Check and Service: resourceexplorer2_indexes_found (#2196)

Co-authored-by: Sergio Garcia <38561120+sergargar@users.noreply.github.com>
This commit is contained in:
Gabriel Soltz
2023-04-14 10:18:36 +02:00
committed by GitHub
parent 946c943457
commit fa2ec63f45
8 changed files with 312 additions and 0 deletions

View File

@@ -0,0 +1,108 @@
from unittest import mock
from unittest.mock import patch
import botocore
from boto3 import session
from prowler.providers.aws.lib.audit_info.models import AWS_Audit_Info
from prowler.providers.aws.services.resourceexplorer2.resourceexplorer2_service import (
Indexes,
)
AWS_ACCOUNT_NUMBER = "123456789012"
AWS_REGION = "us-east-1"
INDEX_ARN = "arn:aws:resource-explorer-2:ap-south-1:123456789012:index/123456-2896-4fe8-93d2-15ec137e5c47"
INDEX_REGION = "us-east-1"
# Mocking Backup Calls
make_api_call = botocore.client.BaseClient._make_api_call
def mock_make_api_call(self, operation_name, kwarg):
"""
Mock every AWS API call
"""
if operation_name == "ListIndexes":
return {
"Indexes": [
{"Arn": INDEX_ARN, "Region": INDEX_REGION, "Type": "LOCAL"},
],
"NextToken": "string",
}
return make_api_call(self, operation_name, kwarg)
@patch("botocore.client.BaseClient._make_api_call", new=mock_make_api_call)
class Test_resourceexplorer2_indexes_found:
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=AWS_ACCOUNT_NUMBER,
audited_user_id=None,
audited_partition="aws",
audited_identity_arn=None,
profile=None,
profile_region="us-east-1",
credentials=None,
assumed_role_info=None,
audited_regions="us-east-1",
organizations_metadata=None,
audit_resources=None,
)
return audit_info
def test_no_indexes_found(self):
resourceexplorer2_client = mock.MagicMock
resourceexplorer2_client.indexes = []
resourceexplorer2_client.region = AWS_REGION
with mock.patch(
"prowler.providers.aws.services.resourceexplorer2.resourceexplorer2_service.ResourceExplorer2",
new=resourceexplorer2_client,
):
# Test Check
from prowler.providers.aws.services.resourceexplorer2.resourceexplorer2_indexes_found.resourceexplorer2_indexes_found import (
resourceexplorer2_indexes_found,
)
check = resourceexplorer2_indexes_found()
result = check.execute()
# Assertions
assert len(result) == 1
assert result[0].status == "FAIL"
assert result[0].status_extended == "No Resource Explorer Indexes found"
assert result[0].resource_id == ""
assert result[0].resource_arn == "NoResourceExplorer"
assert result[0].region == AWS_REGION
def test_one_index_found(self):
resourceexplorer2_client = mock.MagicMock
resourceexplorer2_client.indexes = [
Indexes(arn=INDEX_ARN, region=INDEX_REGION, type="LOCAL")
]
resourceexplorer2_client.region = AWS_REGION
with mock.patch(
"prowler.providers.aws.services.resourceexplorer2.resourceexplorer2_service.ResourceExplorer2",
new=resourceexplorer2_client,
):
# Test Check
from prowler.providers.aws.services.resourceexplorer2.resourceexplorer2_indexes_found.resourceexplorer2_indexes_found import (
resourceexplorer2_indexes_found,
)
check = resourceexplorer2_indexes_found()
result = check.execute()
# Assertions
assert len(result) == 1
assert result[0].status == "PASS"
assert result[0].status_extended == "Resource Explorer Indexes found: 1"
assert result[0].resource_id == ""
assert result[0].resource_arn == INDEX_ARN
assert result[0].region == AWS_REGION

View File

@@ -0,0 +1,88 @@
from unittest.mock import patch
import botocore
from boto3 import session
from prowler.providers.aws.lib.audit_info.models import AWS_Audit_Info
from prowler.providers.aws.services.resourceexplorer2.resourceexplorer2_service import (
ResourceExplorer2,
)
AWS_ACCOUNT_NUMBER = "123456789012"
AWS_REGION = "eu-west-1"
INDEX_ARN = "arn:aws:resource-explorer-2:ap-south-1:123456789012:index/123456-2896-4fe8-93d2-15ec137e5c47"
INDEX_REGION = "us-east-1"
# Mocking Backup Calls
make_api_call = botocore.client.BaseClient._make_api_call
def mock_make_api_call(self, operation_name, kwarg):
"""
Mock every AWS API call
"""
if operation_name == "ListIndexes":
return {
"Indexes": [
{"Arn": INDEX_ARN, "Region": INDEX_REGION, "Type": "LOCAL"},
]
}
return make_api_call(self, operation_name, kwarg)
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("botocore.client.BaseClient._make_api_call", new=mock_make_api_call)
@patch(
"prowler.providers.aws.services.resourceexplorer2.resourceexplorer2_service.generate_regional_clients",
new=mock_generate_regional_clients,
)
class Test_ResourceExplorer2_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=AWS_ACCOUNT_NUMBER,
audited_user_id=None,
audited_partition="aws",
audited_identity_arn=None,
profile=None,
profile_region=None,
credentials=None,
assumed_role_info=None,
audited_regions="us-east-1",
organizations_metadata=None,
audit_resources=None,
)
return audit_info
def test__get_client__(self):
audit_info = self.set_mocked_audit_info()
resourceeplorer2 = ResourceExplorer2(audit_info)
assert (
resourceeplorer2.regional_clients[AWS_REGION].__class__.__name__
== "ResourceExplorer"
)
def test__get_service__(self):
audit_info = self.set_mocked_audit_info()
resourceeplorer2 = ResourceExplorer2(audit_info)
assert resourceeplorer2.service == "resource-explorer-2"
def test__list_indexes__(self):
audit_info = self.set_mocked_audit_info()
resourceeplorer2 = ResourceExplorer2(audit_info)
assert len(resourceeplorer2.indexes) == 1
assert resourceeplorer2.indexes[0].arn == INDEX_ARN
assert resourceeplorer2.indexes[0].region == INDEX_REGION
assert resourceeplorer2.indexes[0].type == "LOCAL"