feat(ignore unused services): add --ignore-unused-services argument to ignore findings from services not in actual use (#2936)

tests/providers/aws/services/macie/macie_is_enabled/macie_is_enabled_test.py

@@ -1,13 +1,62 @@
 from unittest import mock
 
+from boto3 import session
+from moto import mock_s3
+
+from prowler.providers.aws.lib.audit_info.models import AWS_Audit_Info
 from prowler.providers.aws.services.macie.macie_service import Session
+from prowler.providers.aws.services.s3.s3_service import Bucket
+from prowler.providers.common.models import Audit_Metadata
 
 AWS_ACCOUNT_NUMBER = "123456789012"
 
 
+AWS_REGION = "us-east-1"
+AWS_ACCOUNT_NUMBER = "123456789012"
+
+
 class Test_macie_is_enabled:
+    # 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,
+                region_name=AWS_REGION,
+            ),
+            audited_account=AWS_ACCOUNT_NUMBER,
+            audited_account_arn=f"arn:aws:iam::{AWS_ACCOUNT_NUMBER}:root",
+            audited_user_id=None,
+            audited_partition="aws",
+            audited_identity_arn=None,
+            profile=None,
+            profile_region=AWS_REGION,
+            credentials=None,
+            assumed_role_info=None,
+            audited_regions=None,
+            organizations_metadata=None,
+            audit_resources=None,
+            mfa_enabled=False,
+            audit_metadata=Audit_Metadata(
+                services_scanned=0,
+                expected_checks=[],
+                completed_checks=0,
+                audit_progress=0,
+            ),
+        )
+        return audit_info
+
+    @mock_s3
     def test_macie_disabled(self):
+        s3_client = mock.MagicMock
+        s3_client.audit_info = self.set_mocked_audit_info()
+        s3_client.buckets = []
+        s3_client.regions_with_buckets = []
+
         macie_client = mock.MagicMock
+        macie_client.audit_info = self.set_mocked_audit_info()
         macie_client.audited_account = AWS_ACCOUNT_NUMBER
         macie_client.audited_account_arn = f"arn:aws:iam::{AWS_ACCOUNT_NUMBER}:root"
         macie_client.sessions = [
@@ -16,9 +65,17 @@ class Test_macie_is_enabled:
                 region="eu-west-1",
             )
         ]
+        current_audit_info = self.set_mocked_audit_info()
+
         with mock.patch(
-            "prowler.providers.aws.services.macie.macie_service.Macie",
+            "prowler.providers.aws.lib.audit_info.audit_info.current_audit_info",
+            new=current_audit_info,
+        ), mock.patch(
+            "prowler.providers.aws.services.macie.macie_is_enabled.macie_is_enabled.macie_client",
             new=macie_client,
+        ), mock.patch(
+            "prowler.providers.aws.services.macie.macie_is_enabled.macie_is_enabled.s3_client",
+            new=s3_client,
         ):
             # Test Check
             from prowler.providers.aws.services.macie.macie_is_enabled.macie_is_enabled import (
@@ -33,8 +90,15 @@ class Test_macie_is_enabled:
             assert result[0].status_extended == "Macie is not enabled."
             assert result[0].resource_id == AWS_ACCOUNT_NUMBER
 
+    @mock_s3
     def test_macie_enabled(self):
+        s3_client = mock.MagicMock
+        s3_client.audit_info = self.set_mocked_audit_info()
+        s3_client.buckets = []
+        s3_client.regions_with_buckets = []
+
         macie_client = mock.MagicMock
+        macie_client.audit_info = self.set_mocked_audit_info()
         macie_client.audited_account = AWS_ACCOUNT_NUMBER
         macie_client.audited_account_arn = f"arn:aws:iam::{AWS_ACCOUNT_NUMBER}:root"
         macie_client.sessions = [
@@ -43,9 +107,17 @@ class Test_macie_is_enabled:
                 region="eu-west-1",
             )
         ]
+        current_audit_info = self.set_mocked_audit_info()
+
         with mock.patch(
-            "prowler.providers.aws.services.macie.macie_service.Macie",
+            "prowler.providers.aws.lib.audit_info.audit_info.current_audit_info",
+            new=current_audit_info,
+        ), mock.patch(
+            "prowler.providers.aws.services.macie.macie_is_enabled.macie_is_enabled.macie_client",
             new=macie_client,
+        ), mock.patch(
+            "prowler.providers.aws.services.macie.macie_is_enabled.macie_is_enabled.s3_client",
+            new=s3_client,
         ):
             # Test Check
             from prowler.providers.aws.services.macie.macie_is_enabled.macie_is_enabled import (
@@ -60,8 +132,15 @@ class Test_macie_is_enabled:
             assert result[0].status_extended == "Macie is enabled."
             assert result[0].resource_id == AWS_ACCOUNT_NUMBER
 
-    def test_macie_suspended(self):
+    @mock_s3
+    def test_macie_suspended_ignored(self):
+        s3_client = mock.MagicMock
+        s3_client.audit_info = self.set_mocked_audit_info()
+        s3_client.buckets = []
+        s3_client.regions_with_buckets = []
+
         macie_client = mock.MagicMock
+        macie_client.audit_info = self.set_mocked_audit_info()
         macie_client.audited_account = AWS_ACCOUNT_NUMBER
         macie_client.audited_account_arn = f"arn:aws:iam::{AWS_ACCOUNT_NUMBER}:root"
         macie_client.sessions = [
@@ -70,9 +149,108 @@ class Test_macie_is_enabled:
                 region="eu-west-1",
             )
         ]
