#138 Can now populate custom tokens with Properties and optional prefix and suffix

Author: rjrudin

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

@@ -176,10 +176,10 @@ public class AppConfig {
     // Path to use for DeployFlexrepCommand
     private String flexrepPath;
 
-    // Whether or not to replace tokens in modules
+	// Whether or not to replace tokens in modules
     private boolean replaceTokensInModules = true;
     // Whether or not to prefix each module token with "@ml."
-    private boolean useRoxyTokenPrefix = true;
+    private boolean useRoxyTokenPrefix = false;
     // Additional PropertiesSources instance to use for replacing module tokens
     private List<PropertiesSource> moduleTokensPropertiesSources = new ArrayList<>();
 
@@ -216,6 +216,39 @@ public AppConfig(String defaultModulePath, String defaultSchemasPath) {
         schemasPath = defaultSchemasPath;
     }
 
+	public void populateCustomTokens(PropertiesSource propertiesSource) {
+		populateCustomTokens(propertiesSource, "%%", "%%");
+	}
+
+	/**
+	 * Populate the customTokens map in this class with the properties from the given properties source.
+	 * @param propertiesSource
+	 * @param prefix optional; if set, then each token key that is added has the prefix prepended to it
+	 * @param suffix optional; if set, then each token key that is added has the suffix appended to it
+	 */
+	public void populateCustomTokens(PropertiesSource propertiesSource, String prefix, String suffix) {
+		Properties props = propertiesSource.getProperties();
+		if (props != null) {
+			if (customTokens == null) {
+				customTokens = new HashMap<>();
+			}
+			for (Object key : props.keySet()) {
+				String skey = (String)key;
+				String value = props.getProperty(skey);
+				if (value != null) {
+					String token = skey;
+					if (prefix != null) {
+						token = prefix + token;
+					}
+					if (suffix != null) {
+						token = token + suffix;
+					}
+					customTokens.put(token, value);
+				}
+			}
+		}
+	}
+
     public void setSimpleSslConfig() {
 		setRestSslContext(SimpleX509TrustManager.newSSLContext());
 		setRestSslHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier.ANY);

src/main/java/com/marklogic/appdeployer/command/modules/DefaultModulesLoaderFactory.java

@@ -1,6 +1,7 @@
 package com.marklogic.appdeployer.command.modules;
 
 import com.marklogic.appdeployer.AppConfig;
+import com.marklogic.appdeployer.util.MapPropertiesSource;
 import com.marklogic.client.ext.batch.RestBatchWriter;
 import com.marklogic.client.ext.helper.LoggingObject;
 import com.marklogic.client.ext.modulesloader.ModulesLoader;
@@ -79,15 +80,8 @@ protected StaticChecker newStaticChecker(AppConfig appConfig) {
 	protected TokenReplacer buildModuleTokenReplacer(AppConfig appConfig) {
 		DefaultTokenReplacer r = appConfig.isUseRoxyTokenPrefix() ? new RoxyTokenReplacer() : new DefaultTokenReplacer();
 		final Map<String, String> customTokens = appConfig.getCustomTokens();
-		if (customTokens != null && !customTokens.isEmpty()) {
-			r.addPropertiesSource(new PropertiesSource() {
-				@Override
-				public Properties getProperties() {
-					Properties p = new Properties();
-					p.putAll(customTokens);
-					return p;
-				}
-			});
+		if (customTokens != null) {
+			r.addPropertiesSource(new MapPropertiesSource(customTokens));
 		}
 
 		if (appConfig.getModuleTokensPropertiesSources() != null) {

src/main/java/com/marklogic/appdeployer/util/MapPropertiesSource.java

@@ -0,0 +1,27 @@
+package com.marklogic.appdeployer.util;
+
+import com.marklogic.client.ext.tokenreplacer.PropertiesSource;
+
+import java.util.Map;
+import java.util.Properties;
+
+public class MapPropertiesSource implements PropertiesSource {
+
+	private Map<String, String> map;
+
+	public MapPropertiesSource(Map<String, String> map) {
+		this.map = map;
+	}
+
+	/**
+	 * Lazily builds a Properties object based on the Map contained in this class.
+	 *
+	 * @return
+	 */
+	@Override
+	public Properties getProperties() {
+		Properties props = new Properties();
+		props.putAll(map);
+		return props;
+	}
+}

src/main/java/com/marklogic/appdeployer/util/SimplePropertiesSource.java

@@ -0,0 +1,19 @@
+package com.marklogic.appdeployer.util;
+
+import com.marklogic.client.ext.tokenreplacer.PropertiesSource;
+
+import java.util.Properties;
+
+public class SimplePropertiesSource implements PropertiesSource {
+
+	private Properties props;
+
+	public SimplePropertiesSource(Properties props) {
+		this.props = props;
+	}
+
+	@Override
+	public Properties getProperties() {
+		return props;
+	}
+}

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

@@ -0,0 +1,60 @@
+package com.marklogic.appdeployer;
+
+import com.marklogic.appdeployer.util.SimplePropertiesSource;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+import java.util.Map;
+import java.util.Properties;
+
+public class PopulateCustomTokensTest extends Assert {
+
+	private AppConfig appConfig;
+	private Properties props;
+
+	@Before
+	public void setup() {
+		appConfig = new AppConfig();
+
+		props = new Properties();
+		props.setProperty("color", "blue");
+		props.setProperty("size", "M");
+	}
+
+	@Test
+	public void defaultPrefixAndSuffix() {
+		appConfig.populateCustomTokens(new SimplePropertiesSource(props));
+
+		Map<String, String> tokens = appConfig.getCustomTokens();
+		assertEquals("blue", tokens.get("%%color%%"));
+		assertEquals("M", tokens.get("%%size%%"));
+	}
+
+	@Test
+	public void customPrefixAndSuffix() {
+		appConfig.populateCustomTokens(new SimplePropertiesSource(props), "!!", "!!");
+
+		Map<String, String> tokens = appConfig.getCustomTokens();
+		assertEquals("blue", tokens.get("!!color!!"));
+		assertEquals("M", tokens.get("!!size!!"));
+	}
+
+	@Test
+	public void onlyPrefix() {
+		appConfig.populateCustomTokens(new SimplePropertiesSource(props), "!!", null);
+
+		Map<String, String> tokens = appConfig.getCustomTokens();
+		assertEquals("blue", tokens.get("!!color"));
+		assertEquals("M", tokens.get("!!size"));
+	}
+
+	@Test
+	public void onlySuffix() {
+		appConfig.populateCustomTokens(new SimplePropertiesSource(props), null, "!!");
+
+		Map<String, String> tokens = appConfig.getCustomTokens();
+		assertEquals("blue", tokens.get("color!!"));
+		assertEquals("M", tokens.get("size!!"));
+	}
+}

src/test/java/com/marklogic/appdeployer/command/ReplaceTokensTest.java

@@ -0,0 +1,50 @@
+package com.marklogic.appdeployer.command;
+
+import com.marklogic.appdeployer.AbstractAppDeployerTest;
+import com.marklogic.appdeployer.ConfigDir;
+import com.marklogic.appdeployer.command.modules.LoadModulesCommand;
+import com.marklogic.appdeployer.command.restapis.DeployRestApiServersCommand;
+import com.marklogic.appdeployer.util.SimplePropertiesSource;
+import com.marklogic.client.DatabaseClient;
+import com.marklogic.client.ext.modulesloader.impl.DefaultModulesLoader;
+import com.marklogic.client.io.BytesHandle;
+import com.marklogic.client.io.StringHandle;
+import org.junit.Test;
+
+import java.io.File;
+import java.util.Arrays;
+import java.util.Properties;
+
+public class ReplaceTokensTest extends AbstractAppDeployerTest {
+
+	@Test
+	public void test() {
+		appConfig.setContentForestsPerHost(1);
+		appConfig.setConfigDir(new ConfigDir(new File("src/test/resources/token-test/ml-config")));
+		appConfig.setModulePaths(Arrays.asList("src/test/resources/token-test/ml-modules"));
+
+		Properties props = new Properties();
+		props.setProperty("xdbcEnabled", "true");
+		props.setProperty("sample-token", "replaced!");
+		appConfig.populateCustomTokens(new SimplePropertiesSource(props));
+
+		LoadModulesCommand loadModulesCommand = new LoadModulesCommand();
+		loadModulesCommand.initializeDefaultModulesLoader(new CommandContext(appConfig, manageClient, adminManager));
+		((DefaultModulesLoader) loadModulesCommand.getModulesLoader()).setModulesManager(null);
+
+		initializeAppDeployer(new DeployRestApiServersCommand(), loadModulesCommand);
+		deploySampleApp();
+
+		// We know xdbcEnabled was replaced, otherwise the deployment of the REST API server would have failed
+		// Gotta verify the text in the module was replaced
+
+		DatabaseClient modulesClient = appConfig.newAppServicesDatabaseClient(appConfig.getModulesDatabaseName());
+		try {
+			String moduleText = new String(modulesClient.newDocumentManager().read("/hello.xqy", new BytesHandle()).get());
+			assertTrue("Did not find replaced text in module: " + moduleText, moduleText.contains("replaced!"));
+		} finally {
+			modulesClient.release();
+			undeploySampleApp();
+		}
+	}
+}

src/test/resources/token-test/ml-config/rest-api.json

@@ -0,0 +1,11 @@
+{
+	"rest-api": {
+		"name": "%%NAME%%",
+		"group": "%%GROUP%%",
+		"database": "%%DATABASE%%",
+		"modules-database": "%%MODULES_DATABASE%%",
+		"port": "%%PORT%%",
+		"xdbc-enabled": %%xdbcEnabled%%,
+		"error-format": "json"
+	}
+}

src/test/resources/token-test/ml-modules/root/hello.xqy

@@ -0,0 +1,3 @@
+<test>
+	<sample>%%sample-token%%</sample>
+</test>