#213 New property for controlling which databases have forests created on one host

Author: rjrudin

gradle.properties

@@ -1,6 +1,6 @@
 group=com.marklogic
 javadocsDir=../gh-pages-marklogic-java/javadocs
 version=dev
-mlJavaclientUtilVersion=77
+mlJavaclientUtilVersion=3.2-78
 mlJunitVersion=3.1.0
 

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

@@ -14,10 +14,7 @@
 
 import javax.net.ssl.SSLContext;
 import java.io.FileFilter;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 import java.util.regex.Pattern;
 
 /**
@@ -153,6 +150,9 @@ public class AppConfig {
     // Comma-delimited string used for configuring forest replicas
     private String databaseNamesAndReplicaCounts;
 
+    // Comma-delimited string of database names that should only have forests (most likely just one) created on one host
+    private Set<String> databaseNamesWithForestsOnOneHost;
+
     // Data/fast/large directories for default forests
     private String forestDataDirectory;
     private String forestFastDataDirectory;
@@ -1055,4 +1055,12 @@ public boolean isCatchUndeployExceptions() {
 	public void setCatchUndeployExceptions(boolean catchUndeployExceptions) {
 		this.catchUndeployExceptions = catchUndeployExceptions;
 	}
+
+	public Set<String> getDatabaseNamesWithForestsOnOneHost() {
+		return databaseNamesWithForestsOnOneHost;
+	}
+
+	public void setDatabaseNamesWithForestsOnOneHost(Set<String> databaseNamesWithForestsOnOneHost) {
+		this.databaseNamesWithForestsOnOneHost = databaseNamesWithForestsOnOneHost;
+	}
 }

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

@@ -276,6 +276,17 @@ public AppConfig newAppConfig() {
 			c.setDatabaseNamesAndReplicaCounts(prop);
 		}
 
+		prop = getProperty("mlDatabaseNamesWithForestsOnOneHost");
+		if (prop != null) {
+			logger.info("Databases that will have their forest(s) created on a single host: " + prop);
+			String[] names = prop.split(",");
+			Set<String> set = new HashSet<>();
+			for (String name : names) {
+				set.add(name);
+			}
+			c.setDatabaseNamesWithForestsOnOneHost(set);
+		}
+
 		prop = getProperty("mlForestDataDirectory");
 		if (prop != null) {
 			logger.info("Default forest data directory for all databases: " + prop);

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

@@ -16,6 +16,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
@@ -283,6 +284,9 @@ protected boolean customForestsExist(CommandContext context, String dbName) {
     /**
      * Allows for how an instance of DeployForestsCommand is built to be overridden by a subclass.
      *
+     * Starting in 3.2.0, the "createForestsOnEachHost" property is overridden if the database name is in the
+     * databaseNamesWithForestsOnOneHost property in AppConfig.
+     *
      * @param dbPayload
      *            Needed so we can look up forest counts based on the database name
      * @param receipt
@@ -294,7 +298,17 @@ protected DeployForestsCommand buildDeployForestsCommand(String dbPayload, SaveR
     	final String databaseName = receipt.getResourceId();
 
         DeployForestsCommand c = new DeployForestsCommand();
-        c.setCreateForestsOnEachHost(createForestsOnEachHost);
+
+	    Set<String> names = context.getAppConfig().getDatabaseNamesWithForestsOnOneHost();
+	    if (names != null && names.contains(databaseName)) {
+	    	if (logger.isInfoEnabled()) {
+	    		logger.info("Will only create forest(s) on one host for database: " + databaseName);
+		    }
+	    	c.setCreateForestsOnEachHost(false);
+	    } else {
+		    c.setCreateForestsOnEachHost(createForestsOnEachHost);
+	    }
+
         c.setForestsPerHost(determineForestCountPerHost(dbPayload, context));
         c.setForestFilename(forestFilename);
         c.setDatabaseName(databaseName);

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

@@ -3,6 +3,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Properties;
+import java.util.Set;
 
 import com.marklogic.client.DatabaseClientFactory;
 import com.marklogic.client.ext.SecurityContextType;
@@ -139,6 +140,7 @@ public void allProperties() {
 	    p.setProperty("mlResourceFilenamesToIncludeRegex", "qa-.*");
 
 	    p.setProperty("mlDatabaseNamesAndReplicaCounts", "Documents,1,Security,2");
+	    p.setProperty("mlDatabaseNamesWithForestsOnOneHost", "Documents,Security");
 
 	    p.setProperty("mlForestDataDirectory", "/data/path");
 	    p.setProperty("mlForestFastDataDirectory", "/fast/path");
@@ -163,7 +165,7 @@ public void allProperties() {
 
         assertTrue(config.isCatchDeployExceptions());
         assertTrue(config.isCatchUndeployExceptions());
-        
+
         assertEquals("prophost", config.getHost());
         assertEquals("propname", config.getName());
         assertTrue(config.isNoRestServer());
@@ -239,6 +241,11 @@ public void allProperties() {
 
 	    assertEquals("Documents,1,Security,2", config.getDatabaseNamesAndReplicaCounts());
 
+	    Set<String> set = config.getDatabaseNamesWithForestsOnOneHost();
+	    assertEquals(2, set.size());
+	    assertTrue(set.contains("Documents"));
+	    assertTrue(set.contains("Security"));
+
 	    assertEquals("/data/path", config.getForestDataDirectory());
 	    assertEquals("/fast/path", config.getForestFastDataDirectory());
 	    assertEquals("/large/path", config.getForestLargeDataDirectory());

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

@@ -0,0 +1,45 @@
+package com.marklogic.appdeployer.command.databases;
+
+import com.marklogic.appdeployer.AppConfig;
+import com.marklogic.appdeployer.command.CommandContext;
+import com.marklogic.appdeployer.command.forests.DeployForestsCommand;
+import com.marklogic.mgmt.SaveReceipt;
+import org.junit.Assert;
+import org.junit.Test;
+
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+
+public class CreateForestsOnOneHostTest extends Assert {
+
+	@Test
+	public void test() {
+		DeployDatabaseCommand command = new DeployDatabaseCommand();
+
+		AppConfig appConfig = new AppConfig();
+		CommandContext context = new CommandContext(appConfig, null, null);
+
+		Set<String> names = new HashSet<>();
+		names.add("some-name");
+		appConfig.setDatabaseNamesWithForestsOnOneHost(names);
+
+		Map<String, Integer> forestCountMap = new HashMap<>();
+		forestCountMap.put("some-name", 3);
+		forestCountMap.put("other-name", 2);
+		appConfig.setForestCounts(forestCountMap);
+
+		String payload = "{\"database-name\":\"some-name\"}";
+		SaveReceipt receipt = new SaveReceipt("some-name", payload, null, null);
+		DeployForestsCommand forestsCommand = command.buildDeployForestsCommand(payload, receipt, context);
+		assertFalse(forestsCommand.isCreateForestsOnEachHost());
+		assertEquals(3, forestsCommand.getForestsPerHost());
+
+		payload = "{\"database-name\":\"other-name\"}";
+		receipt = new SaveReceipt("other-name", payload, null, null);
+		forestsCommand = command.buildDeployForestsCommand(payload, receipt, context);
+		assertTrue(forestsCommand.isCreateForestsOnEachHost());
+		assertEquals(2, forestsCommand.getForestsPerHost());
+	}
+}

src/test/java/com/marklogic/appdeployer/command/forests/CreateForestsOnOneHostDebug.java

@@ -0,0 +1,39 @@
+package com.marklogic.appdeployer.command.forests;
+
+import com.marklogic.appdeployer.AppConfig;
+import com.marklogic.appdeployer.command.CommandContext;
+import com.marklogic.appdeployer.command.databases.DeployDatabaseCommand;
+import com.marklogic.mgmt.ManageClient;
+import com.marklogic.mgmt.ManageConfig;
+
+import java.util.HashSet;
+import java.util.Set;
+
+/**
+ * Debug program for verifying that a forest is only created on one host. Gotta run this against a cluster with 2 or
+ * more hosts.
+ */
+public class CreateForestsOnOneHostDebug {
+
+	public static void main(String[] args) {
+		final String host = args[0];
+		final String password = args[1];
+
+		ManageConfig config = new ManageConfig(host, 8002, "admin", password);
+		ManageClient manageClient = new ManageClient(config);
+
+		AppConfig appConfig = new AppConfig();
+		Set<String> names = new HashSet<>();
+		names.add("testdb");
+		appConfig.setDatabaseNamesWithForestsOnOneHost(names);
+		CommandContext context = new CommandContext(appConfig, manageClient, null);
+
+		DeployDatabaseCommand ddc = new DeployDatabaseCommand();
+		ddc.setForestsPerHost(1);
+		ddc.setCreateDatabaseWithoutFile(true);
+		ddc.setDatabaseName("testdb");
+
+		ddc.execute(context);
+		ddc.undo(context);
+	}
+}