com.greenpepper.runner.ant.AntTaskRunner Maven / Gradle / Ivy
/*
* Copyright (c) 2008 Pyxis Technologies inc.
*
* This is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA,
* or see the FSF site: http://www.fsf.org.
*/
package com.greenpepper.runner.ant;
import java.io.File;
import java.lang.reflect.Constructor;
import java.util.ArrayList;
import java.util.List;
import com.greenpepper.shaded.org.apache.commons.codec.StringDecoder;
import com.greenpepper.shaded.org.apache.tools.ant.AntClassLoader;
import com.greenpepper.shaded.org.apache.tools.ant.BuildException;
import com.greenpepper.shaded.org.apache.tools.ant.Project;
import com.greenpepper.shaded.org.apache.tools.ant.Task;
import com.greenpepper.shaded.org.apache.tools.ant.types.Path;
import com.greenpepper.shaded.org.apache.tools.ant.util.LoaderUtils;
import com.greenpepper.shaded.org.apache.xmlrpc.XmlRpcClient;
import com.greenpepper.GreenPepper;
import com.greenpepper.GreenPepperCore;
import com.greenpepper.util.DuckType;
/**
* AntTaskRunner class.
*
* @author oaouattara
* @version $Id: $Id
*/
public class AntTaskRunner extends Task
{
private boolean failOnError = false;
private boolean suite = false;
private String input;
private File output;
private String outputType;
private SectionElement section;
private SystemUnderDevelopmentElement systemDevelopment;
private RepositoryElement repository;
private boolean stopOnFirstFailure = false;
private String locale;
private String selector;
private boolean debug = false;
private Path classpath;
private Path runtimeClasspath;
/**
* Constructor for AntTaskRunner.
*/
public AntTaskRunner()
{
super();
}
/**
* isFailOnError.
*
* @return a boolean.
*/
boolean isFailOnError()
{
return failOnError;
}
/**
* Setter for the field failOnError.
*
* @param failOnError a boolean.
*/
public void setFailOnError(boolean failOnError)
{
this.failOnError = failOnError;
}
/**
* isSuite.
*
* @return a boolean.
*/
public boolean isSuite()
{
return suite;
}
/**
* Setter for the field suite.
*
* @param suite a boolean.
*/
public void setSuite(boolean suite)
{
this.suite = suite;
}
/**
* Getter for the field input.
*
* @return a {@link java.lang.String} object.
*/
public String getInput()
{
return input;
}
/**
* Setter for the field input.
*
* @param input a {@link java.lang.String} object.
*/
public void setInput(String input)
{
this.input = input;
}
/**
* Getter for the field output.
*
* @return a {@link java.io.File} object.
*/
public File getOutput()
{
return output;
}
/**
* Setter for the field output.
*
* @param output a {@link java.io.File} object.
*/
public void setOutput(File output)
{
this.output = output;
}
/**
* Getter for the field outputType.
*
* @return a {@link java.lang.String} object.
*/
String getOutputType()
{
return outputType;
}
/**
* Setter for the field outputType.
*
* @param type a {@link java.lang.String} object.
*/
public void setOutputType(String type) {
this.outputType = type.equalsIgnoreCase("xml") ? "xml": null;
}
/**
* Getter for the field section.
*
* @return a {@link com.greenpepper.runner.ant.SectionElement} object.
*/
public SectionElement getSection()
{
return section;
}
/**
* Setter for the field section.
*
* @param section a {@link com.greenpepper.runner.ant.SectionElement} object.
*/
public void setSection(SectionElement section)
{
this.section = section;
}
/**
* createSection.
*
* @return a {@link com.greenpepper.runner.ant.SectionElement} object.
*/
public SectionElement createSection()
{
if (getSection() != null)
{
throw new IllegalArgumentException("Section already defined!");
}
section = new SectionElement();
return section;
}
/**
* Getter for the field systemDevelopment.
*
* @return a {@link com.greenpepper.runner.ant.SystemUnderDevelopmentElement} object.
*/
public SystemUnderDevelopmentElement getSystemDevelopment()
{
return systemDevelopment;
}
/**
* createSystemUnderDevelopment.
*
* @return a {@link com.greenpepper.runner.ant.SystemUnderDevelopmentElement} object.
*/
public SystemUnderDevelopmentElement createSystemUnderDevelopment()
{
if (systemDevelopment != null)
{
throw new IllegalArgumentException("SystemUnderDevelopment already defined!");
}
systemDevelopment = new SystemUnderDevelopmentElement();
return systemDevelopment;
}
/**
* Getter for the field repository.
*
* @return a {@link com.greenpepper.runner.ant.RepositoryElement} object.
*/
public RepositoryElement getRepository()
{
return repository;
}
/**
* createRepository.
*
* @return a {@link com.greenpepper.runner.ant.RepositoryElement} object.
*/
public RepositoryElement createRepository()
{
if (repository != null)
{
throw new IllegalArgumentException("Repository already defined!");
}
repository = new RepositoryElement();
return repository;
}
/**
* isStopOnFirstFailure.
*
* @return a boolean.
*/
public boolean isStopOnFirstFailure()
{
return stopOnFirstFailure;
}
/**
* Setter for the field stopOnFirstFailure.
*
* @param stopOnFirstFailure a boolean.
*/
public void setStopOnFirstFailure(boolean stopOnFirstFailure)
{
this.stopOnFirstFailure = stopOnFirstFailure;
}
/**
* Getter for the field locale.
*
* @return a {@link java.lang.String} object.
*/
public String getLocale()
{
return locale;
}
/**
* Setter for the field locale.
*
* @param locale a {@link java.lang.String} object.
*/
public void setLocale(String locale)
{
this.locale = locale;
}
/**
* Getter for the field selector.
*
* @return a {@link java.lang.String} object.
*/
public String getSelector()
{
return selector;
}
/**
* Setter for the field selector.
*
* @param selector a {@link java.lang.String} object.
*/
public void setSelector(String selector)
{
this.selector = selector;
}
/**
* isDebug.
*
* @return a boolean.
*/
public boolean isDebug()
{
return debug;
}
/**
* Setter for the field debug.
*
* @param debug a boolean.
*/
public void setDebug(boolean debug)
{
this.debug = debug;
}
/**
* createClasspath.
*
* @return a {@link com.greenpepper.shaded.org.apache.tools.ant.types.Path} object.
*/
public Path createClasspath() {
if (classpath == null) {
classpath = new Path(getProject());
}
return classpath;
}
/**
* execute.
*
* @throws com.greenpepper.shaded.org.apache.tools.ant.BuildException if any.
*/
public void execute()
throws BuildException
{
try
{
verboseHeaderToLog();
List args = buildCommandLine();
verboseCommandLineToLog(args);
doRun(args);
}
catch (BuildException ex) {
throw ex;
}
catch (Exception ex)
{
throw new BuildException("AntTaskRunner", ex);
}
}
private void verboseHeaderToLog()
{
log("\n-------------------------------------------------------", Project.MSG_INFO);
log(" G R E E N P E P P E R S P E C I F I C A T I O N S ", Project.MSG_INFO);
log("-------------------------------------------------------\n", Project.MSG_INFO);
}
private List buildCommandLine()
{
String currentDirectory = getCurrentDirectory();
log(String.format("CurrentDir \"%s\"", currentDirectory), Project.MSG_VERBOSE);
log(String.format("BaseDir \"%s\"", getProject().getBaseDir()), Project.MSG_VERBOSE);
if (createRuntimeClasspath() != null && createRuntimeClasspath().size() > 0) {
log("Classpath :", Project.MSG_VERBOSE);
for (String path : createRuntimeClasspath().list()) {
log(String.format("\t%s", path), Project.MSG_VERBOSE);
}
}
List args = new ArrayList();
if (getLocale() != null)
{
args.add("--locale");
args.add(getLocale());
log(String.format("Locale \"%s\"", getLocale()), Project.MSG_VERBOSE);
}
if (getSelector() != null)
{
args.add("--selector");
args.add(getSelector());
log(String.format("Selector \"%s\"", getSelector()), Project.MSG_VERBOSE);
}
if (getSystemDevelopment() != null)
{
args.add("-f");
args.add(getSystemDevelopment().toArgument(this));
}
if (getRepository() != null)
{
args.add("-r");
args.add(getRepository().toArgument(this));
}
String outputLocation = currentDirectory;
if (getOutput() != null)
{
outputLocation = getOutput().getAbsolutePath();
}
log(String.format("Output \"%s\"", outputLocation), Project.MSG_VERBOSE);
args.add("-o");
args.add(outputLocation);
if (isSuite())
{
log(String.format("Suite ? \"%s\"", isSuite()), Project.MSG_VERBOSE);
args.add("-s");
}
if (getSection() != null)
{
args.add("-t");
args.add(getSection().toArgument(this));
}
if (getOutputType() != null)
{
args.add("--xml");
}
if (isStopOnFirstFailure())
{
args.add("--stop");
}
if (isDebug())
{
args.add("--debug");
}
log(String.format("Input \"%s\"", getInput()), Project.MSG_VERBOSE);
args.add(getInput());
return args;
}
private String getCurrentDirectory()
{
return System.getProperty("user.dir");
}
private void verboseCommandLineToLog(List args)
{
for(String arg : args)
{
log(arg, Project.MSG_VERBOSE);
}
}
private void doRun(List args)
throws Exception
{
AntClassLoader classLoader = new AntClassLoader( null, createRuntimeClasspath(), false );
try
{
classLoader.setThreadContextLoader();
log(classLoader.toString(), Project.MSG_DEBUG);
AntTaskRunnerMonitor recorderMonitor = new AntTaskRunnerMonitor();
Object runnerInstance = createRunner( classLoader , new AntTaskRunnerLogger(this), recorderMonitor );
CommandLineRunnerMirror runner = DuckType.implement( CommandLineRunnerMirror.class, runnerInstance );
String[] arguments = new String[args.size()];
args.toArray(arguments);
runner.run(arguments);
log(String.format("Results: %s for %s specification(s)",
recorderMonitor.getStatistics().toString(),
recorderMonitor.getLocationCount()), Project.MSG_INFO);
checkResults(recorderMonitor.hasException(), "Some greenpepper tests did not run");
checkResults(recorderMonitor.hasTestFailures(), "There were greenpepper tests failures");
}
finally
{
classLoader.resetThreadContextLoader();
}
}
private Path createRuntimeClasspath()
{
if (runtimeClasspath == null)
{
runtimeClasspath = new Path( getProject() );
runtimeClasspath.append( createClasspath() );
appendGreenPepperCoreClasspath( runtimeClasspath );
}
return runtimeClasspath;
}
private void appendGreenPepperCoreClasspath(Path path)
{
appendClasspath( path, AntTaskRunner.class, String.format( "greenpepper-extensions-java-%s.jar", GreenPepperCore.VERSION ) );
appendClasspath( path, GreenPepper.class, String.format( "greenpepper-core-%s.jar", GreenPepperCore.VERSION ) );
}
private void appendClasspath(Path path, Class c, String expectedJar)
{
File location = LoaderUtils.getClassSource( c );
if (location != null)
{
path.createPath().setLocation( location );
log( String.format( "Implicitly adding '%s' to CLASSPATH", location ), Project.MSG_VERBOSE );
}
else
{
log( String.format( "Couldn't found classpath for '%s'", c ), Project.MSG_WARN );
log( String.format( "Make sure you have '%s' in the