#355 Not deploying amps when they haven't changed

Author: rjrudin

src/main/java/com/marklogic/appdeployer/command/security/DeployAmpsCommand.java

@@ -9,11 +9,15 @@
 import com.marklogic.mgmt.api.security.Amp;
 import com.marklogic.mgmt.resource.ResourceManager;
 import com.marklogic.mgmt.resource.security.AmpManager;
+import com.marklogic.rest.util.ResourcesFragment;
 
 import java.io.File;
 
 public class DeployAmpsCommand extends AbstractResourceCommand implements SupportsCmaCommand {
 
+	private AmpManager ampManager;
+	private ResourcesFragment existingAmpResources;
+
 	public DeployAmpsCommand() {
 		setExecuteSortOrder(SortOrderConstants.DEPLOY_AMPS);
 		setUndoSortOrder(SortOrderConstants.DELETE_AMPS);
@@ -22,6 +26,13 @@ public DeployAmpsCommand() {
 		setResourceClassType(Amp.class);
 	}
 
+	@Override
+	public void execute(CommandContext context) {
+		ampManager = new AmpManager(context.getManageClient());
+		existingAmpResources = ampManager.getAsXml();
+		super.execute(context);
+	}
+
 	@Override
 	protected File[] getResourceDirs(CommandContext context) {
 		return findResourceDirs(context, configDir -> configDir.getAmpsDir());
@@ -37,9 +48,32 @@ public boolean cmaShouldBeUsed(CommandContext context) {
 		return context.getAppConfig().getCmaConfig().isDeployAmps();
 	}
 
+	/**
+	 * Because amps are static and CMA doesn't allow for roles to be changed, we can do some optimization here and
+	 * not deploy the amp if it exists - which means its local name, namespace, document URI, and modules database are
+	 * all the same.
+	 *
+	 * @param amp
+	 * @param configuration the CMA Configuration object that the payload should be added to
+	 */
 	@Override
-	public void addResourceToConfiguration(ObjectNode payload, Configuration configuration) {
-		configuration.addAmp(payload);
+	public void addResourceToConfiguration(ObjectNode amp, Configuration configuration) {
+		if (ampIsUnchanged(amp)) {
+			logger.info("Amp is unchanged, so not deploying: " + amp.get("local-name"));
+		} else {
+			configuration.addAmp(amp);
+		}
+	}
+
+	protected boolean ampIsUnchanged(ObjectNode amp) {
+		if (existingAmpResources != null) {
+			String localName = amp.get("local-name").asText();
+			String namespace = amp.has("namespace") ? amp.get("namespace").asText() : null;
+			String documentUri = amp.get("document-uri").asText();
+			String modulesDatabase = amp.has("modules-database") ? amp.get("modules-database").asText() : null;
+			return ampManager.ampExists(existingAmpResources, localName, documentUri, namespace, modulesDatabase);
+		}
+		return false;
 	}
 
 	@Override

src/main/java/com/marklogic/mgmt/resource/security/AmpManager.java

@@ -1,9 +1,9 @@
 package com.marklogic.mgmt.resource.security;
 
 import com.fasterxml.jackson.databind.JsonNode;
-import com.marklogic.mgmt.resource.AbstractResourceManager;
 import com.marklogic.mgmt.ManageClient;
 import com.marklogic.mgmt.SaveReceipt;
+import com.marklogic.mgmt.resource.AbstractResourceManager;
 import com.marklogic.rest.util.Fragment;
 import com.marklogic.rest.util.ResourcesFragment;
 import org.springframework.http.ResponseEntity;
@@ -74,17 +74,19 @@ public SaveReceipt save(String payload) {
 	public boolean ampExists(String payload) {
 		String resourceId = getResourceId(payload);
 		AmpParams params = getAmpParams(payload);
-		ResourcesFragment resources = getAsXml();
+		return ampExists(getAsXml(), resourceId, params.documentUri, params.namespace, params.modulesDatabase);
+	}
 
+	public boolean ampExists(ResourcesFragment resources, String localName, String documentUri, String namespace, String modulesDatabase) {
 		String xpath = "/node()/*[local-name(.) = 'list-items']/node()[" +
 			"(*[local-name(.) = 'nameref'] = '%s' or *[local-name(.) = 'idref'] = '%s')" +
 			" and *[local-name(.) = 'document-uri'] = '%s'";
-		xpath = format(xpath, resourceId, resourceId, params.documentUri);
-		if (params.namespace != null) {
-			xpath += format(" and *[local-name(.) = 'namespace'] = '%s'", params.namespace);
+		xpath = format(xpath, localName, localName, documentUri);
+		if (namespace != null) {
+			xpath += format(" and *[local-name(.) = 'namespace'] = '%s'", namespace);
 		}
-		if (params.modulesDatabase != null) {
-			xpath += format(" and *[local-name(.) = 'modules-database'] = '%s'", params.modulesDatabase);
+		if (modulesDatabase != null) {
+			xpath += format(" and *[local-name(.) = 'modules-database'] = '%s'", modulesDatabase);
 		} else {
 			xpath += format(" and *[local-name(.) = 'modules-database'] = 'filesystem'");
 		}

src/test/java/com/marklogic/appdeployer/command/cma/DeployAmpsWithCmaTest.java

@@ -4,6 +4,7 @@
 import com.marklogic.appdeployer.ConfigDir;
 import com.marklogic.appdeployer.command.CommandContext;
 import com.marklogic.appdeployer.command.security.DeployAmpsCommand;
+import com.marklogic.mgmt.api.configuration.Configuration;
 import com.marklogic.mgmt.resource.ResourceManager;
 import com.marklogic.mgmt.resource.security.AmpManager;
 import org.junit.Test;
@@ -31,7 +32,10 @@ public void test() throws Exception {
 			assertTrue(mgr.ampExists(amp1));
 			assertTrue(mgr.ampExists(amp2));
 
+			// On the second invocation, nothing should be sent.
+			initializeAppDeployer(new SecondDeploymentDeployAmpsCommand());
 			deploySampleApp();
+
 			assertTrue(mgr.ampExists(amp1));
 			assertTrue(mgr.ampExists(amp2));
 		} finally {
@@ -56,3 +60,14 @@ protected ResourceManager getResourceManager(CommandContext context) {
 	}
 
 }
+
+class SecondDeploymentDeployAmpsCommand extends TestDeployAmpsCommand {
+
+	@Override
+	protected void deployConfiguration(CommandContext context, Configuration config) {
+		if (config.getAmps() != null && !config.getAmps().isEmpty()) {
+			throw new RuntimeException("No amps should have been added during the second deployment as none of them changed");
+		}
+		super.deployConfiguration(context, config);
+	}
+}