Merge pull request #647 from marklogic-community/feature/update-example-projects

Updating example projects

Author: rjrudin

examples/README.md

@@ -0,0 +1,25 @@
+This directory contains example ml-gradle projects to demonstrate various features and common
+deployment scenarios. 
+
+To try a particular project, clone this repository, `cd` to the directory of the project you wish to try, 
+and do the following:
+
+1. Most of the projects default to a username and password of "admin". You can change this either by modifying the 
+	 `mlPassword` property in the `gradle.properties` file in the project, or - if the project is using the [Gradle 
+	 properties plugin](https://plugins.gradle.org/plugin/net.saliman.properties) - you can create the file 
+	 `gradle-local.properties` and set both `mlUsername` and `mlPassword` in that file.
+2. If the project has any ports defined in `gradle.properties`, verify that those ports are open and available on the 
+	 machine that is running MarkLogic.
+3. Most projects have the [Gradle wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) setup, in 
+	 which case you can deploy the project to your MarkLogic instance via `./gradlew -i mlDeploy`. If the project does 
+	 not have the Gradle wrapper (you can tell by checking for a "gradlew" file in the project directory), then you'll 
+	 need to have [Gradle installed](https://gradle.org/install/). After installing Gradle, you can run `./gradle -i 
+	 mldeploy`.
+
+After you've deployed and examined/tested the application, you can undeploy it via:
+
+    ./gradlew -i -Pconfirm=true mlUndeploy
+
+Please note that these example projects are not re-tested with every ml-gradle release. If you run into a problem with 
+any of them, please file an [issue with ml-gradle](https://github.com/marklogic-community/ml-gradle/wiki).
+

examples/corb2-project/build.gradle

@@ -21,7 +21,7 @@ buildscript {
 }
 
 plugins {
-    id "com.marklogic.ml-gradle" version "4.1.0"
+    id "com.marklogic.ml-gradle" version "4.4.0"
 }
 
 repositories {

examples/custom-rest-rewriter-project/build.gradle

@@ -1,5 +1,5 @@
 plugins {
-	id "com.marklogic.ml-gradle" version "3.9.0"
+	id "com.marklogic.ml-gradle" version "4.4.0"
 }
 
 task generateCustomRewriterModules {

examples/data-services/build.gradle

@@ -2,7 +2,7 @@ plugins {
 	id "java"
 	id "net.saliman.properties" version "1.5.1"
 	id "com.marklogic.ml-gradle" version "4.4.0"
-	id 'com.marklogic.ml-development-tools' version '5.5.0'
+	id 'com.marklogic.ml-development-tools' version '6.0.0'
 }
 
 task generateHelloWorld(type: com.marklogic.client.tools.gradle.EndpointProxiesGenTask) {
@@ -20,12 +20,12 @@ test {
 
 dependencies {
 	implementation 'org.slf4j:slf4j-api:1.7.31'
-	implementation 'com.marklogic:marklogic-client-api:5.5.0'
+	implementation 'com.marklogic:marklogic-client-api:6.0.0'
 
-	testImplementation "org.junit.jupiter:junit-jupiter:5.7.2"
+	testImplementation "org.junit.jupiter:junit-jupiter:5.9.1"
 
 	// Force usage of logback for logging
-	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"
+	testImplementation "ch.qos.logback:logback-classic:1.3.5"
+	testImplementation "org.slf4j:jcl-over-slf4j:1.7.36"
+	testImplementation "org.slf4j:slf4j-api:1.7.36"
 }

examples/dependency-project/dhf-client-project/build.gradle

@@ -11,7 +11,7 @@ buildscript {
 }
 
 plugins {
-	id 'net.saliman.properties' version '1.4.6'
+	id 'net.saliman.properties' version '1.5.1'
 }
 
 apply plugin: "com.marklogic.ml-data-hub"

examples/dependency-project/ml-gradle-client-project/build.gradle

@@ -10,7 +10,7 @@
 
 plugins {
 	id "net.saliman.properties" version "1.5.1"
-	id "com.marklogic.ml-gradle" version "4.2.0"
+	id "com.marklogic.ml-gradle" version "4.4.0"
 }
 
 //apply plugin: "com.marklogic.ml-gradle"

examples/disconnected-project-using-plugins-and-gradlew/build.gradle

@@ -7,7 +7,6 @@ buildscript {
 		} else {
 			println "Using online buildscript dependency repositories"
 			mavenCentral()
-			maven { url "http://developer.marklogic.com/maven2/" }
 		}
 	}
 }
@@ -26,7 +25,6 @@ repositories {
 	} else {
 		println "Using online dependency repositories"
 		mavenCentral()
-		maven { url "http://developer.marklogic.com/maven2/" }
 	}
 }
 
@@ -35,9 +33,6 @@ configurations {
 }
 
 dependencies {
-	// sample java compile dependency. Remove if not required
-	compile 'com.marklogic:marklogic-xcc:10.0.7'
-
 	//sample mlcp dependency. Remove if not required
 	mlcp "com.marklogic:mlcp:10.0.6.2"
 }
@@ -60,9 +55,8 @@ task downloadToProjectMavenRepo(type: Copy) {
 	/*
 	 * Include any configuration dependencies here that you want to copy the dependencies for.
 	 * These are defined in the 'dependencies' block. E.g. you need to include
-	 * configurations.compile.files if you want your java 'compile' dependencies downloaded
+	 * configurations.implementation.files if you want your java 'implementation' dependencies downloaded
 	 */
-	configurations.compile.files //includes 'java' compile dependencies. Remove if not needed
 	configurations.mlcp.files //includes 'mlcp' dependencies. Remove if not needed
 
 	from new File(gradle.gradleUserHomeDir, 'caches/modules-2/files-2.1') // correct as of gradle 4.7

examples/disconnected-project-using-plugins-and-gradlew/gradle.properties

@@ -1,3 +1,6 @@
+mlUsername=admin
+mlPassword=admin
+
 projectMavenRepo=build/offline/maven-repo
 # if you change this, you need to modify gradlew and gradlew.bat also
-projectGradleHome=build/gradle-home
+projectGradleHome=build/gradle-home

examples/disconnected-project/gradle.properties

@@ -1,4 +1,4 @@
-mlGradleDependency=com.marklogic:ml-gradle:3.6.0
+mlGradleDependency=com.marklogic:ml-gradle:4.4.0
 mlSalimanDependency=net.saliman:gradle-properties-plugin:1.4.6
 
 mlHost=localhost

examples/docker-projects/single-node-with-nifi/build.gradle

@@ -1,7 +1,7 @@
 plugins {
     // gradle -PenvironmentName=x ...
-    id 'net.saliman.properties' version '1.4.6'
-    id "com.marklogic.ml-gradle" version "3.8.2"
+    id 'net.saliman.properties' version '1.5.1'
+    id "com.marklogic.ml-gradle" version "4.4.0"
     id 'com.avast.gradle.docker-compose' version "0.6.11"
 }
 dockerCompose {
@@ -12,7 +12,7 @@ task mlDockerSetupNode(dependsOn:composeUp)  {
   doLast {
     sleep(5 * 1000) //ensure node is up
     exec {
-      commandLine 'docker', 'exec', 'node1.single', 'init-marklogic' 
+      commandLine 'docker', 'exec', 'node1.single', 'init-marklogic'
     }
   }
 }
@@ -30,4 +30,4 @@ task mlDockerStop(type:Exec) {
 task mlDockerTeardown(dependsOn:composeDown) {
   //remove logs directory
   delete 'logs'
-}
+}