feat(engine): add support for externallyTerminated for modification

Related to CAM-11131
meiti · Dec 2, 2019 · bcc42f3 · bcc42f3
1 parent 8bf3d8b
commit bcc42f3
Show file tree

Hide file tree

Showing 3 changed files with 79 additions and 0 deletions.
diff --git a/engine/src/main/java/org/camunda/bpm/engine/impl/ProcessInstanceModificationBuilderImpl.java b/engine/src/main/java/org/camunda/bpm/engine/impl/ProcessInstanceModificationBuilderImpl.java
@@ -93,6 +93,7 @@ public ProcessInstanceModificationBuilder cancelActivityInstance(String activity
     return cancelActivityInstance(activityInstanceId, false);
   }
 
+  @Override
   public ProcessInstanceModificationBuilder cancelActivityInstance(String activityInstanceId, boolean externallyTerminated) {
     ensureNotNull(NotValidException.class, "activityInstanceId", activityInstanceId);
     this.externallyTerminated = externallyTerminated;

diff --git a/engine/src/main/java/org/camunda/bpm/engine/runtime/ProcessInstanceModificationBuilder.java b/engine/src/main/java/org/camunda/bpm/engine/runtime/ProcessInstanceModificationBuilder.java
@@ -95,6 +95,23 @@ public interface ProcessInstanceModificationBuilder extends
    */
   ProcessInstanceModificationBuilder cancelActivityInstance(String activityInstanceId);
 
+  /**
+   * <p><i>Submits the instruction:</i></p>
+   *
+   * <p>Cancel an activity instance in a process. If this instance has child activity instances
+   * (e.g. in a subprocess instance), these children, their grandchildren, etc. are cancelled as well.</p>
+   *
+   * <p>Process instance cancellation will propagate upward, removing any parent process instances that are
+   * only waiting on the cancelled process to complete.</p>
+   * 
+   * <p>All canceled activity instances will be marked as terminated internally or externally to indicate if
+   * the cancelation was triggered from internal or external context. (internal = engine, external = e.g. API call)</p>
+   *
+   * @param activityInstanceId the id of the activity instance to cancel
+   * @param externallyTerminated indicator if deletion triggered from external context, for instance API call
+   */
+  ProcessInstanceModificationBuilder cancelActivityInstance(String activityInstanceId, boolean externallyTerminated);
+
   /**
    * <p><i>Submits the instruction:</i></p>
    *

diff --git a/...a/org/camunda/bpm/engine/test/api/runtime/ProcessInstanceTerminationCascadeStateTest.java b/...a/org/camunda/bpm/engine/test/api/runtime/ProcessInstanceTerminationCascadeStateTest.java
@@ -27,6 +27,7 @@
 import org.camunda.bpm.engine.RuntimeService;
 import org.camunda.bpm.engine.history.HistoricProcessInstance;
 import org.camunda.bpm.engine.repository.Deployment;
+import org.camunda.bpm.engine.runtime.ActivityInstance;
 import org.camunda.bpm.engine.runtime.ProcessInstance;
 import org.camunda.bpm.engine.test.ProcessEngineRule;
 import org.camunda.bpm.engine.test.RequiredHistoryLevel;
@@ -141,6 +142,66 @@ public void shouldNotCascadeStateFromProcessDownDeletion() {
     assertHistoricProcessInstances();
   }
 
+  @Test
+  public void shouldNotCascadeStateFromSubprocessUpCancelation() {
+    // given
+    runtimeService.startProcessInstanceByKey("process");
+    ProcessInstance subProcess = runtimeService.createProcessInstanceQuery().processDefinitionKey("subProcess").singleResult();
+    ActivityInstance activityInstance = runtimeService.getActivityInstance(subProcess.getId());
+    externallyTerminated = false;
+
+    // when
+    runtimeService.createProcessInstanceModification(subProcess.getId()).cancelActivityInstance(activityInstance.getId(), externallyTerminated).execute();
+
+    // then
+    assertHistoricProcessInstances();
+  }
+
+  @Test
+  public void shouldNotCascadeStateFromProcessDownCancelation() {
+    // given
+    runtimeService.startProcessInstanceByKey("process");
+    ProcessInstance process = runtimeService.createProcessInstanceQuery().processDefinitionKey("process").singleResult();
+    ActivityInstance activityInstance = runtimeService.getActivityInstance(process.getId());
+    externallyTerminated = false;
+
+    // when
+    runtimeService.createProcessInstanceModification(process.getId()).cancelActivityInstance(activityInstance.getId(), externallyTerminated).execute();
+
+    // then
+    assertHistoricProcessInstances();
+  }
+
+  @Test
+  public void shouldCascadeStateFromSubprocessUpCancelation() {
+    // given
+    runtimeService.startProcessInstanceByKey("process");
+    ProcessInstance subProcess = runtimeService.createProcessInstanceQuery().processDefinitionKey("subProcess").singleResult();
+    ActivityInstance activityInstance = runtimeService.getActivityInstance(subProcess.getId());
+    externallyTerminated = true;
+
+    // when
+    runtimeService.createProcessInstanceModification(subProcess.getId()).cancelActivityInstance(activityInstance.getId(), externallyTerminated).execute();
+
+    // then
+    assertHistoricProcessInstances();
+  }
+
+  @Test
+  public void shouldCascadeStateFromProcessDownCancelation() {
+    // given
+    runtimeService.startProcessInstanceByKey("process");
+    ProcessInstance process = runtimeService.createProcessInstanceQuery().processDefinitionKey("process").singleResult();
+    ActivityInstance activityInstance = runtimeService.getActivityInstance(process.getId());
+    externallyTerminated = true;
+
+    // when
+    runtimeService.createProcessInstanceModification(process.getId()).cancelActivityInstance(activityInstance.getId(), externallyTerminated).execute();
+
+    // then
+    assertHistoricProcessInstances();
+  }
+
   protected void assertHistoricProcessInstances() {
     List<HistoricProcessInstance> historicProcessInstances = historyService.createHistoricProcessInstanceQuery().list();
     assertThat(historicProcessInstances.size()).isEqualTo(2);