#268 Can now customize the naming of forests

Author: rjrudin

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

@@ -1,5 +1,6 @@
 package com.marklogic.appdeployer;
 
+import com.marklogic.appdeployer.command.forests.ForestNamingStrategy;
 import com.marklogic.client.DatabaseClient;
 import com.marklogic.client.DatabaseClientFactory;
 import com.marklogic.client.DatabaseClientFactory.Authentication;
@@ -175,6 +176,8 @@ public class AppConfig {
     private String replicaForestLargeDataDirectory;
     private String replicaForestFastDataDirectory;
 
+    private Map<String, ForestNamingStrategy> forestNamingStrategies = new HashMap<>();
+
     // Path to use for DeployFlexrepCommand
     private String flexrepPath;
 
@@ -1193,4 +1196,12 @@ public Map<String, Integer> getDatabaseNamesAndReplicaCounts() {
 	public void setDatabaseNamesAndReplicaCounts(Map<String, Integer> databaseNamesAndReplicaCounts) {
 		this.databaseNamesAndReplicaCounts = databaseNamesAndReplicaCounts;
 	}
+
+	public Map<String, ForestNamingStrategy> getForestNamingStrategies() {
+		return forestNamingStrategies;
+	}
+
+	public void setForestNamingStrategies(Map<String, ForestNamingStrategy> forestNamingStrategies) {
+		this.forestNamingStrategies = forestNamingStrategies;
+	}
 }

src/main/java/com/marklogic/appdeployer/command/forests/DefaultForestNamingStrategy.java

@@ -0,0 +1,16 @@
+package com.marklogic.appdeployer.command.forests;
+
+import com.marklogic.appdeployer.AppConfig;
+
+public class DefaultForestNamingStrategy implements ForestNamingStrategy {
+
+	@Override
+	public String getForestName(String databaseName, int forestNumber, AppConfig appConfig) {
+		return databaseName + "-" + forestNumber;
+	}
+
+	@Override
+	public String getReplicaName(String databaseName, String forestName, int forestReplicaNumber, AppConfig appConfig) {
+		return forestName + "-replica-" + forestReplicaNumber;
+	}
+}

src/main/java/com/marklogic/appdeployer/command/forests/ForestBuilder.java

@@ -18,6 +18,16 @@
  */
 public class ForestBuilder extends LoggingObject {
 
+	private ForestNamingStrategy forestNamingStrategy;
+
+	public ForestBuilder() {
+		this(new DefaultForestNamingStrategy());
+	}
+
+	public ForestBuilder(ForestNamingStrategy forestNamingStrategy) {
+		this.forestNamingStrategy = forestNamingStrategy;
+	}
+
 	/**
 	 * Builds a list of Forest objects based on the given ForestPlan and AppConfig. If replicaCount on the ForestPlan
 	 * is greater than zero, then ForestReplica objects are added to each Forest as well.
@@ -52,7 +62,7 @@ public List<Forest> buildForests(ForestPlan forestPlan, AppConfig appConfig) {
 				for (int i = 0; i < forestsPerDataDirectory; i++) {
 					if (forestCounter <= numberToBuild) {
 						Forest forest = newForest(forestPlan);
-						forest.setForestName(getForestName(databaseName, appConfig, forestCounter));
+						forest.setForestName(getForestName(databaseName, forestCounter, appConfig));
 						forest.setHost(hostName);
 						forest.setDatabase(databaseName);
 
@@ -130,7 +140,7 @@ public void addReplicasToForests(List<Forest> forests, ForestPlan forestPlan, Ap
 			int dataDirectoryPointer = dataDirectories.indexOf(f.getDataDirectory());
 			for (int i = 1; i <= replicaCount; i++) {
 				ForestReplica replica = new ForestReplica();
-				replica.setReplicaName(f.getForestName() + "-replica-" + i);
+				replica.setReplicaName(getForestReplicaName(databaseName, f.getForestName(), i, appConfig));
 				replicas.add(replica);
 
 				hostPointer++;
@@ -268,15 +278,40 @@ protected int determineForestsPerDataDirectory(ForestPlan forestPlan, AppConfig
 	}
 
 	/**
-	 * Construct the name of a forest. Protected so it can be overridden. Could eventually have a strategy interface here
-	 * for allowing for easy customization.
 	 *
 	 * @param databaseName
-	 * @param appConfig
 	 * @param forestNumber
+	 * @param appConfig
+	 * @return
+	 */
+	protected String getForestName(String databaseName, int forestNumber, AppConfig appConfig) {
+		return determineForestNamingStrategy(databaseName, appConfig).getForestName(databaseName, forestNumber, appConfig);
+	}
+
+	/**
+	 *
+	 * @param databaseName
+	 * @param forestName
+	 * @param forestReplicaNumber
+	 * @param appConfig
+	 * @return
+	 */
+	protected String getForestReplicaName(String databaseName, String forestName, int forestReplicaNumber, AppConfig appConfig) {
+		return determineForestNamingStrategy(databaseName, appConfig).getReplicaName(databaseName, forestName, forestReplicaNumber, appConfig);
+	}
+
+	/**
+	 *
+	 * @param databaseName
+	 * @param appConfig
 	 * @return
 	 */
-	protected String getForestName(String databaseName, AppConfig appConfig, int forestNumber) {
-		return databaseName + "-" + forestNumber;
+	protected ForestNamingStrategy determineForestNamingStrategy(String databaseName, AppConfig appConfig) {
+		ForestNamingStrategy fns = null;
+		Map<String, ForestNamingStrategy> map = appConfig.getForestNamingStrategies();
+		if (map != null) {
+			fns = map.get(databaseName);
+		}
+		return fns != null ? fns : this.forestNamingStrategy;
 	}
 }

src/main/java/com/marklogic/appdeployer/command/forests/ForestNamingStrategy.java

@@ -0,0 +1,26 @@
+package com.marklogic.appdeployer.command.forests;
+
+import com.marklogic.appdeployer.AppConfig;
+import com.marklogic.mgmt.api.forest.Forest;
+
+public interface ForestNamingStrategy {
+
+	/**
+	 * @param databaseName
+	 * @param forestNumber Keeps track of the total number of primary forests being created for the given database
+	 * @param appConfig
+	 * @return
+	 */
+	String getForestName(String databaseName, int forestNumber, AppConfig appConfig);
+
+	/**
+	 * @param databaseName
+	 * @param forestName
+	 * @param forestReplicaNumber Keeps track of the total number of replica forests being created for the given
+	 *                             forest
+	 * @param appConfig
+	 * @return
+	 */
+	String getReplicaName(String databaseName, String forestName, int forestReplicaNumber, AppConfig appConfig);
+
+}

src/test/java/com/marklogic/appdeployer/command/cpf/ManageCpfTest.java

@@ -1,8 +1,5 @@
 package com.marklogic.appdeployer.command.cpf;
 
-import org.junit.After;
-import org.junit.Test;
-
 import com.marklogic.appdeployer.AbstractAppDeployerTest;
 import com.marklogic.appdeployer.command.databases.DeployContentDatabasesCommand;
 import com.marklogic.appdeployer.command.databases.DeploySchemasDatabaseCommand;
@@ -11,26 +8,28 @@
 import com.marklogic.mgmt.resource.cpf.CpfConfigManager;
 import com.marklogic.mgmt.resource.cpf.DomainManager;
 import com.marklogic.mgmt.resource.cpf.PipelineManager;
+import org.junit.After;
+import org.junit.Test;
 
 public class ManageCpfTest extends AbstractAppDeployerTest {
 
-    @After
-    public void teardown() {
-        undeploySampleApp();
-    }
+	@After
+	public void teardown() {
+		undeploySampleApp();
+	}
 
-    @Test
-    public void test() {
-        initializeAppDeployer(new DeployRestApiServersCommand(), new DeployContentDatabasesCommand(),
-                new DeploySchemasDatabaseCommand(), new DeployTriggersDatabaseCommand(), new DeployDomainsCommand(),
-                new DeployCpfConfigsCommand(), new DeployPipelinesCommand());
+	@Test
+	public void test() {
+		initializeAppDeployer(new DeployContentDatabasesCommand(1), new DeployRestApiServersCommand(),
+			new DeploySchemasDatabaseCommand(), new DeployTriggersDatabaseCommand(), new DeployDomainsCommand(),
+			new DeployCpfConfigsCommand(), new DeployPipelinesCommand());
 
-        appDeployer.deploy(appConfig);
+		appDeployer.deploy(appConfig);
 
-        String dbName = appConfig.getTriggersDatabaseName();
-        assertEquals(2, new DomainManager(manageClient, dbName).getAsXml().getResourceCount());
-        assertEquals(1, new CpfConfigManager(manageClient, dbName).getAsXml().getResourceCount());
-        assertEquals(1, new PipelineManager(manageClient, dbName).getAsXml().getResourceCount());
-    }
+		String dbName = appConfig.getTriggersDatabaseName();
+		assertEquals(2, new DomainManager(manageClient, dbName).getAsXml().getResourceCount());
+		assertEquals(1, new CpfConfigManager(manageClient, dbName).getAsXml().getResourceCount());
+		assertEquals(1, new PipelineManager(manageClient, dbName).getAsXml().getResourceCount());
+	}
 
 }

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

@@ -8,8 +8,47 @@
 import org.junit.Assert;
 import org.junit.Test;
 
+import java.util.List;
+
 public class BuildForestReplicaTest extends Assert {
 
+	@Test
+	public void customNamingStrategy() {
+		AppConfig appConfig = newAppConfig();
+		appConfig.getForestNamingStrategies().put("my-database", new ForestNamingStrategy() {
+			@Override
+			public String getForestName(String databaseName, int forestNumber, AppConfig appConfig) {
+				return "forest-" + forestNumber;
+			}
+
+			@Override
+			public String getReplicaName(String databaseName, String forestName, int forestReplicaNumber, AppConfig appConfig) {
+				return "my-replica-" + forestName + "-" + forestReplicaNumber;
+			}
+		});
+
+		List<Forest> forests = new ForestBuilder().buildForests(
+			new ForestPlan("my-database", "host1", "host2", "host3").withReplicaCount(2), appConfig);
+
+		Forest f1 = forests.get(0);
+		assertEquals("forest-1", f1.getForestName());
+		assertEquals("host1", f1.getHost());
+		assertEquals("my-replica-forest-1-1", f1.getForestReplica().get(0).getReplicaName());
+		assertEquals("my-replica-forest-1-2", f1.getForestReplica().get(1).getReplicaName());
+
+		Forest f2 = forests.get(1);
+		assertEquals("forest-2", f2.getForestName());
+		assertEquals("host2", f2.getHost());
+		assertEquals("my-replica-forest-2-1", f2.getForestReplica().get(0).getReplicaName());
+		assertEquals("my-replica-forest-2-2", f2.getForestReplica().get(1).getReplicaName());
+
+		Forest f3 = forests.get(2);
+		assertEquals("forest-3", f3.getForestName());
+		assertEquals("host3", f3.getHost());
+		assertEquals("my-replica-forest-3-1", f3.getForestReplica().get(0).getReplicaName());
+		assertEquals("my-replica-forest-3-2", f3.getForestReplica().get(1).getReplicaName());
+	}
+
 	@Test
 	public void databaseAgnosticDirectories() {
 		ForestReplica replica = buildForestReplica(
@@ -81,9 +120,7 @@ public void databaseSpecificReplicaDirectories() {
 	}
 
 	private ForestReplica buildForestReplica(String... propertyNamesAndValues) {
-		SimplePropertySource source = new SimplePropertySource(propertyNamesAndValues);
-		DefaultAppConfigFactory f = new DefaultAppConfigFactory(source);
-		AppConfig config = f.newAppConfig();
+		AppConfig config = newAppConfig(propertyNamesAndValues);
 
 		Forest forest = new ForestBuilder().buildForests(
 			new ForestPlan("my-database", "host1", "host2").withReplicaCount(1), config).get(0);
@@ -92,4 +129,10 @@ private ForestReplica buildForestReplica(String... propertyNamesAndValues) {
 		assertEquals("host2", replica.getHost());
 		return replica;
 	}
+
+	protected AppConfig newAppConfig(String... propertyNamesAndValues) {
+		SimplePropertySource source = new SimplePropertySource(propertyNamesAndValues);
+		DefaultAppConfigFactory f = new DefaultAppConfigFactory(source);
+		return f.newAppConfig();
+	}
 }

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

@@ -14,19 +14,39 @@ public class BuildForestTest extends Assert {
 
 	private ForestBuilder builder = new ForestBuilder();
 
+	@Test
+	public void customNamingStrategy() {
+		AppConfig appConfig = new AppConfig();
+		appConfig.getForestNamingStrategies().put("testdb", new ForestNamingStrategy() {
+			@Override
+			public String getForestName(String databaseName, int forestNumber, AppConfig appConfig) {
+				return "custom-" + databaseName + "-" + forestNumber;
+			}
+
+			@Override
+			public String getReplicaName(String databaseName, String forestName, int forestReplicaNumber, AppConfig appConfig) {
+				return null;
+			}
+		});
+		appConfig.getForestNamingStrategies().put("shouldn't be used", new DefaultForestNamingStrategy());
+
+		ForestPlan plan = new ForestPlan("testdb", "host1", "host2");
+		List<Forest> forests = builder.buildForests(plan, appConfig);
+		verifyNameAndHost(forests.get(0), "custom-testdb-1", "host1");
+		verifyNameAndHost(forests.get(1), "custom-testdb-2", "host2");
+	}
+
 	@Test
 	public void withTemplate() {
 		ForestPlan plan = new ForestPlan("testdb", "host1", "host2");
 		plan.withTemplate("{\"rebalancer-enable\":false, \"failover-enable\":true}");
 
 		List<Forest> forests = builder.buildForests(plan, new AppConfig());
-		assertEquals("testdb-1", forests.get(0).getForestName());
-		assertEquals("host1", forests.get(0).getHost());
+		verifyNameAndHost(forests.get(0), "testdb-1", "host1");
 		assertFalse(forests.get(0).isRebalancerEnable());
 		assertTrue(forests.get(0).getFailoverEnable());
 
-		assertEquals("testdb-2", forests.get(1).getForestName());
-		assertEquals("host2", forests.get(1).getHost());
+		verifyNameAndHost(forests.get(1), "testdb-2", "host2");
 		assertFalse(forests.get(1).isRebalancerEnable());
 		assertTrue(forests.get(1).getFailoverEnable());
 	}