Part of ALF-4133 - running replication actions list webscript, plus tests

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@21678 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

config/alfresco/templates/webscripts/org/alfresco/repository/action/running-replication-actions.get.desc.xml

@@ -0,0 +1,10 @@
+<webscript>
+  <shortname>List Running Replication Actions</shortname>
+  <description>
+  Returns (limited) details on all currently running replication actions.
+  </description>
+  <url>/api/running-replication-actions?name={name?}</url>
+  <format default="json"/>
+  <authentication>admin</authentication>
+  <transaction allow="readonly">required</transaction>
+</webscript>

config/alfresco/templates/webscripts/org/alfresco/repository/action/running-replication-actions.get.json.ftl

@@ -0,0 +1,10 @@
+<#import "running-action.lib.ftl" as actionLib />
+{
+   "data": 
+   [
+      <#list runningActions as action>
+         <@actionLib.runningActionJSON action=action />
+         <#if action_has_next>,</#if>
+      </#list>
+   ]
+}

config/alfresco/web-scripts-application-context.xml

@@ -925,4 +925,11 @@
           parent="abstractActionWebScript">
     </bean>
 
+    <!-- Lists the running replication actions -->
+    <bean id="webscript.org.alfresco.repository.action.running-replication-actions.get"
+          class="org.alfresco.repo.web.scripts.action.RunningReplicationActionsGet"
+          parent="abstractActionWebScript">
+        <property name="replicationService" ref="ReplicationService" />
+    </bean>
+
 </beans>

source/java/org/alfresco/repo/web/scripts/action/RunningActionRestApiTest.java

@@ -24,6 +24,7 @@ import org.alfresco.model.ContentModel;
 import org.alfresco.repo.action.ActionImpl;
 import org.alfresco.repo.cache.EhCacheAdapter;
 import org.alfresco.repo.model.Repository;
+import org.alfresco.repo.replication.ReplicationDefinitionImpl;
 import org.alfresco.repo.security.authentication.AuthenticationUtil;
 import org.alfresco.repo.security.person.TestPersonManager;
 import org.alfresco.repo.web.scripts.BaseWebScriptTest;
@@ -58,7 +59,7 @@ public class RunningActionRestApiTest extends BaseWebScriptTest
 {
     private static final String URL_RUNNING_ACTION = "api/running-action/";
     private static final String URL_RUNNING_ACTIONS = "api/running-actions";
-    private static final String URL_RUNNING_REPLICATION_ACTIONS = "api/running-replication-actions/";
+    private static final String URL_RUNNING_REPLICATION_ACTIONS = "api/running-replication-actions";
     
     private static final String JSON = "application/json";
     
@@ -121,7 +122,7 @@ public class RunningActionRestApiTest extends BaseWebScriptTest
         JSONObject jsonRD = (JSONObject)results.get(0);
         assertNotNull(jsonRD);
         assertEquals(id, jsonRD.get("actionId"));
-        assertEquals("replicationActionExecutor", jsonRD.get("actionType"));
+        assertEquals(ReplicationDefinitionImpl.EXECUTOR_NAME, jsonRD.get("actionType"));
         assertEquals(instance, jsonRD.get("actionInstance"));
         assertEquals(rd.getNodeRef().toString(), jsonRD.get("actionNodeRef"));
         assertEquals(startedAt, jsonRD.get("startedAt"));
@@ -161,7 +162,7 @@ public class RunningActionRestApiTest extends BaseWebScriptTest
         jsonRD = (JSONObject)results.get(0);
         assertNotNull(jsonRD);
         assertEquals(id, jsonRD.get("actionId"));
-        assertEquals("replicationActionExecutor", jsonRD.get("actionType"));
+        assertEquals(ReplicationDefinitionImpl.EXECUTOR_NAME, jsonRD.get("actionType"));
         assertEquals(instance, jsonRD.get("actionInstance"));
         assertEquals(rd.getNodeRef().toString(), jsonRD.get("actionNodeRef"));
         assertEquals(startedAt, jsonRD.get("startedAt"));
@@ -263,7 +264,7 @@ public class RunningActionRestApiTest extends BaseWebScriptTest
         jsonRD = (JSONObject)results.get(0);
         assertNotNull(jsonRD);
         assertEquals(id, jsonRD.get("actionId"));
-        assertEquals("replicationActionExecutor", jsonRD.get("actionType"));
+        assertEquals(ReplicationDefinitionImpl.EXECUTOR_NAME, jsonRD.get("actionType"));
         assertEquals(instance, jsonRD.get("actionInstance"));
         assertEquals(rd.getNodeRef().toString(), jsonRD.get("actionNodeRef"));
         assertEquals(startedAt, jsonRD.get("startedAt"));
@@ -288,7 +289,7 @@ public class RunningActionRestApiTest extends BaseWebScriptTest
         jsonRD = (JSONObject)results.get(0);
         assertNotNull(jsonRD);
         assertEquals(id2, jsonRD.get("actionId"));
-        assertEquals("replicationActionExecutor", jsonRD.get("actionType"));
+        assertEquals(ReplicationDefinitionImpl.EXECUTOR_NAME, jsonRD.get("actionType"));
         assertEquals(instance2, jsonRD.get("actionInstance"));
         assertEquals(rd.getNodeRef().toString(), jsonRD.get("actionNodeRef"));
         assertEquals(startedAt2, jsonRD.get("startedAt"));
@@ -367,6 +368,222 @@ public class RunningActionRestApiTest extends BaseWebScriptTest
     }
     
     
