#127 Tokens can now be replaced in values in property files

Author: rjrudin

gradle.properties

@@ -1,3 +1,3 @@
 group=com.marklogic
 javadocsDir=../gh-pages-marklogic-java/javadocs
-version=3.13.4
+version=3.14.0-develop

src/main/java/com/marklogic/client/ext/file/CollectionsFileDocumentFileProcessor.java

@@ -23,12 +23,12 @@ public CollectionsFileDocumentFileProcessor(String propertiesFilename) {
 	protected void processProperties(DocumentFile documentFile, Properties properties) {
 		String name = documentFile.getFile().getName();
 		if (properties.containsKey(name)) {
-			String value = properties.getProperty(name);
+			String value = getPropertyValue(properties, name);
 			documentFile.getDocumentMetadata().withCollections(value.split(delimiter));
 		}
 
 		if (properties.containsKey(WILDCARD_KEY)) {
-			String value = properties.getProperty(WILDCARD_KEY);
+			String value = getPropertyValue(properties, WILDCARD_KEY);
 			documentFile.getDocumentMetadata().withCollections(value.split(delimiter));
 		}
 	}

src/main/java/com/marklogic/client/ext/file/GenericFileLoader.java

@@ -86,7 +86,7 @@ public List<DocumentFile> loadFiles(String... paths) {
 	 * If batchSize is not set, then this method will load all the documents in one call to the BatchWriter. Otherwise,
 	 * this will divide up the list of documentFiles into batches matching the value of batchSize, with the last batch
 	 * possibly being less than batchSize.
-	 * 
+	 *
 	 * @param documentFiles
 	 * @param startPosition
 	 */
@@ -155,6 +155,8 @@ public void prepareAbstractDocumentFileReader(AbstractDocumentFileReader reader)
 			reader.addDocumentFileProcessor(processor);
 		}
 
+		applyTokenReplacerOnKnownDocumentProcessors(reader);
+
 		if (additionalBinaryExtensions != null) {
 			FormatDocumentFileProcessor processor = reader.getFormatDocumentFileProcessor();
 			FormatGetter formatGetter = processor.getFormatGetter();
@@ -170,6 +172,27 @@ public void prepareAbstractDocumentFileReader(AbstractDocumentFileReader reader)
 		}
 	}
 
