#434 Upgraded tests to JUnit 5

Author: rjrudin

build.gradle

@@ -21,10 +21,10 @@ repositories {
 
 dependencies {
   api 'com.marklogic:ml-javaclient-util:4.2.0-rc1'
-  api 'jaxen:jaxen:1.2.0'
-  api 'org.apache.httpcomponents:httpclient:4.5.13'
   api 'org.springframework:spring-web:5.3.7'
 
+	implementation 'jaxen:jaxen:1.2.0'
+	implementation 'org.apache.httpcomponents:httpclient:4.5.13'
 	implementation 'org.jdom:jdom2:2.0.6'
 
 	// Forcing httpclient to use this to address https://snyk.io/vuln/SNYK-JAVA-COMMONSCODEC-561518
@@ -37,24 +37,23 @@ dependencies {
 	implementation "com.flipkart.zjsonpatch:zjsonpatch:0.4.11"
 
 	// Required for Java 11
-	api "javax.xml.bind:jaxb-api:2.3.1"
-	api "com.sun.xml.bind:jaxb-core:2.3.0.1"
-	api "com.sun.xml.bind:jaxb-impl:2.3.3"
+	implementation "javax.xml.bind:jaxb-api:2.3.1"
+	implementation "com.sun.xml.bind:jaxb-core:2.3.0.1"
+	implementation "com.sun.xml.bind:jaxb-impl:2.3.3"
 
 	// Don't want to include this in the published jar, just the executable jar
 	compileOnly "com.beust:jcommander:1.78"
 	compileOnly "ch.qos.logback:logback-classic:1.2.3"
 
-	// This uses JUnit 4; we'll soon replace this with marklogic-junit5 and JUnit5
-	testImplementation 'com.marklogic:ml-junit:3.2.0'
-
-	testImplementation "org.springframework:spring-test:5.3.7"
+	testImplementation "org.junit.jupiter:junit-jupiter:5.7.1"
+	testImplementation 'org.springframework:spring-test:5.3.7'
 	testImplementation 'commons-io:commons-io:2.8.0'
+	testImplementation 'xmlunit:xmlunit:1.6'
 
 	// Forcing Spring to use logback for testing instead of commons-logging
 	testImplementation "ch.qos.logback:logback-classic:1.2.3"
-	testImplementation group: "org.slf4j", name: "jcl-over-slf4j", version: "1.7.30"
-	testImplementation group: "org.slf4j", name: "slf4j-api", version: "1.7.30"
+	testImplementation "org.slf4j:jcl-over-slf4j:1.7.30"
+	testImplementation "org.slf4j:slf4j-api:1.7.30"
 }
 
 // This ensures that Gradle includes in the published jar any non-java files under src/main/java
@@ -83,6 +82,7 @@ publishing {
 }
 
 test {
+	useJUnitPlatform()
   testLogging {
     events 'started','passed', 'skipped', 'failed'
     exceptionFormat 'full'

gradle/wrapper/gradle-wrapper.properties

@@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.5.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.3-bin.zip

src/test/java/com/marklogic/appdeployer/AbstractAppDeployerTest.java

@@ -7,7 +7,7 @@
 import com.marklogic.client.ext.modulesloader.impl.DefaultModulesLoader;
 import com.marklogic.mgmt.AbstractMgmtTest;
 import com.marklogic.xcc.template.XccTemplate;
-import org.junit.Before;
+import org.junit.jupiter.api.BeforeEach;
 
 import java.io.File;
 
@@ -27,7 +27,7 @@ public abstract class AbstractAppDeployerTest extends AbstractMgmtTest {
     protected AppDeployer appDeployer;
     protected AppConfig appConfig;
 
-    @Before
+    @BeforeEach
     public void initialize() {
         initializeAppConfig();
     }

src/test/java/com/marklogic/appdeployer/DefaultAppConfigFactoryTest.java

@@ -5,16 +5,16 @@
 import com.marklogic.client.ext.SecurityContextType;
 import com.marklogic.client.ext.modulesloader.impl.PropertiesModuleManager;
 import com.marklogic.mgmt.util.SimplePropertySource;
-import org.junit.Assert;
-import org.junit.Test;
+import static org.junit.jupiter.api.Assertions.*;
+import org.junit.jupiter.api.Test;
 
 import java.io.File;
 import java.util.List;
 import java.util.Map;
 import java.util.Properties;
 import java.util.Set;
 
-public class DefaultAppConfigFactoryTest extends Assert {
+public class DefaultAppConfigFactoryTest  {
 
 	private DefaultAppConfigFactory sut;
 
@@ -84,8 +84,8 @@ public void invalidPropertyValue() {
 		} catch (IllegalArgumentException ex) {
 			String message = ex.getMessage();
 			assertTrue(
-				"Expected the exception to identify the property name and value; message: " + message,
-				message.startsWith("Unable to parse value '3' for property 'mlForestsPerHost'")
+				message.startsWith("Unable to parse value '3' for property 'mlForestsPerHost'"),
+				"Expected the exception to identify the property name and value; message: " + message
 			);
 		}
 	}
@@ -127,8 +127,8 @@ public void moduleTimestampsPath() {
 	public void unrecognizedProperties() {
 		sut = new DefaultAppConfigFactory(new SimplePropertySource("foo.mlHost", "host", "foo.mlUsername", "user"));
 		AppConfig config = sut.newAppConfig();
-		assertEquals("Should use default", "localhost", config.getHost());
-		assertEquals("Should use default", AppConfig.DEFAULT_USERNAME, config.getRestAdminUsername());
+		assertEquals("localhost", config.getHost(), "Should use default");
+		assertEquals(AppConfig.DEFAULT_USERNAME, config.getRestAdminUsername(), "Should use default");
 	}
 
 	@Test
@@ -168,8 +168,8 @@ public void cpfDatabaseName() {
 		sut = new DefaultAppConfigFactory(new SimplePropertySource("mlAppName", "test"));
 		AppConfig config = sut.newAppConfig();
 		assertEquals("test-triggers", config.getTriggersDatabaseName());
-		assertEquals("CPF database should default to the triggers database when not specified",
-			"test-triggers", config.getCpfDatabaseName());
+		assertEquals("test-triggers", config.getCpfDatabaseName(),
+			"CPF database should default to the triggers database when not specified");
 
 		sut = new DefaultAppConfigFactory(new SimplePropertySource("mlAppName", "test", "mlCpfDatabaseName", "my-cpf-db"));
 		config = sut.newAppConfig();
@@ -413,7 +413,7 @@ public void mostProperties() {
 		assertEquals("appServicesCertPassword", config.getAppServicesCertPassword());
 		assertEquals("appServicesExternalName", config.getAppServicesExternalName());
 		assertNotNull(config.getAppServicesSslContext());
-		assertNotNull("As of 3.15.0, a trust manager must be set in order for SSL to work on >= Java 9", config.getAppServicesTrustManager());
+		assertNotNull(config.getAppServicesTrustManager(), "As of 3.15.0, a trust manager must be set in order for SSL to work on >= Java 9");
 		assertEquals(DatabaseClientFactory.SSLHostnameVerifier.ANY, config.getAppServicesSslHostnameVerifier());
 
 		assertEquals("my-rest-server", config.getRestServerName());
@@ -437,7 +437,7 @@ public void mostProperties() {
 
 		assertNotNull(config.getRestSslContext());
 		assertNotNull(config.getRestSslHostnameVerifier());
-		assertNotNull("As of 3.15.0, a trust manager is set so that simple SSL works on >= Java 9", config.getRestTrustManager());
+		assertNotNull(config.getRestTrustManager(), "As of 3.15.0, a trust manager is set so that simple SSL works on >= Java 9");
 		assertEquals("my-content-db", config.getContentDatabaseName());
 		assertEquals("my-test-db", config.getTestContentDatabaseName());
 		assertEquals("my-modules", config.getModulesDatabaseName());
@@ -561,13 +561,13 @@ public void mlUsernameAndPassword() {
 			new SimplePropertySource("mlUsername", "customuser", "mlPassword", "custompassword"));
 		AppConfig config = sut.newAppConfig();
 
-		assertEquals("When mlRestAdminUsername is not set, mlUsername should be used", "customuser",
-			config.getRestAdminUsername());
-		assertEquals("When mlRestAdminPassword is not set, mlPassword should be used", "custompassword",
-			config.getRestAdminPassword());
+		assertEquals("customuser", config.getRestAdminUsername(),
+			"When mlRestAdminUsername is not set, mlUsername should be used");
+		assertEquals("custompassword", config.getRestAdminPassword(),
+			"When mlRestAdminPassword is not set, mlPassword should be used");
 
-		assertNull("SSL context should be null by default", config.getRestSslContext());
-		assertNull("SSL hostname verifier should be null by default", config.getRestSslHostnameVerifier());
+		assertNull(config.getRestSslContext(), "SSL context should be null by default");
+		assertNull(config.getRestSslHostnameVerifier(), "SSL hostname verifier should be null by default");
 	}
 
 	@Test
@@ -581,8 +581,8 @@ public void dontModifySetOfDatabasesWithForestsOnOneHostIfItsBeenConfigured() {
 		assertTrue(set.contains("db2"));
 
 		final String message = "If the user has configured the set of databases, then the default schema and trigger databases names should not be added automatically";
-		assertFalse(message, set.contains("example-triggers"));
-		assertFalse(message, set.contains("example-schemas"));
+		assertFalse(set.contains("example-triggers"), message);
+		assertFalse(set.contains("example-schemas"), message);
 	}
 
 	@Test

src/test/java/com/marklogic/appdeployer/MergeResourcesWhileDeployingTest.java

@@ -21,19 +21,21 @@
 import com.marklogic.mgmt.resource.security.PrivilegeManager;
 import com.marklogic.mgmt.resource.security.RoleManager;
 import com.marklogic.mgmt.resource.security.UserManager;
-import org.junit.After;
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 
 import java.io.File;
 import java.util.ArrayList;
 import java.util.List;
 
+import static org.junit.jupiter.api.Assertions.*;
+
 public class MergeResourcesWhileDeployingTest extends AbstractAppDeployerTest {
 
 	private ResourceMapper resourceMapper;
 
-	@Before
+	@BeforeEach
 	public void setup() {
 		List<ConfigDir> list = new ArrayList<>();
 		list.add(new ConfigDir(new File("src/test/resources/sample-app/multiple-config-paths/path1")));
@@ -43,7 +45,7 @@ public void setup() {
 		resourceMapper = new DefaultResourceMapper(new API(manageClient));
 	}
 
-	@After
+	@AfterEach
 	public void teardown() {
 		undeploySampleApp();
 	}
@@ -56,7 +58,7 @@ public void users() {
 		UserManager mgr = new UserManager(manageClient);
 		User user = resourceMapper.readResource(mgr.getAsJson("sample-app-jane"), User.class);
 		assertEquals(2, user.getRole().size());
-		assertEquals("The role from the first path should be first", "rest-reader", user.getRole().get(0));
+		assertEquals("rest-reader", user.getRole().get(0), "The role from the first path should be first");
 		assertEquals("manage-user", user.getRole().get(1));
 	}
 
@@ -138,8 +140,8 @@ private void deployMultipleDatabasesNeededMergingAndVerify() {
 		assertEquals(2, db.getRangeElementIndex().size());
 		assertEquals("id", db.getRangeElementIndex().get(0).getLocalname());
 		assertEquals("otherId", db.getRangeElementIndex().get(1).getLocalname());
-		assertTrue("The file in the second path should override single-value properties from the " +
-			"file in the first path", db.getTripleIndex());
+		assertTrue(db.getTripleIndex(), "The file in the second path should override single-value properties from the " +
+			"file in the first path");
 		assertEquals("sample-app-schema-database", db.getSchemaDatabase());
 		assertEquals("sample-app-triggers-database", db.getTriggersDatabase());
 

src/test/java/com/marklogic/appdeployer/PopulateCustomTokensTest.java

@@ -1,19 +1,19 @@
 package com.marklogic.appdeployer;
 
 import com.marklogic.appdeployer.util.SimplePropertiesSource;
-import org.junit.Assert;
-import org.junit.Before;
-import org.junit.Test;
+import static org.junit.jupiter.api.Assertions.*;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 
 import java.util.Map;
 import java.util.Properties;
 
-public class PopulateCustomTokensTest extends Assert {
+public class PopulateCustomTokensTest  {
 
 	private AppConfig appConfig;
 	private Properties props;
 
-	@Before
+	@BeforeEach
 	public void setup() {
 		appConfig = new AppConfig();
 

src/test/java/com/marklogic/appdeployer/command/AbstractIncrementalDeployTest.java

@@ -2,19 +2,19 @@
 
 import com.marklogic.appdeployer.AbstractAppDeployerTest;
 import com.marklogic.mgmt.ManageClient;
-import org.junit.Before;
+import org.junit.jupiter.api.BeforeEach;
 
 public abstract class AbstractIncrementalDeployTest extends AbstractAppDeployerTest {
 
 	protected ManageClient originalManageClient;
 
-	@Before
+	@BeforeEach
 	public void setupIncrementalDeployTest() {
 		appConfig.setIncrementalDeploy(true);
 		this.originalManageClient = this.manageClient;
 		deleteResourceTimestampsFile();
 	}
-	
+
 	public void deleteResourceTimestampsFile() {
 		new ResourceFileManagerImpl().deletePropertiesFile();
 	}

src/test/java/com/marklogic/appdeployer/command/AbstractManageResourceTest.java

@@ -2,7 +2,10 @@
 
 import com.marklogic.appdeployer.AbstractAppDeployerTest;
 import com.marklogic.mgmt.resource.ResourceManager;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 /**
  * Provides a basic create-then-delete test for testing any implementation of ResourceManager.

src/test/java/com/marklogic/appdeployer/command/PayloadPropertiesTest.java

@@ -4,14 +4,16 @@
 import com.marklogic.appdeployer.command.databases.DeployOtherDatabasesCommand;
 import com.marklogic.mgmt.resource.databases.DatabaseManager;
 import com.marklogic.rest.util.Fragment;
-import org.junit.After;
-import org.junit.Test;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.Test;
 
 import java.io.File;
 
+import static org.junit.jupiter.api.Assertions.*;
+
 public class PayloadPropertiesTest extends AbstractAppDeployerTest {
 
-	@After
+	@AfterEach
 	public void teardown() {
 		undeploySampleApp();
 	}

src/test/java/com/marklogic/appdeployer/command/ReplaceTokensTest.java

@@ -9,12 +9,14 @@
 import com.marklogic.client.ext.modulesloader.impl.DefaultModulesLoader;
 import com.marklogic.client.io.BytesHandle;
 import com.marklogic.client.io.StringHandle;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 import java.io.File;
 import java.util.Arrays;
 import java.util.Properties;
 
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
 public class ReplaceTokensTest extends AbstractAppDeployerTest {
 
 	@Test
@@ -41,7 +43,7 @@ public void test() {
 		DatabaseClient modulesClient = appConfig.newAppServicesDatabaseClient(appConfig.getModulesDatabaseName());
 		try {
 			String moduleText = new String(modulesClient.newDocumentManager().read("/hello.xqy", new BytesHandle()).get());
-			assertTrue("Did not find replaced text in module: " + moduleText, moduleText.contains("replaced!"));
+			assertTrue(moduleText.contains("replaced!"), "Did not find replaced text in module: " + moduleText);
 		} finally {
 			modulesClient.release();
 			undeploySampleApp();