net.jangaroo.jooc.mvnplugin.test.PhantomJsTestRunner Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jangaroo-maven-plugin Show documentation
This plugin compiles Jangaroo sources to JavaScript.
The newest version!
package net.jangaroo.jooc.mvnplugin.test;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.SystemUtils;
import org.apache.maven.plugin.logging.Log;
import org.codehaus.plexus.util.cli.CommandLineException;
import org.codehaus.plexus.util.cli.CommandLineUtils;
import org.codehaus.plexus.util.cli.Commandline;
import org.codehaus.plexus.util.cli.StreamConsumer;

import java.io.File;
import java.io.FilenameFilter;
import java.util.ArrayList;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import static org.codehaus.plexus.util.StringUtils.isBlank;

public class PhantomJsTestRunner {

  public static final Pattern LOG_LEVEL_PATTERN = Pattern.compile("^\\[([A-Z]+)\\]\\s*(.*)$");

  private static volatile Boolean phantomjsExecutableFound;

  private final String testPageUrl;
  private final int phantomjsResourceTimeout;
  private final boolean phantomjsDebug;
  private final boolean phantomjsWebSecurity;
  private String testResultFilename;
  private final String phantomjs;
  private final Log log;
  private final String testRunner;
  private final int timeout;
  private final int maxRetriesOnCrashes;

  /**
   * @param phantomjs           the binary to execute
   * @param testPageUrl         the URL of the test page to load
   * @param testResultFilename  the file to write the test result into
   * @param testRunner          the test bootstrap script to be loaded in phantomjs
   * @param timeout             timeout in seconds
   * @param maxRetriesOnCrashes number of retries when receiving unexpected result from phantomjs (crash?)
   * @param phantomjsResourceTimeout
   * @param phantomjsDebug
   * @param phantomjsWebSecurity
   * @param log                 the maven log
   */
  public PhantomJsTestRunner(String phantomjs, String testPageUrl, String testResultFilename, String testRunner, int timeout, int maxRetriesOnCrashes, int phantomjsResourceTimeout, boolean phantomjsDebug, boolean phantomjsWebSecurity, Log log) {
    this.phantomjs = makeOsSpecific(phantomjs);
    this.testPageUrl = testPageUrl;
    this.testResultFilename = testResultFilename;
    this.testRunner = testRunner;
    this.timeout = timeout;
    this.maxRetriesOnCrashes = maxRetriesOnCrashes;
    this.phantomjsResourceTimeout = phantomjsResourceTimeout;
    this.log = log;
    this.phantomjsDebug = phantomjsDebug;
    this.phantomjsWebSecurity = phantomjsWebSecurity;
  }

  private static String makeOsSpecific(String phantomjs) {
    if(SystemUtils.IS_OS_WINDOWS) {
      if(!isBlank(phantomjs) && phantomjs.charAt(phantomjs.length() - 4) != '.') {
        return phantomjs +  ".exe";
      }
    }
    return phantomjs;
  }

  public boolean execute() throws CommandLineException {
    long started = System.currentTimeMillis() + 100;

    final StreamConsumer outConsumer = new LoggingStreamConsumer();
    final StreamConsumer errConsumer = new WarningStreamConsumer();

    final Commandline cmd = createCommandLine();
    log.info("executing phantomjs cmd: " + cmd.toString());
    for (int tryCount = 0; tryCount <= maxRetriesOnCrashes; ++tryCount) {
      int returnCode = CommandLineUtils.executeCommandLine(cmd, outConsumer, errConsumer, getTimeoutInSeconds(started));
      if (returnCode >= 0 && returnCode <= 4) { // valid phantomjs-joounit-page-runner return codes!
        return returnCode == 0;
      }
      log.warn(String.format("unexpected result %d from phantomjs run #%d", returnCode, tryCount + 1));

      // seems that phantomjs keeps state and needs some time to recover .... really ?
      try {
        Thread.sleep(phantomjsResourceTimeout);
      } catch (InterruptedException e) { // NOSONAR
        // IGNORE
      }
    }
    log.error(String.format("Got %d unexpected results from phantomjs, giving up.", maxRetriesOnCrashes + 1));
    return false;
  }

  /**
   * Compute remaining timeout: The configured timeout without time already spent for trying
   */
  private int getTimeoutInSeconds(long started) {
    return (int)(timeout - (System.currentTimeMillis() - started)) / 1000;
  }

  public boolean canRun() {
    return
            testResultFilename != null &&
                    testRunner != null &&
                    phantomjs != null &&
                    isExecutableAvailable();
  }

  private boolean isExecutableAvailable() {
    if(phantomjsExecutableFound == null) {
      synchronized (PhantomJsTestRunner.class) {
        phantomjsExecutableFound = (new File(phantomjs).canExecute() || canExecutePhantomJs());
      }
    }
    return phantomjsExecutableFound;
  }

  private boolean canExecutePhantomJs() {
    final String path = System.getenv("PATH");
    final String[] directoryNames = StringUtils.split(path, File.pathSeparatorChar);
    for (String directoryName : directoryNames) {
      final File[] files = new File(directoryName).listFiles(new FilenameFilter() {
        @Override
        public boolean accept(File dir, String name) {
          return phantomjs.equals(name);
        }
      });
      if(!(files == null || files.length == 0)) {
        return true;
      }
    }
    log.warn(phantomjs + " not found in " + path);
    return false;
  }

  private Commandline createCommandLine() {
    final Commandline commandline = new Commandline();
    commandline.setExecutable(phantomjs);
    final ArrayList arguments = new ArrayList<>();
    arguments.add("--debug=" + String.valueOf(phantomjsDebug));
    arguments.add("--web-security=" + String.valueOf(phantomjsWebSecurity));

    arguments.add(testRunner);

    arguments.add(testPageUrl);
    arguments.add(testResultFilename);
    arguments.add(String.valueOf(phantomjsResourceTimeout));
    commandline.addArguments(arguments.toArray(new String[arguments.size()]));

    return commandline;
  }

  @Override
  public String toString() {
    return "PhantomJsTestRunner{" +
            "phantomjs=" + phantomjs +
            ", testRunner='" + testRunner + '\'' +
            ", testPageUrl='" + testPageUrl + '\'' +
            ", testResultFilename=" + testResultFilename +
            '}';
  }

  private class LoggingStreamConsumer implements StreamConsumer {
    @Override
    public void consumeLine(String line) {
      Matcher matcher = LOG_LEVEL_PATTERN.matcher(line);
      String logLevel;
      String msg;
      if (matcher.matches()) {
        logLevel = matcher.group(1);
        msg = matcher.group(2);
      } else {
        logLevel = "DEBUG";
        msg = line;
      }
      if ("ERROR".equals(logLevel)) {
        log.error(msg);
      } else if ("WARN".equals(logLevel)) {
        log.warn(msg);
      } else if ("INFO".equals(logLevel)) {
        log.info(msg);
      } else {
        log.debug(msg);
      }
    }
  }

  private class WarningStreamConsumer implements StreamConsumer {
    @Override
    public void consumeLine(String line) {
      log.warn(line);
    }
  }
}