+
+        current_audit_info = self.set_mocked_audit_info()
+        macie_client.audit_info.ignore_unused_services = True
+
         with mock.patch(
-            "prowler.providers.aws.services.macie.macie_service.Macie",
+            "prowler.providers.aws.lib.audit_info.audit_info.current_audit_info",
+            new=current_audit_info,
+        ), mock.patch(
+            "prowler.providers.aws.services.macie.macie_is_enabled.macie_is_enabled.macie_client",
             new=macie_client,
+        ), mock.patch(
+            "prowler.providers.aws.services.macie.macie_is_enabled.macie_is_enabled.s3_client",
+            new=s3_client,
+        ):
+            # Test Check
+            from prowler.providers.aws.services.macie.macie_is_enabled.macie_is_enabled import (
+                macie_is_enabled,
+            )
+
+            check = macie_is_enabled()
+            result = check.execute()
+
+            assert len(result) == 0
+
+    @mock_s3
+    def test_macie_suspended_ignored_with_buckets(self):
+        s3_client = mock.MagicMock
+        s3_client.regions_with_buckets = [AWS_REGION]
+        s3_client.audit_info = self.set_mocked_audit_info()
+        s3_client.buckets = [
+            Bucket(
+                name="test",
+                arn="test-arn",
+                region=AWS_REGION,
+            )
+        ]
+
+        macie_client = mock.MagicMock
+        macie_client.audit_info = self.set_mocked_audit_info()
+        macie_client.audited_account = AWS_ACCOUNT_NUMBER
+        macie_client.audited_account_arn = f"arn:aws:iam::{AWS_ACCOUNT_NUMBER}:root"
+        macie_client.sessions = [
+            Session(
+                status="PAUSED",
+                region=AWS_REGION,
+            )
+        ]
+
+        macie_client.audit_info.ignore_unused_services = True
+        current_audit_info = self.set_mocked_audit_info()
+
+        with mock.patch(
+            "prowler.providers.aws.lib.audit_info.audit_info.current_audit_info",
+            new=current_audit_info,
+        ), mock.patch(
+            "prowler.providers.aws.services.macie.macie_is_enabled.macie_is_enabled.macie_client",
+            new=macie_client,
+        ), mock.patch(
+            "prowler.providers.aws.services.macie.macie_is_enabled.macie_is_enabled.s3_client",
+            new=s3_client,
+        ):
+            # Test Check
+            from prowler.providers.aws.services.macie.macie_is_enabled.macie_is_enabled import (
+                macie_is_enabled,
+            )
+
+            check = macie_is_enabled()
+            result = check.execute()
+
+            assert len(result) == 1
+            assert result[0].status == "FAIL"
+            assert (
+                result[0].status_extended == "Macie is currently in a SUSPENDED state."
+            )
+            assert result[0].resource_id == AWS_ACCOUNT_NUMBER
+
+    @mock_s3
+    def test_macie_suspended(self):
+        s3_client = mock.MagicMock
+        s3_client.audit_info = self.set_mocked_audit_info()
+
+        macie_client = mock.MagicMock
+        macie_client.audit_info = self.set_mocked_audit_info()
+        macie_client.audited_account = AWS_ACCOUNT_NUMBER
+        macie_client.audited_account_arn = f"arn:aws:iam::{AWS_ACCOUNT_NUMBER}:root"
+        macie_client.sessions = [
+            Session(
+                status="PAUSED",
+                region="eu-west-1",
+            )
+        ]
+        current_audit_info = self.set_mocked_audit_info()
+
+        with mock.patch(
+            "prowler.providers.aws.lib.audit_info.audit_info.current_audit_info",
+            new=current_audit_info,
+        ), mock.patch(
+            "prowler.providers.aws.services.macie.macie_is_enabled.macie_is_enabled.macie_client",
+            new=macie_client,
+        ), mock.patch(
+            "prowler.providers.aws.services.macie.macie_is_enabled.macie_is_enabled.s3_client",
+            new=s3_client,
         ):
             # Test Check
             from prowler.providers.aws.services.macie.macie_is_enabled.macie_is_enabled import (