helix-core/src/test/java/org/apache/helix/integration/task/TestContextRedundantUpdates.java

package org.apache.helix.integration.task;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

import com.google.common.collect.ImmutableMap;
import org.apache.helix.TestHelper;
import org.apache.helix.task.JobConfig;
import org.apache.helix.task.JobContext;
import org.apache.helix.task.TaskPartitionState;
import org.apache.helix.task.TaskState;
import org.apache.helix.task.TaskUtil;
import org.apache.helix.task.Workflow;
import org.testng.Assert;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;

/**
 * This test checks of the workflow and job context get updates only if the update is necessary
 */
public class TestContextRedundantUpdates extends TaskTestBase {
  @BeforeClass
  public void beforeClass() throws Exception {
    _numDbs = 1;
    _numPartitions = 1;
    super.beforeClass();
  }

  @Test
  public void testFinishWorkflowContextNoUpdate() throws Exception {
    // Create a workflow with short running job
    String workflowName1 = TestHelper.getTestMethodName() + "_1";
    String jobName = "JOB0";
    JobConfig.Builder jobBuilder1 = JobConfig.Builder.fromMap(WorkflowGenerator.DEFAULT_JOB_CONFIG)
        .setWorkflow(workflowName1).setNumberOfTasks(1).setNumConcurrentTasksPerInstance(100)
        .setTimeoutPerTask(Long.MAX_VALUE).setCommand(MockTask.TASK_COMMAND)
        .setJobCommandConfigMap(ImmutableMap.of(MockTask.JOB_DELAY, "1000"));
    Workflow.Builder workflowBuilder1 =
        new Workflow.Builder(workflowName1).addJob(jobName, jobBuilder1);
    _driver.start(workflowBuilder1.build());

    _driver.pollForJobState(workflowName1, TaskUtil.getNamespacedJobName(workflowName1, jobName),
        TaskState.COMPLETED);
    _driver.pollForWorkflowState(workflowName1, TaskState.COMPLETED);

    int initialWorkflowContextVersion = _manager.getHelixDataAccessor()
        .getProperty(
            _manager.getHelixDataAccessor().keyBuilder().workflowContextZNode(workflowName1))
        .getRecord().getVersion();

    // Create another workflow with short running job
    String workflowName2 = TestHelper.getTestMethodName() + "_2";
    JobConfig.Builder jobBuilder2 = JobConfig.Builder.fromMap(WorkflowGenerator.DEFAULT_JOB_CONFIG)
        .setWorkflow(workflowName2).setNumberOfTasks(10).setNumConcurrentTasksPerInstance(100)
        .setTimeoutPerTask(Long.MAX_VALUE).setCommand(MockTask.TASK_COMMAND)
        .setJobCommandConfigMap(ImmutableMap.of(MockTask.JOB_DELAY, "5000"));
    Workflow.Builder workflowBuilder2 =
        new Workflow.Builder(workflowName2).addJob(jobName, jobBuilder2);
    // Start new workflow and make sure it gets completed. This would help us to make sure pipeline
    // has been run several times
    _driver.start(workflowBuilder2.build());
    _driver.pollForWorkflowState(workflowName2, TaskState.COMPLETED);

    int finalWorkflowContextVersion = _manager.getHelixDataAccessor()
        .getProperty(
            _manager.getHelixDataAccessor().keyBuilder().workflowContextZNode(workflowName1))
        .getRecord().getVersion();

    Assert.assertEquals(initialWorkflowContextVersion, finalWorkflowContextVersion);
  }

