Adding support for Maven Central and updating dependencies (#134)

rjrudin · web-flow · commit cd1ddfa5b145 · 2021-07-20T13:52:12.000-04:00
Can now publish all 3 modules to Maven Central - though I'm not 100% sure about the modules project. publishToMavenLocal works fine, but won't know if Maven Central accepts it until we try it. It's a bit different of course because it contains modules and not Java code, and thus the javadoc jar is empty. 

Updated all the dependencies to latest versions, most notably Java Client to 5.5.0 and ml-javaclient-util to 4.3.0 (which is not yet published to Maven Central, but will be very soon - likely today). 

Also updated the marklogic-unit-test-client tests to use JUnit 5 instead of JUnit 4 . This has no impact on users though.

Co-authored-by: Rob Rudin &lt;rob.rudin@marklogic.com&gt;
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -124,15 +124,15 @@ 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.)
 
 ##### 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
 
diff --git a/build.gradle b/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-SNAPSHOT"
+
+  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')
+}
diff --git a/gradle.properties b/gradle.properties
@@ -1,2 +1,8 @@
-group=com.marklogic
-version=1.1-SNAPSHOT
+# 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
diff --git a/gradle/wrapper/gradle-wrapper.properties b/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-6.5.1-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
diff --git a/marklogic-junit5/build.gradle b/marklogic-junit5/build.gradle
@@ -1,77 +1,91 @@
 plugins {
-	id "java-library"
-	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.5.1"
-}
-
-sourceCompatibility = "1.8"
-targetCompatibility = "1.8"
-
-repositories {
-	jcenter()
+	id "com.github.jk1.dependency-license-report" version "1.17"
 }
 
 dependencies {
   api project(":marklogic-unit-test-client")
-	api "com.marklogic:ml-javaclient-util:4.1.1"
-	api "jaxen:jaxen:1.1.6"
-	api "org.junit.jupiter:junit-jupiter-api:5.7.1"
-	api "org.junit.jupiter:junit-jupiter-params:5.7.1"
-	api "org.springframework:spring-context:5.2.9.RELEASE"
-	api "org.springframework:spring-test:5.2.9.RELEASE"
+	api "com.marklogic:ml-javaclient-util:4.3.0"
+  api "org.jdom:jdom2:2.0.6"
+  api "org.junit.jupiter:junit-jupiter-api:5.7.2"
+  api "org.junit.jupiter:junit-jupiter-params: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.30"
+	api "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/
-	testRuntime "org.junit.jupiter:junit-jupiter-engine:5.7.1"
+  implementation "jaxen:jaxen:1.2.0"
+
+  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.2.3"
-	testRuntime group: "org.slf4j", name: "jcl-over-slf4j", version: "1.7.30"
-	testRuntime group: "org.slf4j", name: "slf4j-api", version: "1.7.30"
+  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 = "general@developer.marklogic.com"
+            organization = "MarkLogic"
+            organizationUrl = "https://www.marklogic.com"
+          }
+        }
+        scm {
+          url = "git@github.com:marklogic-community/${project.name}.git"
+          connection = "scm:git@github.com:marklogic-community/${project.name}.git"
+          developerConnection = "scm:git@github.com:marklogic-community/${project.name}.git"
+        }
+      }
+      from components.java
+      artifact sourcesJar
+      artifact javadocJar
+    }
+  }
+  repositories {
+    maven {
+      name = "central"
+      url = mavenCentralUrl
+      credentials {
+        username mavenCentralUsername
+        password mavenCentralPassword
+      }
+    }
+  }
 }
diff --git a/marklogic-unit-test-client/build.gradle b/marklogic-unit-test-client/build.gradle
@@ -1,68 +1,79 @@
 plugins {
-	id "java-library"
-	id "maven-publish"
-	id "com.jfrog.bintray" version "1.8.4"
-
 	// ml-gradle is used for deploying a test application so that this project itself can be tested
-	id "com.marklogic.ml-gradle" version "3.12.0"
+	id "com.marklogic.ml-gradle" version "4.2.1"
 
 	// Used to generate a license report
-	id "com.github.jk1.dependency-license-report" version "1.3"
-}
-
-sourceCompatibility = "1.8"
-targetCompatibility = "1.8"
-
-repositories {
-	jcenter()
-	mavenCentral()
+	id "com.github.jk1.dependency-license-report" version "1.17"
 }
 
 dependencies {
-	api "com.marklogic:marklogic-client-api:4.1.1"
+	api "com.marklogic:marklogic-client-api:5.5.0"
+  implementation "org.slf4j:slf4j-api:1.7.31"
 
-	testImplementation "junit:junit:4+"
+  testImplementation "org.junit.jupiter:junit-jupiter:5.7.2"
 }
 
 task sourcesJar(type: Jar, dependsOn: classes) {
-	classifier "sources"
-	from sourceSets.main.allJava
+  classifier 'sources'
+  from sourceSets.main.allSource
 }
 
