fix(output-filename): Handle argument (#1604)

prowler/lib/cli/parser.py

@@ -116,7 +116,7 @@ Detailed documentation at https://docs.prowler.cloud
             "--output-filename",
             nargs="?",
             default=None,
-            help="Custom output report name, if not specified will use default output/prowler-output-ACCOUNT_NUM-OUTPUT_DATE.format",
+            help="Custom output report name without the file extension, if not specified will use default output/prowler-output-ACCOUNT_NUM-OUTPUT_DATE.format",
         )
         common_outputs_parser.add_argument(
             "-o",

prowler/providers/common/outputs.py

@@ -60,11 +60,14 @@ class Azure_Output_Options(Provider_Output_Options):
         super().__init__(arguments, allowlist_file, bulk_checks_metadata)
 
         # Check if custom output filename was input, if not, set the default
-        if not arguments.output_filename:
+        if not hasattr(arguments, "output_filename"):
             if audit_info.identity.domain:
                 self.output_filename = f"prowler-output-{audit_info.identity.domain}-{output_file_timestamp}"
             else:
                 self.output_filename = f"prowler-output-{'-'.join(audit_info.identity.tenant_ids)}-{output_file_timestamp}"
+        else:
+            self.output_filename = arguments.output_filename
+
         # Remove HTML Output since it is not supported yet
         if "html" in arguments.output_modes:
             arguments.output_modes.remove("html")
@@ -82,10 +85,12 @@ class Aws_Output_Options(Provider_Output_Options):
             change_config_var("shodan_api_key", arguments.shodan)
 
         # Check if custom output filename was input, if not, set the default
-        if not arguments.output_filename:
+        if not hasattr(arguments, "output_filename"):
             self.output_filename = (
                 f"prowler-output-{audit_info.audited_account}-{output_file_timestamp}"
             )
+        else:
+            self.output_filename = arguments.output_filename
 
         # Security Hub Outputs
         self.security_hub_enabled = arguments.security_hub

tests/providers/common/common_outputs_test.py

@@ -0,0 +1,186 @@
+from prowler.providers.common.outputs import (
+    Aws_Output_Options,
+    Azure_Output_Options,
+    set_provider_output_options,
+)
+
+
+from prowler.providers.aws.lib.audit_info.audit_info import AWS_Audit_Info
+from prowler.providers.azure.lib.audit_info.audit_info import (
+    Azure_Audit_Info,
+    Azure_Identity_Info,
+)
+from boto3 import session
+from mock import patch
+from argparse import Namespace
+
+AWS_ACCOUNT_NUMBER = "012345678912"
+DATETIME = "20230101120000"
+
+
+def mock_change_config_var(*_):
+    pass
+
+
+@patch(
+    "prowler.providers.common.outputs.change_config_var",
+    new=mock_change_config_var,
+)
+@patch("prowler.providers.common.outputs.output_file_timestamp", new=DATETIME)
+class Test_Common_Output_Options:
+    # Mocked Azure Audit Info
+    def set_mocked_azure_audit_info(self):
+        audit_info = Azure_Audit_Info(credentials=None, identity=Azure_Identity_Info())
+        return audit_info
+
+    # Mocked AWS Audit Info
+    def set_mocked_aws_audit_info(self):
+        audit_info = AWS_Audit_Info(
+            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=None,
+            organizations_metadata=None,
+        )
+        return audit_info
+
+    def test_set_provider_output_options_aws(self):
+        #  Set the cloud provider
+        provider = "aws"
+        # Set the arguments passed
+        arguments = Namespace()
+        arguments.quiet = True
+        arguments.output_modes = ["html", "csv", "json"]
+        arguments.output_directory = "output_test_directory"
+        arguments.verbose = True
+        arguments.output_filename = "output_test_filename"
+        arguments.security_hub = True
+        arguments.shodan = "test-api-key"
+
+        audit_info = self.set_mocked_aws_audit_info()
+        allowlist_file = ""
+        bulk_checks_metadata = {}
+        output_options = set_provider_output_options(
+            provider, arguments, audit_info, allowlist_file, bulk_checks_metadata
+        )
+        assert isinstance(output_options, Aws_Output_Options)
+        assert output_options.security_hub_enabled
+        assert output_options.is_quiet
+        assert output_options.output_modes == ["html", "csv", "json", "json-asff"]
+        assert output_options.output_directory == arguments.output_directory
+        assert output_options.allowlist_file == ""
+        assert output_options.bulk_checks_metadata == {}
+        assert output_options.verbose
+        assert output_options.output_filename == arguments.output_filename
+
+    def test_set_provider_output_options_aws_no_output_filename(self):
+        #  Set the cloud provider
+        provider = "aws"
+        # Set the arguments passed
+        arguments = Namespace()
+        arguments.quiet = True
+        arguments.output_modes = ["html", "csv", "json"]
+        arguments.output_directory = "output_test_directory"
+        arguments.verbose = True
+        arguments.security_hub = True
+        arguments.shodan = "test-api-key"
+
+        # Mock AWS Audit Info
+        audit_info = self.set_mocked_aws_audit_info()
+
+        allowlist_file = ""
+        bulk_checks_metadata = {}
+        output_options = set_provider_output_options(
+            provider, arguments, audit_info, allowlist_file, bulk_checks_metadata
+        )
+        assert isinstance(output_options, Aws_Output_Options)
+        assert output_options.security_hub_enabled
+        assert output_options.is_quiet
+        assert output_options.output_modes == ["html", "csv", "json", "json-asff"]
+        assert output_options.output_directory == arguments.output_directory
+        assert output_options.allowlist_file == ""
+        assert output_options.bulk_checks_metadata == {}
+        assert output_options.verbose
+        assert (
+            output_options.output_filename
+            == f"prowler-output-{AWS_ACCOUNT_NUMBER}-{DATETIME}"
+        )
+
+    def test_set_provider_output_options_azure_domain(self):
+        #  Set the cloud provider
+        provider = "azure"
+        # Set the arguments passed
+        arguments = Namespace()
+        arguments.quiet = True
+        arguments.output_modes = ["html", "csv", "json"]
+        arguments.output_directory = "output_test_directory"
+        arguments.verbose = True
+
+        # Mock Azure Audit Info
+        audit_info = self.set_mocked_azure_audit_info()
+        audit_info.identity.domain = "test-domain"
+
+        allowlist_file = ""
+        bulk_checks_metadata = {}
+        output_options = set_provider_output_options(
+            provider, arguments, audit_info, allowlist_file, bulk_checks_metadata
+        )
+        assert isinstance(output_options, Azure_Output_Options)
+        assert output_options.is_quiet
+        assert output_options.output_modes == [
+            "csv",
+            "json",
+        ]
+        assert output_options.output_directory == arguments.output_directory
+        assert output_options.allowlist_file == ""
+        assert output_options.bulk_checks_metadata == {}
+        assert output_options.verbose
+        assert (
+            output_options.output_filename
+            == f"prowler-output-{audit_info.identity.domain}-{DATETIME}"
+        )
+
+    def test_set_provider_output_options_azure_tenant_ids(self):
+        #  Set the cloud provider
+        provider = "azure"
+        # Set the arguments passed
+        arguments = Namespace()
+        arguments.quiet = True
+        arguments.output_modes = ["html", "csv", "json"]
+        arguments.output_directory = "output_test_directory"
+        arguments.verbose = True
+
+        # Mock Azure Audit Info
+        audit_info = self.set_mocked_azure_audit_info()
+        tenants = ["tenant-1", "tenant-2"]
+        audit_info.identity.tenant_ids = tenants
+
+        allowlist_file = ""
+        bulk_checks_metadata = {}
+        output_options = set_provider_output_options(
+            provider, arguments, audit_info, allowlist_file, bulk_checks_metadata
+        )
+        assert isinstance(output_options, Azure_Output_Options)
+        assert output_options.is_quiet
+        assert output_options.output_modes == [
+            "csv",
+            "json",
+        ]
+        assert output_options.output_directory == arguments.output_directory
+        assert output_options.allowlist_file == ""
+        assert output_options.bulk_checks_metadata == {}
+        assert output_options.verbose
+        assert (
+            output_options.output_filename
+            == f"prowler-output-{'-'.join(tenants)}-{DATETIME}"
+        )