#210 Can now customize the FileFilter for loading schemas

Author: rjrudin

gradle.properties

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

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

@@ -142,6 +142,7 @@ public class AppConfig {
     private String modulePermissions = "rest-admin,read,rest-admin,update,rest-extension-user,execute";
 
     private FileFilter assetFileFilter;
+    private FileFilter schemasFileFilter;
 
     // Additional module extensions that should be loaded as binaries into the modules database
     private String[] additionalBinaryExtensions;
@@ -588,7 +589,15 @@ public void setAssetFileFilter(FileFilter assetFileFilter) {
         this.assetFileFilter = assetFileFilter;
     }
 
-    public String getFlexrepPath() {
+	public FileFilter getSchemasFileFilter() {
+		return schemasFileFilter;
+	}
+
+	public void setSchemasFileFilter(FileFilter schemasFileFilter) {
+		this.schemasFileFilter = schemasFileFilter;
+	}
+
+	public String getFlexrepPath() {
         return flexrepPath;
     }
 

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

@@ -6,8 +6,11 @@
 import com.marklogic.appdeployer.command.SortOrderConstants;
 import com.marklogic.client.DatabaseClient;
 import com.marklogic.client.FailedRequestException;
+import com.marklogic.client.ext.schemasloader.SchemasLoader;
 import com.marklogic.client.ext.schemasloader.impl.DefaultSchemasLoader;
 
+import java.io.FileFilter;
+
 public class LoadSchemasCommand extends AbstractCommand {
 
 	public LoadSchemasCommand() {
@@ -22,7 +25,7 @@ public void execute(CommandContext context) {
 	protected void loadSchemasIntoSchemasDatabase(CommandContext context) {
 		AppConfig config = context.getAppConfig();
 		DatabaseClient client = config.newSchemasDatabaseClient();
-		DefaultSchemasLoader schemasLoader = new DefaultSchemasLoader(client);
+		SchemasLoader schemasLoader = buildSchemasLoader(context, client);
 		try {
 			String schemasPath = config.getSchemasPath();
 			logger.info("Loading schemas from path: " + schemasPath);
@@ -39,4 +42,21 @@ protected void loadSchemasIntoSchemasDatabase(CommandContext context) {
 			client.release();
 		}
 	}
+
+	/**
+	 * Will utilize schemasFileFilter in AppConfig if it's been set.
+	 *
+	 * @param context
+	 * @param client
+	 * @return
+	 */
+	protected SchemasLoader buildSchemasLoader(CommandContext context, DatabaseClient client) {
+		AppConfig config = context.getAppConfig();
+		DefaultSchemasLoader schemasLoader = new DefaultSchemasLoader(client);
+		FileFilter filter = config.getSchemasFileFilter();
+		if (filter != null) {
+			schemasLoader.addFileFilter(filter);
+		}
+		return schemasLoader;
+	}
 }

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

@@ -2,7 +2,7 @@
 
 import com.marklogic.appdeployer.AbstractAppDeployerTest;
 import com.marklogic.appdeployer.command.restapis.DeployRestApiServersCommand;
-import com.marklogic.client.ext.modulesloader.impl.AssetFileFilter;
+import com.marklogic.client.ext.modulesloader.impl.DefaultFileFilter;
 import com.marklogic.junit.Fragment;
 import com.marklogic.junit.PermissionsFragment;
 import com.marklogic.xcc.template.XccTemplate;
@@ -139,8 +139,8 @@ public void testServerExists() {
 
 		appDeployer.deploy(appConfig);
 
-		String[] uris = new String[] { "/Default/sample-app/rest-api/options/sample-app-options.xml",
-			"/Default/sample-app/rest-api/options/sample-app-options.xml" };
+		String[] uris = new String[]{"/Default/sample-app/rest-api/options/sample-app-options.xml",
+			"/Default/sample-app/rest-api/options/sample-app-options.xml"};
 		for (String uri : uris) {
 			assertEquals("true", xccTemplate.executeAdhocQuery(format("doc-available('%s')", uri)));
 		}
@@ -166,7 +166,7 @@ private void assertModuleExistsWithDefaultPermissions(String message, String uri
 
 	/**
 	 * Apparently, the REST API won't let you remove these 3 default permissions, they're always present.
-	 *
+	 * <p>
 	 * And, now that we're loading modules via the REST API by default, rest-reader/read and rest-writer/update are
 	 * always present, at least on 8.0-6.3 and 9.0-1.1, which seems like a bug.
 	 */
@@ -184,7 +184,7 @@ private void assertDefaultPermissionsExists(String uri) {
 
 }
 
-class TestFileFilter extends AssetFileFilter {
+class TestFileFilter extends DefaultFileFilter {
 
 	@Override
 	public boolean accept(File f) {

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

@@ -1,63 +1,77 @@
 package com.marklogic.appdeployer.command.schemas;
 
-import org.junit.After;
-import org.junit.Test;
-
 import com.marklogic.appdeployer.AbstractAppDeployerTest;
 import com.marklogic.appdeployer.command.Command;
 import com.marklogic.appdeployer.command.databases.DeployContentDatabasesCommand;
 import com.marklogic.appdeployer.command.databases.DeploySchemasDatabaseCommand;
 import com.marklogic.appdeployer.command.databases.DeployTriggersDatabaseCommand;
-import com.marklogic.appdeployer.command.restapis.DeployRestApiServersCommand;
 import com.marklogic.client.DatabaseClient;
 import com.marklogic.client.document.GenericDocumentManager;
 import com.marklogic.client.io.DocumentMetadataHandle;
+import org.junit.After;
+import org.junit.Test;
+
+import java.io.File;
+import java.io.FileFilter;
 
 public class LoadSchemasTest extends AbstractAppDeployerTest {
 
-    @Test
-    public void testSchemaLoading() {
-        initializeAppDeployer(new DeploySchemasDatabaseCommand(), new DeployTriggersDatabaseCommand(),
-                new DeployContentDatabasesCommand(1), new DeployRestApiServersCommand(), newCommand());
-        appDeployer.deploy(appConfig);
+	@Test
+	public void testSchemaLoading() {
+		initializeAppDeployer(new DeploySchemasDatabaseCommand(), new DeployTriggersDatabaseCommand(),
+			new DeployContentDatabasesCommand(1), newCommand());
+		appDeployer.deploy(appConfig);
+
+		DatabaseClient client = appConfig.newSchemasDatabaseClient();
 
-        DatabaseClient client = appConfig.newSchemasDatabaseClient();
+		GenericDocumentManager docMgr = client.newDocumentManager();
 
-        GenericDocumentManager docMgr = client.newDocumentManager();
+		assertNull("Rules document loaded", docMgr.exists("notExists"));
+		assertNotNull("Rules document loaded", docMgr.exists("/my.rules").getUri());
+		assertNotNull("XSD document loaded", docMgr.exists("/x.xsd").getUri());
+		assertNull(docMgr.exists("/.do-not-load"));
+		assertNull(docMgr.exists(".do-not-load"));
+	}
 
-        assertNull("Rules document loaded", docMgr.exists("notExists"));
-        assertNotNull("Rules document loaded", docMgr.exists("/my.rules").getUri());
-        assertNotNull("XSD document loaded", docMgr.exists("/x.xsd").getUri());
-    }
+	@Test
+	public void testCustomSchemasPathWithCustomFileFilter() {
+		initializeAppDeployer(new DeploySchemasDatabaseCommand(), new DeployTriggersDatabaseCommand(),
+			new DeployContentDatabasesCommand(1), newCommand());
 
-    @Test
-    public void testSchemaCustomSchemasPath() {
-        initializeAppDeployer(new DeploySchemasDatabaseCommand(), new DeployTriggersDatabaseCommand(),
-                new DeployContentDatabasesCommand(1), new DeployRestApiServersCommand(), newCommand());
-        appConfig.setSchemasPath("src/test/resources/schemas-marklogic9");
-        appDeployer.deploy(appConfig);
+		appConfig.setSchemasPath("src/test/resources/schemas-marklogic9");
+		appConfig.setSchemasFileFilter(new CustomFileFilter());
+		appDeployer.deploy(appConfig);
 
-        DatabaseClient client = appConfig.newSchemasDatabaseClient();
+		DatabaseClient client = appConfig.newSchemasDatabaseClient();
 
-        GenericDocumentManager docMgr = client.newDocumentManager();
+		GenericDocumentManager docMgr = client.newDocumentManager();
 
-        assertNotNull("TDEXML document loaded", docMgr.exists("/x.tdex").getUri());
-        assertNotNull("TDEJSON document loaded", docMgr.exists("/x.tdej").getUri());
+		assertNotNull("TDEXML document loaded", docMgr.exists("/x.tdex").getUri());
+		assertNotNull("TDEJSON document loaded", docMgr.exists("/x.tdej").getUri());
+		assertNull(docMgr.exists("/to-be-ignored/test.xml"));
+		assertNull(docMgr.exists("to-be-ignored/test.xml"));
 
-        for (String uri : new String[] { "/x.tdex", "/x.tdej" }) {
-            DocumentMetadataHandle h = docMgr.readMetadata(uri, new DocumentMetadataHandle());
-            assertEquals("Files ending in tdex and tdej go into a special collection", "http://marklogic.com/xdmp/tde",
-                    h.getCollections().iterator().next());
-        }
-    }
+		for (String uri : new String[]{"/x.tdex", "/x.tdej"}) {
+			DocumentMetadataHandle h = docMgr.readMetadata(uri, new DocumentMetadataHandle());
+			assertEquals("Files ending in tdex and tdej go into a special collection", "http://marklogic.com/xdmp/tde",
+				h.getCollections().iterator().next());
+		}
+	}
 
-    @After
-    public void cleanup() {
-        undeploySampleApp();
-    }
+	@After
+	public void cleanup() {
+		undeploySampleApp();
+	}
 
-    private Command newCommand() {
-        return new LoadSchemasCommand();
-    }
+	private Command newCommand() {
+		return new LoadSchemasCommand();
+	}
+
+}
 
+class CustomFileFilter implements FileFilter {
+	@Override
+	public boolean accept(File pathname) {
+		return !(pathname.isDirectory() && "to-be-ignored".equals(pathname.getName()));
+	}
 }

src/test/resources/sample-app/src/main/ml-schemas/.do-not-load

@@ -0,0 +1 @@
+<test/>