issue-16-review

CHANGELOG.mdown

@@ -5,7 +5,10 @@
 * Added SetSslFipsEnabledCommand
 * [#67](https://github.com/rjrudin/ml-app-deployer/issues/67) Now supporting triggers (requires ML 8.0-4)
 * [#68](https://github.com/rjrudin/ml-app-deployer/issues/68) Now supporting alert configs, actions, and rules (requires ML 8.0-4)
-
+* Can delete all scheduled tasks with TaskManager
+* Can delete all flexrep configs with ConfigManager
+* Can delete all alert configs with AlertConfigManager
+
 ## 2.0b12
 
 * Added null-check in SimpleAppDeployer

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

@@ -31,9 +31,6 @@ public abstract class SortOrderConstants {
     public static Integer DEPLOY_AMPS = 450;
 
     public static Integer DEPLOY_TRIGGERS = 700;
-    public static Integer DEPLOY_ALERT_CONFIGS = 710;
-    public static Integer DEPLOY_ALERT_ACTIONS = 720;
-    public static Integer DEPLOY_ALERT_RULES = 730;
 
     public static Integer DEPLOY_SCHEDULED_TASKS = 800;
 
@@ -42,6 +39,10 @@ public abstract class SortOrderConstants {
     public static Integer DEPLOY_DOMAINS = 910;
     public static Integer DEPLOY_CPF_CONFIGS = 920;
 
+    public static Integer DEPLOY_ALERT_CONFIGS = 950;
+    public static Integer DEPLOY_ALERT_ACTIONS = 960;
+    public static Integer DEPLOY_ALERT_RULES = 970;
+
     public static Integer DEPLOY_FLEXREP_CONFIGS = 1000;
     public static Integer DEPLOY_FLEXREP_TARGETS = 1010;
 

src/main/java/com/rjrudin/marklogic/mgmt/AbstractResourceManager.java

@@ -51,18 +51,17 @@ public Fragment getPropertiesAsXml(String resourceNameOrId) {
                 .getXml(getPropertiesPath(resourceNameOrId));
     }
 
+    /**
+     * Determines whether to create a new resource or update an existing one based on the contents of the payload.
+     */
     public SaveReceipt save(String payload) {
         String resourceId = getResourceId(payload);
         String label = getResourceName();
         String path = null;
         ResponseEntity<String> response = null;
         if (exists(resourceId)) {
             if (updateAllowed) {
-                path = getPropertiesPath(resourceId);
-                path = appendParamsAndValuesToPath(path, getUpdateResourceParams(payload));
-                logger.info(format("Found %s with name of %s, so updating at path %s", label, resourceId, path));
-                response = putPayload(manageClient, path, payload);
-                logger.info(format("Updated %s at %s", label, path));
+                return updateResource(payload, resourceId);
             } else {
                 logger.info("Resource already exists and updates are not supported, so not updating: " + resourceId);
             }
@@ -75,6 +74,24 @@ public SaveReceipt save(String payload) {
         return new SaveReceipt(resourceId, payload, path, response);
     }
 
+    /**
+     * Most clients should just use the save method, but this is public for scenarios where a client knows an update
+     * should be performed.
+     * 
+     * @param payload
+     * @param resourceId
+     * @return
+     */
+    public SaveReceipt updateResource(String payload, String resourceId) {
+        String path = getPropertiesPath(resourceId);
+        String label = getResourceName();
+        path = appendParamsAndValuesToPath(path, getUpdateResourceParams(payload));
+        logger.info(format("Found %s with name of %s, so updating at path %s", label, resourceId, path));
+        ResponseEntity<String> response = putPayload(manageClient, path, payload);
+        logger.info(format("Updated %s at %s", label, path));
+        return new SaveReceipt(resourceId, payload, path, response);
+    }
+
     protected String getCreateResourcePath(String payload) {
         return getResourcesPath();
     }
@@ -87,25 +104,28 @@ public boolean deleteByIdField(String resourceIdFieldValue) {
 
     public boolean delete(String payload) {
         String resourceId = getResourceId(payload);
-        String label = getResourceName();
         if (!exists(resourceId)) {
-            logger.info(format("Could not find %s with name or ID of %s, so not deleting", label, resourceId));
+            logger.info(format("Could not find %s with name or ID of %s, so not deleting", getResourceName(), resourceId));
             return false;
         } else {
             String path = getResourcePath(resourceId);
             path = appendParamsAndValuesToPath(path, getDeleteResourceParams(payload));
-
-            logger.info(format("Deleting %s at path %s", label, path));
-            if (useAdminUser()) {
-                manageClient.deleteAsAdmin(path);
-            } else {
-                manageClient.delete(path);
-            }
-            logger.info(format("Deleted %s at path %s", label, path));
+            deleteAtPath(path);
             return true;
         }
     }
 
+    public void deleteAtPath(String path) {
+        String label = getResourceName();
+        logger.info(format("Deleting %s at path %s", label, path));
+        if (useAdminUser()) {
+            manageClient.deleteAsAdmin(path);
+        } else {
+            manageClient.delete(path);
+        }
+        logger.info(format("Deleted %s at path %s", label, path));
+    }
+
     protected String appendParamsAndValuesToPath(String path, String... paramsAndValues) {
         if (paramsAndValues.length > 0) {
             path += "?";

src/main/java/com/rjrudin/marklogic/mgmt/ManageClient.java

@@ -63,62 +63,47 @@ public void initialize(ManageConfig config) {
     }
 
     public ResponseEntity<String> putJson(String path, String json) {
+        logRequest(path, "JSON", "PUT");
         return restTemplate.exchange(baseUrl + path, HttpMethod.PUT, buildJsonEntity(json), String.class);
     }
 
     public ResponseEntity<String> putJsonAsAdmin(String path, String json) {
-        if (logger.isDebugEnabled()) {
-            logger.debug("Sending JSON PUT request as user with MarkLogic admin role");
-        }
+        logAdminRequest(path, "JSON", "PUT");
         return adminRestTemplate.exchange(baseUrl + path, HttpMethod.PUT, buildJsonEntity(json), String.class);
     }
 
     public ResponseEntity<String> putXml(String path, String xml) {
+        logRequest(path, "XML", "PUT");
         return restTemplate.exchange(baseUrl + path, HttpMethod.PUT, buildXmlEntity(xml), String.class);
     }
 
     public ResponseEntity<String> putXmlAsAdmin(String path, String xml) {
-        if (logger.isDebugEnabled()) {
-            logger.debug("Sending XML PUT request as user with MarkLogic admin role");
-        }
+        logAdminRequest(path, "XML", "PUT");
         return adminRestTemplate.exchange(baseUrl + path, HttpMethod.PUT, buildXmlEntity(xml), String.class);
     }
 
     public ResponseEntity<String> postJson(String path, String json) {
+        logRequest(path, "JSON", "POST");
         return restTemplate.exchange(baseUrl + path, HttpMethod.POST, buildJsonEntity(json), String.class);
     }
 
     public ResponseEntity<String> postJsonAsAdmin(String path, String json) {
-        if (logger.isDebugEnabled()) {
-            logger.debug("Sending JSON POST request as user with MarkLogic admin role");
-        }
+        logAdminRequest(path, "JSON", "POST");
         return adminRestTemplate.exchange(baseUrl + path, HttpMethod.POST, buildJsonEntity(json), String.class);
     }
 
     public ResponseEntity<String> postXml(String path, String xml) {
+        logRequest(path, "XML", "POST");
         return restTemplate.exchange(baseUrl + path, HttpMethod.POST, buildXmlEntity(xml), String.class);
     }
 
     public ResponseEntity<String> postXmlAsAdmin(String path, String xml) {
-        if (logger.isDebugEnabled()) {
-            logger.debug("Sending XML POST request as user with MarkLogic admin role");
-        }
+        logAdminRequest(path, "XML", "POST");
         return adminRestTemplate.exchange(baseUrl + path, HttpMethod.POST, buildXmlEntity(xml), String.class);
     }
 
-    public HttpEntity<String> buildJsonEntity(String json) {
-        HttpHeaders headers = new HttpHeaders();
-        headers.setContentType(MediaType.APPLICATION_JSON);
-        return new HttpEntity<String>(json, headers);
-    }
-
-    public HttpEntity<String> buildXmlEntity(String xml) {
-        HttpHeaders headers = new HttpHeaders();
-        headers.setContentType(MediaType.APPLICATION_XML);
-        return new HttpEntity<String>(xml, headers);
-    }
-
     public ResponseEntity<String> postForm(String path, String... params) {
+        logRequest(path, "form", "POST");
         HttpHeaders headers = new HttpHeaders();
         headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
         MultiValueMap<String, String> map = new LinkedMultiValueMap<String, String>();
@@ -130,6 +115,7 @@ public ResponseEntity<String> postForm(String path, String... params) {
     }
 
     public Fragment getXml(String path, String... namespacePrefixesAndUris) {
+        logRequest(path, "XML", "GET");
         String xml = getRestTemplate().getForObject(getBaseUrl() + path, String.class);
         List<Namespace> list = new ArrayList<Namespace>();
         for (int i = 0; i < namespacePrefixesAndUris.length; i += 2) {
@@ -139,9 +125,7 @@ public Fragment getXml(String path, String... namespacePrefixesAndUris) {
     }
 
     public Fragment getXmlAsAdmin(String path, String... namespacePrefixesAndUris) {
-        if (logger.isDebugEnabled()) {
-            logger.debug("Sending GET request as user with MarkLogic admin role");
-        }
+        logAdminRequest(path, "XML", "GET");
         String xml = getAdminRestTemplate().getForObject(getBaseUrl() + path, String.class);
         List<Namespace> list = new ArrayList<Namespace>();
         for (int i = 0; i < namespacePrefixesAndUris.length; i += 2) {
@@ -151,16 +135,41 @@ public Fragment getXmlAsAdmin(String path, String... namespacePrefixesAndUris) {
     }
 
     public void delete(String path) {
+        logRequest(path, "", "DELETE");
         restTemplate.delete(baseUrl + path);
     }
 
     public void deleteAsAdmin(String path) {
-        if (logger.isDebugEnabled()) {
-            logger.debug("Sending DELETE request as user with MarkLogic admin role");
-        }
+        logAdminRequest(path, "", "DELETE");
         adminRestTemplate.delete(baseUrl + path);
     }
 
+    public HttpEntity<String> buildJsonEntity(String json) {
+        HttpHeaders headers = new HttpHeaders();
+        headers.setContentType(MediaType.APPLICATION_JSON);
+        return new HttpEntity<String>(json, headers);
+    }
+
+    public HttpEntity<String> buildXmlEntity(String xml) {
+        HttpHeaders headers = new HttpHeaders();
+        headers.setContentType(MediaType.APPLICATION_XML);
+        return new HttpEntity<String>(xml, headers);
+    }
+
+    protected void logRequest(String path, String contentType, String method) {
+        if (logger.isInfoEnabled()) {
+            logger.info(String.format("Sending %s %s request as user '%s' to path: %s", contentType, method,
+                    manageConfig.getUsername(), path));
+        }
+    }
+
+    protected void logAdminRequest(String path, String contentType, String method) {
+        if (logger.isInfoEnabled()) {
+            logger.info(String.format("Sending %s %s request as user with admin role '%s' to path: %s", contentType,
+                    method, manageConfig.getUsername(), path));
+        }
+    }
+
     public RestTemplate getRestTemplate() {
         return restTemplate;
     }

src/main/java/com/rjrudin/marklogic/mgmt/ManageConfig.java

@@ -26,6 +26,42 @@ public ManageConfig(String host, int port, String username, String password) {
         setAdminPassword(password);
     }
 
+    /**
+     * Convenience method for building a new instance from the following system properties: mlManageHost, mlManagePort,
+     * mlManageUsername, mlManagePassword, mlAdminUsername, and mlAdminPassword. First created to assist with groovysh
+     * integration.
+     * 
+     * @return
+     */
+    public static ManageConfig buildFromSystemProps() {
+        ManageConfig c = new ManageConfig();
+        String prop = System.getProperty("mlManageHost");
+        if (prop != null) {
+            c.setHost(prop);
+        }
+        prop = System.getProperty("mlManagePort");
+        if (prop != null) {
+            c.setPort(Integer.parseInt(prop));
+        }
+        prop = System.getProperty("mlManageUsername");
+        if (prop != null) {
+            c.setUsername(prop);
+        }
+        prop = System.getProperty("mlManagePassword");
+        if (prop != null) {
+            c.setPassword(prop);
+        }
+        prop = System.getProperty("mlAdminUsername");
+        if (prop != null) {
+            c.setAdminUsername(prop);
+        }
+        prop = System.getProperty("mlAdminPassword");
+        if (prop != null) {
+            c.setAdminPassword(prop);
+        }
+        return c;
+    }
+
     public String getAdminUsername() {
         return adminUsername;
     }

src/main/java/com/rjrudin/marklogic/mgmt/alert/AlertConfigManager.java

@@ -45,8 +45,19 @@ public SaveReceipt save(String payload) {
             if (logger.isInfoEnabled()) {
                 logger.info("Immediately updating alert config after it's been created to ensure that CPF domains are set");
             }
-            super.save(payload);
+            // Calling updateResource instead of save to avoid any chance of an infinite loop
+            return super.updateResource(payload, getResourceId(payload));
         }
         return receipt;
     }
+
+    /**
+     * Deletes all alert configs, which will also delete all actions and rules associated with each config (this is
+     * contrary to deleting a flexrep config, where the associated targets must first be deleted).
+     */
+    public void deleteAllConfigs() {
+        for (String nameref : getAsXml().getListItemNameRefs()) {
+            deleteByIdField(nameref);
+        }
+    }
 }

src/main/java/com/rjrudin/marklogic/mgmt/databases/DatabaseManager.java

@@ -19,8 +19,12 @@ public DatabaseManager(ManageClient manageClient) {
     public void clearDatabase(String databaseIdOrName) {
         String path = format("/manage/v2/databases/%s", databaseIdOrName);
         logger.info(format("Clearing database %s", databaseIdOrName));
-        getManageClient().postJson(path, "{\"operation\":\"clear-database\"}");
-        logger.info(format("Cleared database %s", databaseIdOrName));
+        try {
+            getManageClient().postJson(path, "{\"operation\":\"clear-database\"}");
+            logger.info(format("Cleared database %s", databaseIdOrName));
+        } catch (Exception e) {
+            logger.error("Unable to clear database; cause: " + e.getMessage());
+        }
     }
 
     public void deleteByName(String databaseName) {

src/main/java/com/rjrudin/marklogic/mgmt/flexrep/ConfigManager.java

@@ -22,4 +22,16 @@ protected String getIdFieldName() {
         return "domain-name";
     }
 
+    /**
+     * Iterate over every config and delete all the targets first, then delete the config.
+     */
+    public void deleteAllConfigs() {
+        for (String nameref : getAsXml().getListItemNameRefs()) {
+            TargetManager mgr = new TargetManager(getManageClient(), this.databaseIdOrName, nameref);
+            for (String idref : mgr.getAsXml().getListItemIdRefs()) {
+                mgr.deleteByIdField(idref);
+            }
+            deleteByIdField(nameref);
+        }
+    }
 }

src/main/java/com/rjrudin/marklogic/mgmt/tasks/TaskManager.java

@@ -65,7 +65,17 @@ public boolean exists(String resourceNameOrId) {
                 resourceNameOrId));
     }
 
+    public void deleteAllScheduledTasks() {
+        for (String id : getAsXml().getListItemIdRefs()) {
+            deleteAtPath(getResourcesPath() + "/" + id + "?group-id=" + groupName);
+        }
+    }
+
     public void setGroupName(String groupName) {
         this.groupName = groupName;
     }
+
+    public String getGroupName() {
+        return groupName;
+    }
 }

src/main/java/com/rjrudin/marklogic/rest/util/ResourcesFragment.java

@@ -1,5 +1,7 @@
 package com.rjrudin.marklogic.rest.util;
 
+import java.util.List;
+
 import org.jdom2.Namespace;
 
 /**
@@ -37,4 +39,17 @@ public String getListItemValue(String resourceIdOrName, String elementLocalName)
         xpath = String.format(xpath, resourceIdOrName, resourceIdOrName, elementLocalName);
         return getElementValue(xpath);
     }
+
+    public List<String> getListItemIdRefs() {
+        return getListItemValues("idref");
+    }
+
+    public List<String> getListItemNameRefs() {
+        return getListItemValues("nameref");
+    }
+
+    public List<String> getListItemValues(String elementName) {
+        String xpath = "/node()/*[local-name(.) = 'list-items']/node()/*[local-name(.) = '%s']";
+        return getElementValues(String.format(xpath, elementName));
+    }
 }