Merge branch 'master' into abhsingh

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/messages/messaging_integrations/__init__.py

@@ -0,0 +1,9 @@
+from .file_system import FileSystemMessagingIntegration
+from .slack_webhook import SlackWebhookMessagingIntegration
+from .teams_webhook import TeamsWebhookMessagingIntegration
+
+__all__ = [
+    "FileSystemMessagingIntegration",
+    "TeamsWebhookMessagingIntegration",
+    "SlackWebhookMessagingIntegration",
+]

elementary/messages/messaging_integrations/file_system.py

@@ -0,0 +1,73 @@
+import json
+from datetime import datetime
+from pathlib import Path
+
+from elementary.messages.message_body import MessageBody
+from elementary.messages.messaging_integrations.base_messaging_integration import (
+    BaseMessagingIntegration,
+    MessageSendResult,
+)
+from elementary.messages.messaging_integrations.empty_message_context import (
+    EmptyMessageContext,
+)
+from elementary.messages.messaging_integrations.exceptions import (
+    MessagingIntegrationError,
+)
+from elementary.utils.log import get_logger
+
+logger = get_logger(__name__)
+
+
+class FileSystemMessagingIntegration(
+    BaseMessagingIntegration[str, EmptyMessageContext]
+):
+    def __init__(self, directory: str, create_if_missing: bool = True) -> None:
+        self.directory = Path(directory).expanduser().resolve()
+        self._create_if_missing = create_if_missing
+
+        if not self.directory.exists():
+            if self._create_if_missing:
+                logger.info(
+                    f"Creating directory for FileSystemMessagingIntegration: {self.directory}"
+                )
+                self.directory.mkdir(parents=True, exist_ok=True)
+            else:
+                raise MessagingIntegrationError(
+                    f"Directory {self.directory} does not exist and create_if_missing is False"
+                )
+
+    def supports_reply(self) -> bool:
+        return False
+
+    def send_message(
+        self, destination: str, body: MessageBody
+    ) -> MessageSendResult[EmptyMessageContext]:
+        channel_dir = self.directory / destination
+        if not channel_dir.exists():
+            if self._create_if_missing:
+                channel_dir.mkdir(parents=True, exist_ok=True)
+            else:
+                raise MessagingIntegrationError(
+                    f"Channel directory {channel_dir} does not exist and create_if_missing is False"
+                )
+
+        filename = datetime.utcnow().strftime("%Y%m%dT%H%M%S_%fZ.json")
+        file_path = channel_dir / filename
+
+        try:
+            json_str = json.dumps(body.dict(), indent=2)
+            file_path.write_text(json_str, encoding="utf-8")
+        except Exception as exc:
+            logger.error(
+                f"Failed to write alert message to file {file_path}: {exc}",
+                exc_info=True,
+            )
+            raise MessagingIntegrationError(
+                f"Failed writing alert message to file {file_path}"
+            ) from exc
+
+        return MessageSendResult(
+            timestamp=datetime.utcnow(),
+            message_format="json",
+            message_context=EmptyMessageContext(),
+        )

elementary/monitor/cli.py

@@ -528,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,
@@ -640,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,
@@ -688,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,

tests/unit/messages/messaging_integrations/test_file_system.py

@@ -0,0 +1,59 @@
+import json
+from pathlib import Path
+
+import pytest
+
+from elementary.messages.blocks import LineBlock, LinesBlock, TextBlock
+from elementary.messages.message_body import MessageBody
+from elementary.messages.messaging_integrations.exceptions import (
+    MessagingIntegrationError,
+)
+from elementary.messages.messaging_integrations.file_system import (
+    FileSystemMessagingIntegration,
+)
+
+
+def _build_body() -> MessageBody:
+    return MessageBody(
+        blocks=[LinesBlock(lines=[LineBlock(inlines=[TextBlock(text="hello")])])]
+    )
+
+
+def test_send_message_creates_file_in_channel_dir(tmp_path: Path) -> None:
+    root_dir = tmp_path / "alerts"
+    integ = FileSystemMessagingIntegration(directory=str(root_dir))
+    body = _build_body()
+
+    integ.send_message("channel", body)
+
+    channel_dir = root_dir / "channel"
+    files = list(channel_dir.glob("*.json"))
+    assert len(files) == 1, "Expected exactly one file in the channel directory"
+
+    message_json = files[0].read_text()
+    assert json.loads(message_json) == json.loads(body.json())
+
+
+def test_send_multiple_messages_creates_multiple_files(tmp_path: Path) -> None:
+    root_dir = tmp_path / "alerts"
+    integ = FileSystemMessagingIntegration(directory=str(root_dir))
+    body1 = _build_body()
+    body2 = _build_body()
+
+    integ.send_message("channel", body1)
+    integ.send_message("channel", body2)
+
+    channel_dir = root_dir / "channel"
+    files = sorted(channel_dir.glob("*.json"))
+
+    assert len(files) == 2
+    assert json.loads(files[0].read_text()) == json.loads(body1.json())
+    assert json.loads(files[1].read_text()) == json.loads(body2.json())
+
+
+def test_send_message_no_create_flag(tmp_path: Path) -> None:
+    directory = tmp_path / "alerts-no-create"
+    with pytest.raises(MessagingIntegrationError):
+        FileSystemMessagingIntegration(
+            directory=str(directory), create_if_missing=False
+        )