Merge branch 'develop'

Author: rjrudin

CONTRIBUTING.md

@@ -124,15 +124,17 @@ When finished, verify that the self-test works.
 To deploy the marklogic-unit-test project by itself, run the following commands:
 
 - cd marklogic-unit-test-client
-- gradle mlDeploy
+- ../gradlew -i mlDeploy
 
-That process will create an application server on port 8090 (create a file
+That process will create an application server on port 8008 (create a file
 marklogic-unit-test-client/gradle-local.properties and copy the `mlRestPort` property 
 to change the port.)
 
+For modifications to code in the ./marklogic-junit 5 project, please see the README file in that project. 
+
 ##### Running Tests in the GUI
 
-Point a browser to http://localhost:8090/test/. 
+Point a browser to http://localhost:8008/test/. 
 
 ##### Running Tests with Gradle
 

README.md

@@ -19,52 +19,51 @@ Testing MarkLogic from a Java project is made easy with marklogic-junit5:
 
 MarkLogic unit test can easily be integrated into your project as an [ml-bundle](https://github.com/marklogic-community/ml-gradle/wiki/Bundles).
   The following steps will configure a project to import and use marklogic-unit-tests.
-  
-If you'd like to skip straight to the end, you can check out a [working example project](https://github.com/marklogic-community/ml-gradle/tree/dev/examples/unit-test-project). 
+
+If you'd like to skip straight to the end, you can check out a [working example project](https://github.com/marklogic-community/ml-gradle/tree/dev/examples/unit-test-project).
 You can use that project's `build.gradle` file as an example of how to use marklogic-unit-test in your own project.
 
 ### Add marklogic-unit-test to `build.gradle`
 
 ```groovy
 buildscript {
   repositories {
-    jcenter()
-    mavenLocal()
+    mavenCentral()
   }
   dependencies {
-    classpath "com.marklogic:marklogic-unit-test-client:1.0.0"
-    classpath "com.marklogic:ml-gradle:3.14.0"
+    classpath "com.marklogic:marklogic-unit-test-client:1.1.0"
+    classpath "com.marklogic:ml-gradle:4.2.1"
   }
 }
 
 apply plugin: "com.marklogic.ml-gradle"
 
 repositories {
-  jcenter()
+  mavenCentral()
 }
 
 dependencies {
-  mlBundle "com.marklogic:marklogic-unit-test-modules:1.0.0"
+  mlBundle "com.marklogic:marklogic-unit-test-modules:1.1.0"
 }
 ```
 
 ### Add Test Properties to `gradle.properties`
 
 ```properties
-// Settings for any ml-gradle project
-mlHost=localhost    // Assuming local development
-mlAppName=my-app    // Application name, defaults to my-app
-mlRestPort=8003     // Application Port, defaults to 8003
-mlUsername=         // Username used to manage MarkLogic
-mlPassword=         // Password used to manage MarkLogic
+# Settings for any ml-gradle project
+mlHost=localhost    # Assuming local development
+mlAppName=my-app    # Application name, defaults to my-app
+mlRestPort=8003     # Application Port, defaults to 8003
+mlUsername=         # Username used to manage MarkLogic
+mlPassword=         # Password used to manage MarkLogic
 
 
-// Settings specific to marklogic-unit-test
-mlTestRestPort=8004 // Testing port, view and run tests from this port
+# Settings specific to marklogic-unit-test
+mlTestRestPort=8004 # Testing port, view and run tests from this port
 
-// ml-gradle supports deploying to multiple environments (https://github.com/marklogic-community/ml-gradle/wiki/Configuring-ml-gradle#environment-based-properties).\
-// Add the following line to gradle-{env}.properties files for which you would like to deploy the tests. Typically
-// tests are only deployed to environments that execute automated tests, like local development and CI environments. 
+# ml-gradle supports deploying to multiple environments (https://github.com/marklogic-community/ml-gradle/wiki/Configuring-ml-gradle#environment-based-properties).\
+# Add the following line to gradle-{env}.properties files for which you would like to deploy the tests. Typically
+# tests are only deployed to environments that execute automated tests, like local development and CI environments.
 mlModulePaths=src/main/ml-modules,src/test/ml-modules
 ```
 
@@ -94,6 +93,11 @@ Creating test suites is easy using the mlGenerateUnitTestSuite gradle task.  Run
 ./gradlew mlGenerateUnitTestSuite
 ```
 
+More options exist for mlGenerateUnitTestSuite, consult the gradle help
+```sh
+./gradlew help --task mlGenerateUnitTestSuite
+```
+
 Now a new test suite has been generated in `src/test/ml-modules/root/test/suites` called `SampleTestSuite`.
 
 If `mlWatch` is being used, refreshing the web browser at http://localhost:8004/test/ will now show the newly created

build.gradle

@@ -0,0 +1,22 @@
+subprojects {
+  apply plugin: "java-library"
+  apply plugin: "maven-publish"
+  apply plugin: "signing"
+
+  group = "com.marklogic"
+  version = "1.1.0"
+
+  sourceCompatibility = "8"
+  targetCompatibility = "8"
+
+  repositories {
+    mavenCentral()
+
+    // For local development
+    mavenLocal()
+  }
+
+  javadoc.failOnError = false
+  // Ignores warnings on params that don't have descriptions, which is a little too noisy
+  javadoc.options.addStringOption('Xdoclint:none', '-quiet')
+}

gradle.properties

@@ -1,2 +1,8 @@
-group=com.marklogic
-version=1.0.0
+# Define these on the command line to publish to OSSRH
+# See https://central.sonatype.org/publish/publish-gradle/#credentials for more information
+mavenCentralUsername=
+mavenCentralPassword=
+mavenCentralUrl=https://oss.sonatype.org/service/local/staging/deploy/maven2/
+#signing.keyId=YourKeyId
+#signing.password=YourPublicKeyPassword
+#signing.secretKeyRingFile=PathToYourKeyRingFile

gradle/wrapper/gradle-wrapper.properties

@@ -3,4 +3,5 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.8-bin.zip
+# Using 6.9 until ml-gradle 4.3 is available, which will support 7.x
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.9-bin.zip

marklogic-junit5/README.md

@@ -39,8 +39,25 @@ public class SearchTest extends AbstractSpringMarkLogicTest {
 If you'd like to use marklogic-junit5 on a regular ml-gradle project (not a DHF project), then 
 start with the ml-gradle example project to see a working example with instructions on how to get started. 
 
-## Getting started on a Data Hub Framework project
+## Getting started on a Data Hub Framework project 
 
-If you're working on a Data Hub Framework (DHF) project and you're like to start writing JUnit tests to verify your application 
-features, then check out the DHF example project to see a working example with instructions on how to get started.
+As of DHF 5.5, support exists within DHF 5 for writing tests and should be used instead of this project. 
+See [this example project](https://github.com/marklogic/marklogic-data-hub/tree/master/examples/reference-entity-model#testing-support) 
+for more information.
 
+If you're using DHF 4, see [the DHF 4 example project](https://github.com/marklogic-community/marklogic-unit-test/tree/1.0.0/marklogic-junit5/examples/simple-dhf4)
+from the 1.0.0 tag of this repository. 
+
+## Running the tests within this project
+
+If you'd like to run the tests within this project, you'll first need to create a gradle-local.properties file in this 
+project that defines your admin user's password - e.g. 
+
+    mlPassword=admin
+
+The tests will make use of MarkLogic's out-of-the-box Documents database. Be sure you do not have anything of importance 
+in this database, as it will be cleared before each test is run.
+
+You can then run the tests via Gradle:
+
+    ../gradlew clean test

marklogic-junit5/build.gradle

@@ -1,80 +1,90 @@
 plugins {
-	id "java"
-	id "maven-publish"
-	id "com.jfrog.bintray" version "1.8.4"
-	id "com.github.jk1.dependency-license-report" version "1.3"
-	id "net.saliman.properties" version "1.4.6"
-}
-
-sourceCompatibility = "1.8"
-targetCompatibility = "1.8"
-
-repositories {
-	jcenter()
+	id "com.github.jk1.dependency-license-report" version "1.17"
 }
 
 dependencies {
-  compile project(":marklogic-unit-test-client")
-	compile "com.marklogic:ml-javaclient-util:3.11.0"
-	compile "jaxen:jaxen:1.1.6"
-	compile "org.junit.jupiter:junit-jupiter-api:5.4.1"
-	compile "org.junit.jupiter:junit-jupiter-params:5.4.1"
-	compile "org.springframework:spring-context:5.0.8.RELEASE"
-	compile "org.springframework:spring-test:5.0.8.RELEASE"
+  api project(":marklogic-unit-test-client")
+  api "com.marklogic:ml-javaclient-util:4.3.0"
+  api "org.jdom:jdom2:2.0.6"
+  api "org.junit.jupiter:junit-jupiter:5.7.2"
+  api "org.springframework:spring-context:5.3.9"
+  api "org.springframework:spring-test:5.3.9"
+  api "com.fasterxml.jackson.core:jackson-databind:2.11.1"
+  api "org.slf4j:slf4j-api:1.7.31"
 
-	// Support for DHF is provided, but a client must specify their own version of the DHF library to use
-	compileOnly ("com.marklogic:marklogic-data-hub:4.2.2") {
-		exclude module: "ml-javaclient-util"
-	}
+  implementation "jaxen:jaxen:1.2.0"
 
-	// Needed by Gradle 4.6+ - see https://www.petrikainulainen.net/programming/testing/junit-5-tutorial-running-unit-tests-with-gradle/
-	testRuntime "org.junit.jupiter:junit-jupiter-engine:5.4.1"
+  testImplementation "org.junit.jupiter:junit-jupiter:5.7.2"
 
 	// Forcing Spring to use logback instead of commons-logging
-	testRuntime "ch.qos.logback:logback-classic:1.1.8"
-	testRuntime group: "org.slf4j", name: "jcl-over-slf4j", version: "1.7.22"
-	testRuntime group: "org.slf4j", name: "slf4j-api", version: "1.7.22"
+  testImplementation "ch.qos.logback:logback-classic:1.2.4"
+  testImplementation "org.slf4j:jcl-over-slf4j:1.7.31"
+  testImplementation "org.slf4j:slf4j-api:1.7.31"
 }
 
-// Needed by Gradle 4.6+ - see https://www.petrikainulainen.net/programming/testing/junit-5-tutorial-running-unit-tests-with-gradle/
 test {
 	useJUnitPlatform()
 }
 
 task sourcesJar(type: Jar, dependsOn: classes) {
-	classifier "sources"
-	from sourceSets.main.allJava
+  classifier 'sources'
+  from sourceSets.main.allSource
 }
 
-publishing {
-	publications {
-		mainJava(MavenPublication) {
-			from components.java
-      artifactId project.name
-		}
-		sourcesJava(MavenPublication) {
-			from components.java
-      artifactId project.name
-			artifact sourcesJar
-		}
-	}
+task javadocJar(type: Jar, dependsOn: javadoc) {
+  classifier "javadoc"
+  from javadoc
 }
 
-if (project.hasProperty("myBintrayUser")) {
-	bintray {
-		user = myBintrayUser
-		key = myBintrayKey
-		publications = ["mainJava", "sourcesJava"]
-		pkg {
-			repo = "Maven"
-			name = project.name
-      userOrg = 'marklogic-community'
-			licenses = ["Apache-2.0"]
-			vcsUrl = "https://github.com/marklogic-community/marklogic-unit-test.git"
-			version {
-				name = project.version
-				released = new Date()
-			}
-		}
-	}
+artifacts {
+  archives javadocJar, sourcesJar
+}
+signing {
+  sign configurations.archives
+}
+
+publishing {
+  publications {
+    mainJava(MavenPublication) {
+      pom {
+        name = "${group}:${project.name}"
+        description = "Supports testing MarkLogic applications"
+        packaging = "jar"
+        url = "https://github.com/marklogic-community/${project.name}"
+        licenses {
+          license {
+            name = "The Apache License, Version 2.0"
+            url = "http://www.apache.org/licenses/LICENSE-2.0.txt"
+          }
+        }
+        developers {
+          developer {
+            id = "marklogic"
+            name = "MarkLogic Github Contributors"
+            email = "[email protected]"
+            organization = "MarkLogic"
+            organizationUrl = "https://www.marklogic.com"
+          }
+        }
+        scm {
+          url = "[email protected]:marklogic-community/${project.name}.git"
+          connection = "scm:[email protected]:marklogic-community/${project.name}.git"
+          developerConnection = "scm:[email protected]:marklogic-community/${project.name}.git"
+        }
+      }
+      from components.java
+      artifact sourcesJar
+      artifact javadocJar
+    }
+  }
+  repositories {
+    maven {
+      name = "central"
+      url = mavenCentralUrl
+      credentials {
+        username mavenCentralUsername
+        password mavenCentralPassword
+      }
+    }
+  }
 }