Back to Repositories

Testing Scheduler Client Implementation in Conductor OSS

This test suite validates the functionality of the Scheduler Client in Conductor’s Java SDK. It covers essential scheduling operations including creating, managing, and monitoring workflow schedules with comprehensive validation of CRUD operations and timezone handling.

Test Coverage Overview

The test suite provides extensive coverage of scheduler operations including:

Schedule creation and deletion
Cron expression validation
Schedule retrieval and search functionality
Tag management operations
Pause/resume capabilities for individual and bulk schedules
Timezone handling verification

Implementation Analysis

The testing approach utilizes JUnit Jupiter’s framework features for structured test organization. Each test method focuses on specific scheduler functionality, employing a clear setup/teardown pattern with @BeforeEach and @AfterEach annotations for test isolation.

The implementation demonstrates thorough validation of scheduler operations through assertion-based testing.

Technical Details

Key technical components include:

JUnit Jupiter test framework
Conductor Java SDK SchedulerClient
Custom test utilities (ClientTestUtil)
Cron expression handling
TagObject management
Timezone configuration testing

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Proper test isolation through setup/cleanup methods
Descriptive test naming using @DisplayName
Comprehensive assertion coverage
Modular test organization
Clear separation of test scenarios
Proper resource cleanup

conductor-oss/conductor

conductor-clients/java/conductor-java-sdk/tests/src/test/java/io/orkes/conductor/client/http/SchedulerClientTests.java

            
/*
 * Copyright 2022 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.client.http;

import java.util.List;

import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

import io.orkes.conductor.client.SchedulerClient;
import io.orkes.conductor.client.model.SaveScheduleRequest;
import io.orkes.conductor.client.model.TagObject;
import io.orkes.conductor.client.model.WorkflowSchedule;
import io.orkes.conductor.client.util.ClientTestUtil;
import io.orkes.conductor.client.util.Commons;

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

public class SchedulerClientTests  {
    private final String NAME = "test_sdk_java_scheduler_name";
    private final String CRON_EXPRESSION = "0 * * * * *";

    private final SchedulerClient schedulerClient = ClientTestUtil.getOrkesClients().getSchedulerClient();

    @BeforeEach
    void beforeEach() {
        schedulerClient.deleteSchedule(NAME);
    }

    @AfterEach
    void afterEach() {
        schedulerClient.deleteSchedule(NAME);
    }

    @Test
    void testMethods() {
        schedulerClient.deleteSchedule(NAME);
        Assertions.assertTrue(schedulerClient.getNextFewSchedules(CRON_EXPRESSION, 0L, 0L, 0).isEmpty());
        schedulerClient.saveSchedule(getSaveScheduleRequest());
        Assertions.assertTrue(schedulerClient.getAllSchedules(Commons.WORKFLOW_NAME).size() > 0);
        WorkflowSchedule workflowSchedule = schedulerClient.getSchedule(NAME);
        assertEquals(NAME, workflowSchedule.getName());
        assertEquals(CRON_EXPRESSION, workflowSchedule.getCronExpression());
        Assertions.assertFalse(schedulerClient.search(0, 10, "ASC", "*", "").getResults().isEmpty());
        schedulerClient.setSchedulerTags(getTagObject(), NAME);
        assertEquals(getTagObject(), schedulerClient.getSchedulerTags(NAME));
        schedulerClient.deleteSchedulerTags(getTagObject(), NAME);
        assertEquals(0, schedulerClient.getSchedulerTags(NAME).size());
        schedulerClient.pauseSchedule(NAME);
        workflowSchedule = schedulerClient.getSchedule(NAME);
        Assertions.assertTrue(workflowSchedule.isPaused());
        schedulerClient.resumeSchedule(NAME);
        workflowSchedule = schedulerClient.getSchedule(NAME);
        Assertions.assertFalse(workflowSchedule.isPaused());
        schedulerClient.deleteSchedule(NAME);
    }

    @Test
    void testDebugMethods() {
        schedulerClient.pauseAllSchedules();
        schedulerClient.resumeAllSchedules();
        schedulerClient.requeueAllExecutionRecords();
    }

    @Test
    @DisplayName("It should set the timezone to Europe/Madrid")
    void testTimeZoneId() {
        var schedule = new SaveScheduleRequest()
                .name(NAME)
                .cronExpression(CRON_EXPRESSION)
                .startWorkflowRequest(Commons.getStartWorkflowRequest())
                .zoneId("Europe/Madrid");
        schedulerClient.saveSchedule(schedule);
        var savedSchedule = schedulerClient.getSchedule(NAME);
        assertEquals("Europe/Madrid", savedSchedule.getZoneId());
    }

    private SaveScheduleRequest getSaveScheduleRequest() {
        return new SaveScheduleRequest()
                .name(NAME)
                .cronExpression(CRON_EXPRESSION)
                .startWorkflowRequest(Commons.getStartWorkflowRequest());
    }

    private List<TagObject> getTagObject() {
        TagObject tagObject = new TagObject();
        tagObject.setKey("department");
        tagObject.setValue("accounts");
        return List.of(tagObject);
    }
}