#178 Added ParameterizedTest to unit-test project

Author: rjrudin

build.gradle

@@ -15,6 +15,11 @@ targetCompatibility = "1.8"
 repositories {
   mavenLocal() // Used for local development only
   jcenter()
+
+	// Needed until ml-unit-test is available via jcenter()
+	maven {
+		url {"https://dl.bintray.com/rjrudin/maven/"}
+	}
 }
 
 dependencies {
@@ -24,7 +29,7 @@ dependencies {
   compile mlcpUtilDependency
   compile group: 'commons-io', name: 'commons-io', version: '2.5'
 
-	compileOnly "com.marklogic:marklogic-unit-test-client:0.4.0"
+	compileOnly "com.marklogic:ml-unit-test-client:0.9.1"
 
 	testCompile localGroovy()
 	testCompile gradleTestKit()

examples/local-testing-project/gradle.properties

@@ -1,6 +1,6 @@
 # Set this to the version you used when running
 # "gradle -Pversion=(something) publishToMavenLocal" on your local ml-gradle repo
-mlGradleVersion=277
+mlGradleVersion=3.5.0
 
 mlHost=localhost
 mlAppName=example

examples/unit-test-project/README.md

@@ -1,23 +1,30 @@
-This project shows an example of using the marklogic-unit-test framework to run server-side tests within MarkLogic.
+This project shows an example of using the ml-unit-test framework to run server-side tests within MarkLogic.
 
-Using marklogic-unit-test requires two additions to the build.gradle file:
+Using ml-unit-test requires two additions to the build.gradle file, as described below.
 
-1. ml-gradle includes an "mlUnitTest" task, which depends on the marklogic-unit-test-client JAR file. ml-gradle does not
-include this by default (not every ml-gradle user will use marklogic-unit-test), so it must be added to the buildscript:
+First, ml-gradle includes an "mlUnitTest" task, which depends on the ml-unit-test-client JAR file. ml-gradle does not
+include this by default (not every ml-gradle user will use ml-unit-test), so it must be added to the buildscript:
 
     buildscript {
       repositories {
         jcenter()
       }
       dependencies {
-    	  classpath "com.marklogic:marklogic-unit-test-client:1.0"
+    	  classpath "com.marklogic:ml-unit-test-client:0.9.1"
       }
     }
 
-1. The marklogic-unit-test framework is depended on and installed as an "mlRestApi" dependency:
+Next, the ml-unit-test framework is depended on and installed as an "mlRestApi" dependency
 
+    // Needed for ml-unit-test-client dependency until it's available via jcenter()
+    repositories {
+      maven {
+        url {"https://dl.bintray.com/rjrudin/maven/"}
+      }
+    }
+      
     dependencies {
-      mlRestApi "com.marklogic:marklogic-unit-test:1.0"
+      mlRestApi "com.marklogic:ml-unit-test:0.9.1"
     }
 
 With those additions in place, the "mlUnitTest" task can be run. This task will use the value of mlTestRestPort to 
@@ -27,10 +34,27 @@ First, deploy the application:
 
     gradle mlDeploy
 
-This will deploy the application along with the marklogic-unit-test modules.
+This will deploy the application along with the ml-unit-test modules.
 
 Then, run the tests:
 
     gradle mlUnitTest
 
 Two tests are run, and one should fail, so you can see what a failed test looks like. 
+
+This project includes the Gradle Java plugin, which allows you to run tests under src/test/java. This project includes
+an example of a JUnit Parameterized test that invokes each ml-unit-test module separately - you can try it like this:
+
+    gradle test
+
+Again, two tests will run, and one will intentionally fail. The Parameterized test can be run in an IDE as well, allowing
+you to take advantage of your IDE's support for JUnit tests.
+
+You can also access the ml-unit-test REST endpoints directly:
+
+- List the tests - http://localhost:8135/v1/resources/ml-unit-test
+- Run a test suite - http://localhost:8135/v1/resources/ml-unit-test?rs:func=run&rs:suite=My%20Tests
+
+And you can run the original UI test runner by going to:
+
+- http://localhost:8135/test/default.xqy

examples/unit-test-project/build.gradle

@@ -1,10 +1,14 @@
 buildscript {
   repositories {
-	  mavenLocal()
     jcenter()
+
+	  // Needed for ml-unit-test-client dependency until it's available via jcenter()
+	  maven {
+		  url {"https://dl.bintray.com/rjrudin/maven/"}
+	  }
   }
   dependencies {
-	  classpath "com.marklogic:marklogic-unit-test-client:0.4.0"
+	  classpath "com.marklogic:ml-unit-test-client:0.9.1"
     classpath "com.marklogic:ml-gradle:${mlGradleVersion}"
   }
 }
@@ -13,10 +17,18 @@ apply plugin: "java"
 apply plugin: "com.marklogic.ml-gradle"
 
 repositories {
-	mavenLocal()
 	jcenter()
+
+	// Needed for ml-unit-test dependency until it's available via jcenter()
+	maven {
+		url {"https://dl.bintray.com/rjrudin/maven/"}
+	}
 }
 
 dependencies {
-	mlRestApi "com.marklogic:marklogic-unit-test:0.4.0"
+	mlRestApi "com.marklogic:ml-unit-test:0.9.1"
+
+	// For running ml-unit-test tests via JUnit
+	testCompile "com.marklogic:ml-unit-test-client:0.9.1"
+	testCompile "junit:junit:4+"
 }

examples/unit-test-project/gradle.properties

@@ -1,6 +1,4 @@
-# Set this to the version you used when running
-# "gradle -Pversion=(something) publishToMavenLocal" on your local ml-gradle repo
-mlGradleVersion=277
+mlGradleVersion=3.5.0
 
 mlHost=localhost
 mlAppName=unit-test-example

examples/unit-test-project/src/test/java/example/ParameterizedTest.java

@@ -0,0 +1,76 @@
+package example;
+
+import com.marklogic.client.DatabaseClient;
+import com.marklogic.client.DatabaseClientFactory;
+import com.marklogic.test.unit.TestManager;
+import com.marklogic.test.unit.TestModule;
+import com.marklogic.test.unit.TestResult;
+import com.marklogic.test.unit.TestSuiteResult;
+import org.junit.AfterClass;
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.Parameterized;
+
+import java.io.FileReader;
+import java.io.IOException;
+import java.util.List;
+import java.util.Properties;
+
+/**
+ * Example of running each test module as a separate JUnit test.
+ */
+@RunWith(Parameterized.class)
+public class ParameterizedTest extends Assert {
+
+	private TestModule testModule;
+
+	private static TestManager testManager;
+	private static DatabaseClient databaseClient;
+
+	public ParameterizedTest(TestModule testModule) {
+		this.testModule = testModule;
+	}
+
+	@AfterClass
+	public static void releaseDatabaseClient() {
+		if (databaseClient != null) {
+			databaseClient.release();
+		}
+	}
+
+	/**
+	 * This sets up the parameters for our test by getting a list of the test modules.
+	 * <p>
+	 * Also creates a DatabaseClient based on the values in gradle.properties. Typically, properties will be retrieved via
+	 * a more robust mechanism, like Spring's test framework support.
+	 *
+	 * @return
+	 * @throws Exception
+	 */
+	@Parameterized.Parameters(name = "{index}: {0}")
+	public static List<TestModule> getTestModules() throws IOException {
+		Properties props = new Properties();
+		props.load(new FileReader("gradle.properties"));
+		final String host = props.getProperty("mlHost");
+		final int port = Integer.parseInt(props.getProperty("mlTestRestPort"));
+		final String username = props.getProperty("mlUsername");
+		final String password = props.getProperty("mlPassword");
+
+		databaseClient = DatabaseClientFactory.newClient(host, port,
+			new DatabaseClientFactory.DigestAuthContext(username, password));
+		testManager = new TestManager(databaseClient);
+		return testManager.list();
+	}
+
+	@Test
+	public void test() {
+		TestSuiteResult result = testManager.run(this.testModule);
+		for (TestResult testResult : result.getTestResults()) {
+			String failureXml = testResult.getFailureXml();
+			if (failureXml != null) {
+				fail(String.format("Test %s in suite %s failed, cause: %s", testResult.getName(), testModule.getSuite(), failureXml));
+			}
+		}
+	}
+}