com.piketec.jenkins.plugins.tpt

Class TptPlugin

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

com.piketec.jenkins.plugins.tpt.TptPlugin

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep

public class TptPlugin
extends hudson.tasks.Builder

This class is just a data container for the TPTPlugin configuration in Jenkins.
If you use this Jenkins plugin you have two Options to run TPT-Test. The first option is just to run TPT via command line and execute the tests. The second option is to execute the tests via API. In this case for every testcase a single slave job will be started. This slvae job must have a proper configured TptPluginSlave Build step. Master-slave execution was was introduced in the year 2016.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TptPlugin.DescriptorImpl The descriptor of TptPlugin

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description

TptPlugin(String exe, String exePaths, String arguments, boolean isTptMaster, String slaveJob, String slaveJobCount, String slaveJobTries, String tptBindingName, String tptPort, ArrayList<JenkinsConfiguration> executionConfiguration, String tptStartUpWaitTime, Boolean enableJunit, String jUnitreport, com.piketec.jenkins.plugins.tpt.TptLog.LogLevel jUnitLogLevel) All the parameter are processed and then they are passed to TptPluginSingleJobExecutor or to TptPluginMasterJobExecutor

Method Summary

Modifier and Type	Method and Description
String	getArguments() Common command line opts.
TptPlugin.DescriptorImpl	getDescriptor()
List<JenkinsConfiguration>	getExecutionConfiguration()
String	getExePaths()
boolean	getIsTptMaster()
com.piketec.jenkins.plugins.tpt.TptLog.LogLevel	getJUnitLogLevel() The severity level of TPT log messages that will be written to failed JUnit tests.
String	getJUnitreport() Report dir (optional).
String	getSlaveJob()
String	getSlaveJobCount()
String	getSlaveJobTries()
String	getTptBindingName()
String	getTptPort()
String	getTptStartUpWaitTime()
boolean	isEnableJunit()
boolean	isIsTptMaster()
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
boolean	performAsMaster(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener, hudson.EnvVars environment, ArrayList<JenkinsConfiguration> normalizedConfigs) Get the required data to create a TptPluginMasterJobExecutor and excecutes it.
boolean	performWithoutSlaves(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener, hudson.EnvVars environment, ArrayList<JenkinsConfiguration> normalizedConfigs) Get the required data to create a TptPluginSingleJobExecutor and excecutes it.
protected Object	readResolve() This method is used to persist the data format when upgrading the plugin.

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Constructor Detail

TptPlugin

@DataBoundConstructor
public TptPlugin(String exe,
                                        String exePaths,
                                        String arguments,
                                        boolean isTptMaster,
                                        String slaveJob,
                                        String slaveJobCount,
                                        String slaveJobTries,
                                        String tptBindingName,
                                        String tptPort,
                                        ArrayList<JenkinsConfiguration> executionConfiguration,
                                        String tptStartUpWaitTime,
                                        Boolean enableJunit,
                                        String jUnitreport,
                                        com.piketec.jenkins.plugins.tpt.TptLog.LogLevel jUnitLogLevel)

All the parameter are processed and then they are passed to TptPluginSingleJobExecutor or to TptPluginMasterJobExecutor

Parameters:

exe - deprecated

exePaths - paths to tpt executables separated by a comma or a semicolon

arguments - the commandline arguments given in the descriptor

isTptMaster - to know if there will be distributed builds or a singleJob

slaveJob - the name of the slave job, used for putting the workload to the right slave

slaveJobCount - the number of slaveJobs that will be executed

slaveJobTries - used for the retryablejob

tptBindingName - the binding name used to connect to the TptApi (for the registry)

tptPort - the port for binding to the TptApi

executionConfiguration - all the jenkins configurations given in the descriptor, used to get the Files,Execution Configuration, test Set, testDataDir, reportDir,etc

tptStartUpWaitTime - the time it should wait before start tpt

enableJunit - to know if is necessary to generate the jUnit report

