feat(inspector2): New Service and Check (#2250)

Co-authored-by: Pepe Fagoaga <pepe@verica.io> Co-authored-by: Sergio Garcia <38561120+sergargar@users.noreply.github.com>
2026-02-10 14:55:00 +00:00 · 2023-04-24 12:15:16 +02:00
parent 828fb37ca8
commit 63501a0d59
8 changed files with 465 additions and 0 deletions
--- a/tests/providers/aws/services/inspector2/inspector2_findings_exist/inspector2_findings_exist_test.py
+++ b/tests/providers/aws/services/inspector2/inspector2_findings_exist/inspector2_findings_exist_test.py
@@ -0,0 +1,153 @@
+from unittest import mock
+
+from prowler.providers.aws.services.inspector2.inspector2_service import (
+    Inspector,
+    InspectorFinding,
+)
+
+AWS_REGION = "us-east-1"
+AWS_ACCOUNT_ID = "123456789012"
+FINDING_ARN = (
+    "arn:aws:inspector2:us-east-1:123456789012:finding/0e436649379db5f327e3cf5bb4421d76"
+)
+
+
+class Test_inspector2_findings_exist:
+    def test_inspector2_disabled(self):
+        # Mock the inspector2 client
+        inspector2_client = mock.MagicMock
+        inspector2_client.region = AWS_REGION
+        inspector2_client.inspectors = [
+            Inspector(
+                id="Inspector2", status="DISABLED", region=AWS_REGION, findings=[]
+            )
+        ]
+        with mock.patch(
+            "prowler.providers.aws.services.inspector2.inspector2_service.Inspector2",
+            new=inspector2_client,
+        ):
+            # Test Check
+            from prowler.providers.aws.services.inspector2.inspector2_findings_exist.inspector2_findings_exist import (
+                inspector2_findings_exist,
+            )
+
+            check = inspector2_findings_exist()
+            result = check.execute()
+
+            assert len(result) == 1
+            assert result[0].status == "FAIL"
+            assert result[0].status_extended == "Inspector2 is not enabled."
+            assert result[0].resource_id == "Inspector2"
+            assert result[0].resource_arn == ""
+            assert result[0].region == AWS_REGION
+
+    def test_enabled_no_finding(self):
+        # Mock the inspector2 client
+        inspector2_client = mock.MagicMock
+        inspector2_client.region = AWS_REGION
+        inspector2_client.inspectors = [
+            Inspector(id="Inspector2", status="ENABLED", region=AWS_REGION, findings=[])
+        ]
+        with mock.patch(
+            "prowler.providers.aws.services.inspector2.inspector2_service.Inspector2",
+            new=inspector2_client,
+        ):
+            # Test Check
+            from prowler.providers.aws.services.inspector2.inspector2_findings_exist.inspector2_findings_exist import (
+                inspector2_findings_exist,
+            )
+
+            check = inspector2_findings_exist()
+            result = check.execute()
+
+            assert len(result) == 1
+            assert result[0].status == "PASS"
+            assert result[0].status_extended == "Inspector2 is enabled with no findings"
+            assert result[0].resource_id == "Inspector2"
+            assert result[0].resource_arn == ""
+            assert result[0].region == AWS_REGION
+
+    def test_enabled_with_no_active_finding(self):
+        # Mock the inspector2 client
+        inspector2_client = mock.MagicMock
+        inspector2_client.region = AWS_REGION
+        inspector2_client.inspectors = [
+            Inspector(
+                id="Inspector2",
+                region=AWS_REGION,
+                status="ENABLED",
+                findings=[
+                    InspectorFinding(
+                        arn=FINDING_ARN,
+                        region=AWS_REGION,
+                        severity="MEDIUM",
+                        status="NOT_ACTIVE",
+                        title="CVE-2022-40897 - setuptools",
+                    )
+                ],
+            )
+        ]
+
+        with mock.patch(
+            "prowler.providers.aws.services.inspector2.inspector2_service.Inspector2",
+            new=inspector2_client,
+        ):
+            # Test Check
+            from prowler.providers.aws.services.inspector2.inspector2_findings_exist.inspector2_findings_exist import (
+                inspector2_findings_exist,
+            )
+
+            check = inspector2_findings_exist()
+            result = check.execute()
+
+            assert len(result) == 1
+            assert result[0].status == "PASS"
+            assert (
+                result[0].status_extended
+                == "Inspector2 is enabled with no active findings"
+            )
+            assert result[0].resource_id == "Inspector2"
+            assert result[0].resource_arn == ""
+            assert result[0].region == AWS_REGION
+
+    def test_enabled_with_active_finding(self):
+        # Mock the inspector2 client
+        inspector2_client = mock.MagicMock
+        inspector2_client.region = AWS_REGION
+        inspector2_client.inspectors = [
+            Inspector(
+                id="Inspector2",
+                region=AWS_REGION,
+                status="ENABLED",
+                findings=[
+                    InspectorFinding(
+                        arn=FINDING_ARN,
+                        region=AWS_REGION,
+                        severity="MEDIUM",
+                        status="ACTIVE",
+                        title="CVE-2022-40897 - setuptools",
+                    )
+                ],
+            )
+        ]
+
+        with mock.patch(
+            "prowler.providers.aws.services.inspector2.inspector2_service.Inspector2",
+            new=inspector2_client,
+        ):
+            # Test Check
+            from prowler.providers.aws.services.inspector2.inspector2_findings_exist.inspector2_findings_exist import (
+                inspector2_findings_exist,
+            )
+
+            check = inspector2_findings_exist()
+            result = check.execute()
+
+            assert len(result) == 1
+            assert result[0].status == "FAIL"
+            assert (
+                result[0].status_extended == "There are 1 ACTIVE Inspector2 findings."
+            )
+            assert result[0].resource_id == "Inspector2"
+            assert result[0].resource_arn == ""
+            assert result[0].region == AWS_REGION
--- a/tests/providers/aws/services/inspector2/inspector2_service_test.py
+++ b/tests/providers/aws/services/inspector2/inspector2_service_test.py
@@ -0,0 +1,139 @@
+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.inspector2.inspector2_service import Inspector2
+
+AWS_REGION = "us-east-1"
+AWS_ACCOUNT_ID = "123456789012"
+FINDING_ARN = (
+    "arn:aws:inspector2:us-east-1:123456789012:finding/0e436649379db5f327e3cf5bb4421d76"
+)
+
+# 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 == "BatchGetAccountStatus":
+        return {
+            "accounts": [
+                {
+                    "accountId": "string",
+                    "resourceState": {
+                        "ec2": {
+                            "errorCode": "ALREADY_ENABLED",
+                            "errorMessage": "string",
+                            "status": "ENABLED",
+                        },
+                        "ecr": {
+                            "errorCode": "ALREADY_ENABLED",
+                            "errorMessage": "string",
+                            "status": "ENABLED",
+                        },
+                        "lambda": {
+                            "errorCode": "ALREADY_ENABLED",
+                            "errorMessage": "string",
+                            "status": "ENABLED",
+                        },
+                    },
+                    "state": {
+                        "errorCode": "ALREADY_ENABLED",
+                        "errorMessage": "string",
+                        "status": "ENABLED",
+                    },
+                }
+            ]
+        }
+    if operation_name == "ListFindings":
+        return {
+            "findings": [
+                {
+                    "awsAccountId": AWS_ACCOUNT_ID,
+                    "findingArn": FINDING_ARN,
+                    "description": "Finding Description",
+                    "severity": "MEDIUM",
+                    "status": "ACTIVE",
+                    "title": "CVE-2022-40897 - setuptools",
+                    "type": "PACKAGE_VULNERABILITY",
+                    "updatedAt": datetime(2024, 1, 1),
+                }
+            ]
+        }
+
+    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.inspector2.inspector2_service.generate_regional_clients",
+    new=mock_generate_regional_clients,
+)
+class Test_Inspector2_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()
+        ssmincidents = Inspector2(audit_info)
+        assert (
+            ssmincidents.regional_clients[AWS_REGION].__class__.__name__ == "Inspector2"
+        )
+
+    def test__get_service__(self):
+        audit_info = self.set_mocked_audit_info()
+        ssmincidents = Inspector2(audit_info)
+        assert ssmincidents.service == "inspector2"
+
+    def test__batch_get_account_status__(self):
+        audit_info = self.set_mocked_audit_info()
+        ssmincidents = Inspector2(audit_info)
+        assert len(ssmincidents.inspectors) == 1
+        assert ssmincidents.inspectors[0].id == "Inspector2"
+        assert ssmincidents.inspectors[0].region == AWS_REGION
+        assert ssmincidents.inspectors[0].status == "ENABLED"
+
+    def test__list_findings__(self):
+        audit_info = self.set_mocked_audit_info()
+        ssmincidents = Inspector2(audit_info)
+        assert len(ssmincidents.inspectors[0].findings) == 1
+        assert ssmincidents.inspectors[0].findings[0].arn == FINDING_ARN
+        assert ssmincidents.inspectors[0].findings[0].region == AWS_REGION
+        assert ssmincidents.inspectors[0].findings[0].severity == "MEDIUM"
+        assert ssmincidents.inspectors[0].findings[0].status == "ACTIVE"
+        assert (
+            ssmincidents.inspectors[0].findings[0].title
+            == "CVE-2022-40897 - setuptools"
+        )