+    public void testRunningReplicationActionsGet() throws Exception
+    {
+       Response response;
+       
+       
+       // Not allowed if you're not an admin
+       AuthenticationUtil.setFullyAuthenticatedUser(AuthenticationUtil.getGuestUserName());
+       response = sendRequest(new GetRequest(URL_RUNNING_REPLICATION_ACTIONS), Status.STATUS_UNAUTHORIZED);
+       assertEquals(Status.STATUS_UNAUTHORIZED, response.getStatus());
+       
+       AuthenticationUtil.setFullyAuthenticatedUser(USER_NORMAL);
+       response = sendRequest(new GetRequest(URL_RUNNING_REPLICATION_ACTIONS), Status.STATUS_UNAUTHORIZED);
+       assertEquals(Status.STATUS_UNAUTHORIZED, response.getStatus());
+       
+      
+       // If nothing running, you don't get anything back
+       AuthenticationUtil.setFullyAuthenticatedUser(AuthenticationUtil.getAdminUserName());
+       response = sendRequest(new GetRequest(URL_RUNNING_REPLICATION_ACTIONS), 200);
+       assertEquals(Status.STATUS_OK, response.getStatus());
+       
+       String jsonStr = response.getContentAsString();
+       JSONObject json = new JSONObject(jsonStr);
+       JSONArray results = json.getJSONArray("data");
+       assertNotNull(results);
+       assertEquals(0, results.length());
+
+       
+       // Add a running action, it should show up
+       ReplicationDefinition rd = replicationService.createReplicationDefinition("Test1", "Testing");
+       replicationService.saveReplicationDefinition(rd);
+       actionTrackingService.recordActionExecuting(rd);
+       String id = rd.getId();
+       String instance = Integer.toString( ((ActionImpl)rd).getExecutionInstance() );
+       String startedAt = ISO8601DateFormat.format(rd.getExecutionStartDate()); 
+       
+       response = sendRequest(new GetRequest(URL_RUNNING_REPLICATION_ACTIONS), 200);
+       assertEquals(Status.STATUS_OK, response.getStatus());
+       
+       jsonStr = response.getContentAsString();
+       json = new JSONObject(jsonStr);
+       results = json.getJSONArray("data");
+       assertNotNull(results);
+       assertEquals(1, results.length());
+       
+       JSONObject jsonRD = (JSONObject)results.get(0);
+       assertNotNull(jsonRD);
+       assertEquals(id, jsonRD.get("actionId"));
+       assertEquals(ReplicationDefinitionImpl.EXECUTOR_NAME, jsonRD.get("actionType"));
+       assertEquals(instance, jsonRD.get("actionInstance"));
+       assertEquals(rd.getNodeRef().toString(), jsonRD.get("actionNodeRef"));
+       assertEquals(startedAt, jsonRD.get("startedAt"));
+       assertEquals(false, jsonRD.getBoolean("cancelRequested"));
+       assertEquals("/" + URL_RUNNING_ACTION + "replicationActionExecutor=" +
+             id + "=" + instance, jsonRD.get("details"));
+       
+       
+       // Ensure we didn't get any unexpected data back,
+       //  only the keys we should have done
+       JSONArray keys = jsonRD.names();
+       for(int i=0; i<keys.length(); i++) {
+          String key = keys.getString(0);
+          if(key.equals("actionId") || key.equals("actionType") ||
+              key.equals("actionInstance") || key.equals("actionNodeRef") ||
+              key.equals("startedAt") || key.equals("cancelRequested") ||
+              key.equals("details")) {
+             // All good
+          } else {
+             fail("Unexpected key '"+key+"' found in json, raw json is\n" + jsonStr);
+          }
+       }
+       
+       
+       // Change the status to pending cancel, and re-check
+       actionTrackingService.requestActionCancellation(rd);
+       
+       response = sendRequest(new GetRequest(URL_RUNNING_REPLICATION_ACTIONS), 200);
+       assertEquals(Status.STATUS_OK, response.getStatus());
+       
+       jsonStr = response.getContentAsString();
+       json = new JSONObject(jsonStr);
+       results = json.getJSONArray("data");
+       assertNotNull(results);
+       assertEquals(1, results.length());
+       
+       jsonRD = (JSONObject)results.get(0);
+       assertNotNull(jsonRD);
+       assertEquals(id, jsonRD.get("actionId"));
+       assertEquals(ReplicationDefinitionImpl.EXECUTOR_NAME, jsonRD.get("actionType"));
+       assertEquals(instance, jsonRD.get("actionInstance"));
+       assertEquals(rd.getNodeRef().toString(), jsonRD.get("actionNodeRef"));
+       assertEquals(startedAt, jsonRD.get("startedAt"));
+       assertEquals(true, jsonRD.getBoolean("cancelRequested"));
+       assertEquals("/" + URL_RUNNING_ACTION + "replicationActionExecutor=" +
+             id + "=" + instance, jsonRD.get("details"));
+       
+      
+       // Add a 2nd and 3rd
+       rd = replicationService.createReplicationDefinition("Test2", "2nd Testing");
+       replicationService.saveReplicationDefinition(rd);
+       actionTrackingService.recordActionExecuting(rd);
+       String id2 = rd.getId();
+       String instance2 = Integer.toString( ((ActionImpl)rd).getExecutionInstance() );
+       String startedAt2 = ISO8601DateFormat.format(rd.getExecutionStartDate()); 
+       
+       rd = replicationService.createReplicationDefinition("AnotherTest", "3rd Testing");
+       replicationService.saveReplicationDefinition(rd);
+       actionTrackingService.recordActionExecuting(rd);
+       String id3 = rd.getId();
+
+       
+       // Check we got all 3
+       boolean has1 = false;
+       boolean has2 = false;
+       boolean has3 = false;
+
+       response = sendRequest(new GetRequest(URL_RUNNING_REPLICATION_ACTIONS), 200);
+       assertEquals(Status.STATUS_OK, response.getStatus());
+       
+       jsonStr = response.getContentAsString();
+       json = new JSONObject(jsonStr);
+       results = json.getJSONArray("data");
+       assertNotNull(results);
+       assertEquals(3, results.length());
+       
+       for(int i=0; i<3; i++) {
+          jsonRD = (JSONObject)results.get(i);
+          if(jsonRD.get("actionId").equals(id)) {
+             has1 = true;
+          }
+          if(jsonRD.get("actionId").equals(id2)) {
+             has2 = true;
+          }
+          if(jsonRD.get("actionId").equals(id3)) {
+             has3 = true;
+          }
+       }
+       assertTrue(has1);
+       assertTrue(has2);
+       assertTrue(has3);
+       
+       
+       // Remove one, check it goes
+       actionTrackingService.recordActionComplete(rd);
+       has1 = false;
+       has2 = false;
+       has3 = false;
+       
+       response = sendRequest(new GetRequest(URL_RUNNING_REPLICATION_ACTIONS), 200);
+       assertEquals(Status.STATUS_OK, response.getStatus());
+       
+       jsonStr = response.getContentAsString();
+       json = new JSONObject(jsonStr);
+       results = json.getJSONArray("data");
+       assertNotNull(results);
+       assertEquals(2, results.length());
+       
+       for(int i=0; i<2; i++) {
+          jsonRD = (JSONObject)results.get(i);
+          if(jsonRD.get("actionId").equals(id)) {
+             has1 = true;
+          }
+          if(jsonRD.get("actionId").equals(id2)) {
+             has2 = true;
+          }
+          if(jsonRD.get("actionId").equals(id3)) {
+             has3 = true;
+          }
+       }
+       assertTrue(has1);
+       assertTrue(has2);
+       assertFalse(has3);
+
+       
+       // Check we correctly filter by name
+       rd = replicationService.loadReplicationDefinition("Test1");
+       
+       response = sendRequest(new GetRequest(URL_RUNNING_REPLICATION_ACTIONS + "?name=Test1"), 200);
+       assertEquals(Status.STATUS_OK, response.getStatus());
+       
+       jsonStr = response.getContentAsString();
+       json = new JSONObject(jsonStr);
+       results = json.getJSONArray("data");
+       assertNotNull(results);
+       assertEquals(1, results.length());
+       
+       jsonRD = (JSONObject)results.get(0);
+       assertNotNull(jsonRD);
+       assertEquals(id, jsonRD.get("actionId"));
+       assertEquals(ReplicationDefinitionImpl.EXECUTOR_NAME, jsonRD.get("actionType"));
+       assertEquals(instance, jsonRD.get("actionInstance"));
+       assertEquals(rd.getNodeRef().toString(), jsonRD.get("actionNodeRef"));
+       assertEquals(startedAt, jsonRD.get("startedAt"));
+       assertEquals(true, jsonRD.getBoolean("cancelRequested"));
+       assertEquals("/" + URL_RUNNING_ACTION + "replicationActionExecutor=" +
+             id + "=" + instance, jsonRD.get("details"));
+       
+
+       // Check we correctly filter by type
+       ActionImpl alt1 = new ActionImpl(null, "12345", "MadeUp1");
+       ActionImpl alt2 = new ActionImpl(null, "54321", "MadeUp2");
+       actionTrackingService.recordActionExecuting(alt1);
+       actionTrackingService.recordActionExecuting(alt2);
+       String startAtAlt2 = ISO8601DateFormat.format( alt2.getExecutionStartDate() );
+       String instanceAlt2 = Integer.toString( alt2.getExecutionInstance() );
+       
+       // 2 replication actions
+       response = sendRequest(new GetRequest(URL_RUNNING_REPLICATION_ACTIONS), 200);
+       assertEquals(Status.STATUS_OK, response.getStatus());
+       jsonStr = response.getContentAsString();
+       json = new JSONObject(jsonStr);
+       results = json.getJSONArray("data");
+       assertNotNull(results);
+       assertEquals(2, results.length());
+    }
+    
+    
     public void testRunningActionGet() throws Exception
     {
         Response response;
@@ -406,7 +623,7 @@ public class RunningActionRestApiTest extends BaseWebScriptTest
         JSONObject jsonRD = new JSONObject(jsonStr);
         assertNotNull(jsonRD);
         assertEquals(id, jsonRD.get("actionId"));
-        assertEquals("replicationActionExecutor", jsonRD.get("actionType"));
+        assertEquals(ReplicationDefinitionImpl.EXECUTOR_NAME, jsonRD.get("actionType"));
         assertEquals(instance, jsonRD.get("actionInstance"));
         assertEquals(rd.getNodeRef().toString(), jsonRD.get("actionNodeRef"));
         assertEquals(startedAt, jsonRD.get("startedAt"));
@@ -448,7 +665,7 @@ public class RunningActionRestApiTest extends BaseWebScriptTest
         jsonRD = new JSONObject(jsonStr);
         assertNotNull(jsonRD);
         assertEquals(id2, jsonRD.get("actionId"));
-        assertEquals("replicationActionExecutor", jsonRD.get("actionType"));
+        assertEquals(ReplicationDefinitionImpl.EXECUTOR_NAME, jsonRD.get("actionType"));
         assertEquals(instance2, jsonRD.get("actionInstance"));
         assertEquals(rd.getNodeRef().toString(), jsonRD.get("actionNodeRef"));
         assertEquals(startedAt2, jsonRD.get("startedAt"));
@@ -465,7 +682,7 @@ public class RunningActionRestApiTest extends BaseWebScriptTest
         jsonRD = new JSONObject(jsonStr);
         assertNotNull(jsonRD);
         assertEquals(id, jsonRD.get("actionId"));
-        assertEquals("replicationActionExecutor", jsonRD.get("actionType"));
+        assertEquals(ReplicationDefinitionImpl.EXECUTOR_NAME, jsonRD.get("actionType"));
         assertEquals(instance, jsonRD.get("actionInstance"));
         assertEquals(rd.getNodeRef().toString(), jsonRD.get("actionNodeRef"));
         assertEquals(startedAt, jsonRD.get("startedAt"));

source/java/org/alfresco/repo/web/scripts/action/RunningReplicationActionsGet.java

@@ -0,0 +1,74 @@
+/*
+ * Copyright (C) 2005-2010 Alfresco Software Limited.
+ *
+ * This file is part of Alfresco
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.alfresco.repo.web.scripts.action;
+
+import java.util.List;
+import java.util.Map;
+
+import org.alfresco.repo.replication.ReplicationDefinitionImpl;
+import org.alfresco.service.cmr.action.Action;
+import org.alfresco.service.cmr.action.ExecutionSummary;
+import org.alfresco.service.cmr.replication.ReplicationDefinition;
+import org.alfresco.service.cmr.replication.ReplicationService;
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.springframework.extensions.webscripts.Cache;
+import org.springframework.extensions.webscripts.Status;
+import org.springframework.extensions.webscripts.WebScriptRequest;
+
+/**
+ * @author Nick Burch
+ * @since 3.4
+ */
+public class RunningReplicationActionsGet extends AbstractActionWebscript
+{
+   private ReplicationService replicationService;
+   
+   @Override
+   protected Map<String, Object> buildModel(
+         RunningActionModelBuilder modelBuilder, WebScriptRequest req,
+         Status status, Cache cache) {
+      List<ExecutionSummary> actions = null;
+      
+      // Do they want all replication actions, or only certain ones?
+      String name = req.getParameter("name");
+      
+      if(name != null) {
+         // Try to find a replication definition with this name
+         ReplicationDefinition rd = replicationService.loadReplicationDefinition(name);
+         
+         // Look up what's running
+         if(rd != null) {
+            actions = actionTrackingService.getExecutingActions(rd);
+         }
+      } else {
+         // All replication actions
+         actions = actionTrackingService.getExecutingActions(
+               ReplicationDefinitionImpl.EXECUTOR_NAME
+         );
+      }
+      
+      // Build the model list
+      return modelBuilder.buildSimpleList(actions);
+   }
+
+   public void setReplicationService(ReplicationService replicationService) 
+   {
+      this.replicationService = replicationService;
+   }
+}