jUnitreport - path to where the jUnit report will generated

jUnitLogLevel - The sverity of log messages that will be written ti the JUnit xml file

Method Detail

readResolve

protected Object readResolve()

This method is used to persist the data format when upgrading the plugin.

Returns:

this

getExePaths

public String getExePaths()

Returns:

The list of paths to possible TPT-installations.

getIsTptMaster

public boolean getIsTptMaster()

Returns:

Should testcase execution be deligated to a slave job

isIsTptMaster

public boolean isIsTptMaster()

Returns:

Should testcase execution be deligated to a slave job

getSlaveJob

public String getSlaveJob()

Returns:

The name of slave job if the plugin runs in master mode

getSlaveJobCount

public String getSlaveJobCount()

Returns:

The number of slave job the plugin will run in master mode. A value below 1 means every test case will be started in its own job.

getSlaveJobTries

public String getSlaveJobTries()

Returns:

If the execution of a slave job fails it is possible to reschedule the job for another try. This is the maximal number of tries.

getTptBindingName

public String getTptBindingName()

Returns:

the RMI binding name for TPT

getTptPort

public String getTptPort()

Returns:

The port of the RMI registry

getArguments

public String getArguments()

Common command line opts. Delimiter between the options is one or more spaces. Inside doublequotes spaces have no special meaning.

Returns:

0 or more options for tpt.

getTptStartUpWaitTime

public String getTptStartUpWaitTime()

Returns:

The time waited before trying to get the API handle after starting TPT

getExecutionConfiguration

public List<JenkinsConfiguration> getExecutionConfiguration()

Returns:

List of all (repeatable) sub-configurations

isEnableJunit

public boolean isEnableJunit()

Returns:

if the TPT test result should be transformed into a JUnit XML (legacy behaviour)

getJUnitreport

public String getJUnitreport()

Report dir (optional).

Returns:

The directory, where to store the results, can be null.

getJUnitLogLevel

public com.piketec.jenkins.plugins.tpt.TptLog.LogLevel getJUnitLogLevel()

The severity level of TPT log messages that will be written to failed JUnit tests.

Returns:

The severity level of TPT log messages that will be written to failed JUnit tests.

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws InterruptedException,
                       IOException

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Throws:

InterruptedException

IOException

performWithoutSlaves

public boolean performWithoutSlaves(hudson.model.AbstractBuild<?,?> build,
                                    hudson.Launcher launcher,
                                    hudson.model.BuildListener listener,
                                    hudson.EnvVars environment,
                                    ArrayList<JenkinsConfiguration> normalizedConfigs)

Get the required data to create a TptPluginSingleJobExecutor and excecutes it. It is called when there are no distributed builds. All the parameters are used to get the data for creating a new TptPluginSingleJobExecutor

Parameters:

build - The current Jenkins build

launcher - The launcher

listener - The listener

environment - The map of envrionment varibales and their value

normalizedConfigs - The configs with already replaced $-variables

Returns:

true if it was possible to execute the TptPluginSingleJobExecutor.

performAsMaster

public boolean performAsMaster(hudson.model.AbstractBuild<?,?> build,
                               hudson.Launcher launcher,
                               hudson.model.BuildListener listener,
                               hudson.EnvVars environment,
                               ArrayList<JenkinsConfiguration> normalizedConfigs)

Get the required data to create a TptPluginMasterJobExecutor and excecutes it. It is called when there are distributed builds. @see the execute() method from TptPluginMasterJobExecutor. All the parameters are used to get the data for creating a new TptPluginMasterJobExecutor

Parameters:

build - The current Jenkins build

launcher - The launcher

listener - The listener

environment - The map of envrionment varibales and their value

normalizedConfigs - The configs with already replaced $-variables

Returns:

true if the execution from slaves and master were successful.

getDescriptor

public TptPlugin.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Builder>

Overrides:

getDescriptor in class hudson.tasks.Builder