adding IT test

Author: salaboy

sdk-tests/src/test/java/io/dapr/it/testcontainers/workflows/DaprWorkflowsIT.java

@@ -20,6 +20,7 @@
 import io.dapr.testcontainers.DaprLogLevel;
 import io.dapr.workflows.client.DaprWorkflowClient;
 import io.dapr.workflows.client.WorkflowInstanceStatus;
+import io.dapr.workflows.client.WorkflowRuntimeStatus;
 import io.dapr.workflows.runtime.WorkflowRuntime;
 import io.dapr.workflows.runtime.WorkflowRuntimeBuilder;
 import org.junit.jupiter.api.BeforeEach;
@@ -117,6 +118,36 @@ public void testWorkflows() throws Exception {
     assertEquals(instanceId, workflowOutput.getWorkflowId());
   }
 
+  @Test
+  public void testSuspendAndResumeWorkflows() throws Exception {
+    TestWorkflowPayload payload = new TestWorkflowPayload(new ArrayList<>());
+    String instanceId = workflowClient.scheduleNewWorkflow(TestWorkflow.class, payload);
+    workflowClient.waitForInstanceStart(instanceId, Duration.ofSeconds(10), false);
+
+    workflowClient.suspendWorkflow(instanceId, "testing suspend.");
+
+
+    WorkflowInstanceStatus instanceState = workflowClient.getInstanceState(instanceId, false);
+    assertNotNull(instanceState);
+    assertEquals(WorkflowRuntimeStatus.SUSPENDED, instanceState.getRuntimeStatus());
+
+    workflowClient.resumeWorkflow(instanceId, "testing resume");
+
+    instanceState = workflowClient.getInstanceState(instanceId, false);
+    assertNotNull(instanceState);
+    assertEquals(WorkflowRuntimeStatus.RUNNING, instanceState.getRuntimeStatus());
+
+    workflowClient.raiseEvent(instanceId, "MoveForward", payload);
+
+    Duration timeout = Duration.ofSeconds(10);
+    instanceState = workflowClient.waitForInstanceCompletion(instanceId, timeout, true);
+
+    assertNotNull(instanceState);
+    assertEquals(WorkflowRuntimeStatus.COMPLETED, instanceState.getRuntimeStatus());
+
+  }
+
+
   private TestWorkflowPayload deserialize(String value) throws JsonProcessingException {
     return OBJECT_MAPPER.readValue(value, TestWorkflowPayload.class);
   }

sdk-workflows/src/main/java/io/dapr/workflows/client/DaprWorkflowClient.java

@@ -129,6 +129,26 @@ public <T extends Workflow> String scheduleNewWorkflow(Class<T> clazz, NewWorkfl
         orchestrationInstanceOptions);
   }
 
