Merge branch 'release/6.0.0'

Author: rjrudin

.classpath

@@ -131,15 +131,7 @@ Use `git rebase` (not `git merge`) to sync your work from time to time.
 #### Test your code
 
 Be sure to run the tests before submitting your pull request. PRs with failing
-tests won't be accepted.
-
-First verify that you have valid server and admin auth info in
-`SERVER_ADMIN_USER` and `SERVER_ADMIN_PASS` fields in
-src/test/java/com/marklogic/client/test/Common.java
-
-    $ ./gradlew clean
-    $ ./gradlew testServerInit
-    $ ./gradlew test
+tests won't be accepted. See the instructions in this repository's README.md file for running the tests.
 
 
 #### If your server is not on localhost

.github/CONTRIBUTING.md

@@ -26,3 +26,10 @@ buildSrc/build
 .idea
 
 */gradle/wrapper/gradle-wrapper.properties
+out
+uriCache.txt
+gradle-local.properties
+bin
+repairXMLFull.xml
+xml-with-props.xml
+

.gitignore

@@ -0,0 +1,46 @@
+To develop the Java Client and ultimately submit a pull request, you'll first need to be able to build the client and 
+run the tests locally. 
+
+Please see [this guide](.github/CONTRIBUTING.md) for information on creating and submitting a pull request.
+
+To build the client locally, complete the following steps:
+
+1. Clone this repository on your machine.
+2. Choose the appropriate branch (usually develop)
+3. Ensure you are using Java 8 or Java 11 or Java 17 (the JVM version used to compile should not matter as compiler flags
+are set to ensure the compiled code will run on Java 8; Jenkins pipelines also exist to ensure that the tests pass on
+Java 8, 11, and 17, and thus they should for you locally as well; note that if you load the project into an IDE, you
+should use Java 8 in case your IDE does not process the build.gradle config that conditionally brings in JAXB dependencies
+required by Java 9+.)
+4. Verify that you can build the client by running `./gradlew build -x test`
+
+"Running the tests" in the context of developing and submitting a pull request refers to running the tests found
+in the `marklogic-client-api` module. The tests for this module depend on a 
+[ml-gradle](https://github.com/marklogic-community/ml-gradle) application being deployed from the `test-app` module.
+This application contains a number of database and security resources that the tests depend on.
+The `./gradle.properties` file defines the connection properties for this application; these default
+to `localhost` and an admin password of `admin`. To override these, create the file `./gradle-local.properties`
+and add the following (you can override additional properties as necessary):
+
+    mlHost=changeme
+    mlPassword=changeme
+
+Note that additional properties are defined via `./tests-app/gradle.properties`, though it is not expected that these
+properties will need to be changed.
+
+The application is then deployed via the following command:
+
+    ./gradlew mlDeploy -i
+
+You can then run the tests, which will use the values of `mlHost` and `mlPassword` for connecting to MarkLogic as an
+admin user:
+
+    ./gradlew marklogic-client-api:test
+
+Individual tests can be run in the following manner (replace `GraphsTest` with the name of the test class you wish to run):
+
+    ./gradlew marklogic-client-api:test --tests GraphsTest
+
+You can also undeploy the test application if you do not wish to keep it around on your MarkLogic instance:
+
+    ./gradlew mlUndeploy -i -Pconfirm=true

.project

@@ -0,0 +1,156 @@
+@Library('shared-libraries') _
+
+def getJava(){
+    if(env.JAVA_VERSION=="JAVA17"){
+        return "/home/builder/java/jdk-17.0.2"
+    }else if(env.JAVA_VERSION=="JAVA11"){
+        return "/home/builder/java/jdk-11.0.2"
+    }else{
+        return "/home/builder/java/openjdk-1.8.0-262"
+    }
+}
+
+def runtests(String type, String version){
+            copyRPM type, version
+            setUpML '$WORKSPACE/xdmp/src/Mark*.rpm'
+            copyConvertersRPM type,version
+            setUpMLConverters '$WORKSPACE/xdmp/src/Mark*Converters*.rpm'
+            sh label:'deploy test app', script: '''#!/bin/bash
+                export JAVA_HOME=$JAVA_HOME_DIR
+                export GRADLE_USER_HOME=$WORKSPACE/$GRADLE_DIR
+                export PATH=$GRADLE_USER_HOME:$JAVA_HOME/bin:$PATH
+                cd java-client-api
+                ./gradlew -i mlDeploy -PmlForestDataDirectory=/space
+            '''
+            sh label:'run marklogic-client-api tests', script: '''#!/bin/bash
+                export JAVA_HOME=$JAVA_HOME_DIR
+                export GRADLE_USER_HOME=$WORKSPACE/$GRADLE_DIR
+                export PATH=$GRADLE_USER_HOME:$JAVA_HOME/bin:$PATH
+                cd java-client-api
+                ./gradlew marklogic-client-api:test  || true
+            '''
+            sh label:'run ml-development-tools tests', script: '''#!/bin/bash
+                export JAVA_HOME=$JAVA_HOME_DIR
+                export GRADLE_USER_HOME=$WORKSPACE/$GRADLE_DIR
+                export PATH=$GRADLE_USER_HOME:$JAVA_HOME/bin:$PATH
+                cd java-client-api
+                ./gradlew ml-development-tools:setupTestServer || true
+                ./gradlew ml-development-tools:generateTests || true
+                ./gradlew ml-development-tools:test || true
+            '''
+            sh label:'run functional tests', script: '''#!/bin/bash
+                export JAVA_HOME=$JAVA_HOME_DIR
+                export GRADLE_USER_HOME=$WORKSPACE/$GRADLE_DIR
+                export PATH=$GRADLE_USER_HOME:$JAVA_HOME/bin:$PATH
+                cd java-client-api
+                ./gradlew -i mlDeploy -PmlForestDataDirectory=/space
+                ./gradlew -i marklogic-client-api-functionaltests:runFunctionalTests || true
+            '''
+            sh label:'post-test-process', script: '''
+                cd $WORKSPACE/java-client-api/marklogic-client-api/build/test-results/test/
+                sed -i "s/classname=\\"/classname=\\"${STAGE_NAME}-/g" TEST*.xml
+                cd $WORKSPACE/java-client-api/ml-development-tools/build/test-results/test/
+                sed -i "s/classname=\\"/classname=\\"${STAGE_NAME}-/g" TEST*.xml
+                cd $WORKSPACE/java-client-api/marklogic-client-api-functionaltests/build/test-results/runFragileTests/
+                sed -i "s/classname=\\"/classname=\\"${STAGE_NAME}-/g" TEST*.xml
+                cd $WORKSPACE/java-client-api/marklogic-client-api-functionaltests/build/test-results/runFastFunctionalTests/
+                sed -i "s/classname=\\"/classname=\\"${STAGE_NAME}-/g" TEST*.xml
+                cd $WORKSPACE/java-client-api/marklogic-client-api-functionaltests/build/test-results/runSlowFunctionalTests/
+                sed -i "s/classname=\\"/classname=\\"${STAGE_NAME}-/g" TEST*.xml
+            '''
+}
+
+pipeline{
+  agent {label 'javaClientLinuxPool'}
+  options {
+    checkoutToSubdirectory 'java-client-api'
+    buildDiscarder logRotator(artifactDaysToKeepStr: '7', artifactNumToKeepStr: '', daysToKeepStr: '7', numToKeepStr: '10')
+  }
+  parameters{
+    booleanParam(name: 'regressions', defaultValue: false, description: 'indicator if build is for regressions')
+    string(name: 'Email', defaultValue: '' ,description: 'Who should I say send the email to?')
+    string(name: 'JAVA_VERSION', defaultValue: 'JAVA8' ,description: 'Who should I say send the email to?')
+  }
+  environment{
+    JAVA_HOME_DIR= getJava()
+    GRADLE_DIR   =".gradle"
+    DMC_USER     = credentials('MLBUILD_USER')
+    DMC_PASSWORD = credentials('MLBUILD_PASSWORD')
+  }
+  stages {
+    stage('pull-request-tests') {
+      when {
+        not {
+          expression {return params.regressions}
+        }
+      }
+      steps {
+        copyRPM 'Latest','11.0'
+        setUpML '$WORKSPACE/xdmp/src/Mark*.rpm'
+        copyConvertersRPM 'Latest','11.0'
+        setUpMLConverters '$WORKSPACE/xdmp/src/Mark*Converters*.rpm'
+        sh label:'deploy test app', script: '''#!/bin/bash
+          export JAVA_HOME=$JAVA_HOME_DIR
+          export GRADLE_USER_HOME=$WORKSPACE/$GRADLE_DIR
+          export PATH=$GRADLE_USER_HOME:$JAVA_HOME/bin:$PATH
+          cd java-client-api
+          ./gradlew -i mlDeploy -PmlForestDataDirectory=/space
+        '''
+        sh label:'run marklogic-client-api tests', script: '''#!/bin/bash
+          export JAVA_HOME=$JAVA_HOME_DIR
+          export GRADLE_USER_HOME=$WORKSPACE/$GRADLE_DIR
+          export PATH=$GRADLE_USER_HOME:$JAVA_HOME/bin:$PATH
+          cd java-client-api
+          ./gradlew -i marklogic-client-api:test  || true
+          ./gradlew marklogic-client-api-functionaltests:runFastFunctionalTests || true
+        '''
+        junit '**/build/**/TEST*.xml'
+      }
+      post{
+        unsuccessful{
+            script{
+                if(params.regressions){
+                    sendMail params.Email,'<h3>Some Tests Failed on Released 11.0 ML Nightly Server Single Node </h3><h4><a href=${JENKINS_URL}/blue/organizations/jenkins/java-client-api-regression/detail/$JOB_BASE_NAME/$BUILD_ID/tests><font color=red>Check the Test Report</font></a></h4><h4><a href=${RUN_DISPLAY_URL}>Check the Pipeline View</a></h4><h4> <a href=${BUILD_URL}/console> Check Console Output Here</a></h4><h4>Please create bugs for the failed regressions and fix them</h4>',false,'${STAGE_NAME} on  develop against ML 11.0-nightly Failed'
+                }
+            }
+        }
+      }
+    }
+
+    stage('regressions-11.0-Latest') {
+      when {
+        allOf {
+          branch 'develop'
+          expression {return params.regressions}
+        }
+      }
+      steps {
+        runtests('Latest','11.0')
+        junit '**/build/**/TEST*.xml'
+      }
+      post {
+        unsuccessful {
+          sendMail params.Email,'<h3>Some Tests Failed on Released 11.0 ML Nightly Server Single Node </h3><h4><a href=${JENKINS_URL}/blue/organizations/jenkins/java-client-api-regression/detail/$JOB_BASE_NAME/$BUILD_ID/tests><font color=red>Check the Test Report</font></a></h4><h4><a href=${RUN_DISPLAY_URL}>Check the Pipeline View</a></h4><h4> <a href=${BUILD_URL}/console> Check Console Output Here</a></h4><h4>Please create bugs for the failed regressions and fix them</h4>',false,'${STAGE_NAME} on  develop against ML 11.0-nightly Failed'
+        }
+      }
+    }
+
+    stage('regressions-10.0-9') {
+      when {
+        allOf {
+          branch 'develop'
+          expression {return params.regressions}
+        }
+      }
+      steps {
+        runtests('Release','10.0-9.5')
+        junit '**/build/**/TEST*.xml'
+      }
+      post {
+        unsuccessful {
+          sendMail params.Email,'<h3>Some Tests Failed on Released 10.0-9.5 ML  Server Single Node </h3><h4><a href=${JENKINS_URL}/blue/organizations/jenkins/java-client-api-regression/detail/$JOB_BASE_NAME/$BUILD_ID/tests><font color=red>Check the Test Report</font></a></h4><h4><a href=${RUN_DISPLAY_URL}>Check the Pipeline View</a></h4><h4> <a href=${BUILD_URL}/console> Check Console Output Here</a></h4><h4>Please create bugs for the failed regressions and fix them</h4>',false,'${STAGE_NAME} on  develop against ML 10.0-9.5 Failed'
+        }
+      }
+    }
+  }
+}