Back to Repositories

Testing Conductor SDK Workflow Operations in conductor-oss/conductor

This test suite demonstrates the implementation and validation of the Conductor SDK workflow functionality, focusing on workflow creation, execution, and task handling. The tests verify the core capabilities of the Conductor Java SDK for creating and managing workflows programmatically.

Test Coverage Overview

The test suite provides comprehensive coverage of the Conductor SDK workflow operations.

Key areas tested include:

Workflow creation and registration
Task execution and completion
Asynchronous workflow execution
Worker task implementation and annotation handling

Integration points cover the interaction between WorkflowExecutor, AnnotatedWorkerExecutor, and ConductorClient components.

Implementation Analysis

The testing approach utilizes JUnit Jupiter for test execution with asynchronous workflow validation. The implementation employs CompletableFuture for handling async operations and includes timeout mechanisms for workflow completion verification.

Key patterns include:

Builder pattern for workflow construction
Annotation-based worker task definition
Async execution with CompletableFuture
Assertion-based validation for workflow status

Technical Details

Testing tools and configuration:

JUnit Jupiter test framework
Conductor Java SDK client
TaskClient for worker execution
WorkerConfiguration for polling setup
ClientTestUtil for test client initialization
Custom worker task annotations

Best Practices Demonstrated

The test suite exemplifies several testing best practices for workflow validation.

Notable practices include:

Proper resource initialization and cleanup
Timeout handling for async operations
Clear separation of workflow definition and execution
Explicit assertion checking for workflow status
Proper error handling with try-catch blocks

conductor-oss/conductor

conductor-clients/java/conductor-java-sdk/tests/src/test/java/io/orkes/conductor/sdk/WorkflowSDKTests.java

            
/*
 * Copyright 2023 Conductor Authors.
 * <p>
 * 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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.orkes.conductor.sdk;

import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;

import com.netflix.conductor.client.http.ConductorClient;
import com.netflix.conductor.client.http.TaskClient;
import com.netflix.conductor.common.run.Workflow;
import com.netflix.conductor.sdk.workflow.def.ConductorWorkflow;
import com.netflix.conductor.sdk.workflow.def.tasks.SimpleTask;
import com.netflix.conductor.sdk.workflow.executor.WorkflowExecutor;
import com.netflix.conductor.sdk.workflow.executor.task.AnnotatedWorkerExecutor;
import com.netflix.conductor.sdk.workflow.executor.task.WorkerConfiguration;
import com.netflix.conductor.sdk.workflow.task.InputParam;
import com.netflix.conductor.sdk.workflow.task.WorkerTask;

import io.orkes.conductor.client.util.ClientTestUtil;


public class WorkflowSDKTests {

    @Test
    public void testCreateWorkflow() {
        ConductorClient client = ClientTestUtil.getClient();

        AnnotatedWorkerExecutor workerExecutor = new AnnotatedWorkerExecutor(new TaskClient(client), new WorkerConfiguration());
        workerExecutor.initWorkers("io.orkes.conductor.sdk");
        workerExecutor.startPolling();

        WorkflowExecutor executor = new WorkflowExecutor(client, workerExecutor);

        ConductorWorkflow<Map<String, String>> workflow = new ConductorWorkflow<>(executor);
        workflow.setName("sdk_workflow");
        workflow.setVersion(1);
        workflow.add(new SimpleTask("sdk_task", "sdk_task"));

        workflow.registerWorkflow(true, true);

        CompletableFuture<Workflow> result = workflow.execute(Map.of("name", "orkes"));
        Assertions.assertNotNull(result);
        try {
            Workflow executedWorkflow = result.get(3, TimeUnit.SECONDS);
            Assertions.assertNotNull(executedWorkflow);
            Assertions.assertEquals(Workflow.WorkflowStatus.COMPLETED, executedWorkflow.getStatus());
        } catch (InterruptedException | ExecutionException | TimeoutException e) {
            Assertions.fail(e.getMessage());
        }
    }

    @WorkerTask(value = "sdk_task", pollingInterval = 10)
    public String sdkTask(@InputParam("name") String name) {
        return "Hello " + name;
    }
}