alluxio-master-2.x/tests/src/test/java/alluxio/job/util/JobTestUtils.java
/*
 * The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
 * (the "License"). You may not use this work except in compliance with the License, which is
 * available at www.apache.org/licenses/LICENSE-2.0
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied, as more fully set forth in the License.
 *
 * See the NOTICE file distributed with this work for information regarding copyright ownership.
 */

package alluxio.job.util;

import alluxio.Constants;
import alluxio.exception.JobDoesNotExistException;
import alluxio.job.wire.JobInfo;
import alluxio.job.wire.Status;
import alluxio.master.job.JobMaster;
import alluxio.util.CommonUtils;
import alluxio.util.WaitForOptions;

import com.google.common.base.Throwables;
import com.google.common.collect.Sets;

import java.util.Arrays;
import java.util.Set;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicReference;

/**
 * Utility methods for tests related to the job service.
 */
public final class JobTestUtils {

  /**
   * Waits for the job with the given job ID to be in the given state.
   *
   * @param jobMaster the job master running the job
   * @param jobId the ID of the job
   * @param status the status to wait for
   * @return the status of the job waited for
   */
  public static JobInfo waitForJobStatus(final JobMaster jobMaster, final long jobId,
      final Status status) throws InterruptedException, TimeoutException {
    return waitForJobStatus(jobMaster, jobId, Sets.newHashSet(status));
  }

  /**
   * Waits for the job with the given job ID to be in the one of given states.
   *
   * @param jobMaster the job master running the job
   * @param jobId the ID of the job
   * @param statuses set of statuses to wait for
   * @return the status of the job waited for
   */
  public static JobInfo waitForJobStatus(final JobMaster jobMaster, final long jobId,
      final Set<Status> statuses) throws InterruptedException, TimeoutException {
    final AtomicReference<JobInfo> singleton = new AtomicReference<>();
    final AtomicReference<String> jobStatus = new AtomicReference<>();
    try {
      CommonUtils.waitFor(
          String.format("job %d to be one of status %s", jobId,
              Arrays.toString(statuses.toArray())),
          () -> {
            JobInfo info;
            try {
              info = jobMaster.getStatus(jobId);
              jobStatus.set(info.toString());
              if (statuses.contains(info.getStatus())) {
                singleton.set(info);
              }
              return statuses.contains(info.getStatus());
            } catch (JobDoesNotExistException e) {
              throw Throwables.propagate(e);
            }
          }, WaitForOptions.defaults().setTimeoutMs(30 * Constants.SECOND_MS));
    } catch (TimeoutException e) {
      throw new TimeoutException(String.format("%s, %s", e.getMessage(), jobStatus.toString()));
    }

    return singleton.get();
  }

  /**
   * Waits for the job with the given job ID to be in the one of given states in provided timeout.
   *
   * @param jobMaster the job master running the job
   * @param jobId the ID of the job
   * @param statuses set of statuses to wait for
   * @param timeout the timeout for the wait period
   * @return the status of the job waited for
   */
  public static JobInfo waitForJobStatus(final JobMaster jobMaster, final long jobId,
      final Set<Status> statuses, int timeout) throws InterruptedException, TimeoutException {
    final AtomicReference<JobInfo> singleton = new AtomicReference<>();
    CommonUtils.waitFor(
        String.format("job %d to be one of status %s", jobId, Arrays.toString(statuses.toArray())),
        () -> {
          JobInfo info;
          try {
            info = jobMaster.getStatus(jobId);
            if (statuses.contains(info.getStatus())) {
              singleton.set(info);
            }
            return statuses.contains(info.getStatus());
          } catch (JobDoesNotExistException e) {
            throw Throwables.propagate(e);
          }
        }, WaitForOptions.defaults().setTimeoutMs(timeout * Constants.SECOND_MS));
    return singleton.get();
  }

  private JobTestUtils() {} // prevent instantiation
}
