#310 Not undeploying default databases

Author: rjrudin

src/main/java/com/marklogic/appdeployer/command/databases/DeployDatabaseCommand.java

@@ -17,6 +17,7 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 
 /**
  * Can be used for creating any kind of database with any sorts of forests. Specifying a config file for the database or
@@ -77,6 +78,11 @@ public class DeployDatabaseCommand extends AbstractCommand implements UndoableCo
     private boolean subDatabase = false;
     private String superDatabaseName;
 
+	/**
+	 * Expected to be set by DeployOtherDatabasesCommand; a list of database names (should default to the ones MarkLogic
+	 * provides out-of-the-box) that won't be undeployed during an "undo" operation.
+	 */
+	private Set<String> databasesToNotUndeploy;
 
     public DeployDatabaseCommand() {
         setExecuteSortOrder(SortOrderConstants.DEPLOY_OTHER_DATABASES);
@@ -129,6 +135,15 @@ public void execute(CommandContext context) {
     @Override
     public void undo(CommandContext context) {
         String payload = buildPayload(context);
+
+        if (databasesToNotUndeploy != null) {
+        	final String dbName = new PayloadParser().getPayloadFieldValue(payload, "database-name", false);
+        	if (dbName != null && databasesToNotUndeploy.contains(dbName)) {
+        		logger.info(format("Not undeploying database %s because it is in the list of database names to not undeploy.", dbName));
+        		return;
+	        }
+        }
+
         if (payload != null) {
         	DatabaseManager dbMgr = newDatabaseManageForDeleting(context);
         	// if this has subdatabases, detach/delete them first
@@ -422,4 +437,12 @@ public String getSuperDatabaseName() {
 	public void setDatabaseFile(File databaseFile) {
 		this.databaseFile = databaseFile;
 	}
+
+	public Set<String> getDatabasesToNotUndeploy() {
+		return databasesToNotUndeploy;
+	}
+
+	public void setDatabasesToNotUndeploy(Set<String> databasesToNotUndeploy) {
+		this.databasesToNotUndeploy = databasesToNotUndeploy;
+	}
 }

src/main/java/com/marklogic/appdeployer/command/databases/DeployOtherDatabasesCommand.java

@@ -31,6 +31,11 @@ public class DeployOtherDatabasesCommand extends AbstractUndoableCommand {
 	private String forestFilename;
 	private boolean createForestsOnEachHost = true;
 
+	/**
+	 * Defines database names that, by default, this command will never undeploy.
+	 */
+	private Set<String> defaultDatabasesToNotUndeploy = new HashSet<>();
+
     public DeployOtherDatabasesCommand() {
         this(1);
     }
@@ -39,8 +44,23 @@ public DeployOtherDatabasesCommand(int forestsPerHost) {
     	setForestsPerHost(forestsPerHost);
 	    setExecuteSortOrder(SortOrderConstants.DEPLOY_OTHER_DATABASES);
 	    setUndoSortOrder(SortOrderConstants.DELETE_OTHER_DATABASES);
+	    initializeDefaultDatabasesToNotUndeploy();
     }
 
+	protected void initializeDefaultDatabasesToNotUndeploy() {
+		defaultDatabasesToNotUndeploy = new HashSet<>();
+		defaultDatabasesToNotUndeploy.add("App-Services");
+		defaultDatabasesToNotUndeploy.add("Documents");
+		defaultDatabasesToNotUndeploy.add("Extensions");
+		defaultDatabasesToNotUndeploy.add("Fab");
+		defaultDatabasesToNotUndeploy.add("Last-Login");
+		defaultDatabasesToNotUndeploy.add("Meters");
+		defaultDatabasesToNotUndeploy.add("Modules");
+		defaultDatabasesToNotUndeploy.add("Schemas");
+		defaultDatabasesToNotUndeploy.add("Security");
+		defaultDatabasesToNotUndeploy.add("Triggers");
+	}
+
     @Override
     public void execute(CommandContext context) {
         List<DeployDatabaseCommand> list = buildDatabaseCommands(context);
@@ -68,6 +88,7 @@ public void undo(CommandContext context) {
         }
     }
 
+
     protected void sortCommandsBeforeUndo(List<DeployDatabaseCommand> list, CommandContext context) {
         Collections.sort(list, new DeployDatabaseCommandComparator(context, true));
     }
@@ -97,6 +118,7 @@ protected DeployDatabaseCommand buildDeployDatabaseCommand(File file) {
 	    c.setCheckForCustomForests(isCheckForCustomForests());
 	    c.setForestFilename(getForestFilename());
 	    c.setCreateForestsOnEachHost(isCreateForestsOnEachHost());
+	    c.setDatabasesToNotUndeploy(this.getDefaultDatabasesToNotUndeploy());
 	    return c;
     }
 
@@ -151,4 +173,12 @@ public boolean isCreateForestsOnEachHost() {
 	public void setCreateForestsOnEachHost(boolean createForestsOnEachHost) {
 		this.createForestsOnEachHost = createForestsOnEachHost;
 	}
+
+	public Set<String> getDefaultDatabasesToNotUndeploy() {
+		return defaultDatabasesToNotUndeploy;
+	}
+
+	public void setDefaultDatabasesToNotUndeploy(Set<String> defaultDatabasesToNotUndeploy) {
+		this.defaultDatabasesToNotUndeploy = defaultDatabasesToNotUndeploy;
+	}
 }

src/test/java/com/marklogic/appdeployer/command/databases/DontUndeployDefaultDatabasesTest.java

@@ -0,0 +1,29 @@
+package com.marklogic.appdeployer.command.databases;
+
+import com.marklogic.appdeployer.AbstractAppDeployerTest;
+import com.marklogic.appdeployer.ConfigDir;
+import com.marklogic.mgmt.resource.databases.DatabaseManager;
+import org.junit.Test;
+
+import java.io.File;
+
+public class DontUndeployDefaultDatabasesTest extends AbstractAppDeployerTest {
+
+	@Test
+	public void test() {
+		DatabaseManager mgr = new DatabaseManager(manageClient);
+
+		appConfig.setConfigDir(new ConfigDir(new File("src/test/resources/sample-app/default-databases")));
+		initializeAppDeployer(new DeployContentDatabasesCommand(1), new DeployOtherDatabasesCommand());
+
+		deploySampleApp();
+
+		assertTrue(mgr.exists(appConfig.getContentDatabaseName()));
+		assertTrue(mgr.exists("Fab"));
+
+		undeploySampleApp();
+
+		assertFalse(mgr.exists(appConfig.getContentDatabaseName()));
+		assertTrue(mgr.exists("Fab"));
+	}
+}

src/test/resources/sample-app/default-databases/databases/content-database.json

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

src/test/resources/sample-app/default-databases/databases/fab-database.json

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