Merge pull request #4198 from gchq/gh-4175-email-sender

PR for #4175 - Error in EmailSender

Author: at055612

build.gradle

@@ -136,6 +136,7 @@ ext.versions = [
         kafka             : '3.6.0',
         okhttp            : '4.12.0',
         poi               : '5.2.4',
+        simple_java_mail  : '8.3.1',
         swagger           : '2.2.18',
         unirest           : '1.4.9',
         zookeeper         : '3.4.8', // Roughly pegged to the server version used by Cloudera, see links above. This version is forced below.
@@ -290,7 +291,8 @@ ext.libs = [
         poi_ooxml                           : "org.apache.poi:poi-ooxml:${versions.poi}",
         restygwt                            : "org.fusesource.restygwt:restygwt:2.2.7",
         saxon_he                            : "net.sf.saxon:Saxon-HE:9.9.1-8",
-        simple_java_mail                    : 'org.simplejavamail:simple-java-mail:8.3.1',
+        simple_java_mail                    : "org.simplejavamail:simple-java-mail:${versions.simple_java_mail}",
+        simple_java_mail_batch_module       : "org.simplejavamail:batch-module:${versions.simple_java_mail}",
         slf4j_api                           : "org.slf4j:slf4j-api", // version controlled by dropwizard-dependencies
         snake_yaml                          : "org.yaml:snakeyaml:2.2",
         solrj                               : "org.apache.solr:solr-solrj:8.2.0",

stroom-analytics/stroom-analytics-impl/build.gradle

@@ -47,6 +47,23 @@ dependencies {
     implementation libs.restygwt
     implementation libs.saxon_he
     implementation libs.simple_java_mail
+    implementation libs.simple_java_mail_batch_module
     implementation libs.slf4j_api
     implementation libs.ws_rs_api
+
+    testImplementation libs.assertj_core
+    testImplementation libs.guice_extension
+    testImplementation libs.junit_jupiter_api
+    testImplementation libs.mockito_core
+    testImplementation libs.mockito_junit_jupiter
+
+    // The following logging libs are needed when running junits outside dropwizard
+    testRuntimeOnly libs.jakarta_activation
+    testRuntimeOnly libs.jaxb_impl
+    testRuntimeOnly libs.jcl_over_slf4j
+    testRuntimeOnly libs.jul_to_slf4j
+    testRuntimeOnly libs.junit_jupiter_engine
+    testRuntimeOnly libs.log4j_over_slf4j
+    testRuntimeOnly libs.logback_classic
+    testRuntimeOnly libs.logback_core
 }

stroom-analytics/stroom-analytics-impl/src/main/java/stroom/analytics/impl/AnalyticsConfig.java

@@ -82,6 +82,10 @@ public CacheConfig getStreamingAnalyticCache() {
         return streamingAnalyticCache;
     }
 
+
+    // --------------------------------------------------------------------------------
+
+
     @BootStrapConfig
     public static class AnalyticsDbConfig extends AbstractDbConfig implements IsStroomConfig {
 

stroom-analytics/stroom-analytics-impl/src/main/java/stroom/analytics/impl/SmtpConfig.java

@@ -38,6 +38,8 @@
 @JsonPropertyOrder(alphabetic = true)
 public class SmtpConfig extends AbstractConfig implements IsStroomConfig {
 
+    public static final String DEFAULT_TRANSPORT = "plain";
+
     @NotNull
     @JsonProperty("host")
     @JsonPropertyDescription("The fully qualified hostname of the SMTP server.")
@@ -66,7 +68,7 @@ public class SmtpConfig extends AbstractConfig implements IsStroomConfig {
     public SmtpConfig() {
         host = "localhost";
         port = 2525;
-        transport = "plain";
+        transport = DEFAULT_TRANSPORT;
         password = null;
         username = null;
     }
@@ -85,6 +87,11 @@ public SmtpConfig(@JsonProperty("host") final String host,
         this.password = password;
     }
 
+    public static SmtpConfig unauthenticated(final String host,
+                                             final int port) {
+        return new SmtpConfig(host, port, DEFAULT_TRANSPORT, null, null);
+    }
+
     public String getHost() {
         return host;
     }
@@ -110,7 +117,7 @@ public TransportStrategy getTransportStrategy() {
         switch (transport) {
             case "TLS", "SSL":
                 return TransportStrategy.SMTP_TLS;
-            case "plain":
+            case DEFAULT_TRANSPORT:
             default:
                 return TransportStrategy.SMTP;
         }

stroom-analytics/stroom-analytics-impl/src/test/java/stroom/analytics/impl/TestEmailSender.java

@@ -0,0 +1,53 @@
+package stroom.analytics.impl;
+
+import stroom.analytics.shared.AnalyticNotificationEmailDestination;
+
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.mockito.junit.jupiter.MockitoExtension;
+
+import java.util.UUID;
+
+@ExtendWith(MockitoExtension.class)
+class TestEmailSender {
+
+    @Mock
+    private AnalyticsConfig mockAnalyticsConfig;
+
+    @Disabled // manual only due to reliance on smtp.freesmtpservers.com
+    @Test
+    void send() {
+        // See https://www.wpoven.com/tools/free-smtp-server-for-testing to check the email sent
+        Mockito.when(mockAnalyticsConfig.getEmailConfig())
+                .thenReturn(new EmailConfig(
+                        SmtpConfig.unauthenticated("smtp.freesmtpservers.com", 25),
+                        "[email protected]",
+                        "Mr Foo"));
+
+        final EmailSender emailSender = new EmailSender(() -> mockAnalyticsConfig);
+
+        final AnalyticNotificationEmailDestination destination = AnalyticNotificationEmailDestination.builder()
+                .to("[email protected]")
+                .build();
+
+        final Detection detection = new Detection(
+                null,
+                "DetectorName",
+                UUID.randomUUID().toString(),
+                null,
+                null,
+                "Headline",
+                null,
+                null,
+                UUID.randomUUID().toString(),
+                null,
+                null,
+                null,
+                null);
+
+        emailSender.send(destination, detection);
+    }
+}

stroom-security/stroom-security-identity/build.gradle

@@ -43,6 +43,7 @@ dependencies {
     implementation libs.jaxb_api
     implementation libs.jose4j
     implementation libs.simple_java_mail
+    implementation libs.simple_java_mail_batch_module
     implementation libs.slf4j_api
     implementation libs.swagger_annotations
     implementation libs.ws_rs_api

unreleased_changes/20240410_130458_422__4175.md

@@ -0,0 +1,24 @@
+* Issue **#4175** : Fix `Batch module not found` error when sending emails.
+
+
+```sh
+# ********************************************************************************
+# Issue title: Error in EmailSender
+# Issue link:  https://github.com/gchq/stroom/issues/4175
+# ********************************************************************************
+
+# ONLY the top line will be included as a change entry in the CHANGELOG.
+# The entry should be in GitHub flavour markdown and should be written on a SINGLE
+# line with no hard breaks. You can have multiple change files for a single GitHub issue.
+# The  entry should be written in the imperative mood, i.e. 'Fix nasty bug' rather than
+# 'Fixed nasty bug'.
+#
+# Examples of acceptable entries are:
+#
+#
+# * Issue **123** : Fix bug with an associated GitHub issue in this repository
+#
+# * Issue **namespace/other-repo#456** : Fix bug with an associated GitHub issue in another repository
+#
+# * Fix bug with no associated GitHub issue.
+```