Converting Jenkinsfile to use a docker-compose file

Switch to images and artifactory.
Removing mapped volumes.
Using .env for mapping a local volume during development.

Author: BillFarber

.gitignore

@@ -37,5 +37,4 @@ ml-development-tools/src/test/ml-modules
 ml-development-tools/src/test/java/com/marklogic/client/test/dbfunction/generated
 
 .vscode
-docker-compose.yaml
 docker/

CONTRIBUTING.md

@@ -28,7 +28,17 @@ and add the following (you can override additional properties as necessary):
 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:
+The tests require a MarkLogic instance with access to several ports (8000,8001,8002,8012,8014,8020). That instance may
+be a local instance or it may be running in a Docker container. If you would like to create a Docker container with the
+instance, you may create the container with the following commands (starting in the project root directory):
+
+```
+cd test-app
+docker-compose up -d --build
+cd ..
+```
+
+Once you have a MarkLogic instance ready, the application is then deployed via the following command:
 
     ./gradlew mlDeploy -i
 

Jenkinsfile

@@ -1,31 +1,39 @@
 @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 if(env.JAVA_VERSION=="JAVA21"){
+	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 if(env.JAVA_VERSION=="JAVA21"){
 		return "/home/builder/java/jdk-21.0.1"
 	}else{
-        return "/home/builder/java/openjdk-1.8.0-262"
-    }
+		return "/home/builder/java/openjdk-1.8.0-262"
+	}
 }
 
