#595: [bug] Spring configuration - add support for simplejavamail.extraproperties (and fix bug where extra properties were overwritten rather than merged in 'add' mode)

Author: Benny Bottema

modules/core-module/src/main/java/org/simplejavamail/config/ConfigLoader.java

@@ -1,5 +1,6 @@
 package org.simplejavamail.config;
 
+import lombok.val;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.simplejavamail.api.email.ContentTransferEncoding;
@@ -16,6 +17,7 @@
 import java.util.Map;
 import java.util.Properties;
 import java.util.Set;
+import java.util.function.Function;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
@@ -396,11 +398,16 @@ private static Map<Property, Object> readProperties(final @NotNull Properties fi
 			}
 		}
 
-		final Map<String, String> extraProperties = new HashMap<>();
+		@SuppressWarnings("unchecked")
+		val extraProperties = RESOLVED_PROPERTIES.containsKey(Property.EXTRA_PROPERTIES)
+					? new HashMap<>((Map<String, String>) RESOLVED_PROPERTIES.get(Property.EXTRA_PROPERTIES))
+					: new HashMap<String, String>();
+
 		extraProperties.putAll(filterExtraJavaMailProperties(null, System.getProperties().entrySet()));
 		//noinspection unchecked,rawtypes
 		extraProperties.putAll(filterExtraJavaMailProperties(null, (Set) System.getenv().entrySet()));
 		extraProperties.putAll(filterExtraJavaMailProperties(filePropertiesLeft, fileProperties.entrySet()));