+	/**
+	 * If this is an instance of DefaultDocumentFileReader and a TokenReplacer has been set on the instance of this
+	 * class, then pass the TokenReplacer along to the known processors in the reader so that those processors
+	 * can replace token occurrences in property values.
+	 *
+	 * @param reader
+	 */
+	protected void applyTokenReplacerOnKnownDocumentProcessors(AbstractDocumentFileReader reader) {
+		if (reader instanceof DefaultDocumentFileReader && tokenReplacer != null) {
+			DefaultDocumentFileReader defaultReader = (DefaultDocumentFileReader)reader;
+			CollectionsFileDocumentFileProcessor cp = defaultReader.getCollectionsFileDocumentFileProcessor();
+			if (cp != null) {
+				cp.setTokenReplacer(tokenReplacer);
+			}
+			PermissionsFileDocumentFileProcessor pp = defaultReader.getPermissionsFileDocumentFileProcessor();
+			if (pp != null) {
+				pp.setTokenReplacer(tokenReplacer);
+			}
+		}
+	}
+
 	/**
 	 * Builds a set of DocumentFileProcessor objects based on how this class has been configured.
 	 *

src/main/java/com/marklogic/client/ext/file/PermissionsFileDocumentFileProcessor.java

@@ -30,12 +30,12 @@ public PermissionsFileDocumentFileProcessor(String propertiesFilename, DocumentP
 	protected void processProperties(DocumentFile documentFile, Properties properties) {
 		String name = documentFile.getFile().getName();
 		if (properties.containsKey(name)) {
-			String value = properties.getProperty(name);
+			String value = getPropertyValue(properties, name);
 			documentPermissionsParser.parsePermissions(value, documentFile.getDocumentMetadata().getPermissions());
 		}
 
 		if (properties.containsKey(WILDCARD_KEY)) {
-			String value = properties.getProperty(WILDCARD_KEY);
+			String value = getPropertyValue(properties, WILDCARD_KEY);
 			documentPermissionsParser.parsePermissions(value, documentFile.getDocumentMetadata().getPermissions());
 		}
 	}

src/main/java/com/marklogic/client/ext/file/PropertiesDrivenDocumentFileProcessor.java

@@ -1,6 +1,7 @@
 package com.marklogic.client.ext.file;
 
 import com.marklogic.client.ext.helper.LoggingObject;
+import com.marklogic.client.ext.tokenreplacer.TokenReplacer;
 
 import java.io.File;
 import java.io.FileFilter;
@@ -23,6 +24,8 @@ public abstract class PropertiesDrivenDocumentFileProcessor extends LoggingObjec
 	// Used to avoid checking for and loading the properties for every file in a directory
 	private Map<File, Properties> propertiesCache = new HashMap<>();
 
+	private TokenReplacer tokenReplacer;
+
 	protected PropertiesDrivenDocumentFileProcessor(String propertiesFilename) {
 		this.propertiesFilename = propertiesFilename;
 	}
@@ -81,11 +84,27 @@ protected Properties loadProperties(File propertiesFile) throws IOException {
 		}
 	}
 
+	protected String getPropertyValue(Properties properties, String propertyName) {
+		if (properties == null || propertyName == null) {
+			return null;
+		}
+		String value = properties.getProperty(propertyName);
+		return tokenReplacer != null && value != null ? tokenReplacer.replaceTokens(value) : value;
+	}
+
 	public Map<File, Properties> getPropertiesCache() {
 		return propertiesCache;
 	}
 
 	public String getPropertiesFilename() {
 		return propertiesFilename;
 	}
+
+	public void setTokenReplacer(TokenReplacer tokenReplacer) {
+		this.tokenReplacer = tokenReplacer;
+	}
+
+	protected TokenReplacer getTokenReplacer() {
+		return tokenReplacer;
+	}
 }

src/test/java/com/marklogic/client/ext/file/CollectionsFileDocumentFileProcessorTest.java

@@ -1,9 +1,11 @@
 package com.marklogic.client.ext.file;
 
+import com.marklogic.client.ext.tokenreplacer.DefaultTokenReplacer;
 import org.junit.Assert;
 import org.junit.Test;
 
 import java.io.File;
+import java.util.Properties;
 
 public class CollectionsFileDocumentFileProcessorTest extends Assert {
 
@@ -25,4 +27,20 @@ public void wildcard() {
 		assertTrue(file.getDocumentMetadata().getCollections().contains("xml-data"));
 		assertTrue(file.getDocumentMetadata().getCollections().contains("global"));
 	}
+
+	@Test
+	public void replaceTokens() {
+		File testDir = new File("src/test/resources/process-files/token-test");
+
+		DefaultTokenReplacer tokenReplacer = new DefaultTokenReplacer();
+		Properties props = new Properties();
+		props.setProperty("%%someCollection%%", "this-was-replaced");
+		tokenReplacer.setProperties(props);
+		processor.setTokenReplacer(tokenReplacer);
+
+		DocumentFile file = new DocumentFile("/test.json", new File(testDir, "test.json"));
+		processor.processDocumentFile(file);
+		assertTrue(file.getDocumentMetadata().getCollections().contains("this-was-replaced"));
+		assertFalse(file.getDocumentMetadata().getCollections().contains("%%someCollection%%"));
+	}
 }

src/test/java/com/marklogic/client/ext/file/PermissionsFileDocumentFileProcessorTest.java

@@ -1,10 +1,12 @@
 package com.marklogic.client.ext.file;
 
+import com.marklogic.client.ext.tokenreplacer.DefaultTokenReplacer;
 import com.marklogic.client.io.DocumentMetadataHandle;
 import org.junit.Assert;
 import org.junit.Test;
 
 import java.io.File;
+import java.util.Properties;
 
 public class PermissionsFileDocumentFileProcessorTest extends Assert {
 
@@ -35,4 +37,20 @@ public void wildcard() {
 		assertNull(permissions.get("manage-admin"));
 		assertTrue(permissions.get("qconsole-user").contains(DocumentMetadataHandle.Capability.UPDATE));
 	}
+
+	@Test
+	public void replaceTokens() {
+		File testDir = new File("src/test/resources/process-files/token-test");
+
+		DefaultTokenReplacer tokenReplacer = new DefaultTokenReplacer();
+		Properties props = new Properties();
+		props.setProperty("%%roleName%%", "rest-admin");
+		tokenReplacer.setProperties(props);
+		processor.setTokenReplacer(tokenReplacer);
+
+		DocumentFile file = new DocumentFile("/test.json", new File(testDir, "test.json"));
+		processor.processDocumentFile(file);
+		DocumentMetadataHandle.DocumentPermissions permissions = file.getDocumentMetadata().getPermissions();
+		assertTrue(permissions.get("rest-admin").contains(DocumentMetadataHandle.Capability.UPDATE));
+	}
 }

src/test/resources/process-files/token-test/collections.properties

@@ -0,0 +1 @@
+test.json=%%someCollection%%

src/test/resources/process-files/token-test/permissions.properties

@@ -0,0 +1 @@
+test.json=%%roleName%%,update

src/test/resources/process-files/token-test/test.json

@@ -0,0 +1,3 @@
+{
+	"test": "test"
+}