#200 Can now disable creation of forests

Author: rjrudin

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

@@ -124,6 +124,9 @@ public class AppConfig {
     // Allows for creating a triggers database without a config file for one
     private boolean createTriggersDatabase = false;
 
+    // Controls whether forests are created when a database is created
+    private boolean createForests = true;
+
     // Controls whether forests are deleted when a database is deleted
     private boolean deleteForests = true;
 
@@ -730,7 +733,15 @@ public void setDeleteForests(boolean deleteForests) {
         this.deleteForests = deleteForests;
     }
 
-    public boolean isNoRestServer() {
+	public boolean isCreateForests() {
+		return createForests;
+	}
+
+	public void setCreateForests(boolean createForests) {
+		this.createForests = createForests;
+	}
+
+	public boolean isNoRestServer() {
         return noRestServer;
     }
 

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

@@ -238,6 +238,12 @@ public AppConfig newAppConfig() {
 			c.setContentForestsPerHost(Integer.parseInt(prop));
 		}
 
+		prop = getProperty("mlCreateForests");
+		if (prop != null) {
+			logger.info("Create forests for each deployed database: " + prop);
+			c.setCreateForests(Boolean.parseBoolean(prop));
+		}
+
 		/**
 		 * For any database besides the content database, configure the number of forests per host.
 		 */

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

@@ -53,10 +53,6 @@ public void execute(CommandContext context) {
                 SaveReceipt receipt = dbMgr.save(json);
 	            if (shouldCreateForests(context, payload)) {
 		            buildDeployForestsCommand(payload, receipt, context).execute(context);
-	            } else {
-		            if (logger.isInfoEnabled()) {
-			            logger.info("Found custom forests for database, so not creating default forests");
-		            }
 	            }
             }
         }
@@ -77,10 +73,10 @@ public void undo(CommandContext context) {
             String json = payloadTokenReplacer.replaceTokens(payload, appConfig, false);
 
             DatabaseManager dbMgr = newDatabaseManageForDeleting(context);
-            
+
             // remove subdatabases if they exist
             removeSubDatabases(dbMgr, context, dbMgr.getResourceId(json));
-            
+
             dbMgr.delete(json);
             if (appConfig.isTestPortSet()) {
                 json = payloadTokenReplacer.replaceTokens(payload, appConfig, true);

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

@@ -59,7 +59,8 @@ public class DeployDatabaseCommand extends AbstractCommand implements UndoableCo
     private int forestsPerHost = 1;
 
     /**
-     * Passed on to DeployForestsCommand.
+     * Passed on to DeployForestsCommand. If forests are to be created, controls whether forests on created on every
+     * host or only one one host.
      */
     private boolean createForestsOnEachHost = true;
 
@@ -99,16 +100,11 @@ public void execute(CommandContext context) {
             databaseName = receipt.getResourceId();
             if (shouldCreateForests(context, payload)) {
 	            buildDeployForestsCommand(payload, receipt, context).execute(context);
-            } else {
-            	if (logger.isInfoEnabled()) {
-            		logger.info("Found custom forests for database, so not creating default forests");
-	            }
             }
-            // subdatabases? create and attach
+
             if(!isSubDatabase()){
-            	this.addSubDatabases(dbMgr, context, receipt.getResourceId());
+            	this.addSubDatabases(dbMgr, context, databaseName);
             }
-
         }
     }
 
@@ -236,7 +232,9 @@ protected String getPayload(CommandContext context) {
     }
 
 	/**
-	 * This is where we check to see if a custom forests directory exists at ./forests/(database name). The database
+	 * Determines if forests should be created after a database is deployed.
+	 *
+	 * This includes checking to see if a custom forests directory exists at ./forests/(database name). The database
 	 * name is extracted from the payload via a PayloadParser. This check can be disabled by setting
 	 * checkForCustomForests to false.
 	 *
@@ -245,10 +243,21 @@ protected String getPayload(CommandContext context) {
 	 * @return
 	 */
 	protected boolean shouldCreateForests(CommandContext context, String payload) {
+		if (!context.getAppConfig().isCreateForests()) {
+			if (logger.isInfoEnabled()) {
+				logger.info("Forest creation is disabled, so not creating any forests");
+			}
+			return false;
+		}
+
 		if (isCheckForCustomForests()) {
 			PayloadParser parser = new PayloadParser();
 			String dbName = parser.getPayloadFieldValue(payload, "database-name");
-			return !customForestsExist(context, dbName);
+			boolean exist = !customForestsExist(context, dbName);
+			if (exist && logger.isInfoEnabled()) {
+				logger.info("Found custom forests for database " + dbName + ", so not creating default forests");
+			}
+			return exist;
 		}
 		return true;
 	}

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

@@ -103,6 +103,7 @@ public void allProperties() {
 	    p.setProperty("mlAppServicesSimpleSsl", "true");
 
 	    p.setProperty("mlContentForestsPerHost", "17");
+	    p.setProperty("mlCreateForests", "false");
 	    p.setProperty("mlForestsPerHost", "some-db,2,other-db,3");
         p.setProperty("mlModulePermissions", "some-perm,read,some-perm,update");
         p.setProperty("mlAdditionalBinaryExtensions", ".gradle,.properties");
@@ -174,6 +175,7 @@ public void allProperties() {
 	    assertEquals(DatabaseClientFactory.SSLHostnameVerifier.ANY, config.getAppServicesSslHostnameVerifier());
 
 	    assertEquals((Integer) 17, config.getContentForestsPerHost());
+	    assertFalse(config.isCreateForests());
 	    Map<String, Integer> forestCounts = config.getForestCounts();
 	    assertEquals(2, (int)forestCounts.get("some-db"));
 	    assertEquals(3, (int)forestCounts.get("other-db"));

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

@@ -1,6 +1,7 @@
 package com.marklogic.appdeployer.command.databases;
 
 import java.io.File;
+import java.util.regex.Pattern;
 
 import org.junit.Test;
 
@@ -11,6 +12,29 @@
 
 public class DeployOtherDatabasesTest extends AbstractAppDeployerTest {
 
+	@Test
+	public void dontCreateForests() {
+		ConfigDir configDir = appConfig.getConfigDir();
+		configDir.setBaseDir(new File("src/test/resources/sample-app/lots-of-databases"));
+
+		appConfig.setResourceFilenamesIncludePattern(Pattern.compile("other-schemas-database.*"));
+		appConfig.setCreateForests(false);
+
+		initializeAppDeployer(new DeployOtherDatabasesCommand());
+
+		final String dbName = "other-sample-app-schemas";
+		DatabaseManager dbMgr = new DatabaseManager(manageClient);
+
+		try {
+			appDeployer.deploy(appConfig);
+			assertTrue(dbMgr.exists(dbName));
+			assertTrue("No forests should have been created for the database", dbMgr.getForestIds(dbName).isEmpty());
+		} finally {
+			undeploySampleApp();
+			assertFalse(dbMgr.exists(dbName));
+		}
+	}
+
     @Test
     public void test() {
         ConfigDir configDir = appConfig.getConfigDir();