#311 Can now deploy and undeploy tasks with the same task-path

Author: rjrudin

src/main/java/com/marklogic/mgmt/api/task/Task.java

@@ -7,27 +7,63 @@
 import com.marklogic.mgmt.api.group.Group;
 import com.marklogic.mgmt.resource.tasks.TaskManager;
 
+import javax.xml.bind.annotation.*;
 import java.util.List;
 
+@XmlRootElement(name = "task-properties")
+@XmlAccessorType(XmlAccessType.FIELD)
 public class Task extends Resource {
 
+	@XmlElement(name = "group-name")
     private String groupName = Group.DEFAULT_GROUP_NAME;
 
+	@XmlElement(name = "task-id")
     private String taskId;
+
+	@XmlElement(name = "task-enabled")
     private Boolean taskEnabled;
+
+	@XmlElement(name = "task-path")
     private String taskPath;
+
+	@XmlElement(name = "task-root")
     private String taskRoot;
+
+	@XmlElement(name = "task-type")
     private String taskType;
+
+	@XmlElement(name = "task-period")
     private Integer taskPeriod;
+
+	@XmlElement(name = "task-month-day")
     private Integer taskMonthDay;
+
+	@XmlElementWrapper(name = "task-days")
+	@XmlElement(name = "task-day")
     private List<String> taskDay;
+
+	@XmlElement(name = "task-start-date")
     private String taskStartDate;
+
+	@XmlElement(name = "task-start-time")
     private String taskStartTime;
+
+	@XmlElement(name = "task-timestamp")
     private String taskTimestamp;
+
+	@XmlElement(name = "task-database")
     private String taskDatabase;
+
+	@XmlElement(name = "task-modules")
     private String taskModules;
+
+	@XmlElement(name = "task-user")
     private String taskUser;
+
+	@XmlElement(name = "task-host")
     private String taskHost;
+
+	@XmlElement(name = "task-priority")
     private String taskPriority;
 
     public Task() {

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

@@ -1,18 +1,16 @@
 package com.marklogic.mgmt.resource.tasks;
 
-import com.marklogic.mgmt.resource.AbstractResourceManager;
 import com.marklogic.mgmt.ManageClient;
+import com.marklogic.mgmt.SaveReceipt;
+import com.marklogic.mgmt.resource.AbstractResourceManager;
 import com.marklogic.mgmt.resource.requests.RequestManager;
 import com.marklogic.rest.util.Fragment;
 
 import java.util.ArrayList;
 import java.util.List;
 
 /**
- * A scheduled task doesn't have a name, and the ID is generated by ML, so this class assumes that task-path will be
- * unique and can thus be used as a way to find an existing task.
- *
- * Note that the "groupName" property of this class corresponds to the "group-id" querystring parameter. It's called
+ * The "groupName" property of this class corresponds to the "group-id" querystring parameter. It's called
  * "groupName" because "group-id" is misleading - it's a name, not an ID.
  */
 public class TaskManager extends AbstractResourceManager {
@@ -28,6 +26,32 @@ public TaskManager(ManageClient client, String groupName) {
 		this.groupName = groupName;
 	}
 
+	/**
+	 * Tasks are tricky because their unique field is "task-id", but that's generated by MarkLogic - it's not expected
+	 * to be in a payload. So this method has to do some extra work to determine what the task-id is for the given
+	 * payload. It does so by looking for an existing task with the same task-path and task-database as what's in the
+	 * given payload. If one exists, then the task-id from the existing task is used. Otherwise, null is returned.
+	 *
+	 * @param payload
+	 * @return
+	 */
+	@Override
+	protected String getResourceId(String payload) {
+		final String taskId = payloadParser.getPayloadFieldValue(payload, "task-id", false);
+		if (taskId != null) {
+			return taskId;
+		}
+
+		final String taskPath = payloadParser.getPayloadFieldValue(payload, "task-path");
+		final String taskDatabase = payloadParser.getPayloadFieldValue(payload, "task-database", false);
+
+		final String xpath = taskDatabase != null ?
+			format("/t:tasks-default-list/t:list-items/t:list-item[t:task-path = '%s' and t:task-database = '%s']/t:idref", taskPath, taskDatabase) :
+			format("/t:tasks-default-list/t:list-items/t:list-item[t:task-path = '%s']/t:idref", taskPath);
+
+		return getAsXml().getElementValue(xpath);
+	}
+
 	@Override
 	public String getResourcesPath() {
 		return appendGroupId(super.getResourcesPath());
@@ -58,30 +82,60 @@ protected String[] getUpdateResourceParams(String payload) {
 
 	@Override
 	protected String getIdFieldName() {
-		return "task-path";
-	}
-
-	public String getTaskIdForTaskPath(String taskPath) {
+		return "task-id";
+	}
+
+	/**
+	 * Previously, this method only accepted a task-path because that was previously used as the unique ID for a task.
+	 * But since two or more tasks can have the same task-path, this class now uses task-id. To preserve backwards
+	 * compatibility then, this method accepts a task-path or a task-id.
+	 *
+	 * @param taskPathOrTaskId
+	 * @return
+	 */
+	public String getTaskIdForTaskPath(String taskPathOrTaskId) {
 		Fragment f = getAsXml();
-		String xpath = "/node()/*[local-name(.) = 'list-items']/node()"
-			+ "[*[local-name(.) = 'task-path'] = '%s']/*[local-name(.) = 'idref']";
-		xpath = String.format(xpath, taskPath);
+		String xpath = "/t:tasks-default-list/t:list-items/t:list-item[t:task-path = '%s' or t:idref = '%s']/t:idref";
+		xpath = String.format(xpath, taskPathOrTaskId, taskPathOrTaskId);
 		String id = f.getElementValue(xpath);
 		if (id == null) {
-			throw new RuntimeException("Could not find a scheduled task with a task-path of: " + taskPath);
+			throw new RuntimeException("Could not find a scheduled task with a task-path or task-id of: " + taskPathOrTaskId);
 		}
 		return id;
 	}
 
+	/**
+	 * This accounts for an existing task with either task-path or task-id equal to the given resourceNameOrId.
+	 * This preserves backwards compatibility to when this class used task-path as the ID property.
+	 *
+	 * @param resourceNameOrId
+	 * @param resourceUrlParams
+	 * @return
+	 */
 	@Override
 	public boolean exists(String resourceNameOrId, String... resourceUrlParams) {
 		if (logger.isInfoEnabled()) {
 			logger.info("Checking for existence of resource: " + resourceNameOrId);
 		}
 		Fragment f = getAsXml();
 		return f.elementExists(format(
-			"/node()/*[local-name(.) = 'list-items']/node()[*[local-name(.) = 'task-path'] = '%s']",
-			resourceNameOrId));
+			"/t:tasks-default-list/t:list-items/t:list-item[t:task-path = '%s' or t:idref = '%s']",
+			resourceNameOrId, resourceNameOrId));
+	}
+
+	/**
+	 * When a task is being created, its resourceId - its task-id - will always be null because MarkLogic generates it.
+	 * This method only needs the resourceId for logging purposes. So it's overridden so that the task-path can be used
+	 * as the resourceId so that the logging is more useful.
+	 *
+	 * @param payload
+	 * @param resourceId
+	 * @return
+	 */
+	@Override
+	protected SaveReceipt createNewResource(String payload, String resourceId) {
+		final String taskPath = payloadParser.getPayloadFieldValue(payload, "task-path", false);
+		return super.createNewResource(payload, taskPath);
 	}
 
 	public List<String> getTaskPaths() {

src/test/java/com/marklogic/appdeployer/command/tasks/DeployTasksWithSamePathTest.java

@@ -0,0 +1,33 @@
+package com.marklogic.appdeployer.command.tasks;
+
+import com.marklogic.appdeployer.AbstractAppDeployerTest;
+import com.marklogic.mgmt.resource.tasks.TaskManager;
+import org.junit.Test;
+
+import java.io.File;
+
+public class DeployTasksWithSamePathTest extends AbstractAppDeployerTest {
+
+	@Test
+	public void test() {
+		appConfig.getFirstConfigDir().setBaseDir(new File("src/test/resources/sample-app/tasks-with-same-path"));
+		initializeAppDeployer(new DeployScheduledTasksCommand());
+
+		new TaskManager(manageClient).deleteAllScheduledTasks();
+
+		TaskManager taskManager = new TaskManager(manageClient);
+		final int initialTaskCount = taskManager.getAsXml().getResourceCount();
+
+		try {
+			deploySampleApp();
+			assertEquals("There should be 2 new tasks", initialTaskCount + 2, taskManager.getAsXml().getResourceCount());
+
+			deploySampleApp();
+			assertEquals("There should still be just 2 new tasks", initialTaskCount + 2, taskManager.getAsXml().getResourceCount());
+		} finally {
+			undeploySampleApp();
+
+			assertEquals("The 2 new tasks should have been deleted", initialTaskCount, taskManager.getAsXml().getResourceCount());
+		}
+	}
+}

src/test/resources/sample-app/tasks-with-same-path/tasks/task-1.json

@@ -0,0 +1,12 @@
+{
+   "task-enabled":true, 
+   "task-path":"/path/to/query.xqy",
+   "task-root":"/", 
+   "task-type":"weekly", 
+   "task-period":2, 
+   "task-day":["tuesday"], 
+   "task-start-time":"12:00:00", 
+   "task-database":"Documents",
+   "task-modules":"", 
+   "task-user":"nobody"
+}

src/test/resources/sample-app/tasks-with-same-path/tasks/task-2.json

@@ -0,0 +1,12 @@
+{
+   "task-enabled":true, 
+   "task-path":"/path/to/query.xqy",
+   "task-root":"/", 
+   "task-type":"weekly", 
+   "task-period":2, 
+   "task-day":["tuesday"], 
+   "task-start-time":"12:00:00", 
+   "task-database":"Modules",
+   "task-modules":"",
+   "task-user":"nobody"
+}