#139 Deleting replicas first before deleting a database

Author: Rob Rudin

src/main/java/com/marklogic/appdeployer/AppConfig.java

@@ -97,6 +97,9 @@ public class AppConfig {
     // Allows for creating a triggers database without a config file for one
     private boolean createTriggersDatabase = true;
 
+    // Controls whether replicas are deleted or not when undeploying a database
+    private boolean deleteReplicas = true;
+
     // As defined by the REST API
     private String modulePermissions = "rest-admin,read,rest-admin,update,rest-extension-user,execute";
 
@@ -706,4 +709,12 @@ public String[] getResourceFilenamesToIgnore() {
 	public void setResourceFilenamesToIgnore(String... resourceFilenamesToIgnore) {
 		this.resourceFilenamesToIgnore = resourceFilenamesToIgnore;
 	}
+
+    public boolean isDeleteReplicas() {
+        return deleteReplicas;
+    }
+
+    public void setDeleteReplicas(boolean deleteReplicas) {
+        this.deleteReplicas = deleteReplicas;
+    }
 }

src/main/java/com/marklogic/appdeployer/DefaultAppConfigFactory.java

@@ -142,6 +142,17 @@ public AppConfig newAppConfig() {
 			c.setDatabaseNamesAndReplicaCounts(prop);
 		}
 
+		/**
+		 * When undo is invoked on DeployDatabaseCommand (such as via mlUndeploy in ml-gradle), this controls whether
+		 * or not replicas are deleted first. Most of the time, you want this set to true (the default) as otherwise,
+		 * the database can't be deleted and the Management REST API will throw an error.
+		 */
+		prop = getProperty("mlDeleteReplicas");
+		if (prop != null) {
+			logger.info("Delete replicas when a database is deleted: " + prop);
+			c.setDeleteReplicas(Boolean.parseBoolean(prop));
+		}
+
 		/**
 		 * When a REST API server is created, the content database name will default to mlAppName-content. This property
 		 * can be used to override that name.

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

@@ -57,6 +57,8 @@ public class DeployDatabaseCommand extends AbstractCommand implements UndoableCo
      */
     private String forestDelete = "data";
 
+    private boolean deleteReplicas = true;
+
     private int undoSortOrder;
 
     public DeployDatabaseCommand() {
@@ -95,6 +97,7 @@ public void undo(CommandContext context) {
         if (payload != null) {
             DatabaseManager dbMgr = new DatabaseManager(context.getManageClient());
             dbMgr.setForestDelete(forestDelete);
+            dbMgr.setDeleteReplicas(deleteReplicas);
             dbMgr.delete(payload);
         }
     }
@@ -244,4 +247,12 @@ public boolean isCreateForestsOnEachHost() {
     public void setCreateForestsOnEachHost(boolean createForestsOnEachHost) {
         this.createForestsOnEachHost = createForestsOnEachHost;
     }
+
+    public boolean isDeleteReplicas() {
+        return deleteReplicas;
+    }
+
+    public void setDeleteReplicas(boolean deleteReplicas) {
+        this.deleteReplicas = deleteReplicas;
+    }
 }

src/main/java/com/marklogic/mgmt/AbstractResourceManager.java

@@ -135,11 +135,19 @@ public DeleteReceipt delete(String payload, String... resourceUrlParams) {
         } else {
             String path = getResourcePath(resourceId, resourceUrlParams);
             path = appendParamsAndValuesToPath(path, getDeleteResourceParams(payload));
+            beforeDelete(resourceId, path, resourceUrlParams);
             deleteAtPath(path);
             return new DeleteReceipt(resourceId, path, true);
         }
     }
 
+    /**
+     * Can be overridden by subclass to perform processing before deleteAtPath is invoked.
+     */
+    protected void beforeDelete(String resourceId, String path, String... resourceUrlParams) {
+
+    }
+
     /**
      * Convenience method for performing a delete once the correct path for the resource has been constructed.
      * 

src/main/java/com/marklogic/mgmt/databases/DatabaseManager.java

@@ -4,12 +4,15 @@
 
 import com.marklogic.mgmt.AbstractResourceManager;
 import com.marklogic.mgmt.ManageClient;
+import com.marklogic.mgmt.ManageConfig;
 import com.marklogic.mgmt.forests.ForestManager;
+import com.marklogic.mgmt.forests.ForestStatus;
 import com.marklogic.rest.util.Fragment;
 
 public class DatabaseManager extends AbstractResourceManager {
 
     private String forestDelete = "data";
+    private boolean deleteReplicas = true;
 
     public DatabaseManager(ManageClient manageClient) {
         super(manageClient);
@@ -57,6 +60,20 @@ public void deleteByName(String databaseName) {
         delete(json);
     }
 
+    @Override
+    protected void beforeDelete(String resourceId, String path, String... resourceUrlParams) {
+        if (deleteReplicas) {
+            logger.info("Deleting any replicas that exist for database: " + resourceId);
+            ForestManager forestManager = new ForestManager(getManageClient());
+            for (String forestId : getPrimaryForestIds(resourceId)) {
+                ForestStatus status = forestManager.getForestStatus(forestId);
+                if (status.isPrimary() && status.hasReplicas()) {
+                    forestManager.deleteReplicas(forestId);
+                }
+            }
+        }
+    }
+
     /**
      * @param databaseNameOrId
      * @return the IDs of all forests - primary and replica - related to the database
@@ -115,4 +132,12 @@ protected String[] getDeleteResourceParams(String payload) {
     public void setForestDelete(String forestDelete) {
         this.forestDelete = forestDelete;
     }
+
+    public boolean isDeleteReplicas() {
+        return deleteReplicas;
+    }
+
+    public void setDeleteReplicas(boolean deleteReplicas) {
+        this.deleteReplicas = deleteReplicas;
+    }
 }

src/test/java/com/marklogic/appdeployer/DefaultAppConfigFactoryTest.java

@@ -58,6 +58,7 @@ public void allProperties() {
         p.setProperty("mlSimpleSsl", "anyvalue");
         p.setProperty("mlContentDatabaseName", "my-content-db");
         p.setProperty("mlModulesDatabaseName", "my-modules");
+        p.setProperty("mlDeleteReplicas", "false");
         p.setProperty("mlGroupName", "other-group");
         p.setProperty("mlAppServicesPort", "8123");
         p.setProperty("mlReplaceTokensInModules", "false");
@@ -93,6 +94,7 @@ public void allProperties() {
         assertNotNull(config.getRestSslHostnameVerifier());
         assertEquals("my-content-db", config.getContentDatabaseName());
         assertEquals("my-modules", config.getModulesDatabaseName());
+        assertFalse(config.isDeleteReplicas());
         assertEquals("other-group", config.getGroupName());
         assertEquals((Integer) 8123, config.getAppServicesPort());
         assertFalse(config.isReplaceTokensInModules());