alluxio-master-2.x/core/common/src/main/java/alluxio/cli/RunTestUtils.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.cli;

import alluxio.Constants;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.PrintStream;
import java.util.concurrent.Callable;

/**
 * Utilities to run the examples.
 */
public final class RunTestUtils {
  private static final Logger LOG = LoggerFactory.getLogger(RunTestUtils.class);

  private RunTestUtils() {} // prevent instantiation

  /**
   * Prints information of the test result to redirected streams.
   *
   * @param pass the test result
   * @param outStream stream for stdout
   */
  public static void printTestStatus(boolean pass, PrintStream outStream) {
    if (pass) {
      outStream.println(Constants.ANSI_GREEN + "Passed the test!" + Constants.ANSI_RESET);
    } else {
      outStream.println(Constants.ANSI_RED + "Failed the test!" + Constants.ANSI_RESET);
    }
  }

  /**
   * Prints information of the test result.
   *
   * @param pass the test result
   */
  public static void printTestStatus(boolean pass) {
    printTestStatus(pass, System.out);
  }

  /**
   * Runs an example.
   *
   * @param example the example to run
   * @return whether the example completes
   */
  public static boolean runExample(final Callable<Boolean> example) {
    boolean result;
    try {
      result = example.call();
    } catch (Exception e) {
      LOG.error("Exception running test: " + example, e);
      result = false;
    }
    RunTestUtils.printTestStatus(result);
    return result;
  }
}
