Merge pull request #493 from marklogic/feature/cascade

DEVEXP-527 Added properties for cascading collections and permissions

Author: rjrudin

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

@@ -155,6 +155,11 @@ public class AppConfig {
 	private String cpfDatabaseName;
 	private String schemasDatabaseName;
 
+	// Since 4.6.0; affects loading of modules, schemas, and data.
+	// Disabled by default for backwards compatibility; will likely default to true in 5.0.0 release.
+	private boolean cascadeCollections;
+	private boolean cascadePermissions;
+
 	private List<String> modulePaths;
 	private boolean staticCheckAssets = false;
 	private boolean staticCheckLibraryAssets = false;
@@ -1535,4 +1540,20 @@ public String getAppServicesSamlToken() {
 	public void setAppServicesSamlToken(String appServicesSamlToken) {
 		this.appServicesSamlToken = appServicesSamlToken;
 	}
+
+	public boolean isCascadeCollections() {
+		return cascadeCollections;
+	}
+
+	public void setCascadeCollections(boolean cascadeCollections) {
+		this.cascadeCollections = cascadeCollections;
+	}
+
+	public boolean isCascadePermissions() {
+		return cascadePermissions;
+	}
+
+	public void setCascadePermissions(boolean cascadePermissions) {
+		this.cascadePermissions = cascadePermissions;
+	}
 }

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

@@ -791,6 +791,16 @@ public void initialize() {
 			config.setModulesLoaderBatchSize(Integer.parseInt(prop));
 		});
 
+		propertyConsumerMap.put("mlCascadeCollections", (config, prop) -> {
+			logger.info("Cascade collections.properties configuration when loading data, modules, and schemas: " + prop);
+			config.setCascadeCollections(Boolean.parseBoolean(prop));
+		});
+
+		propertyConsumerMap.put("mlCascadePermissions", (config, prop) -> {
+			logger.info("Cascade permissions.properties configuration when loading data, modules, and schemas: " + prop);
+			config.setCascadePermissions(Boolean.parseBoolean(prop));
+		});
+
 		/**
 		 * The following properties are all for generating Entity Services artifacts.
 		 */

src/main/java/com/marklogic/appdeployer/command/data/LoadDataCommand.java

