Merge branch 'master' into disable_elementary_logo_print

Author: michael-myaskovsky

elementary/clients/s3/client.py

@@ -41,11 +41,15 @@ def send_report(
         bucket_report_path = remote_bucket_file_path or report_filename
         bucket_website_url = None
         logger.info(f'Uploading to S3 bucket "{self.config.s3_bucket_name}"')
+
+        extra_args = {"ContentType": "text/html"}
+        if self.config.s3_acl is not None:
+            extra_args["ACL"] = self.config.s3_acl
         self.client.upload_file(
             local_html_file_path,
             self.config.s3_bucket_name,
             bucket_report_path,
-            ExtraArgs={"ContentType": "text/html"},
+            ExtraArgs=extra_args,
         )
         logger.info("Uploaded report to S3.")
         if self.config.update_bucket_website:

elementary/config/config.py

@@ -62,6 +62,7 @@ def __init__(
         aws_session_token: Optional[str] = None,
         s3_endpoint_url: Optional[str] = None,
         s3_bucket_name: Optional[str] = None,
+        s3_acl: Optional[str] = None,
         google_project_name: Optional[str] = None,
         google_service_account_path: Optional[str] = None,
         gcs_bucket_name: Optional[str] = None,
@@ -159,6 +160,7 @@ def __init__(
         self.aws_access_key_id = aws_access_key_id
         self.aws_secret_access_key = aws_secret_access_key
         self.aws_session_token = aws_session_token
+        self.s3_acl = s3_acl
 
         google_config = config.get(self._GOOGLE, {})
         self.google_project_name = self._first_not_none(

elementary/monitor/cli.py

@@ -11,6 +11,7 @@
 )
 from elementary.monitor.data_monitoring.schema import FiltersSchema
 from elementary.monitor.data_monitoring.selector_filter import SelectorFilter
+from elementary.monitor.dbt_init import DBTInit
 from elementary.monitor.debug import Debug
 from elementary.tracking.anonymous_tracking import AnonymousCommandLineTracking
 from elementary.utils import bucket_path
@@ -24,6 +25,7 @@ class Command:
     REPORT = "monitor-report"
     SEND_REPORT = "monitor-send-report"
     DEBUG = "debug"
+    DBT_INIT = "dbt-init"
 
 
 # Displayed in reverse order in --help.
@@ -526,6 +528,12 @@ def report(
     default=None,
     help="The name of the S3 bucket to upload the report to.",
 )
+@click.option(
+    "--s3-acl",
+    type=str,
+    default=None,
+    help="S3 Canned ACL value used to modify report permissions, for example set to 'public-read' to make the report publicly accessible.",
+)
 @click.option(
     "--google-service-account-path",
     type=str,
@@ -638,6 +646,7 @@ def send_report(
     aws_session_token,
     s3_endpoint_url,
     s3_bucket_name,
+    s3_acl,
     azure_connection_string,
     azure_container_name,
     google_service_account_path,
@@ -686,6 +695,7 @@ def send_report(
         azure_container_name=azure_container_name,
         s3_endpoint_url=s3_endpoint_url,
         s3_bucket_name=s3_bucket_name,
+        s3_acl=s3_acl,
         google_service_account_path=google_service_account_path,
         google_project_name=google_project_name,
         gcs_bucket_name=gcs_bucket_name,
@@ -766,5 +776,25 @@ def debug(ctx, profiles_dir):
     anonymous_tracking.track_cli_end(Command.DEBUG, None, ctx.command.name)
 
 
+@monitor.command()
+@click.pass_context
+def dbt_init(ctx):
+    """
+    Initializes the Elementary internal dbt project by installing its dbt deps.
+    Run this command after installing EDR as part of builds or CI/CD pipelines when the target
+    environment does not have write permissions on disk or does not have internet connection.
+    This command is not needed in most cases as the dbt deps are installed automatically when running `edr monitor`.
+    """
+    config = Config()
+    anonymous_tracking = AnonymousCommandLineTracking(config)
+    anonymous_tracking.track_cli_start(Command.DEBUG, None, ctx.command.name)
+    dbtinit = DBTInit()
+    success = dbtinit.setup_internal_dbt_packages()
+    if not success:
+        sys.exit(1)
+    click.echo("Elementary internal dbt project has been initialized successfully. ")
+    anonymous_tracking.track_cli_end(Command.DEBUG, None, ctx.command.name)
+
+
 if __name__ == "__main__":
     monitor()

elementary/monitor/dbt_init.py

@@ -0,0 +1,19 @@
+from elementary.clients.dbt.factory import create_dbt_runner
+from elementary.monitor import dbt_project_utils
+
+
+class DBTInit:
+    """
+    Class to handle the initialization of dbt for the Elementary CLI.
+    This can contain all dbt static setup to avoid pulling in runtime dependencies or any other information from internet
+    that is internally used by edr.
+    """
+
+    def setup_internal_dbt_packages(self):
+        """
+        Run dbt deps to install internal dbt packages if needed.
+        It intentionally does not use self.config.run_dbt_deps_if_needed parameter in create_dbt_runner to ensure
+        that dbt deps is always run when setting up the internal dbt packages.
+        """
+        dbt_runner = create_dbt_runner(dbt_project_utils.CLI_DBT_PROJECT_PATH)
+        return dbt_runner.deps()