#448 Now supports multiple schema paths, including those from mlBundles

Author: rjrudin

examples/dependency-project/README.md

@@ -1,7 +1,7 @@
 This set of projects demonstrates:
 
-- How a "provider" project can publish a zip of MarkLogic modules and data
-- How an ml-gradle or DHF project can depend on this zip so that the modules and data are automatically included 
+- How a "provider" project can publish a zip of MarkLogic files (modules, data, schemas, or system plugins)
+- How an ml-gradle or DHF project can depend on this zip so that the files are automatically included 
 in an application
 
 ## Publishing the provider 
@@ -31,7 +31,8 @@ Found mlBundle configuration, will extract all of its dependencies to build/mlBu
 Finished extracting mlBundle dependencies
 Module paths including mlBundle paths: [/Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/build/mlBundle/example-dependency/ml-modules, /Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/src/main/ml-modules]
 Data paths including mlBundle paths: [/Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/build/mlBundle/example-dependency/ml-data, /Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/src/main/ml-data]
-Plugin paths include mlBundle paths: [/Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/build/mlBundle/example-dependency/ml-plugins, /Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/src/main/ml-plugins]
+Plugin paths including mlBundle paths: [/Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/build/mlBundle/example-dependency/ml-plugins, /Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/src/main/ml-plugins]
+Schema paths including mlBundle paths: [/Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/build/mlBundle/example-dependency/ml-schemas, /Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/src/main/ml-schemas]
 :mlPrepareBundles (Thread[Task worker for ':',5,main]) completed. Took 0.059 secs.
 ```
 
@@ -68,9 +69,24 @@ Installed plugin with scope 'native', result: 1
 Finished executing command [com.marklogic.appdeployer.command.plugins.InstallPluginsCommand]
 ```
 
+And finally, some logging like this that indicates that schemas were loaded:
+
+```
+Executing command [com.marklogic.appdeployer.command.schemas.LoadSchemasCommand] with sort order [350]
+Loading schemas into database ml-gradle-client-schemas from: /Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/build/mlBundle/example-dependency/ml-schemas
+TDE templates loaded into ml-gradle-client-schemas will be validated against content database ml-gradle-client-content
+Initializing ExecutorService 
+TDE template passed validation: /Users/rrudin/dev/workspace/ml-gradle/examples/dependency-project/ml-gradle-client-project/build/mlBundle/example-dependency/ml-schemas/tde/template1.json
+Writing 1 files
+Writing: /tde/template1.json
+Shutting down ExecutorService
+Writing 1 documents to MarkLogic; port: 8000; database: ml-gradle-client-schemas
+```
+
 You can then use qconsole to verify that the following documents were inserted:
 
-- In ml-gradle-client-modules: /example.sjs
+- In ml-gradle-client-modules: /example.sjs (in addition to the modules included by this project: /my-lib.xqy and /Default/ml-gradle-client/rest-api/properties.xml)
+- In ml-gradle-client-schemas: /tde/template1.json (in addition to the schema file included in this project: /tde/my-template.json)
 - In ml-gradle-client-content: /example/data1.json and /example/data2.json (in addition to the data files including 
 in this project: /testdata/test1.json, /testdata/test2.json, and /testdata/test3.json)
 - In Extensions: /native/scope.xml, /native/varianceplugin/libvarianceplugin.dylib, and /native/varianceplugin/manifest.xml 

examples/dependency-project/ml-gradle-client-project/src/main/ml-config/databases/content-database.json