+
 		resolvedProps.put(Property.EXTRA_PROPERTIES, extraProperties);
 
 		if (!filePropertiesLeft.isEmpty()) {

modules/simple-java-mail/src/test/java/org/simplejavamail/mailer/MailerTest.java

@@ -191,35 +191,35 @@ public void createMailSession_MinimalConstructor_WithConfig() {
 		assertThat(session.getProperty("extra-properties-property1")).isEqualTo("value1");
 		assertThat(session.getProperty("extra-properties-property2")).isEqualTo("value2");
 	}
-	
+
 	@Test
 	public void createMailSession_MinimalConstructor_WithConfig_OPPORTUNISTIC_TLS() {
 		Properties properties = new Properties();
 		properties.setProperty(OPPORTUNISTIC_TLS.key(), "false");
 		properties.setProperty("simplejavamail.extraproperties.extra-properties-property2", "override");
 		ConfigLoader.loadProperties(properties, true);
-		
+
 		Mailer mailer = MailerBuilder.withTransportStrategy(TransportStrategy.SMTP).buildMailer();
 		Session session = mailer.getSession();
-		
+
 		assertThat(session.getDebug()).isTrue();
 		assertThat(session.getProperty("mail.smtp.host")).isEqualTo("smtp.default.com");
 		assertThat(session.getProperty("mail.smtp.port")).isEqualTo("25");
 		assertThat(session.getProperty("mail.transport.protocol")).isEqualTo("smtp");
-		
+
 		assertThat(session.getProperty("mail.smtp.starttls.enable")).isNull();
 		assertThat(session.getProperty("mail.smtp.starttls.required")).isNull();
 		assertThat(session.getProperty("mail.smtp.ssl.checkserveridentity")).isEqualTo("true");
-		
+
 		assertThat(session.getProperty("mail.smtp.user")).isEqualTo("username smtp");
 		assertThat(session.getProperty("mail.smtp.auth")).isEqualTo("true");
 		// the following two are because authentication is needed, otherwise proxy would be straightworward
 		assertThat(session.getProperty("mail.smtp.socks.host")).isEqualTo("localhost");
 		assertThat(session.getProperty("mail.smtp.socks.port")).isEqualTo("1081");
-		assertThat(session.getProperty("extra-properties-property1")).isNull();
+		assertThat(session.getProperty("extra-properties-property1")).isEqualTo("value1");
 		assertThat(session.getProperty("extra-properties-property2")).isEqualTo("override");
 	}
-	
+
 	@Test
 	public void createMailSession_MinimalConstructor_WithConfig_OPPORTUNISTIC_TLS_Manually_Disabled() {
 		Properties properties = new Properties();

modules/spring-module/pom.xml

@@ -68,6 +68,18 @@
             <artifactId>spring-test</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <version>${spring.boot.version}</version>
+            <scope>test</scope>
+            <exclusions>
+                <exclusion>
+                    <groupId>org.apache.logging.log4j</groupId>
+                    <artifactId>log4j-to-slf4j</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
     </dependencies>
 
     <dependencyManagement>

modules/spring-module/src/main/java/org/simplejavamail/springsupport/SimpleJavaMailSpringSupport.java

@@ -0,0 +1,4 @@
+simplejavamail.defaults.bcc.name=BCC Spring
+simplejavamail.dkim.signing.selector=
+simplejavamail.extraproperties.two=two
+simplejavamail.extraproperties.three=three

modules/spring-module/src/main/resources/application.properties

@@ -0,0 +1,13 @@
+package org.simplejavamail.springsupport;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest(classes = SimpleJavaMailSpringSupport.class) // uses application.properties automatically
+public class SimpleJavaMailSpringSupportBootTest extends SimpleJavaMailSpringSupportTest {
+
+	@Test
+	public void testBootPropertyPropagation() {
+		performConfigAssertions();
+	}
+}

modules/spring-module/src/test/java/org/simplejavamail/springsupport/SimpleJavaMailSpringSupportBootTest.java

@@ -0,0 +1,18 @@
+package org.simplejavamail.springsupport;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.TestPropertySource;
+import org.springframework.test.context.junit.jupiter.SpringExtension;
+
+@ExtendWith(SpringExtension.class)
+@ContextConfiguration(classes = SimpleJavaMailSpringSupport.class)
+@TestPropertySource(locations = "classpath:application.properties") // unlike Spring Boot, this is a manual step
+public class SimpleJavaMailSpringSupportPlainTest extends SimpleJavaMailSpringSupportTest {
+
+	@Test
+	public void testPlainSpringPropertyPropagation() {
+		performConfigAssertions();
+	}
+}

modules/spring-module/src/test/java/org/simplejavamail/springsupport/SimpleJavaMailSpringSupportPlainTest.java

@@ -1,16 +1,30 @@
 package org.simplejavamail.springsupport;
 
-import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.extension.ExtendWith;
-import org.springframework.test.context.ContextConfiguration;
-import org.springframework.test.context.junit.jupiter.SpringExtension;
+import org.jetbrains.annotations.Nullable;
+import org.simplejavamail.config.ConfigLoader;
 
-@ExtendWith(SpringExtension.class)
-@ContextConfiguration(classes = { SimpleJavaMailSpringSupport.class })
-public class SimpleJavaMailSpringSupportTest {
+import java.util.HashMap;
+import java.util.Map;
 
-	@Test
-	public void testSpringPropertyPropagation() {
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.simplejavamail.config.ConfigLoader.Property.EXTRA_PROPERTIES;
 
-	}
-}
+public abstract class SimpleJavaMailSpringSupportTest {
+
+    protected void performConfigAssertions() {
+        assertThat(getProperty(ConfigLoader.Property.DEFAULT_CC_NAME)).isEqualTo("CC Default"); // from normal simplejavamail.properties
+        assertThat(getProperty(ConfigLoader.Property.DEFAULT_BCC_NAME)).isEqualTo("BCC Spring"); // from Spring application.properties
+        assertThat(getProperty(ConfigLoader.Property.DKIM_SELECTOR)).isEqualTo(null); // not set in any properties
+
+        Map<String, String> loaded = ConfigLoader.getProperty(EXTRA_PROPERTIES);
+        Map<String, String> expected = new HashMap<>();
+        expected.put("one", "1"); // from normal simplejavamail.properties
+        expected.put("two", "two"); // overridden from Spring application.properties
+        expected.put("three", "three"); // from Spring application.properties only
+        assertThat(loaded).containsExactlyInAnyOrderEntriesOf(expected);
+    }
+
+    private static @Nullable String getProperty(ConfigLoader.Property property) {
+        return ConfigLoader.valueOrPropertyAsString(null, property, null);
+    }
+}

modules/spring-module/src/test/java/org/simplejavamail/springsupport/SimpleJavaMailSpringSupportTest.java

@@ -51,4 +51,6 @@ simplejavamail.embeddedimages.dynamicresolution.base.classpath=
 simplejavamail.embeddedimages.dynamicresolution.outside.base.dir=
 simplejavamail.embeddedimages.dynamicresolution.outside.base.classpath=
 simplejavamail.embeddedimages.dynamicresolution.outside.base.url=
-simplejavamail.embeddedimages.dynamicresolution.mustbesuccesful=
+simplejavamail.embeddedimages.dynamicresolution.mustbesuccesful=
+simplejavamail.extraproperties.one=1
+simplejavamail.extraproperties.two=2