  @Test
  public void testRunningWorkflowContextNoUpdate() throws Exception {
    // Create a workflow with a long running job
    String workflowName1 = TestHelper.getTestMethodName() + "_1";
    String jobName = "JOB0";
    JobConfig.Builder jobBuilder1 = JobConfig.Builder.fromMap(WorkflowGenerator.DEFAULT_JOB_CONFIG)
        .setWorkflow(workflowName1).setNumberOfTasks(1).setNumConcurrentTasksPerInstance(100)
        .setTimeoutPerTask(Long.MAX_VALUE).setCommand(MockTask.TASK_COMMAND)
        .setJobCommandConfigMap(ImmutableMap.of(MockTask.JOB_DELAY, "10000000"));
    Workflow.Builder workflowBuilder1 =
        new Workflow.Builder(workflowName1).addJob(jobName, jobBuilder1);
    _driver.start(workflowBuilder1.build());

    _driver.pollForJobState(workflowName1, TaskUtil.getNamespacedJobName(workflowName1, jobName),
        TaskState.IN_PROGRESS);
    _driver.pollForWorkflowState(workflowName1, TaskState.IN_PROGRESS);

    int initialWorkflowContextVersion = _manager.getHelixDataAccessor()
        .getProperty(
            _manager.getHelixDataAccessor().keyBuilder().workflowContextZNode(workflowName1))
        .getRecord().getVersion();

    // Create another workflow with short running job
    String workflowName2 = TestHelper.getTestMethodName() + "_2";
    JobConfig.Builder jobBuilder2 = JobConfig.Builder.fromMap(WorkflowGenerator.DEFAULT_JOB_CONFIG)
        .setWorkflow(workflowName2).setNumberOfTasks(10).setNumConcurrentTasksPerInstance(100)
        .setTimeoutPerTask(Long.MAX_VALUE).setCommand(MockTask.TASK_COMMAND)
        .setJobCommandConfigMap(ImmutableMap.of(MockTask.JOB_DELAY, "2000"));
    Workflow.Builder workflowBuilder2 =
        new Workflow.Builder(workflowName2).addJob(jobName, jobBuilder2);
    // Start new workflow and make sure it gets completed. This would help us to make sure pipeline
    // has been run several times
    _driver.start(workflowBuilder2.build());
    _driver.pollForWorkflowState(workflowName2, TaskState.COMPLETED);

    int finalWorkflowContextVersion = _manager.getHelixDataAccessor()
        .getProperty(
            _manager.getHelixDataAccessor().keyBuilder().workflowContextZNode(workflowName1))
        .getRecord().getVersion();

    Assert.assertEquals(initialWorkflowContextVersion, finalWorkflowContextVersion);
  }

  @Test
  public void testRunningJobContextNoUpdate() throws Exception {
    // Create a workflow with a long running job
    String workflowName1 = TestHelper.getTestMethodName() + "_1";
    String jobName = "JOB0";
    JobConfig.Builder jobBuilder1 = JobConfig.Builder.fromMap(WorkflowGenerator.DEFAULT_JOB_CONFIG)
        .setWorkflow(workflowName1).setNumberOfTasks(1).setNumConcurrentTasksPerInstance(100)
        .setTimeoutPerTask(Long.MAX_VALUE).setCommand(MockTask.TASK_COMMAND)
        .setJobCommandConfigMap(ImmutableMap.of(MockTask.JOB_DELAY, "10000000"));
    Workflow.Builder workflowBuilder1 =
        new Workflow.Builder(workflowName1).addJob(jobName, jobBuilder1);
    _driver.start(workflowBuilder1.build());

    _driver.pollForJobState(workflowName1, TaskUtil.getNamespacedJobName(workflowName1, jobName),
        TaskState.IN_PROGRESS);
    _driver.pollForWorkflowState(workflowName1, TaskState.IN_PROGRESS);
    // Make sure task has been assigned to the participant is in RUNNING state
    boolean isTaskAssignedAndRunning = TestHelper.verify(() -> {
      JobContext ctx = _driver.getJobContext(TaskUtil.getNamespacedJobName(workflowName1, jobName));
      String participant = ctx.getAssignedParticipant(0);
      TaskPartitionState taskState = ctx.getPartitionState(0);
      return (participant != null && taskState.equals(TaskPartitionState.RUNNING));
    }, TestHelper.WAIT_DURATION);
    Assert.assertTrue(isTaskAssignedAndRunning);

    int initialJobContextVersion = _manager.getHelixDataAccessor()
        .getProperty(
            _manager.getHelixDataAccessor().keyBuilder().jobContextZNode(workflowName1, jobName))
        .getRecord().getVersion();

    // Create another workflow with short running job
    String workflowName2 = TestHelper.getTestMethodName() + "_2";
    JobConfig.Builder jobBuilder2 = JobConfig.Builder.fromMap(WorkflowGenerator.DEFAULT_JOB_CONFIG)
        .setWorkflow(workflowName2).setNumberOfTasks(10).setNumConcurrentTasksPerInstance(100)
        .setTimeoutPerTask(Long.MAX_VALUE).setCommand(MockTask.TASK_COMMAND)
        .setJobCommandConfigMap(ImmutableMap.of(MockTask.JOB_DELAY, "2000"));
    Workflow.Builder workflowBuilder2 =
        new Workflow.Builder(workflowName2).addJob(jobName, jobBuilder2);
    // Start new workflow and make sure it gets completed. This would help us to make sure pipeline
    // has been run several times
    _driver.start(workflowBuilder2.build());
    _driver.pollForWorkflowState(workflowName2, TaskState.COMPLETED);

    int finalJobContextVersion = _manager.getHelixDataAccessor()
        .getProperty(
            _manager.getHelixDataAccessor().keyBuilder().jobContextZNode(workflowName1, jobName))
        .getRecord().getVersion();
    Assert.assertEquals(initialJobContextVersion, finalJobContextVersion);
  }

