#260: Added api for setting baseUrl as String and added more junit tests and fixed subsequent bug

Author: bbottema

modules/core-module/src/main/java/org/simplejavamail/api/email/EmailPopulatingBuilder.java

@@ -881,6 +881,13 @@ public interface EmailPopulatingBuilder {
 	 */
 	EmailPopulatingBuilder withEmbeddedImageBaseClassPath(@NotNull final String embeddedImageBaseClassPath);
 
+	/**
+	 * Delegates to {@link #withEmbeddedImageBaseUrl(URL)}.
+	 *
+	 * @param embeddedImageBaseUrl The base URL used when resolving images sources in HTML text.
+	 */
+	EmailPopulatingBuilder withEmbeddedImageBaseUrl(@NotNull final String embeddedImageBaseUrl);
+
 	/**
 	 * Sets the base URL used when resolving images sources in HTML text. Without this, the resource needs to be an absolute URL (or a file/classpath resource).
 	 * <p>

modules/simple-java-mail/src/main/java/org/simplejavamail/email/internal/EmailException.java

@@ -13,6 +13,7 @@ class EmailException extends MailException {
 	static final String ERROR_READING_FROM_PEM_INPUTSTREAM = "Was unable to convert PEM data to X509 certificate";
 	static final String ERROR_LOADING_PROVIDER_FOR_SMIME_SUPPORT = "Unable to load certificate (missing bouncy castle), is the S/MIME module on the class path?";
 	static final String ERROR_RESOLVING_IMAGE_DATASOURCE = "Unable to dynamically resolve data source for the following image src: %s";
+	static final String ERROR_PARSING_URL = "Unable to parse URL: %s";
 
 	EmailException(@SuppressWarnings("SameParameterValue") final String message) {
 		super(message);

modules/simple-java-mail/src/main/java/org/simplejavamail/email/internal/EmailPopulatingBuilderImpl.java

@@ -3,6 +3,7 @@
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
+import org.simplejavamail.MailException;
 import org.simplejavamail.api.email.AttachmentResource;
 import org.simplejavamail.api.email.CalendarMethod;
 import org.simplejavamail.api.email.Email;
@@ -28,6 +29,7 @@
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
+import java.net.MalformedURLException;
 import java.net.URL;
 import java.security.NoSuchProviderException;
 import java.security.cert.CertificateException;
@@ -73,6 +75,7 @@
 import static org.simplejavamail.config.ConfigLoader.getStringProperty;
 import static org.simplejavamail.config.ConfigLoader.hasProperty;
 import static org.simplejavamail.email.internal.EmailException.ERROR_LOADING_PROVIDER_FOR_SMIME_SUPPORT;
+import static org.simplejavamail.email.internal.EmailException.ERROR_PARSING_URL;
 import static org.simplejavamail.email.internal.EmailException.ERROR_READING_FROM_FILE;
 import static org.simplejavamail.email.internal.EmailException.ERROR_READING_FROM_PEM_INPUTSTREAM;
 import static org.simplejavamail.email.internal.EmailException.ERROR_RESOLVING_IMAGE_DATASOURCE;
@@ -335,10 +338,10 @@ public class EmailPopulatingBuilderImpl implements InternalEmailPopulatingBuilde
 				withEmbeddedImageBaseDir(assumeNonNull(getStringProperty(EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_DIR)));
 			}
 			if (hasProperty(EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_URL)) {
-				withEmbeddedImageBaseDir(assumeNonNull(getStringProperty(EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_URL)));
+				withEmbeddedImageBaseUrl(assumeNonNull(getStringProperty(EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_URL)));
 			}
 			if (hasProperty(EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_CLASSPATH)) {
-				withEmbeddedImageBaseDir(assumeNonNull(getStringProperty(EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_CLASSPATH)));
+				withEmbeddedImageBaseClassPath(assumeNonNull(getStringProperty(EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_CLASSPATH)));
 			}
 		}
 	}
@@ -1426,6 +1429,18 @@ public EmailPopulatingBuilder withEmbeddedImageBaseClassPath(@NotNull final Stri
 		return this;
 	}
 
+	/**
+	 * @see EmailPopulatingBuilder#withEmbeddedImageBaseUrl(String)
+	 */
+	@Override
+	public EmailPopulatingBuilder withEmbeddedImageBaseUrl(@NotNull final String embeddedImageBaseUrl) {
+		try {
+			return withEmbeddedImageBaseUrl(new URL(embeddedImageBaseUrl));
+		} catch (MalformedURLException e) {
+			throw new EmailException(format(ERROR_PARSING_URL, embeddedImageBaseUrl), e);
+		}
+	}
+
 	/**
 	 * @see EmailPopulatingBuilder#withEmbeddedImageBaseUrl(URL)
 	 */

modules/simple-java-mail/src/test/java/org/simplejavamail/config/ConfigLoaderTest.java

@@ -24,6 +24,9 @@
 import static org.simplejavamail.config.ConfigLoader.Property.DEFAULT_SUBJECT;
 import static org.simplejavamail.config.ConfigLoader.Property.DEFAULT_TO_ADDRESS;
 import static org.simplejavamail.config.ConfigLoader.Property.DEFAULT_TO_NAME;
+import static org.simplejavamail.config.ConfigLoader.Property.EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_CLASSPATH;
+import static org.simplejavamail.config.ConfigLoader.Property.EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_DIR;
+import static org.simplejavamail.config.ConfigLoader.Property.EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_URL;
 import static org.simplejavamail.config.ConfigLoader.Property.JAVAXMAIL_DEBUG;
 import static org.simplejavamail.config.ConfigLoader.Property.PROXY_HOST;
 import static org.simplejavamail.config.ConfigLoader.Property.PROXY_PASSWORD;
@@ -198,6 +201,10 @@ public void loadPropertiesFromFileClassPath() {
 		assertThat(ConfigLoader.getProperty(SMIME_SIGNING_KEY_ALIAS)).isEqualTo("smime_test_user_alias");
 		assertThat(ConfigLoader.getProperty(SMIME_SIGNING_KEY_PASSWORD)).isEqualTo("letmein");
 		assertThat(ConfigLoader.getProperty(SMIME_ENCRYPTION_CERTIFICATE)).isEqualTo("src/test/resources/pkcs12/smime_test_user.pem.standard.crt");
+
+		assertThat(ConfigLoader.getProperty(EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_DIR)).isEqualTo("unable to test this as the value is variable depending on junit working folder");
+		assertThat(ConfigLoader.getProperty(EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_URL)).isEqualTo("http://www.simplejavamail.org");
+		assertThat(ConfigLoader.getProperty(EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_CLASSPATH)).isEqualTo("/pkcs12");
 	}
 
 	@Test
@@ -220,7 +227,6 @@ public void loadPropertiesAddingMode() {
 
 	@Test
 	public void loadPropertiesFromInputStream() {
-
 		String s = "simplejavamail.javaxmail.debug=true\n"
 				+ "simplejavamail.transportstrategy=SMTPS\n"
 				+ "simplejavamail.smtp.host=smtp.default.com\n"

modules/simple-java-mail/src/test/java/org/simplejavamail/email/internal/EmailPopulatingBuilderImpl1Test.java

@@ -46,6 +46,7 @@
 import static org.assertj.core.api.Assertions.failBecauseExceptionWasNotThrown;
 import static org.assertj.core.api.Assumptions.assumeThat;
 import static org.mockito.Mockito.mock;
+import static org.simplejavamail.util.TestDataHelper.getUrl;
 import static org.simplejavamail.util.TestDataHelper.loadPkcs12KeyStore;
 import static testutil.CertificationUtil.extractSignedBy;
 
@@ -959,14 +960,6 @@ public void testEmbeddingImagesWithDynamicDataSourceResolution_relativeUrlWithBa
 		verifyEmbeddedImage(email, "Download Simple Java Mail");
 	}
 
-	private int getUrl(String urlStr) {
-		try {
-			return ((HttpURLConnection) new URL(urlStr).openConnection()).getResponseCode();
-		} catch (IOException e) {
-			return HttpURLConnection.HTTP_NOT_FOUND;
-		}
-	}
-
 	@Test
 	public void testEmbeddingImagesWithDynamicDataSourceResolution_classPathPath()
 			throws IOException {

modules/simple-java-mail/src/test/java/org/simplejavamail/email/internal/EmailPopulatingBuilderImpl2Test.java

@@ -1,21 +1,26 @@
 package org.simplejavamail.email.internal;
 
 import org.apache.commons.collections4.map.HashedMap;
+import org.assertj.core.api.iterable.Extractor;
 import org.junit.Test;
+import org.simplejavamail.api.email.AttachmentResource;
 import org.simplejavamail.api.email.Email;
 import org.simplejavamail.api.email.EmailAssert;
 import org.simplejavamail.api.email.Recipient;
-import org.simplejavamail.api.mailer.config.Pkcs12Config;
 import org.simplejavamail.config.ConfigLoader.Property;
 import org.simplejavamail.email.EmailBuilder;
 import testutil.ConfigLoaderTestHelper;
 
+import java.io.IOException;
+import java.net.HttpURLConnection;
 import java.util.Map;
 
+import static demo.ResourceFolderHelper.determineResourceFolder;
 import static javax.mail.Message.RecipientType.BCC;
 import static javax.mail.Message.RecipientType.CC;
 import static javax.mail.Message.RecipientType.TO;
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assumptions.assumeThat;
 import static org.simplejavamail.config.ConfigLoader.Property.DEFAULT_BCC_ADDRESS;
 import static org.simplejavamail.config.ConfigLoader.Property.DEFAULT_BCC_NAME;
 import static org.simplejavamail.config.ConfigLoader.Property.DEFAULT_BOUNCETO_ADDRESS;
@@ -29,15 +34,25 @@
 import static org.simplejavamail.config.ConfigLoader.Property.DEFAULT_SUBJECT;
 import static org.simplejavamail.config.ConfigLoader.Property.DEFAULT_TO_ADDRESS;
 import static org.simplejavamail.config.ConfigLoader.Property.DEFAULT_TO_NAME;
+import static org.simplejavamail.config.ConfigLoader.Property.EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_CLASSPATH;
+import static org.simplejavamail.config.ConfigLoader.Property.EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_DIR;
+import static org.simplejavamail.config.ConfigLoader.Property.EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_URL;
 import static org.simplejavamail.config.ConfigLoader.Property.SMIME_ENCRYPTION_CERTIFICATE;
 import static org.simplejavamail.config.ConfigLoader.Property.SMIME_SIGNING_KEYSTORE;
 import static org.simplejavamail.config.ConfigLoader.Property.SMIME_SIGNING_KEYSTORE_PASSWORD;
 import static org.simplejavamail.config.ConfigLoader.Property.SMIME_SIGNING_KEY_ALIAS;
 import static org.simplejavamail.config.ConfigLoader.Property.SMIME_SIGNING_KEY_PASSWORD;
+import static org.simplejavamail.util.TestDataHelper.getUrl;
 import static org.simplejavamail.util.TestDataHelper.loadPkcs12KeyStore;
 
 public class EmailPopulatingBuilderImpl2Test {
 
+	private static final String RESOURCES_PATH = determineResourceFolder("simple-java-mail") + "/test/resources";
+
+	private static final String DOWNLOAD_SIMPLE_JAVA_MAIL = "Download Simple Java Mail";
+	private static final String CREATE_SELF_SIGNED_S_MIME_CERTIFICATES = "Create Self-Signed S/MIME Certificates";
+	private static final String CONSOLE_NAME_CONSOLE_TARGET_SYSTEM_OUT = "<Console name=\"console\" target=\"SYSTEM_OUT\">";
+
 	@Test
 	public void testConstructorApplyingPreconfiguredDefaults1() throws Exception {
 		Map<Property, Object> value = new HashedMap<>();
@@ -100,4 +115,51 @@ public void testConstructorApplyingPreconfiguredDefaults2() throws Exception {
 
 		assertThat(email.getX509CertificateForSmimeEncryption()).isNotNull();
 	}
+
+	@Test
+	public void testConstructorApplyingPreconfiguredDefaults_EmbeddedImageResolving() throws Exception {
+		assumeThat(getUrl("http://www.simplejavamail.org")).isEqualTo(HttpURLConnection.HTTP_OK);
+
+		HashedMap<Property, Object> value = new HashedMap<>();
+
+		value.put(EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_DIR, RESOURCES_PATH);
+		value.put(EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_URL, "http://www.simplejavamail.org");
+		value.put(EMBEDDEDIMAGES_DYNAMICRESOLUTION_BASE_CLASSPATH, "/pkcs12");
+
+		ConfigLoaderTestHelper.setResolvedProperties(value);
+
+		Email email = EmailBuilder.startingBlank()
+				.withHTMLText("<img src=\"cid:cid_name\"/>")
+				.appendTextHTML("<img src=\"download.html\"/>") // comes from simplejavamail.org
+				.appendTextHTML("<img src=\"/how-to.html\"/>") // comes from classpath
+				.appendTextHTML("<img src=\"log4j2.xml\"/>") // comes from folder
+				.buildEmail();
+
+		assertThat(email.getEmbeddedImages())
+				.extracting(new DatasourceReadingExtractor())
+				.containsExactlyInAnyOrder(
+						DOWNLOAD_SIMPLE_JAVA_MAIL,
+						CREATE_SELF_SIGNED_S_MIME_CERTIFICATES,
+						CONSOLE_NAME_CONSOLE_TARGET_SYSTEM_OUT
+				);
+	}
+
+	private static class DatasourceReadingExtractor implements Extractor<AttachmentResource, String> {
+		@Override
+		public String extract(final AttachmentResource input) {
+			try {
+				final String sourceContent = input.readAllData();
+				if (sourceContent.contains(DOWNLOAD_SIMPLE_JAVA_MAIL)) {
+					return DOWNLOAD_SIMPLE_JAVA_MAIL;
+				} else if (sourceContent.contains(CREATE_SELF_SIGNED_S_MIME_CERTIFICATES)) {
+					return CREATE_SELF_SIGNED_S_MIME_CERTIFICATES;
+				} else if (sourceContent.contains(CONSOLE_NAME_CONSOLE_TARGET_SYSTEM_OUT)) {
+					return CONSOLE_NAME_CONSOLE_TARGET_SYSTEM_OUT;
+				}
+				return "";
+			} catch (IOException e) {
+				throw new AssertionError();
+			}
+		}
+	}
 }

modules/simple-java-mail/src/test/java/org/simplejavamail/util/TestDataHelper.java

@@ -7,6 +7,10 @@
 import org.jetbrains.annotations.NotNull;
 import javax.mail.util.ByteArrayDataSource;
 
+import java.io.IOException;
+import java.net.HttpURLConnection;
+import java.net.URL;
+
 import static demo.ResourceFolderHelper.determineResourceFolder;
 import static java.util.Objects.requireNonNull;
 
@@ -39,4 +43,12 @@ public static Pkcs12Config loadPkcs12KeyStore() {
 				.keyPassword("letmein")
 				.build();
 	}
+
+	public static int getUrl(String urlStr) {
+		try {
+			return ((HttpURLConnection) new URL(urlStr).openConnection()).getResponseCode();
+		} catch (IOException e) {
+			return HttpURLConnection.HTTP_NOT_FOUND;
+		}
+	}
 }

modules/simple-java-mail/src/test/resources/simplejavamail.properties

@@ -27,4 +27,7 @@ simplejavamail.smime.signing.keystore=src/test/resources/pkcs12/smime_keystore.p
 simplejavamail.smime.signing.keystore_password=letmein
 simplejavamail.smime.signing.key_alias=smime_test_user_alias
 simplejavamail.smime.signing.key_password=letmein
-simplejavamail.smime.encryption.certificate=src/test/resources/pkcs12/smime_test_user.pem.standard.crt
+simplejavamail.smime.encryption.certificate=src/test/resources/pkcs12/smime_test_user.pem.standard.crt
+simplejavamail.embeddedimages.dynamicresolution.base.dir=
+simplejavamail.embeddedimages.dynamicresolution.base.url=
+simplejavamail.embeddedimages.dynamicresolution.base.classpath=

modules/spring-module/src/test/resources/simplejavamail.properties

@@ -27,4 +27,7 @@ simplejavamail.smime.signing.keystore=src/test/resources/pkcs12/smime_keystore.p
 simplejavamail.smime.signing.keystore_password=letmein
 simplejavamail.smime.signing.key_alias=smime_test_user_alias
 simplejavamail.smime.signing.key_password=letmein
-simplejavamail.smime.encryption.certificate=src/test/resources/pkcs12/smime_test_user.pem.standard.crt
+simplejavamail.smime.encryption.certificate=src/test/resources/pkcs12/smime_test_user.pem.standard.crt
+simplejavamail.embeddedimages.dynamicresolution.base.dir=
+simplejavamail.embeddedimages.dynamicresolution.base.url=
+simplejavamail.embeddedimages.dynamicresolution.base.classpath=