#415 Can now preview a deployment

Author: rjrudin

examples/sample-project/.gitignore

@@ -4,3 +4,4 @@
 /build
 .gradle
 .settings
+gradle-local.properties

examples/sample-project/build.gradle

@@ -15,6 +15,8 @@ buildscript {
 plugins {
 	// The following plugins are optional
 
+	id "net.saliman.properties" version "1.4.6"
+
 	// The Java plugin is used to compile and run JUnit tests
 	id "java"
 

examples/sample-project/src/main/ml-config/security/amps/amp-1.json

@@ -2,6 +2,6 @@
   "namespace": "http://example.com/uri",
   "local-name": "sample-project-amp-1",
   "document-uri": "/module/path/name",
-  "modules-database": "",
+  "modules-database": "%%MODULES_DATABASE%%",
   "role": ["rest-reader"]
 }

gradle.properties

@@ -2,7 +2,7 @@ group=com.marklogic
 version=3.10.2
 javadocsDir=../gh-pages-marklogic-java/javadocs
 
-mlAppDeployerDependency=com.marklogic:ml-app-deployer:3.10.1
+mlAppDeployerDependency=com.marklogic:ml-app-deployer:3.11.dev
 mlcpUtilDependency=com.marklogic:mlcp-util:0.9.0
 mlDataMovementDependency=com.marklogic:marklogic-data-movement-components:1.1
 mlUnitTestDependency=com.marklogic:marklogic-unit-test-client:0.12.0

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

@@ -102,6 +102,7 @@ class MarkLogicPlugin implements Plugin<Project> {
 		project.task("mlUndeploy", group: deployGroup, dependsOn: ["mlUndeployApp", "mlPostUndeploy", "mlDeleteResourceTimestampsFile"], description: "Undeploys all application resources in the configuration directory and allows for additional steps via mlPostUndeploy.dependsOn; requires -Pconfirm=true to be set so this isn't accidentally executed")
 		project.task("mlRedeploy", group: deployGroup, dependsOn: ["mlClearModulesDatabase", "mlDeploy", "mlDeleteResourceTimestampsFile"], description: "Clears the modules database and then deploys the application")
 		project.task("mlDeleteResourceTimestampsFile", type: DeleteResourceTimestampsFileTask, group: deployGroup, description: "Delete the properties file in the build directory (stored there by default) that keeps track of when each resource was last deployed; the file path can be overridden by setting the filePath property of this class")
+		project.task("mlPreviewDeploy", type: PreviewDeployTask, group: deployGroup, description: "Preview a deployment without making any changes")
 
 		String adminGroup = "ml-gradle Admin"
 		project.task("mlInit", type: InitTask, group: adminGroup, description: "Perform a one-time initialization of a MarkLogic server; uses the properties 'mlLicenseKey' and 'mlLicensee'")

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

@@ -0,0 +1,47 @@
+package com.marklogic.gradle.task
+
+
+import com.marklogic.appdeployer.command.security.DeployRolesCommand
+import com.marklogic.appdeployer.impl.SimpleAppDeployer
+import com.marklogic.mgmt.util.ObjectMapperFactory
+import com.marklogic.rest.util.PreviewInterceptor
+import org.gradle.api.tasks.TaskAction
+
+/**
+ * Extends DeployAppTask and applies an instance of PreviewInterceptor to the RestTemplate objects associated with
+ * the ManageClient created by MarkLogicPlugin. Because of this extension, a user can use the "ignore" property
+ * supported by the parent class to ignore any commands that cause issues with doing a preview.
+ */
+class PreviewDeployTask extends DeployAppTask {
+
+	@TaskAction
+	void deployApp() {
+		// Disable loading of any modules
+		getAppConfig().setModulePaths(new ArrayList<String>())
+
+		// Disable loading of any schemas
+		getAppConfig().setSchemasPath(null)
+
+		SimpleAppDeployer deployer = getAppDeployer()
+
+		// Loading roles in two phases breaks the preview feature, so it's disabled
+		DeployRolesCommand deployRolesCommand = deployer.getCommandOfType(DeployRolesCommand.class)
+		if (deployRolesCommand != null) {
+			deployRolesCommand.setDeployRolesInTwoPhases(false)
+		}
+
+		PreviewInterceptor interceptor = new PreviewInterceptor(getManageClient())
+		getManageClient().getRestTemplate().getInterceptors().add(interceptor)
+		getManageClient().getRestTemplate().setErrorHandler(interceptor)
+		if (getManageClient().getRestTemplate() != getManageClient().getSecurityUserRestTemplate()) {
+			getManageClient().getSecurityUserRestTemplate().getInterceptors().add(interceptor)
+			getManageClient().getSecurityUserRestTemplate().setErrorHandler(interceptor)
+		}
+
+		super.deployApp()
+
+		println "\nPREVIEW OF DEPLOYMENT:\n"
+		println ObjectMapperFactory.getObjectMapper().writeValueAsString(interceptor.getResults())
+	}
+
+}