@@ -1,5 +1,6 @@
 {
 	"database-name": "%%DATABASE%%",
+	"schema-database": "%%SCHEMAS_DATABASE%%",
 	"range-element-index": [
 		{
 			"collation": "",

examples/dependency-project/ml-gradle-client-project/src/main/ml-config/databases/schemas-database.json

@@ -0,0 +1,3 @@
+{
+  "database-name": "%%SCHEMAS_DATABASE%%"
+}

examples/dependency-project/ml-gradle-client-project/src/main/ml-modules/root/my-lib.xqy

@@ -0,0 +1 @@
+<test/>

examples/dependency-project/ml-gradle-client-project/src/main/ml-schemas/tde/my-template.json

@@ -0,0 +1,21 @@
+{
+	"template": {
+		"context": "/data",
+		"collections": [
+			"data"
+		],
+		"rows": [
+			{
+				"schemaName": "Data",
+				"viewName": "default",
+				"columns": [
+					{
+						"name": "Id",
+						"scalarType": "string",
+						"val": "Id"
+					}
+				]
+			}
+		]
+	}
+}

examples/dependency-project/provider-project/build.gradle

@@ -19,6 +19,9 @@ task bundleJar(type: Jar) {
 	from("src/main/ml-plugins") {
 		into("example-dependency/ml-plugins")
 	}
+	from("src/main/ml-schemas") {
+		into("example-dependency/ml-schemas")
+	}
 	destinationDir file("build/libs")
 	baseName "example-dependency"
 }

examples/dependency-project/provider-project/src/main/ml-schemas/tde/template1.json

@@ -0,0 +1,21 @@
+{
+	"template": {
+		"context": "/example",
+		"collections": [
+			"example"
+		],
+		"rows": [
+			{
+				"schemaName": "Example",
+				"viewName": "default",
+				"columns": [
+					{
+						"name": "Id",
+						"scalarType": "string",
+						"val": "Id"
+					}
+				]
+			}
+		]
+	}
+}

src/main/groovy/com/marklogic/gradle/MarkLogicPlugin.groovy

@@ -242,7 +242,8 @@ class MarkLogicPlugin implements Plugin<Project> {
 
 		String schemasGroup = "ml-gradle Schemas"
 		project.task("mlDeleteUserSchemas", type: DeleteUserSchemasTask, group: schemasGroup, description: "Delete documents in a schemas database that were not created via the deployment of resources such as temporal collections or view schemas")
-		project.task("mlLoadSchemas", type: LoadSchemasTask, group: schemasGroup, description: "Loads special-purpose data into the schemas database (XSD schemas, Inference rules, and [MarkLogic 9] Extraction Templates)").mustRunAfter("mlDeleteUserSchemas")
+		project.task("mlLoadSchemas", type: LoadSchemasTask, group: schemasGroup, dependsOn: "mlPrepareBundles",
+			description: "Loads files into schema databases, including schema files that are part of mlBundle dependencies").mustRunAfter("mlDeleteUserSchemas")
 		project.task("mlReloadSchemas", dependsOn: ["mlDeleteUserSchemas", "mlLoadSchemas"], group: schemasGroup, description: "Deletes user schemas via mlDeleteUserSchemas and then loads schemas via mlLoadSchemas")
 
 		String serverGroup = "ml-gradle Server"

src/main/groovy/com/marklogic/gradle/task/PreviewDeployTask.groovy

@@ -34,9 +34,15 @@ class PreviewDeployTask extends DeployAppTask {
 		// Disable loading of any modules
 		getAppConfig().setModulePaths(new ArrayList<String>())
 
-		// Disable loading of schemas from the default path
+		// Disable loading of schemas
 		// Database-specific schema paths are handled by removing instances of LoadSchemasCommand
-		getAppConfig().setSchemasPath(null)
+		getAppConfig().setSchemaPaths(null)
+
+		// Disable loading of data
+		getAppConfig().getDataConfig().setDataPaths(null)
+
+		// Disable installing of plugins
+		getAppConfig().getPluginConfig().setPluginPaths(null)
 	}
 
 	void modifyAppDeployerBeforePreview() {

src/main/groovy/com/marklogic/gradle/task/client/PrepareBundlesTask.groovy

@@ -54,6 +54,9 @@ class PrepareBundlesTask extends MarkLogicTask {
 				List<String> pluginPaths = getAppConfig().getPluginConfig().getPluginPaths()
 				List<String> newPluginPaths = new ArrayList<>()
 
+				List<String> schemaPaths = getAppConfig().getSchemaPaths()
+				List<String> newSchemaPaths = new ArrayList<>()
+
 				for (dir in buildDir.listFiles()) {
 					if (dir.isDirectory()) {
 						File modulesDir = new File(dir, "ml-modules")
@@ -70,6 +73,11 @@ class PrepareBundlesTask extends MarkLogicTask {
 						if (pluginsDir != null && pluginsDir.exists()) {
 							newPluginPaths.add(pluginsDir.getAbsolutePath())
 						}
+
+						File schemasDir = new File(dir, "ml-schemas")
+						if (schemasDir != null && schemasDir.exists()) {
+							newSchemaPaths.add(schemasDir.getAbsolutePath())
+						}
 					}
 				}
 
@@ -91,7 +99,13 @@ class PrepareBundlesTask extends MarkLogicTask {
 				if (!newPluginPaths.isEmpty()) {
 					newPluginPaths.addAll(pluginPaths)
 					getAppConfig().getPluginConfig().setPluginPaths(newPluginPaths)
-					println "Plugin paths include mlBundle paths: " + getAppConfig().getPluginConfig().getPluginPaths()
+					println "Plugin paths including mlBundle paths: " + getAppConfig().getPluginConfig().getPluginPaths()
+				}
+
+				if (!newSchemaPaths.isEmpty()) {
+					newSchemaPaths.addAll(schemaPaths)
+					getAppConfig().setSchemaPaths(newSchemaPaths)
+					println "Schema paths including mlBundle paths: " + getAppConfig().getSchemaPaths()
 				}
 			}
 		}