@@ -70,6 +70,9 @@ protected FileLoader buildFileLoader(AppConfig appConfig) {
 		final DatabaseClient client = determineDatabaseClient(appConfig);
 		final GenericFileLoader loader = new GenericFileLoader(client);
 
+		loader.setCascadeCollections(appConfig.isCascadeCollections());
+		loader.setCascadePermissions(appConfig.isCascadePermissions());
+
 		DataConfig dataConfig = appConfig.getDataConfig();
 
 		final Integer batchSize = dataConfig.getBatchSize();

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

@@ -59,6 +59,8 @@ public ModulesLoader newModulesLoader(AppConfig appConfig) {
 		RestBatchWriter assetBatchWriter = new RestBatchWriter(modulesDatabaseClient, false);
 		assetBatchWriter.setThreadCount(threadCount);
 		AssetFileLoader assetFileLoader = new AssetFileLoader(assetBatchWriter, modulesManager);
+		assetFileLoader.setCascadeCollections(appConfig.isCascadeCollections());
+		assetFileLoader.setCascadePermissions(appConfig.isCascadePermissions());
 		if (appConfig.getModulesLoaderBatchSize() != null) {
 			assetFileLoader.setBatchSize(appConfig.getModulesLoaderBatchSize());
 		}

src/main/java/com/marklogic/appdeployer/command/schemas/LoadSchemasCommand.java

@@ -124,6 +124,8 @@ protected SchemasLoader buildSchemasLoader(CommandContext context, DatabaseClien
 		}
 
 		DefaultSchemasLoader schemasLoader = new DefaultSchemasLoader(client, tdeValidationDatabase);
+		schemasLoader.setCascadeCollections(appConfig.isCascadeCollections());
+		schemasLoader.setCascadePermissions(appConfig.isCascadePermissions());
 		FileFilter filter = appConfig.getSchemasFileFilter();
 		if (filter != null) {
 			schemasLoader.addFileFilter(filter);

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

@@ -144,4 +144,8 @@ protected final void configureRestServersToNotRequireSSL() {
 		payload.put("server-name", SAMPLE_APP_NAME + "-test");
 		mgr.save(payload.toString());
 	}
+
+	protected final CommandContext newCommandContext() {
+		return new CommandContext(appConfig, manageClient, adminManager);
+	}
 }

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

@@ -393,6 +393,10 @@ public void mostProperties() {
 
 		p.setProperty("mlUpdateMimetypeWhenPropertiesAreEqual", "true");
 
+		// 4.6.0
+		p.setProperty("mlCascadeCollections", "true");
+		p.setProperty("mlCascadePermissions", "true");
+
 		sut = new DefaultAppConfigFactory(new SimplePropertySource(p));
 		AppConfig config = sut.newAppConfig();
 
@@ -565,6 +569,9 @@ public void mostProperties() {
 		assertEquals("other-group", map.get("host2"));
 
 		assertTrue(config.isUpdateMimetypeWhenPropertiesAreEqual());
+
+		assertTrue(config.isCascadeCollections());
+		assertTrue(config.isCascadePermissions());
 	}
 
 	/**

src/test/java/com/marklogic/appdeployer/command/data/LoadDataTest.java

@@ -20,14 +20,19 @@
 import com.marklogic.appdeployer.command.restapis.DeployRestApiServersCommand;
 import com.marklogic.client.DatabaseClient;
 import com.marklogic.client.document.GenericDocumentManager;
+import com.marklogic.client.ext.file.GenericFileLoader;
 import com.marklogic.client.io.DocumentMetadataHandle;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 
 import java.io.File;
 import java.util.Set;
 
-import static org.junit.jupiter.api.Assertions.*;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 public class LoadDataTest extends AbstractAppDeployerTest {
 
@@ -92,4 +97,18 @@ public void databaseNameIsSet() {
 		assertEquals(appConfig.getAppServicesPort(), client.getPort());
 		client.release();
 	}
+
+	/**
+	 * Just verifies the config; we assume that ml-javaclient-util will work properly if cascade is set to true.
+	 */
+	@Test
+	void cascadeCollectionsAndPermissions() {
+		appConfig.setCascadePermissions(true);
+		appConfig.setCascadeCollections(true);
+
+		GenericFileLoader loader = (GenericFileLoader) new LoadDataCommand().buildFileLoader(appConfig);
+
+		assertTrue(loader.isCascadeCollections());
+		assertTrue(loader.isCascadePermissions());
+	}
 }

src/test/java/com/marklogic/appdeployer/command/modules/DefaultsModulesLoaderFactoryTest.java

@@ -21,7 +21,9 @@
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 public class DefaultsModulesLoaderFactoryTest extends AbstractAppDeployerTest {
 
@@ -43,4 +45,20 @@ public void dontUseHost() {
 		PropertiesModuleManager manager = (PropertiesModuleManager) loader.getModulesManager();
 		assertNull(manager.getHost());
 	}
+
+	@Test
+	void cascadeCollectionsAndPermissions() {
+		DefaultModulesLoader loader = (DefaultModulesLoader) factory.newModulesLoader(appConfig);
+
+		// Should default to false in the 4.x timeframe
+		assertFalse(loader.getAssetFileLoader().isCascadeCollections());
+		assertFalse(loader.getAssetFileLoader().isCascadePermissions());
+
+		appConfig.setCascadeCollections(true);
+		appConfig.setCascadePermissions(true);
+
+		loader = (DefaultModulesLoader) factory.newModulesLoader(appConfig);
+		assertTrue(loader.getAssetFileLoader().isCascadeCollections());
+		assertTrue(loader.getAssetFileLoader().isCascadePermissions());
+	}
 }

src/test/java/com/marklogic/appdeployer/command/schemas/LoadSchemasTest.java

@@ -20,6 +20,7 @@
 import com.marklogic.appdeployer.command.databases.DeployOtherDatabasesCommand;
 import com.marklogic.client.DatabaseClient;
 import com.marklogic.client.document.GenericDocumentManager;
+import com.marklogic.client.ext.schemasloader.impl.DefaultSchemasLoader;
 import com.marklogic.client.io.BytesHandle;
 import com.marklogic.client.io.DocumentMetadataHandle;
 import org.junit.jupiter.api.AfterEach;
@@ -28,7 +29,11 @@
 import java.io.File;
 import java.io.FileFilter;
 
-import static org.junit.jupiter.api.Assertions.*;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.fail;
 
 public class LoadSchemasTest extends AbstractAppDeployerTest {
 
@@ -162,6 +167,21 @@ public void multipleSchemaPaths() {
 		assertTrue(docMgr.readMetadata("/tde/template2.json", new DocumentMetadataHandle()).getCollections().contains("http://marklogic.com/xdmp/tde"));
 	}
 
+	/**
+	 * Just verifies the config; we assume that ml-javaclient-util will work properly if cascade is set to true.
+	 */
+	@Test
+	void cascadeCollectionsAndPermissions() {
+		appConfig.setCascadePermissions(true);
+		appConfig.setCascadeCollections(true);
+
+		DefaultSchemasLoader loader = (DefaultSchemasLoader) new LoadSchemasCommand().buildSchemasLoader(
+			newCommandContext(), appConfig.newSchemasDatabaseClient(), null);
+
+		assertTrue(loader.isCascadeCollections());
+		assertTrue(loader.isCascadePermissions());
+	}
+
 	private Command newCommand() {
 		return new LoadSchemasCommand();
 	}