+  /**
+   * Suspend the workflow associated with the provided instance id.
+   *
+   * @param workflowInstanceId Workflow instance id to suspend.
+   * @param reason             reason for suspending the workflow instance.
+   */
+  public void suspendWorkflow(String workflowInstanceId, @Nullable String reason) {
+    this.innerClient.suspendInstance(workflowInstanceId, reason);
+  }
+
+  /**
+   * Resume the workflow associated with the provided instance id.
+   *
+   * @param workflowInstanceId Workflow instance id to resume.
+   * @param reason             reason for resuming the workflow instance.
+   */
+  public void resumeWorkflow(String workflowInstanceId, @Nullable String reason) {
+    this.innerClient.resumeInstance(workflowInstanceId, reason);
+  }
+
   /**
    * Terminates the workflow associated with the provided instance id.
    *

sdk-workflows/src/test/java/io/dapr/workflows/client/DaprWorkflowClientTest.java

@@ -217,6 +217,17 @@ public void raiseEvent() {
         expectedEventName, expectedEventPayload);
   }
 
+  @Test
+  public void suspendResumeInstance() {
+    String expectedArgument = "TestWorkflowInstanceId";
+    client.suspendWorkflow(expectedArgument, "suspending workflow instance");
+    client.resumeWorkflow(expectedArgument, "resuming workflow instance");
+    verify(mockInnerClient, times(1)).suspendInstance(expectedArgument,
+            "suspending workflow instance");
+    verify(mockInnerClient, times(1)).resumeInstance(expectedArgument,
+            "resuming workflow instance");
+  }
+
   @Test
   public void purgeInstance() {
     String expectedArgument = "TestWorkflowInstanceId";

spring-boot-examples/workflows/src/main/java/io/dapr/springboot/examples/wfp/WorkflowPatternsRestController.java

@@ -24,6 +24,7 @@
 import io.dapr.springboot.examples.wfp.fanoutin.Result;
 import io.dapr.springboot.examples.wfp.remoteendpoint.Payload;
 import io.dapr.springboot.examples.wfp.remoteendpoint.RemoteEndpointWorkflow;
+import io.dapr.springboot.examples.wfp.suspendresume.SuspendResumeWorkflow;
 import io.dapr.workflows.client.DaprWorkflowClient;
 import io.dapr.workflows.client.WorkflowInstanceStatus;
 import org.slf4j.Logger;
@@ -153,4 +154,39 @@ public Payload remoteEndpoint(@RequestBody Payload payload)
     return workflowInstanceStatus.readOutputAs(Payload.class);
   }
 
+  @PostMapping("wfp/suspendresume")
+  public String suspendResume(@RequestParam("orderId") String orderId) {
+    String instanceId = daprWorkflowClient.scheduleNewWorkflow(SuspendResumeWorkflow.class);
+    logger.info("Workflow instance " + instanceId + " started");
+    ordersToApprove.put(orderId, instanceId);
+    return instanceId;
+  }
+
+  @PostMapping("wfp/suspendresume-suspend")
+  public String suspendResumeExecuteSuspend(@RequestParam("orderId") String orderId) {
+    String instanceId = ordersToApprove.get(orderId);
+    daprWorkflowClient.suspendWorkflow(instanceId, "testing suspend");
+    WorkflowInstanceStatus instanceState = daprWorkflowClient.getInstanceState(instanceId, false);
+    return instanceState.getRuntimeStatus().name();
+  }
+
+  @PostMapping("wfp/suspendresume-resume")
+  public String suspendResumeExecuteResume(@RequestParam("orderId") String orderId) {
+    String instanceId = ordersToApprove.get(orderId);
+    daprWorkflowClient.resumeWorkflow(instanceId, "testing resume");
+    WorkflowInstanceStatus instanceState = daprWorkflowClient.getInstanceState(instanceId, false);
+    return instanceState.getRuntimeStatus().name();
+  }
+
+
+  @PostMapping("wfp/suspendresume-continue")
+  public Decision suspendResumeContinue(@RequestParam("orderId") String orderId, @RequestParam("decision") Boolean decision)
+          throws TimeoutException {
+    String instanceId = ordersToApprove.get(orderId);
+    logger.info("Workflow instance " + instanceId + " continue");
+    daprWorkflowClient.raiseEvent(instanceId, "Approval", decision);
+    WorkflowInstanceStatus workflowInstanceStatus = daprWorkflowClient
+            .waitForInstanceCompletion(instanceId, null, true);
+    return workflowInstanceStatus.readOutputAs(Decision.class);
+  }
 }

spring-boot-examples/workflows/src/main/java/io/dapr/springboot/examples/wfp/suspendresume/PerformTaskActivity.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2023 The Dapr Authors
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package io.dapr.springboot.examples.wfp.suspendresume;
+
+import io.dapr.workflows.WorkflowActivity;
+import io.dapr.workflows.WorkflowActivityContext;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.stereotype.Component;
+
+import java.util.concurrent.TimeUnit;
+
+@Component
+public class PerformTaskActivity implements WorkflowActivity {
+  @Override
+  public Object run(WorkflowActivityContext ctx) {
+    Logger logger = LoggerFactory.getLogger(PerformTaskActivity.class);
+    logger.info("Starting Activity: " + ctx.getName());
+
+    logger.info("Running activity...");
+    //Sleeping for 5 seconds to simulate long running operation
+    try {
+      TimeUnit.SECONDS.sleep(5);
+    } catch (InterruptedException e) {
+      throw new RuntimeException(e);
+    }
+
+    logger.info("Completing activity...");
+
+    return "OK";
+  }
+}

spring-boot-examples/workflows/src/main/java/io/dapr/springboot/examples/wfp/suspendresume/SuspendResumeWorkflow.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2023 The Dapr Authors
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package io.dapr.springboot.examples.wfp.suspendresume;
+
+import io.dapr.springboot.examples.wfp.externalevent.Decision;
+import io.dapr.workflows.Workflow;
+import io.dapr.workflows.WorkflowStub;
+import org.springframework.stereotype.Component;
+
+@Component
+public class SuspendResumeWorkflow implements Workflow {
+  @Override
+  public WorkflowStub create() {
+    return ctx -> {
+      ctx.getLogger().info("Starting Workflow: " + ctx.getName());
+
+      ctx.callActivity(PerformTaskActivity.class.getName(), String.class).await();
+
+      ctx.getLogger().info("Waiting for approval...");
+      Boolean approved = ctx.waitForExternalEvent("Approval", boolean.class).await();
+
+      ctx.getLogger().info("approval-event arrived");
+
+      ctx.callActivity(PerformTaskActivity.class.getName(), String.class).await();
+
+      ctx.complete(new Decision(approved));
+    };
+  }
+}

spring-boot-examples/workflows/src/test/java/io/dapr/springboot/examples/wfp/WorkflowPatternsAppTests.java

@@ -13,10 +13,10 @@
 
 package io.dapr.springboot.examples.wfp;
 
-import io.dapr.client.DaprClient;
 import io.dapr.springboot.DaprAutoConfiguration;
 import io.dapr.springboot.examples.wfp.continueasnew.CleanUpLog;
 import io.dapr.springboot.examples.wfp.remoteendpoint.Payload;
+import io.dapr.workflows.client.WorkflowRuntimeStatus;
 import io.github.microcks.testcontainers.MicrocksContainersEnsemble;
 import io.restassured.RestAssured;
 import io.restassured.http.ContentType;
@@ -32,15 +32,13 @@
 import static org.hamcrest.CoreMatchers.containsString;
 import static org.hamcrest.Matchers.equalTo;
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
 
 @SpringBootTest(classes = {TestWorkflowPatternsApplication.class, DaprTestContainersConfig.class,
         DaprAutoConfiguration.class, },
         webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
 class WorkflowPatternsAppTests {
 
-  @Autowired
-  private DaprClient daprClient;
-
   @Autowired
   private MicrocksContainersEnsemble ensemble;
 
@@ -160,4 +158,47 @@ void testRemoteEndpoint() {
             .getServiceInvocationsCount("API Payload Processor", "1.0.0"));
   }
 
+  @Test
+  void testSuspendResume() {
+
+    String instanceId = given()
+            .queryParam("orderId", "123")
+            .when()
+            .post("/wfp/suspendresume")
+            .then()
+            .statusCode(200).extract().asString();
+
+    assertNotNull(instanceId);
+
+    // The workflow is waiting on an event, let's suspend the workflow
+    String state = given()
+            .queryParam("orderId", "123")
+            .when()
+            .post("/wfp/suspendresume-suspend")
+            .then()
+            .statusCode(200).extract().asString();
+
+    assertEquals(WorkflowRuntimeStatus.SUSPENDED.name(), state);
+
+    // The let's resume the suspended workflow and check the state
+    state = given()
+            .queryParam("orderId", "123")
+            .when()
+            .post("/wfp/suspendresume-resume")
+            .then()
+            .statusCode(200).extract().asString();
+
+    assertEquals(WorkflowRuntimeStatus.RUNNING.name(), state);
+
+    // Now complete the workflow by sending an event
+    given()
+            .queryParam("orderId", "123")
+            .queryParam("decision", false)
+            .when()
+            .post("/wfp/suspendresume-continue")
+            .then()
+            .statusCode(200).body("approved", equalTo(false));
+
+  }
+
 }