  @Test
  public void testCompletedJobContextNoUpdate() throws Exception {
    // Create a workflow with a short running job
    String workflowName1 = TestHelper.getTestMethodName() + "_1";
    String jobName = "JOB0";
    JobConfig.Builder jobBuilder1 = JobConfig.Builder.fromMap(WorkflowGenerator.DEFAULT_JOB_CONFIG)
        .setWorkflow(workflowName1).setNumberOfTasks(1).setNumConcurrentTasksPerInstance(100)
        .setTimeoutPerTask(Long.MAX_VALUE).setCommand(MockTask.TASK_COMMAND)
        .setJobCommandConfigMap(ImmutableMap.of(MockTask.JOB_DELAY, "1000"));
    Workflow.Builder workflowBuilder1 =
        new Workflow.Builder(workflowName1).addJob(jobName, jobBuilder1);
    _driver.start(workflowBuilder1.build());

    _driver.pollForJobState(workflowName1, TaskUtil.getNamespacedJobName(workflowName1, jobName),
        TaskState.COMPLETED);
    _driver.pollForWorkflowState(workflowName1, TaskState.COMPLETED);

    int initialJobContextVersion = _manager.getHelixDataAccessor()
        .getProperty(
            _manager.getHelixDataAccessor().keyBuilder().jobContextZNode(workflowName1, jobName))
        .getRecord().getVersion();

    // Create another workflow with short running job
    String workflowName2 = TestHelper.getTestMethodName() + "_2";
    JobConfig.Builder jobBuilder2 = JobConfig.Builder.fromMap(WorkflowGenerator.DEFAULT_JOB_CONFIG)
        .setWorkflow(workflowName2).setNumberOfTasks(10).setNumConcurrentTasksPerInstance(100)
        .setTimeoutPerTask(Long.MAX_VALUE).setCommand(MockTask.TASK_COMMAND)
        .setJobCommandConfigMap(ImmutableMap.of(MockTask.JOB_DELAY, "2000"));
    Workflow.Builder workflowBuilder2 =
        new Workflow.Builder(workflowName2).addJob(jobName, jobBuilder2);
    // Start new workflow and make sure it gets completed. This would help us to make sure pipeline
    // has been run several times
    _driver.start(workflowBuilder2.build());
    _driver.pollForWorkflowState(workflowName2, TaskState.COMPLETED);

    int finalJobContextVersion = _manager.getHelixDataAccessor()
        .getProperty(
            _manager.getHelixDataAccessor().keyBuilder().jobContextZNode(workflowName1, jobName))
        .getRecord().getVersion();
    Assert.assertEquals(initialJobContextVersion, finalJobContextVersion);
  }
}