-def runAllTests(String type, String version, Boolean useReverseProxy){
-            copyRPM type, version
-            sh 'sudo /usr/local/sbin/mladmin removeforest /space/Forests'
-            setUpML '$WORKSPACE/xdmp/src/Mark*.rpm'
-            copyConvertersRPM type,version
-            setUpMLConverters '$WORKSPACE/xdmp/src/Mark*Converters*.rpm'
+def setupDockerMarkLogic(String image){
+	sh label:'mlsetup', script: '''#!/bin/bash
+	echo "Removing any running MarkLogic server and clean up MarkLogic data directory"
+    sudo /usr/local/sbin/mladmin remove
+    sudo /usr/local/sbin/mladmin cleandata
+    cd java-client-api/test-app
+//     mkdir -p docker/marklogic/logs
+    docker compose down -v || true
+    echo "Using image: "'''+image+'''
+    MARKLOGIC_IMAGE='''+image+''' MARKLOGIC_LOGS_VOLUME=marklogicLogs docker compose up -d --build
+	  echo "mlPassword=admin" > gradle-local.properties
+    echo "Waiting for MarkLogic server to initialize."
+    sleep 30s
+    cd ..
+	export GRADLE_USER_HOME=$WORKSPACE/$GRADLE_DIR
+	export PATH=$GRADLE_USER_HOME:$JAVA_HOME/bin:$PATH
+   	./gradlew -i mlDeploy mlReloadSchemas
+  '''
+}
 
-            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 mlReloadSchemas -PmlForestDataDirectory=/space
-            '''
+def runAllTests(Boolean useReverseProxy, String image){
+		setupDockerMarkLogic(image)
 
             if (useReverseProxy) {
 							sh label:'run marklogic-client-api tests with reverse proxy', script: '''#!/bin/bash
@@ -155,18 +163,9 @@ pipeline{
         }
       }
       steps {
-        copyRPM 'Latest','11'
-        sh 'sudo /usr/local/sbin/mladmin removeforest /space/Forests'
-        setUpML '$WORKSPACE/xdmp/src/Mark*.rpm'
-        copyConvertersRPM 'Latest','11'
-        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 mlReloadSchemas -PmlForestDataDirectory=/space
-        '''
+	      setupDockerMarkLogic("ml-docker-db-dev-tierpoint.bed-artifactory.bedford.progress.com/marklogic/marklogic-server-ubi:latest-11")
+
+
         sh label:'run marklogic-client-api tests', script: '''#!/bin/bash
           export JAVA_HOME=$JAVA_HOME_DIR
           export GRADLE_USER_HOME=$WORKSPACE/$GRADLE_DIR
@@ -177,6 +176,15 @@ pipeline{
         '''
         junit '**/build/**/TEST*.xml'
       }
+      post{
+        always{
+          sh label:'dockerCleanup', script: '''#!/bin/bash
+				    cd java-client-api/test-app
+            docker compose down -v || true
+//             sudo /usr/local/sbin/mladmin delete $WORKSPACE/java-client-api/test-app/docker/
+          '''
+        }
+      }
     }
     stage('publish'){
       when {
@@ -205,7 +213,7 @@ pipeline{
 				}
 			}
 			steps {
-			runAllTests('Release', '11.2.0', false)
+			runAllTests(false, "ml-docker-db-dev-tierpoint.bed-artifactory.bedford.progress.com/marklogic/marklogic-server-ubi:11.2.0-ubi")
 				junit '**/build/**/TEST*.xml'
 			}
 		}
@@ -218,7 +226,7 @@ pipeline{
 				}
 			}
 			steps {
-				runAllTests('Latest', '11', false)
+				runAllTests(false, "ml-docker-db-dev-tierpoint.bed-artifactory.bedford.progress.com/marklogic/marklogic-server-ubi:latest-11")
 				junit '**/build/**/TEST*.xml'
 			}
 		}
@@ -231,7 +239,7 @@ pipeline{
 				}
 			}
 			steps {
-				runAllTests('Latest', '11', true)
+				runAllTests(true, "ml-docker-db-dev-tierpoint.bed-artifactory.bedford.progress.com/marklogic/marklogic-server-ubi:latest-11")
 				junit '**/build/**/TEST*.xml'
 			}
 		}
@@ -244,7 +252,7 @@ pipeline{
 				}
 			}
 			steps {
-				runAllTests('Latest', '12', false)
+				runAllTests(false, "ml-docker-db-dev-tierpoint.bed-artifactory.bedford.progress.com/marklogic/marklogic-server-ubi:latest-12")
 				junit '**/build/**/TEST*.xml'
 			}
 		}
@@ -257,20 +265,7 @@ pipeline{
 				}
 			}
 			steps {
-				runAllTests('Latest', '10.0', false)
-				junit '**/build/**/TEST*.xml'
-			}
-		}
-
-		stage('regressions-10.0-10.2') {
-			when {
-				allOf {
-					branch 'develop'
-					expression {return params.regressions}
-				}
-			}
-			steps {
-				runAllTests('Release', '10.0-10.2', false)
+				runAllTests(false, "ml-docker-db-dev-tierpoint.bed-artifactory.bedford.progress.com/marklogic/marklogic-server-ubi:latest-10")
 				junit '**/build/**/TEST*.xml'
 			}
 		}

test-app/.env

@@ -0,0 +1,4 @@
+# Defines environment variables for docker-compose.
+# Can be overridden via e.g. `MARKLOGIC_TAG=latest-10.0 docker-compose up -d --build`.
+MARKLOGIC_IMAGE=progressofficial/marklogic-db:latest
+MARKLOGIC_LOGS_VOLUME=./docker/marklogic/logs

test-app/docker-compose.yaml

@@ -0,0 +1,21 @@
+name: marklogic-javaclient-test-app
+
+services:
+
+  marklogic:
+    image: "${MARKLOGIC_IMAGE}"
+    platform: linux/amd64
+    environment:
+      - MARKLOGIC_INIT=true
+      - MARKLOGIC_ADMIN_USERNAME=admin
+      - MARKLOGIC_ADMIN_PASSWORD=admin
+    volumes:
+      - ${MARKLOGIC_LOGS_VOLUME}:/var/opt/MarkLogic/Logs
+    ports:
+      - "8000-8002:8000-8002"
+      - "8012:8012"
+      - "8014:8014"
+      - "8020:8020"
+
+volumes:
+  marklogicLogs: