Merge branch 'dev'

rjrudin · rjrudin · commit 3ce91d25eaeb · 2019-02-08T17:05:15.000-05:00
diff --git a/examples/jsdoc-project/.gitignore b/examples/jsdoc-project/.gitignore
@@ -0,0 +1,4 @@
+.gradle
+.idea
+build
+node_modules
diff --git a/examples/jsdoc-project/README.md b/examples/jsdoc-project/README.md
@@ -0,0 +1,26 @@
+## Overview
+
+Example of how to use [jsdoc](http://usejsdoc.org/) in MarkLogic project
+
+This project uses the [JSDoc Gradle Plugin](https://github.com/liferay/liferay-portal/tree/master/modules/sdk/gradle-plugins-jsdoc) to run the jsdoc task
+
+
+## Usage
+
+All of the configuration is captured in the __build.gradle__ file and the __jsdoc.json__ file. To test this, clone this repoitory and execute the command below in this directory 
+
+```
+gradle generateJsDoc
+```
+
+This will generate jsdoc for the code in __src/main/ml-modules/lib__
+
+The html documentation will be generated in __build/docs/jsdoc__
+
+## Customize
+
+To customise the jsdoc output, you can modify the __jsdoc.json__ file. Refer to the http://usejsdoc.org/about-configuring-jsdoc.html site for details on how to configure this.
+
+To customise the jsdoc task generator, please customize the __generateJsDoc__ task in the __build.gradle__ file. Refer to the [JSDoc Gradle Plugin](https://github.com/liferay/liferay-portal/tree/master/modules/sdk/gradle-plugins-jsdoc) site for details on how to configure this.
+
+
diff --git a/examples/jsdoc-project/build.gradle b/examples/jsdoc-project/build.gradle
@@ -0,0 +1,21 @@
+buildscript {
+    repositories {
+        mavenCentral()
+    }
+
+    dependencies {
+        classpath 'commons-io:commons-io:2.6'
+    }
+}
+
+plugins {
+  id "com.marklogic.ml-gradle" version "3.11.0"
+  id "com.liferay.app.jsdoc" version "2.0.19"
+}
+
+
+task generateJsDoc(type:com.liferay.gradle.plugins.jsdoc.JSDocTask) {
+    configuration = project.resources.text.fromFile(file("jsdoc.json"))
+    destinationDir = "build/docs/jsdoc"
+    sourceDirs = file("src/main/ml-modules/lib")
+} 
diff --git a/examples/jsdoc-project/jsdoc.json b/examples/jsdoc-project/jsdoc.json
@@ -0,0 +1,17 @@
+{
+    "plugins": [],
+    "recurseDepth": 10,
+    "source": {
+        "includePattern": ".+\\.s?js(doc|x)?$",
+        "excludePattern": "(^|\\/|\\\\)_"
+    },
+    "sourceType": "module",
+    "tags": {
+        "allowUnknownTags": true,
+        "dictionaries": ["jsdoc","closure"]
+    },
+    "templates": {
+        "cleverLinks": false,
+        "monospaceLinks": false
+    }
+}
diff --git a/examples/jsdoc-project/src/main/ml-modules/lib/sample.sjs b/examples/jsdoc-project/src/main/ml-modules/lib/sample.sjs
@@ -0,0 +1,20 @@
+/**
+ * Sample Module
+ * 
+ * @module "/sample.sjs"
+ */
+module.exports = {
+    /**
+     * Returns "Hello " plus the str parameter
+     * 
+     * @example
+     * const sampleLib = require("/sample.sjs")
+     * // returns "Hello World"
+     * sampleLib.hello("World")
+     * 
+     * @param {string} str the string to say hello to
+     */
+    hello: function(str) {
+        return `Hello ${str}` 
+    }
+}
diff --git a/examples/sample-project/build.gradle b/examples/sample-project/build.gradle
@@ -58,6 +58,11 @@ dependencies {
 	testCompile "com.marklogic:ml-junit:3.0.0"
 	testCompile "com.jayway.restassured:rest-assured:2.4.1"
 
+	// Required for Java 11
+	testRuntime "javax.xml.bind:jaxb-api:2.3.1"
+	testRuntime "com.sun.xml.bind:jaxb-core:2.3.0.1"
+	testRuntime "com.sun.xml.bind:jaxb-impl:2.3.2"
+
 	// corb jar available from jcenter
 	corb "com.marklogic:marklogic-corb:2.3.2"
 }
diff --git a/gradle.properties b/gradle.properties
@@ -1,8 +1,8 @@
 group=com.marklogic
-version=3.11.0
+version=3.12.0
 javadocsDir=../gh-pages-marklogic-java/javadocs
 
-mlAppDeployerDependency=com.marklogic:ml-app-deployer:3.11.0
+mlAppDeployerDependency=com.marklogic:ml-app-deployer:3.12.0
 mlcpUtilDependency=com.marklogic:mlcp-util:0.9.0
-mlDataMovementDependency=com.marklogic:marklogic-data-movement-components:1.1
+mlDataMovementDependency=com.marklogic:marklogic-data-movement-components:1.2.0
 mlUnitTestDependency=com.marklogic:marklogic-unit-test-client:0.12.0
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-3.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.2-bin.zip
diff --git a/src/main/groovy/com/marklogic/gradle/MarkLogicPlugin.groovy b/src/main/groovy/com/marklogic/gradle/MarkLogicPlugin.groovy
@@ -135,6 +135,7 @@ class MarkLogicPlugin implements Plugin<Project> {
 		project.task("mlClearSchemasDatabase", type: ClearSchemasDatabaseTask, group: dbGroup, description: "Deletes all documents in the schemas database. " +
 			"Note that this includes those created via the deployment of resources such as temporal collections and view schemas. You may want to use mlDeleteUserSchemas instead.")
 		project.task("mlClearTriggersDatabase", type: ClearTriggersDatabaseTask, group: dbGroup, description: "Deletes all documents in the triggers database")
+		project.task("mlDeleteDatabase", type: DeleteDatabaseTask, group: dbGroup, description: "Delete a database along with all of its forests and any replicas; requires -Pconfirm=true to be set so this isn't accidentally executed")
 		project.task("mlDeployDatabases", type: DeployDatabasesTask, group: dbGroup, dependsOn: "mlPrepareRestApiDependencies", description: "Deploy each database, updating it if it exists, in the configuration directory")
 		project.task("mlMergeContentDatabase", type: MergeContentDatabaseTask, group: dbGroup, description: "Merge the database named by mlAppConfig.contentDatabaseName")
 		project.task("mlMergeDatabase", type: MergeDatabaseTask, group: dbGroup, description: "Merge the database named by the project property dbName; e.g. gradle mlMergeDatabase -PdbName=my-database")
@@ -344,8 +345,17 @@ class MarkLogicPlugin implements Plugin<Project> {
 		project.extensions.add("mlAdminConfig", adminConfig)
 
 		ProjectPropertySource propertySource = new ProjectPropertySource(project);
+
 		DefaultAppConfigFactory appConfigFactory = new DefaultAppConfigFactory(propertySource)
+		// The ConfigDir objects constructed by AppConfig must all be relative to the project directory
+		// when using Java 11. In case this causes problems, a user can disable this via the below property
+		if (project.hasProperty("mlIgnoreProjectDir") && "true".equals(project.property("mlIgnoreProjectDir"))) {
+			println "The Gradle projectDir will not be used to resolve file paths"
+		} else {
+			appConfigFactory.setProjectDir(project.getProjectDir())
+		}
 		project.extensions.add("mlAppConfigFactory", appConfigFactory)
+
 		AppConfig appConfig = appConfigFactory.newAppConfig()
 		project.extensions.add("mlAppConfig", appConfig)
 
diff --git a/src/main/groovy/com/marklogic/gradle/task/MarkLogicTask.groovy b/src/main/groovy/com/marklogic/gradle/task/MarkLogicTask.groovy
@@ -44,21 +44,29 @@ class MarkLogicTask extends DefaultTask {
 		project.hasProperty("mlAdminPassword") ? project.property("mlAdminPassword") : project.property("mlPassword")
 	}
 
+	DatabaseClient newClient() {
+		newClient(null)
+    }
+
 	/**
-	 * If the "database" property is set, then the DatabaseClient that's returned will use the App-Services port
-	 * (defaults to 8000) to connect to the given database. Otherwise, the DatabaseClient will try to connect to the
-	 * REST API server defined by mlRestPort.
+	 * If the "database" property is set or is passed as a parameter, then the DatabaseClient that's returned will use
+	 * the App-Services port (defaults to 8000) to connect to the given database. Otherwise, the DatabaseClient will
+	 * try to connect to the REST API server defined by mlRestPort.
 	 * @return
 	 */
-	DatabaseClient newClient() {
-		if (project.hasProperty("database")) {
+	DatabaseClient newClient(String database) {
+		if (database != null){
+			println "Connecting via the App-Services port to database: " + database
+			return getAppConfig().newAppServicesDatabaseClient(database)
+		}
+		else if (project.hasProperty("database")) {
 			println "Connecting via the App-Services port to database: " + project.property("database")
 			return getAppConfig().newAppServicesDatabaseClient(project.property("database"))
 		}
 		else {
 			getAppConfig().newDatabaseClient()
 		}
-    }
+	}
 
     void deployWithCommandListProperty(String propertyName) {
         deployWithCommands(getProject().property(propertyName))
diff --git a/src/main/groovy/com/marklogic/gradle/task/MlcpTask.groovy b/src/main/groovy/com/marklogic/gradle/task/MlcpTask.groovy
@@ -28,6 +28,9 @@ class MlcpTask extends JavaExec {
 	// Set this to define a URI in your content database for mlcp output to be written to as a text document
 	String logOutputUri
 
+	// Allow the user to provide a custom DatabaseClient for logging mlcp output
+	DatabaseClient logClient
+
 	Logger getLogger() {
 		return Logging.getLogger(MlcpTask.class)
 	}
@@ -109,9 +112,13 @@ class MlcpTask extends JavaExec {
 		super.exec()
 
 		if (logOutputFile != null) {
-			AppConfig appConfig = project.property("mlAppConfig")
-			DatabaseClient client = appConfig.newDatabaseClient()
-			client.newDocumentManager().write(logOutputUri, new FileHandle(logOutputFile))
+			DatabaseClient databaseClient
+			if (logClient != null) {
+				databaseClient = logClient
+			} else {
+				databaseClient = project.property("mlAppConfig").newDatabaseClient()
+			}
+			databaseClient.newDocumentManager().write(logOutputUri, new FileHandle(logOutputFile))
 			println "Wrote mlcp log output to URI: " + logOutputUri
 		}
 	}
diff --git a/src/main/groovy/com/marklogic/gradle/task/NewProjectTask.groovy b/src/main/groovy/com/marklogic/gradle/task/NewProjectTask.groovy
@@ -42,7 +42,7 @@ class NewProjectTask extends MarkLogicTask {
 		if (ant.mlPropertiesPlugin == "y") {
 			def text = 'plugins {' +
 				'\n  id "net.saliman.properties" version "1.4.6"' +
-				'\n  id "com.marklogic.ml-gradle" version "3.11.0"' +
+				'\n  id "com.marklogic.ml-gradle" version "3.12.0"' +
 				'\n}'
 			println "Updating build.gradle so that the Gradle properties plugin can be applied"
 			writeFile("build.gradle", text)
diff --git a/src/main/groovy/com/marklogic/gradle/task/client/CopySearchOptionsTask.groovy b/src/main/groovy/com/marklogic/gradle/task/client/CopySearchOptionsTask.groovy
@@ -0,0 +1,35 @@
+package com.marklogic.gradle.task.client
+
+import com.marklogic.client.DatabaseClient
+import com.marklogic.gradle.task.MarkLogicTask
+import org.gradle.api.tasks.TaskAction
+
+/**
+ * Addresses a problem common to DHF options where search options are loaded via the final server and thus only
+ * available via that server, but a user would like to use them via the staging server too.
+ */
+class CopySearchOptionsTask extends MarkLogicTask {
+
+	DatabaseClient client
+	String group = "Default"
+	String sourceServer
+	String targetServer
+	String optionsFilename
+
+	@TaskAction
+	void copySearchOptions() {
+		DatabaseClient databaseClient
+		if (client != null) {
+			databaseClient = client
+		} else {
+			databaseClient = getAppConfig().newModulesDatabaseClient()
+		}
+
+		def script = "declareUpdate();\nconst uri = '/${group}/${sourceServer}/rest-api/options/${optionsFilename}';\n"
+		script += "xdmp.documentInsert('/${group}/${targetServer}/rest-api/options/${optionsFilename}', cts.doc(uri), " +
+			"xdmp.documentGetPermissions(uri), xdmp.documentGetCollections(uri))";
+		println "Copying search options via:\n" + script
+		databaseClient.newServerEval().javascript(script).eval()
+	}
+
+}
diff --git a/src/main/groovy/com/marklogic/gradle/task/client/CreateResourceTask.groovy b/src/main/groovy/com/marklogic/gradle/task/client/CreateResourceTask.groovy
@@ -90,8 +90,15 @@ declare function delete(
     void createResource() {
         String propName = "resourceName"
         if (getProject().hasProperty(propName)) {
-            servicesDir = servicesDir ? servicesDir : getAppConfig().getModulePaths().get(0) + "/services"
-            
+	        String servicesPath = servicesDir
+	        if (!servicesPath) {
+		        List<String> modulePaths = getAppConfig().getModulePaths()
+		        if (modulePaths != null && !modulePaths.isEmpty()) {
+			        // Use the last path so modules aren't written to e.g. mlRestApi paths
+			        servicesPath = modulePaths.get(modulePaths.size() - 1) + "/services"
+		        }
+	        }
+
             String name = getProject().getProperties().get(propName)
 
             String template = RESOURCE_TEMPLATE
@@ -102,12 +109,12 @@ declare function delete(
             }
 
             String resource = template.replace("%%RESOURCE_NAME%%", name)
-            new File(servicesDir).mkdirs()
-            def resourceFile = new File(servicesDir, name + fileExtension)
+            new File(servicesPath).mkdirs()
+            def resourceFile = new File(servicesPath, name + fileExtension)
             println "Creating new resource at " + resourceFile.getAbsolutePath()
             resourceFile.write(resource)
 
-            def metadataDir = new File(servicesDir, "metadata")
+            def metadataDir = new File(servicesPath, "metadata")
             metadataDir.mkdirs()
             String metadata = METADATA_TEMPLATE.replace("%%RESOURCE_NAME%%", name)
             def metadataFile = new File(metadataDir, name + ".xml")
diff --git a/src/main/groovy/com/marklogic/gradle/task/client/CreateTransformTask.groovy b/src/main/groovy/com/marklogic/gradle/task/client/CreateTransformTask.groovy
@@ -1,9 +1,7 @@
 package com.marklogic.gradle.task.client
 
-import org.gradle.api.DefaultTask;
-import org.gradle.api.tasks.TaskAction;
-
-import com.marklogic.gradle.task.MarkLogicTask;
+import com.marklogic.gradle.task.MarkLogicTask
+import org.gradle.api.tasks.TaskAction
 
 class CreateTransformTask extends MarkLogicTask {
 
@@ -54,7 +52,14 @@ exports.transform = transform;
     void createResource() {
         String propName = "transformName"
         if (getProject().hasProperty(propName)) {
-            transformsDir = transformsDir ? transformsDir : getAppConfig().getModulePaths().get(0) + "/transforms"
+	        String transformsPath = transformsDir
+	        if (!transformsPath) {
+		        List<String> modulePaths = getAppConfig().getModulePaths()
+		        if (modulePaths != null && !modulePaths.isEmpty()) {
+			        // Use the last path so modules aren't written to e.g. mlRestApi paths
+			        transformsPath = modulePaths.get(modulePaths.size() - 1) + "/transforms"
+		        }
+	        }
 
             String name = getProject().getProperties().get(propName)
 
@@ -76,12 +81,12 @@ exports.transform = transform;
 
             String transform = template.replace("%%TRANSFORM_NAME%%", name)
 
-            new File(transformsDir).mkdirs()
-            def transformFile = new File(transformsDir, name + fileExtension)
+            new File(transformsPath).mkdirs()
+            def transformFile = new File(transformsPath, name + fileExtension)
             println "Creating new transform at " + transformFile.getAbsolutePath()
             transformFile.write(transform)
 
-			def metadataDir = new File(transformsDir, "metadata")
+			def metadataDir = new File(transformsPath, "metadata")
 			metadataDir.mkdirs()
 			String metadata = METADATA_TEMPLATE.replace("%%TRANSFORM_NAME%%", name)
 			def metadataFile = new File(metadataDir, name + ".xml")
diff --git a/src/main/groovy/com/marklogic/gradle/task/databases/DeleteDatabaseTask.groovy b/src/main/groovy/com/marklogic/gradle/task/databases/DeleteDatabaseTask.groovy
@@ -0,0 +1,24 @@
+package com.marklogic.gradle.task.databases
+
+import com.marklogic.gradle.task.AbstractConfirmableTask
+import com.marklogic.mgmt.resource.databases.DatabaseManager
+import org.gradle.api.GradleException
+
+class DeleteDatabaseTask extends AbstractConfirmableTask {
+
+	@Override
+	void executeIfConfirmed() {
+		if (project.hasProperty("database")) {
+			String db = project.property("database")
+			DatabaseManager mgr = new DatabaseManager(getManageClient())
+			mgr.setForestDelete(DatabaseManager.DELETE_FOREST_DATA)
+			println "Deleting primary and replica forests for database: " + db
+			mgr.deleteForestsAndReplicas(db)
+			println "Deleting database: " + db
+			mgr.deleteByName(db)
+			println "Finished deleting database: " + db
+		} else {
+			throw new GradleException("The property 'database' must be specified")
+		}
+	}
+}
diff --git a/src/main/groovy/com/marklogic/gradle/task/databases/DeleteUserSchemasTask.groovy b/src/main/groovy/com/marklogic/gradle/task/databases/DeleteUserSchemasTask.groovy
@@ -31,7 +31,7 @@ class DeleteUserSchemasTask extends MarkLogicTask {
 		String fullQuery = "cts:uris((), (), " + xquery + ") ! xdmp:document-delete(.)"
 		println "Deleting user schemas in database '" + database + "' via : " + fullQuery
 
-		def client = newClient()
+		def client = newClient(database)
 		try {
 			client.newServerEval().xquery(fullQuery).eval()
 		} finally {
diff --git a/src/main/groovy/com/marklogic/gradle/task/export/ExportResourcesTask.groovy b/src/main/groovy/com/marklogic/gradle/task/export/ExportResourcesTask.groovy
@@ -52,6 +52,11 @@ class ExportResourcesTask extends MarkLogicTask {
 	void export(ResourceSelector selector) {
 		def path = getAppConfig().getConfigDir().getBaseDir()
 		if (getProject().hasProperty("exportPath")) {
+			/**
+			 * Note that if a user provides a path and they're using Java 11 and the Gradle daemon, then the path
+			 * should be absolute. Otherwise, it will be resolved from the directory that the daemon was launched
+			 * from, which is likely not desirable.
+			 */
 			path = new File(getProject().property("exportPath"))
 		}
 		println "Exporting resources to: " + path

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +.gradle
 +.idea
 +build
 +node_modules