-// Setup publishing of both a jar (containing the src/main/java code) and the modules zip
-// Can eventually include a test jar (containing some src/test/java code) if desired
-// Run "gradle publishtomavenlocal" to publish these locally
-publishing {
-	publications {
-		mainJava(MavenPublication) {
-			from components.java
-			artifactId "marklogic-unit-test-client"
-		}
-		sourcesJava(MavenPublication) {
-			from components.java
-			artifactId "marklogic-unit-test-client"
-			artifact sourcesJar
-		}
-	}
+task javadocJar(type: Jar, dependsOn: javadoc) {
+  classifier "javadoc"
+  from javadoc
+}
+
+artifacts {
+  archives javadocJar, sourcesJar
+}
+signing {
+  sign configurations.archives
 }
 
-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()
-			}
-		}
-	}
+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 = "general@developer.marklogic.com"
+            organization = "MarkLogic"
+            organizationUrl = "https://www.marklogic.com"
+          }
+        }
+        scm {
+          url = "git@github.com:marklogic-community/${project.name}.git"
+          connection = "scm:git@github.com:marklogic-community/${project.name}.git"
+          developerConnection = "scm:git@github.com:marklogic-community/${project.name}.git"
+        }
+      }
+      from components.java
+      artifact sourcesJar
+      artifact javadocJar
+    }
+  }
+  repositories {
+    maven {
+      name = "central"
+      url = mavenCentralUrl
+      credentials {
+        username mavenCentralUsername
+        password mavenCentralPassword
+      }
+    }
+  }
 }
 
 task createHttpCredentials(type: com.marklogic.gradle.task.MarkLogicTask) {
diff --git a/marklogic-unit-test-client/gradle.properties b/marklogic-unit-test-client/gradle.properties
@@ -1,10 +1,10 @@
 # These properties are used for the test application that ml-gradle deploys so we can test out marklogic-unit-test
 mlAppName=marklogic-unit-test-testapp
 mlHost=localhost
-mlGradleVersion=4.1.1
 mlUsername=admin
 mlPassword=admin
-mlRestPort=8090
+mlRestPort=8008
+mlContentForestsPerHost=1
 
 # Load both the marklogic-unit-test framework code and some test modules
 mlModulePaths=../marklogic-unit-test-modules/src/main/ml-modules,src/test/ml-modules
diff --git a/marklogic-unit-test-client/src/test/java/com/marklogic/test/unit/NonMarkLogicUnitTest.java b/marklogic-unit-test-client/src/test/java/com/marklogic/test/unit/NonMarkLogicUnitTest.java
@@ -1,17 +1,18 @@
 package com.marklogic.test.unit;
 
-import org.junit.Assert;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 /**
  * This is included as a demonstration of MarkLogic unit tests being included with non-MarkLogic unit tests in the
  * same suite.
  */
-public class NonMarkLogicUnitTest extends Assert {
+public class NonMarkLogicUnitTest {
 
-	@Test
-	public void thisShouldSucceed() {
-		assertEquals("1", "1");
-	}
+  @Test
+  public void thisShouldSucceed() {
+    assertEquals("1", "1");
+  }
 
-}
+}
diff --git a/marklogic-unit-test-client/src/test/java/com/marklogic/test/unit/ParameterizedTest.java b/marklogic-unit-test-client/src/test/java/com/marklogic/test/unit/ParameterizedTest.java
diff --git a/marklogic-unit-test-client/src/test/java/com/marklogic/test/unit/RunSuiteTest.java b/marklogic-unit-test-client/src/test/java/com/marklogic/test/unit/RunSuiteTest.java
diff --git a/marklogic-unit-test-client/src/test/java/com/marklogic/test/unit/SampleParameterizedTest.java b/marklogic-unit-test-client/src/test/java/com/marklogic/test/unit/SampleParameterizedTest.java
diff --git a/marklogic-unit-test-modules/build.gradle b/marklogic-unit-test-modules/build.gradle
