#177 New command for deleting test modules

Merged from 2.x

Author: rjrudin

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

@@ -95,6 +95,8 @@ public class AppConfig {
 	private boolean staticCheckLibraryAssets = false;
 	private boolean bulkLoadAssets = true;
 	private String moduleTimestampsPath = PropertiesModuleManager.DEFAULT_FILE_PATH;
+	private boolean deleteTestModules = false;
+	private String deleteTestModulesPattern = "/test/**";
 
     private String schemasPath;
     private ConfigDir configDir;
@@ -766,4 +768,20 @@ public boolean isSortRolesByDependencies() {
 	public void setSortRolesByDependencies(boolean sortRolesByDependencies) {
 		this.sortRolesByDependencies = sortRolesByDependencies;
 	}
+
+	public boolean isDeleteTestModules() {
+		return deleteTestModules;
+	}
+
+	public void setDeleteTestModules(boolean deleteTestModules) {
+		this.deleteTestModules = deleteTestModules;
+	}
+
+	public String getDeleteTestModulesPattern() {
+		return deleteTestModulesPattern;
+	}
+
+	public void setDeleteTestModulesPattern(String deleteTestModulesPattern) {
+		this.deleteTestModulesPattern = deleteTestModulesPattern;
+	}
 }

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

@@ -365,6 +365,18 @@ public AppConfig newAppConfig() {
 			c.setStaticCheckLibraryAssets(Boolean.parseBoolean(prop));
 		}
 
+		prop = getProperty("mlDeleteTestModules");
+		if (prop != null) {
+			logger.info("Delete test modules: " + prop);
+			c.setDeleteTestModules(Boolean.parseBoolean(prop));
+		}
+
+		prop = getProperty("mlDeleteTestModulesPattern");
+		if (prop != null) {
+			logger.info("Delete test modules pattern: " + prop);
+			c.setDeleteTestModulesPattern(prop);
+		}
+
 		/**
 		 * The following properties are all for generating Entity Services artifacts.
 		 */

src/main/java/com/marklogic/appdeployer/command/CommandMapBuilder.java

@@ -20,6 +20,7 @@
 import com.marklogic.appdeployer.command.forests.DeployCustomForestsCommand;
 import com.marklogic.appdeployer.command.groups.DeployGroupsCommand;
 import com.marklogic.appdeployer.command.mimetypes.DeployMimetypesCommand;
+import com.marklogic.appdeployer.command.modules.DeleteTestModulesCommand;
 import com.marklogic.appdeployer.command.modules.LoadModulesCommand;
 import com.marklogic.appdeployer.command.restapis.DeployRestApiServersCommand;
 import com.marklogic.appdeployer.command.schemas.LoadSchemasCommand;
@@ -93,6 +94,7 @@ public Map<String, List<Command>> buildCommandMap() {
 		// Modules
 		List<Command> moduleCommands = new ArrayList<>();
 		moduleCommands.add(new LoadModulesCommand());
+		moduleCommands.add(new DeleteTestModulesCommand());
 		map.put("mlModuleCommands", moduleCommands);
 
 		// Alerting

src/main/java/com/marklogic/appdeployer/command/SortOrderConstants.java

@@ -32,6 +32,7 @@ public abstract class SortOrderConstants {
     // Modules have to be loaded after the REST API server has been updated, for if the deployer is expecting to load
     // modules via SSL, then the REST API server must already be configured with a certificate template
     public static Integer LOAD_MODULES = 400;
+    public static Integer DELETE_TEST_MODULES = 410;
 
     // The modules database must exist before we deploy amps
     public static Integer DEPLOY_AMPS = 450;

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

@@ -0,0 +1,58 @@
+package com.marklogic.appdeployer.command.modules;
+
+import com.marklogic.appdeployer.AppConfig;
+import com.marklogic.appdeployer.command.AbstractCommand;
+import com.marklogic.appdeployer.command.CommandContext;
+import com.marklogic.client.DatabaseClient;
+import com.marklogic.client.DatabaseClientFactory;
+
+public class DeleteModulesCommand extends AbstractCommand {
+
+	private String pattern;
+	private String databaseName;
+
+	public DeleteModulesCommand() {
+		super();
+	}
+
+	public DeleteModulesCommand(String pattern) {
+		this();
+		this.pattern = pattern;
+	}
+
+	@Override
+	public void execute(CommandContext context) {
+		if (pattern == null || pattern.trim().length() == 0) {
+			logger.warn("No pattern was specified, so not deleting any modules");
+		}
+
+		AppConfig appConfig = context.getAppConfig();
+
+		String dbName = databaseName != null ? databaseName : appConfig.getModulesDatabaseName();
+		if (logger.isInfoEnabled()) {
+			logger.info(format("Deleting modules in database '%s' with URIs matching pattern '%s'", dbName, pattern));
+		}
+
+		DatabaseClient client = DatabaseClientFactory.newClient(appConfig.getHost(), appConfig.getAppServicesPort(), dbName,
+			appConfig.getRestAdminUsername(), appConfig.getRestAdminPassword(), appConfig.getRestAuthentication(),
+			appConfig.getRestSslContext(), appConfig.getRestSslHostnameVerifier());
+
+		String xquery = "for $uri in cts:uri-match('%s') where fn:doc-available($uri) return xdmp:document-delete($uri)";
+		try {
+			client.newServerEval().xquery(format(xquery, pattern)).evalAs(String.class);
+			if (logger.isInfoEnabled()) {
+				logger.info("Finished deleting modules");
+			}
+		} finally {
+			client.release();
+		}
+	}
+
+	public void setPattern(String pattern) {
+		this.pattern = pattern;
+	}
+
+	public void setDatabaseName(String databaseName) {
+		this.databaseName = databaseName;
+	}
+}

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

@@ -0,0 +1,33 @@
+package com.marklogic.appdeployer.command.modules;
+
+import com.marklogic.appdeployer.command.CommandContext;
+import com.marklogic.appdeployer.command.SortOrderConstants;
+
+/**
+ * Subclass that is primarily intended for current Roxy users that are accustomed to having test-only modules deployed
+ * under the "/test" path.
+ */
+public class DeleteTestModulesCommand extends DeleteModulesCommand {
+
+	public final static String DEFAULT_TEST_MODULES_PATTERN = "/test/**";
+
+	public DeleteTestModulesCommand() {
+		this(DEFAULT_TEST_MODULES_PATTERN);
+	}
+
+	public DeleteTestModulesCommand(String pattern) {
+		super(pattern);
+		setExecuteSortOrder(SortOrderConstants.DELETE_TEST_MODULES);
+	}
+
+	@Override
+	public void execute(CommandContext context) {
+		if (context.getAppConfig().isDeleteTestModules()) {
+			String pattern = context.getAppConfig().getDeleteTestModulesPattern();
+			if (pattern != null) {
+				setPattern(pattern);
+			}
+			super.execute(context);
+		}
+	}
+}

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

@@ -103,6 +103,8 @@ public void allProperties() {
         p.setProperty("mlUseRoxyTokenPrefix", "false");
         p.setProperty("mlModulePaths", "path1,path2,path3");
         p.setProperty("mlModuleTimestampsPath", "custom/timestamps/path.properties");
+        p.setProperty("mlDeleteTestModules", "true");
+        p.setProperty("mlDeleteTestModulesPattern", "/some/pattern");
 
         p.setProperty("mlModelsPath", "ml/models");
         p.setProperty("mlInstanceConverterPath", "ext/my/path");
@@ -149,6 +151,8 @@ public void allProperties() {
         assertEquals((Integer) 8123, config.getAppServicesPort());
         assertFalse(config.isReplaceTokensInModules());
         assertFalse(config.isUseRoxyTokenPrefix());
+        assertTrue(config.isDeleteTestModules());
+        assertEquals("/some/pattern", config.getDeleteTestModulesPattern());
 
         assertEquals("ml/models", config.getModelsPath());
         assertEquals("ext/my/path", config.getInstanceConverterPath());

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

@@ -14,18 +14,18 @@
 
 public class LoadModulesTest extends AbstractAppDeployerTest {
 
-    private XccTemplate xccTemplate;
+	private XccTemplate xccTemplate;
 
-    @Before
-    public void setup() {
-        xccTemplate = new XccTemplate(format("xcc://%s:%s@%s:8000/%s", "admin", "admin", appConfig.getHost(),
-                appConfig.getModulesDatabaseName()));
-    }
+	@Before
+	public void setup() {
+		xccTemplate = new XccTemplate(format("xcc://%s:%s@%s:8000/%s", appConfig.getRestAdminUsername(),
+			appConfig.getRestAdminPassword(), appConfig.getHost(), appConfig.getModulesDatabaseName()));
+	}
 
-    @After
-    public void teardown() {
-        undeploySampleApp();
-    }
+	@After
+	public void teardown() {
+		undeploySampleApp();
+	}
 
 	@Test
 	public void loadModulesWithStaticCheck() {
@@ -48,19 +48,21 @@ public void loadModulesWithStaticCheck() {
 			assertTrue("Loading modules with 2.11.0 of ml-javaclient-util defaults to bulk loading, so static checking should as well; message: " + message,
 				message.contains("Unexpected token syntax error"));
 			assertTrue(message.contains("in /ext/bad.xqy, on line 2"));
+		} finally {
+			initializeAppDeployer(new DeployRestApiServersCommand(true));
 		}
 	}
 
 	@Test
 	public void customModuleTimestampsPath() {
-    	String path = "build/custom-path.properties";
-    	File customFile = new File(path);
-    	customFile.mkdirs();
-    	if (customFile.exists()) {
-    		customFile.delete();
-	    }
-
-    	appConfig.setModuleTimestampsPath("build/custom-path.properties");
+		String path = "build/custom-path.properties";
+		File customFile = new File(path);
+		customFile.mkdirs();
+		if (customFile.exists()) {
+			customFile.delete();
+		}
+
+		appConfig.setModuleTimestampsPath("build/custom-path.properties");
 		initializeAppDeployer(new DeployRestApiServersCommand(true), new LoadModulesCommand());
 		appDeployer.deploy(appConfig);
 		assertTrue("The custom file should have been created when the modules were loaded", customFile.exists());
@@ -127,7 +129,6 @@ public void loadModulesWithAssetFileFilterAndTokenReplacement() {
         Fragment f = parse(xml);
         f.assertElementValue("/test/color", "red");
         f.assertElementValue("/test/description", "red description");
-
     }
 
     @Test
@@ -145,35 +146,49 @@ public void testServerExists() {
         }
     }
 
-    private void assertModuleExistsWithDefaultPermissions(String message, String uri) {
-        assertEquals(message, "true", xccTemplate.executeAdhocQuery(format("fn:doc-available('%s')", uri)));
-        assertDefaultPermissionsExists(uri);
-    }
+	@Test
+	public void deleteTestModules() {
+		appConfig.setDeleteTestModules(true);
+		appConfig.setDeleteTestModulesPattern("/ext/lib/*.xqy");
 
-    /**
-     * Apparently, the REST API won't let you remove these 3 default permissions, they're always present.
-     *
-     * 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.
-     */
-    private void assertDefaultPermissionsExists(String uri) {
-        PermissionsFragment perms = getDocumentPermissions(uri, xccTemplate);
-        perms.assertPermissionCount(5);
-        perms.assertPermissionExists("rest-admin", "read");
-        perms.assertPermissionExists("rest-admin", "update");
-        perms.assertPermissionExists("rest-extension-user", "execute");
+		initializeAppDeployer(new DeployRestApiServersCommand(true), buildLoadModulesCommand(),
+			new DeleteTestModulesCommand());
+		appDeployer.deploy(appConfig);
+
+		String xquery = "fn:count(cts:uri-match('/ext/**.xqy'))";
+		assertEquals(1, Integer.parseInt(xccTemplate.executeAdhocQuery(xquery)));
+	}
+
+	private void assertModuleExistsWithDefaultPermissions(String message, String uri) {
+		assertEquals(message, "true", xccTemplate.executeAdhocQuery(format("fn:doc-available('%s')", uri)));
+		assertDefaultPermissionsExists(uri);
+	}
+
+	/**
+	 * Apparently, the REST API won't let you remove these 3 default permissions, they're always present.
+	 *
+	 * 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.
+	 */
+	private void assertDefaultPermissionsExists(String uri) {
+		PermissionsFragment perms = getDocumentPermissions(uri, xccTemplate);
+		perms.assertPermissionCount(5);
+		perms.assertPermissionExists("rest-admin", "read");
+		perms.assertPermissionExists("rest-admin", "update");
+		perms.assertPermissionExists("rest-extension-user", "execute");
+
+		// Not really expected!
+		perms.assertPermissionExists("rest-reader", "read");
+		perms.assertPermissionExists("rest-writer", "update");
+	}
 
-        // Not really expected!
-	    perms.assertPermissionExists("rest-reader", "read");
-	    perms.assertPermissionExists("rest-writer", "update");
-    }
 }
 
 class TestFileFilter extends AssetFileFilter {
 
-    @Override
-    public boolean accept(File f) {
-        return !f.getName().equals("test2.xqy") && super.accept(f);
-    }
+	@Override
+	public boolean accept(File f) {
+		return !f.getName().equals("test2.xqy") && super.accept(f);
+	}
 
 }