com.piketec.jenkins.plugins.tpt.Configuration

Class JenkinsConfiguration

java.lang.Object

com.piketec.jenkins.plugins.tpt.Configuration.JenkinsConfiguration

All Implemented Interfaces:

hudson.model.Describable<JenkinsConfiguration>

public class JenkinsConfiguration
extends Object
implements hudson.model.Describable<JenkinsConfiguration>

Repeatable subelement for the TPT configuration. Mainly a pair of TPT file and execution configuration enriched with some additional information.

Author:

jkuhnert, PikeTec GmbH

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JenkinsConfiguration.DescriptorImpl Inline class for jenkins. so it is an repeatable object in conf.jelly

Constructor Summary

Constructors

Constructor and Description
JenkinsConfiguration(String tptFile, String configuration, String testdataDir, String reportDir, boolean enableTest, long timeout, String testSet) the execution configuration is used by tpt to determine which file and which arguments is used.

Method Summary

Modifier and Type	Method and Description
String	getConfiguration()
String	getConfigurationWithUnderscore()
hudson.model.Descriptor<JenkinsConfiguration>	getDescriptor()
String	getReportDir()
String	getTestdataDir()
String	getTestSet()
long	getTimeout()
String	getTptFile()
boolean	isEnableTest()
protected Object	readResolve()
JenkinsConfiguration	replaceAndNormalize(hudson.EnvVars environment)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JenkinsConfiguration

@DataBoundConstructor
public JenkinsConfiguration(String tptFile,
                                                   String configuration,
                                                   String testdataDir,
                                                   String reportDir,
                                                   boolean enableTest,
                                                   long timeout,
                                                   String testSet)

the execution configuration is used by tpt to determine which file and which arguments is used. later on, the back 2 back test determine the reference files with this.

Parameters:

tptFile - - path to an executable tpt file *.tpt

configuration - - arguments and configuration (configuration in double quotes)

testdataDir - Testdata directory, if empty, path from the configuration will used.

reportDir - Report directory, if empty, path from the configuration will used.

enableTest - - true if you want to skip this configuration

timeout - how long the execution of this test run is allwoed to take at max

testSet - the name of test set that should be used, null or empty if the test set defined in the file should be used.

Method Detail

readResolve

protected Object readResolve()

isEnableTest

public boolean isEnableTest()

Returns:

if this JenkinsConfiguration should run at all

getTimeout

public long getTimeout()

Returns:

how long the execution of this test run is allwoed to take at max

getTptFile

public String getTptFile()

Returns:

The TPT file

getTestSet

public String getTestSet()

Returns:

the name of test set that should be used, null or empty if the test set defined in the file should be used.

getConfigurationWithUnderscore

public String getConfigurationWithUnderscore()

Returns:

the configuration with replaced whitespace. " " -> "_"

getConfiguration

public String getConfiguration()

Returns:

the whole configuration string defined in the jenkins conf

getDescriptor

public hudson.model.Descriptor<JenkinsConfiguration> getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<JenkinsConfiguration>

Returns:

the actual descriptor of this object

getReportDir

public String getReportDir()

Returns:

the directory where the TPT report shall be written to.

getTestdataDir

public String getTestdataDir()

Returns:

The directory where the execution result data shall be written to

replaceAndNormalize

public JenkinsConfiguration replaceAndNormalize(hudson.EnvVars environment)

Parameters:

environment - The map of environment variables and their values

Returns:

A JenkinsConfiguration where all "${}"-Variables are replaced by their value if available in environment.