Skip to content

workflow-testing.md

Latest commit

 

History

History
65 lines (47 loc) · 2.56 KB

workflow-testing.md

File metadata and controls

65 lines (47 loc) · 2.56 KB
Raw

Workflow test harness

WorkflowTestRunner downloads and starts a real Conductor server, then registers annotated workers and workflow metadata against it. It is an integration-test harness, not a mock-only unit-test framework.

Use it to verify input/output wiring, dynamic branches, and worker behavior without managing a separate server process. Test retry policy separately with a concrete SIMPLE task definition; older server versions do not apply the resolved worker task's retry policy through a DYNAMIC wrapper.

JUnit setup

The maintained SDK test currently exercises Conductor 3.21.23.

import com.netflix.conductor.sdk.testing.WorkflowTestRunner;
import com.netflix.conductor.sdk.workflow.executor.WorkflowExecutor;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;

class QuoteWorkflowTest {
    private static WorkflowTestRunner testRunner;
    private static WorkflowExecutor executor;

    @BeforeAll
    static void startServer() throws Exception {
        testRunner = new WorkflowTestRunner(8096, "3.21.23");
        testRunner.init("com.example.workflowtests");
        executor = testRunner.getWorkflowExecutor();
        executor.loadTaskDefs("/tasks.json");
        executor.loadWorkflowDefs("/quote_workflow.json");
    }

    @AfterAll
    static void stopServer() {
        testRunner.shutdown();
    }
}

The package passed to init must contain public @WorkerTask methods. The JSON files are classpath resources.

Execute and assert

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;

import java.util.Map;

import com.netflix.conductor.common.run.Workflow;

Workflow workflow = executor.executeWorkflow(
        "quote_workflow", 1, Map.of("name", "personA", "amount", 1_000_000))
        .get();

assertNotNull(workflow);
assertEquals(Workflow.WorkflowStatus.COMPLETED, workflow.getStatus());
assertNotNull(workflow.getOutput());

The full maintained example is WorkflowTestFrameworkTests. Its dynamic-task path and missing-input failure path are run in this repository's test suite.

What to cover

  • Missing or invalid inputs produce the expected workflow status.
  • Retryable workers are invoked again and terminal failures are not retried.
  • SWITCH, dynamic-task, and fork/join paths select the intended branch.
  • Workflow outputs contain the contract your callers depend on.