#366 No longer undeploying default ML users

Author: rjrudin

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

@@ -5,22 +5,51 @@
 import com.marklogic.appdeployer.command.CommandContext;
 import com.marklogic.appdeployer.command.SortOrderConstants;
 import com.marklogic.appdeployer.command.SupportsCmaCommand;
+import com.marklogic.mgmt.PayloadParser;
 import com.marklogic.mgmt.api.configuration.Configuration;
 import com.marklogic.mgmt.api.security.User;
 import com.marklogic.mgmt.resource.ResourceManager;
 import com.marklogic.mgmt.resource.security.UserManager;
 
 import java.io.File;
+import java.util.HashSet;
+import java.util.Set;
 
 public class DeployUsersCommand extends AbstractResourceCommand implements SupportsCmaCommand {
 
+	// Defines users that, by default, this command will never undeploy
+	private Set<String> defaultUsersToNotUndeploy = new HashSet<>();
+
 	public DeployUsersCommand() {
 		setExecuteSortOrder(SortOrderConstants.DEPLOY_USERS);
 		setUndoSortOrder(SortOrderConstants.DELETE_USERS);
 
 		setSupportsResourceMerging(true);
 		setResourceClassType(User.class);
 		setResourceIdPropertyName("user-name");
+
+		initializeDefaultUsersToNotUndeploy();
+	}
+
+	protected void initializeDefaultUsersToNotUndeploy() {
+		defaultUsersToNotUndeploy = new HashSet<>();
+		defaultUsersToNotUndeploy.add("admin");
+		defaultUsersToNotUndeploy.add("healthcheck");
+		defaultUsersToNotUndeploy.add("infostudio-admin");
+		defaultUsersToNotUndeploy.add("nobody");
+	}
+
+	@Override
+	protected String adjustPayloadBeforeDeletingResource(ResourceManager mgr, CommandContext context, File f, String payload) {
+		if (defaultUsersToNotUndeploy != null && !defaultUsersToNotUndeploy.isEmpty()) {
+			final String username = new PayloadParser().getPayloadFieldValue(payload, "user-name", false);
+			if (username != null && defaultUsersToNotUndeploy.contains(username)) {
+				logger.info(format("Not undeploying user '%s', as it's included in the list of users to not undeploy", username));
+				return null;
+			}
+		}
+
+		return super.adjustPayloadBeforeDeletingResource(mgr, context, f, payload);
 	}
 
 	protected File[] getResourceDirs(CommandContext context) {
@@ -51,4 +80,12 @@ protected void deployConfiguration(CommandContext context, Configuration config)
 			super.deployConfiguration(context, config);
 		}
 	}
+
+	public Set<String> getDefaultUsersToNotUndeploy() {
+		return defaultUsersToNotUndeploy;
+	}
+
+	public void setDefaultUsersToNotUndeploy(Set<String> defaultUsersToNotUndeploy) {
+		this.defaultUsersToNotUndeploy = defaultUsersToNotUndeploy;
+	}
 }

src/test/java/com/marklogic/appdeployer/command/security/DontUndeployDefaultUsersTest.java

@@ -0,0 +1,45 @@
+package com.marklogic.appdeployer.command.security;
+
+import com.marklogic.appdeployer.AbstractAppDeployerTest;
+import com.marklogic.mgmt.resource.security.UserManager;
+import org.junit.Test;
+
+import java.io.File;
+import java.util.Set;
+
+public class DontUndeployDefaultUsersTest extends AbstractAppDeployerTest {
+
+	@Test
+	public void test() {
+		appConfig.getFirstConfigDir().setBaseDir(new File("src/test/resources/sample-app/users-to-not-undeploy"));
+		initializeAppDeployer(new DeployUsersCommand());
+
+		UserManager mgr = new UserManager(manageClient);
+		assertFalse(mgr.exists("ml-app-deployer-test-user"));
+		assertTrue(mgr.exists("nobody"));
+
+		deploySampleApp();
+
+		try {
+			assertTrue(mgr.exists("ml-app-deployer-test-user"));
+			assertTrue(mgr.exists("nobody"));
+		} finally {
+			undeploySampleApp();
+
+			assertFalse(mgr.exists("ml-app-deployer-test-user"));
+			assertTrue("The 'nobody' user should not have been deleted since it's in the list of " +
+				"users to not undeploy", mgr.exists("nobody"));
+		}
+	}
+
+	@Test
+	public void verifySetOfDefaultUsers() {
+		// Current as of ML 9.0-9.1
+		Set<String> users = new DeployUsersCommand().getDefaultUsersToNotUndeploy();
+		assertEquals(4, users.size());
+		assertTrue(users.contains("admin"));
+		assertTrue(users.contains("healthcheck"));
+		assertTrue(users.contains("infostudio-admin"));
+		assertTrue(users.contains("nobody"));
+	}
+}

src/test/resources/sample-app/users-to-not-undeploy/security/users/custom-user.json

@@ -0,0 +1,4 @@
+{
+	"user-name": "ml-app-deployer-test-user",
+	"password": "changeme"
+}

src/test/resources/sample-app/users-to-not-undeploy/security/users/nobody-user.json

@@ -0,0 +1,3 @@
+{
+	"user-name": "nobody"
+}