control-service: add amazon ses smtp mail notifications

projects/control-service/projects/pipelines_control_service/build.gradle

@@ -42,6 +42,7 @@ dependencies { // Implementation dependencies are found on compile classpath of
     implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
     implementation 'org.springframework.retry:spring-retry'
 
+    implementation 'io.awspring.cloud:spring-cloud-starter-aws-ses:2.4.4'
     // Hashicorp Vault client libraries
     implementation versions.'org.springframework.vault:spring-vault-core'
 

projects/control-service/projects/pipelines_control_service/src/main/java/com/vmware/taurus/service/notification/AmazonSesEmailNotification.java

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2023-2024 Broadcom
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package com.vmware.taurus.service.notification;
+
+import com.amazonaws.auth.AWSStaticCredentialsProvider;
+import com.amazonaws.auth.DefaultAWSCredentialsProviderChain;
+import com.amazonaws.auth.STSAssumeRoleSessionCredentialsProvider;
+import com.amazonaws.services.securitytoken.AWSSecurityTokenServiceClientBuilder;
+import com.amazonaws.services.simpleemail.AmazonSimpleEmailServiceClientBuilder;
+import com.amazonaws.services.simpleemail.model.*;
+import com.google.common.collect.Lists;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.mail.MessagingException;
+import javax.mail.internet.InternetAddress;
+import java.util.Arrays;
+
+/**
+ * The AmazonEmailNotification class is responsible for implementing the email notifications
+ * functionality in AWS using SES. The single exposed send method accepts pre-build notification
+ * object.
+ *
+ * @see DataJobNotification
+ * @see NotificationContent
+ */
+public class AmazonSesEmailNotification implements EmailNotification {
+
+  static Logger log = LoggerFactory.getLogger(AmazonSesEmailNotification.class);
+  private final String roleArn;
+  private final String region;
+
+  public AmazonSesEmailNotification(EmailConfiguration emailConfiguration) {
+    this.region = emailConfiguration.smtpWithPrefix().get("mail.smtp.host");
+    this.roleArn = emailConfiguration.getUsername();
+  }
+
+  @Override
+  public void send(NotificationContent notificationContent) throws MessagingException {
+    String roleSessionName = "email-session";
+
+    STSAssumeRoleSessionCredentialsProvider credentialsProvider =
+        new STSAssumeRoleSessionCredentialsProvider.Builder(roleArn, roleSessionName)
+            .withStsClient(
+                AWSSecurityTokenServiceClientBuilder.standard()
+                    .withCredentials(new DefaultAWSCredentialsProviderChain())
+                    .withRegion(this.region)
+                    .build())
+            .build();
+
+    var sesClient =
+        AmazonSimpleEmailServiceClientBuilder.standard()
+            .withCredentials(new AWSStaticCredentialsProvider(credentialsProvider.getCredentials()))
+            .withRegion(this.region)
+            .build();
+    log.debug("Send AmazonSesEmailNotification");
+    SendEmailResult sendEmailResult =
+        sesClient.sendEmail(
+            new SendEmailRequest()
+                .withSource(notificationContent.getSender().toString())
+                .withDestination(
+                    new Destination(
+                        Lists.newArrayList(
+                            Arrays.stream(notificationContent.getRecipients())
+                                .map(InternetAddress::toString)
+                                .toList())))
+                .withMessage(
+                    new Message(
+                        new Content(notificationContent.getSubject()),
+                        new Body().withHtml(new Content(notificationContent.getContent())))));
+    log.info("Email sent using Amazon SES. Message ID: {}", sendEmailResult.getMessageId());
+  }
+}

projects/control-service/projects/pipelines_control_service/src/main/java/com/vmware/taurus/service/notification/DefaultEmailNotification.java

@@ -0,0 +1,114 @@
+/*
+ * Copyright 2023-2024 Broadcom
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package com.vmware.taurus.service.notification;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.mail.*;
+import javax.mail.internet.MimeMessage;
+import java.util.Arrays;
+import java.util.Properties;
+import java.util.stream.Collectors;
+
+/**
+ * The DefaultEmailNotification class is responsible for implementing the email notifications
+ * functionality. The single exposed send method accepts pre-build notification object.
+ *
+ * @see DataJobNotification
+ * @see NotificationContent
+ */
+public class DefaultEmailNotification implements EmailNotification {
+
+  static Logger log = LoggerFactory.getLogger(DefaultEmailNotification.class);
+
+  private static final String CONTENT_TYPE = "text/html; charset=utf-8";
+
+  private final Session session;
+  private final EmailConfiguration emailConfiguration;
+
+  public DefaultEmailNotification(EmailConfiguration emailConfiguration) {
+    this.emailConfiguration = emailConfiguration;
+    Properties properties = System.getProperties();
+    properties.putAll(emailConfiguration.smtpWithPrefix());
+    properties.setProperty("mail.transport.protocol", emailConfiguration.getTransportProtocol());
+    session = Session.getInstance(properties);
+  }
+
+  public void send(NotificationContent notificationContent) throws MessagingException {
+    log.debug("Send DefaultEmailNotification");
+    if (recipientsExist(notificationContent.getRecipients())) {
+      try {
+        sendEmail(notificationContent, notificationContent.getRecipients());
+      } catch (SendFailedException firstException) {
+        log.info(
+            "Following addresses are invalid: {}",
+            concatAddresses(firstException.getInvalidAddresses()));
+        var validUnsentAddresses = firstException.getValidUnsentAddresses();
+        if (recipientsExist(validUnsentAddresses)) {
+          log.info("Retrying unsent valid addresses: {}", concatAddresses(validUnsentAddresses));
+          try {
+            sendEmail(notificationContent, validUnsentAddresses);
+          } catch (SendFailedException retriedException) {
+            log.warn(
+                "\nwhat: {}\nwhy: {}\nconsequence: {}\ncountermeasure: {}",
+                "Unable to send notification to the recipients",
+                retriedException.getMessage(),
+                "Listed recipients won't receive notifications for the job's status",
+                "There might be misconfiguration or outage. Check error message for more details");
+          }
+        }
+      }
+    }
+  }
+
+  private void sendEmail(NotificationContent notificationContent, Address[] recipients)
+      throws MessagingException {
+    if (emailConfiguration.isAuthEnabled()) {
+      sendAuthenticatedEmail(notificationContent, recipients);
+    } else {
+      sendUnauthenticatedEmail(notificationContent, recipients);
+    }
+  }
+
+  private void sendUnauthenticatedEmail(
+      NotificationContent notificationContent, Address[] recipients) throws MessagingException {
+    var mimeMessage = prepareMessage(notificationContent);
+    Transport.send(mimeMessage, recipients);
+  }
+
+  private void sendAuthenticatedEmail(NotificationContent notificationContent, Address[] recipients)
+      throws MessagingException {
+    Transport transport = session.getTransport();
+    var mimeMessage = prepareMessage(notificationContent);
+    try {
+      transport.connect(emailConfiguration.getUsername(), emailConfiguration.getPassword());
+      transport.sendMessage(mimeMessage, recipients);
+    } finally {
+      transport.close();
+    }
+  }
+
+  private MimeMessage prepareMessage(NotificationContent notificationContent)
+      throws MessagingException {
+    MimeMessage mimeMessage = new MimeMessage(session);
+    mimeMessage.setFrom(notificationContent.getSender());
+    mimeMessage.setRecipients(MimeMessage.RecipientType.TO, notificationContent.getRecipients());
+    mimeMessage.setSubject(notificationContent.getSubject());
+    mimeMessage.setContent(notificationContent.getContent(), CONTENT_TYPE);
+    return mimeMessage;
+  }
+
+  private boolean recipientsExist(Address[] recipients) {
+    return recipients.length > 0;
+  }
+
+  String concatAddresses(Address[] addresses) {
+    return addresses == null
+        ? null
+        : Arrays.stream(addresses).map(Address::toString).collect(Collectors.joining(" "));
+  }
+}

projects/control-service/projects/pipelines_control_service/src/main/java/com/vmware/taurus/service/notification/EmailConfiguration.java

@@ -5,12 +5,13 @@
 
 package com.vmware.taurus.service.notification;
 
-import java.util.HashMap;
-import java.util.Map;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
+import java.util.HashMap;
+import java.util.Map;
+
 @Configuration
 public class EmailConfiguration {
 
@@ -19,6 +20,15 @@ public class EmailConfiguration {
   private final String MAIL_SMTP_AUTH = "mail.smtp.auth";
   private final String TRANSPORT_PROTOCOL = "transport.protocol";
 
+  @Bean
+  public EmailNotification emailNotification() {
+    if (this.smtpWithPrefix().get("mail.smtp.user").startsWith("arn:aws:")) {
+      return new AmazonSesEmailNotification(this);
+    } else {
+      return new DefaultEmailNotification(this);
+    }
+  }
+
   @Bean
   @ConfigurationProperties(prefix = "mail")
   Map<String, String> mail() {

projects/control-service/projects/pipelines_control_service/src/main/java/com/vmware/taurus/service/notification/EmailNotification.java

@@ -5,18 +5,7 @@
 
 package com.vmware.taurus.service.notification;
 
-import java.util.Arrays;
-import java.util.Properties;
-import java.util.stream.Collectors;
-import javax.mail.Address;
 import javax.mail.MessagingException;
-import javax.mail.SendFailedException;
-import javax.mail.Session;
-import javax.mail.Transport;
-import javax.mail.internet.MimeMessage;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.springframework.stereotype.Component;
 
 /**
  * The EmailNotification class is responsible for implementing the email notifications
@@ -25,94 +14,7 @@
  * @see DataJobNotification
  * @see NotificationContent
  */
-@Component
-public class EmailNotification {
+public interface EmailNotification {
 
-  static Logger log = LoggerFactory.getLogger(EmailNotification.class);
-
-  private static final String CONTENT_TYPE = "text/html; charset=utf-8";
-
-  private final Session session;
-  private final EmailConfiguration emailConfiguration;
-
-  public EmailNotification(EmailConfiguration emailConfiguration) {
-    this.emailConfiguration = emailConfiguration;
-    Properties properties = System.getProperties();
-    properties.putAll(emailConfiguration.smtpWithPrefix());
-    properties.setProperty("mail.transport.protocol", emailConfiguration.getTransportProtocol());
-    session = Session.getInstance(properties);
-  }
-
-  public void send(NotificationContent notificationContent) throws MessagingException {
-    if (recipientsExist(notificationContent.getRecipients())) {
-      try {
-        sendEmail(notificationContent, notificationContent.getRecipients());
-      } catch (SendFailedException firstException) {
-        log.info(
-            "Following addresses are invalid: {}",
-            concatAddresses(firstException.getInvalidAddresses()));
-        var validUnsentAddresses = firstException.getValidUnsentAddresses();
-        if (recipientsExist(validUnsentAddresses)) {
-          log.info("Retrying unsent valid addresses: {}", concatAddresses(validUnsentAddresses));
-          try {
-            sendEmail(notificationContent, validUnsentAddresses);
-          } catch (SendFailedException retriedException) {
-            log.warn(
-                "\nwhat: {}\nwhy: {}\nconsequence: {}\ncountermeasure: {}",
-                "Unable to send notification to the recipients",
-                retriedException.getMessage(),
-                "Listed recipients won't receive notifications for the job's status",
-                "There might be misconfiguration or outage. Check error message for more details");
-          }
-        }
-      }
-    }
-  }
-
-  private void sendEmail(NotificationContent notificationContent, Address[] recipients)
-      throws MessagingException {
-    if (emailConfiguration.isAuthEnabled()) {
-      sendAuthenticatedEmail(notificationContent, recipients);
-    } else {
-      sendUnauthenticatedEmail(notificationContent, recipients);
-    }
-  }
-
-  private void sendUnauthenticatedEmail(
-      NotificationContent notificationContent, Address[] recipients) throws MessagingException {
-    var mimeMessage = prepareMessage(notificationContent);
-    Transport.send(mimeMessage, recipients);
-  }
-
-  private void sendAuthenticatedEmail(NotificationContent notificationContent, Address[] recipients)
-      throws MessagingException {
-    Transport transport = session.getTransport();
-    var mimeMessage = prepareMessage(notificationContent);
-    try {
-      transport.connect(emailConfiguration.getUsername(), emailConfiguration.getPassword());
-      transport.sendMessage(mimeMessage, recipients);
-    } finally {
-      transport.close();
-    }
-  }
-
-  private MimeMessage prepareMessage(NotificationContent notificationContent)
-      throws MessagingException {
-    MimeMessage mimeMessage = new MimeMessage(session);
-    mimeMessage.setFrom(notificationContent.getSender());
-    mimeMessage.setRecipients(MimeMessage.RecipientType.TO, notificationContent.getRecipients());
-    mimeMessage.setSubject(notificationContent.getSubject());
-    mimeMessage.setContent(notificationContent.getContent(), CONTENT_TYPE);
-    return mimeMessage;
-  }
-
-  private boolean recipientsExist(Address[] recipients) {
-    return recipients.length > 0;
-  }
-
-  String concatAddresses(Address[] addresses) {
-    return addresses == null
-        ? null
-        : Arrays.stream(addresses).map(Address::toString).collect(Collectors.joining(" "));
-  }
+  public void send(NotificationContent notificationContent) throws MessagingException;
 }

projects/control-service/projects/pipelines_control_service/src/test/java/com/vmware/taurus/service/notification/AuthenticatedEmailNotificationTest.java

@@ -50,7 +50,7 @@ public void setup() {
 
     this.dataJobNotification =
         new DataJobNotification(
-            new EmailNotification(emailPropertiesConfiguration),
+            new DefaultEmailNotification(emailPropertiesConfiguration),
             "Example Name",
             TEST_USER,
             Collections.singletonList("cc@dummy.com"));

projects/control-service/projects/pipelines_control_service/src/test/java/com/vmware/taurus/service/notification/DataJobNotificationTest.java

@@ -40,7 +40,7 @@ public void setup() throws IOException {
 
     this.dataJobNotification =
         new DataJobNotification(
-            new EmailNotification(emailPropertiesConfiguration),
+            new DefaultEmailNotification(emailPropertiesConfiguration),
             "Example Name",
             "your_username@vmware.com",
             Collections.singletonList("cc@dummy.com"));

projects/control-service/projects/pipelines_control_service/src/test/java/com/vmware/taurus/service/notification/EmailNotificationTest.java

@@ -17,7 +17,7 @@
 @SpringBootTest(classes = ControlplaneApplication.class)
 public class EmailNotificationTest {
 
-  @Autowired private EmailNotification emailNotification;
+  @Autowired private DefaultEmailNotification emailNotification;
 
   @Test
   public void testConcatAddresses_nullAddresses_shouldReturnNull() {