Back to Repositories

Validating Sub-Workflow Execution Patterns in Conductor OSS

This test suite demonstrates the validation of sub-workflow executions within the Conductor OSS framework. It focuses on testing complex workflow scenarios involving nested workflows, dynamic task creation, and state verification.

Test Coverage Overview

The test suite provides comprehensive coverage of sub-workflow functionality in Conductor OSS.

Key areas tested include:

Sub-workflow registration and execution
Dynamic task creation and handling
Workflow state transitions and completion
Variable persistence and verification

Integration points cover workflow definition loading, metadata client interaction, and workflow execution verification.

Implementation Analysis

The testing approach utilizes JUnit Jupiter for assertion handling and implements a structured workflow testing pattern.

Technical implementation includes:

Mock task output configuration for dynamic tasks
Workflow definition loading from JSON files
Sub-workflow registration through metadata client
Workflow execution state validation

Technical Details

Testing tools and configuration:

JUnit Jupiter testing framework
AbstractWorkflowTests base class extension
WorkflowTestRequest for test configuration
WorkflowDef for workflow definitions
MetadataClient for workflow registration
Dynamic task reference mapping

Best Practices Demonstrated

The test implementation showcases several testing best practices in workflow validation.

Notable practices include:

Systematic task output mocking
Comprehensive state verification
Clear test organization and structure
Explicit assertion messages
Proper resource cleanup and management

conductor-oss/conductor

client/src/test/java/com/netflix/conductor/client/testing/SubWorkflowTest.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 com.netflix.conductor.client.testing;

import java.io.IOException;
import java.util.List;

import com.netflix.conductor.common.metadata.workflow.WorkflowDef;
import com.netflix.conductor.common.run.Workflow;
import com.netflix.conductor.common.run.WorkflowTestRequest;

import static org.junit.jupiter.api.Assertions.*;

/** Demonstrates how to test workflows that contain sub-workflows */
public class SubWorkflowTest extends AbstractWorkflowTests {

    // @Test
    // Tests are commented out since it requires a running server
    public void verifySubWorkflowExecutions() throws IOException {
        WorkflowDef def = getWorkflowDef("/workflows/kitchensink.json");
        assertNotNull(def);

        WorkflowDef subWorkflowDef = getWorkflowDef("/workflows/PopulationMinMax.json");
        metadataClient.registerWorkflowDef(subWorkflowDef);

        WorkflowTestRequest testRequest = getWorkflowTestRequest(def);

        // The following are the dynamic tasks which are not present in the workflow definition but
        // are created by dynamic fork
        testRequest
                .getTaskRefToMockOutput()
                .put("_x_test_worker_0_0", List.of(new WorkflowTestRequest.TaskMock()));
        testRequest
                .getTaskRefToMockOutput()
                .put("_x_test_worker_0_1", List.of(new WorkflowTestRequest.TaskMock()));
        testRequest
                .getTaskRefToMockOutput()
                .put("_x_test_worker_0_2", List.of(new WorkflowTestRequest.TaskMock()));
        testRequest
                .getTaskRefToMockOutput()
                .put("simple_task_1__1", List.of(new WorkflowTestRequest.TaskMock()));
        testRequest
                .getTaskRefToMockOutput()
                .put("simple_task_5", List.of(new WorkflowTestRequest.TaskMock()));

        Workflow execution = workflowClient.testWorkflow(testRequest);
        assertNotNull(execution);

        // Verfiy that the workflow COMPLETES
        assertEquals(Workflow.WorkflowStatus.COMPLETED, execution.getStatus());

        // That the workflow executes a wait task
        assertTrue(
                execution.getTasks().stream()
                        .anyMatch(t -> t.getReferenceTaskName().equals("wait")));

        // That the call_made variable was set to True
        assertEquals(true, execution.getVariables().get("call_made"));

        // Total number of tasks executed are 17
        assertEquals(17, execution.getTasks().size());
    }
}