com.compuware.jenkins.totaltest

Class TotalTestBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

com.compuware.jenkins.totaltest.AbstractTotalTestBuilderMigration

com.compuware.jenkins.totaltest.TotalTestBuilder

All Implemented Interfaces:

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

public class TotalTestBuilder
extends AbstractTotalTestBuilderMigration
implements jenkins.tasks.SimpleBuildStep

Sample Builder.

When the user configures the project and enables this builder, Descriptor.newInstance(StaplerRequest) is invoked and a new TotalTestRunner is created. The created instance is persisted to the project configuration XML by using XStream, so this allows you to use instance fields to remember remember the configuration.

When a build is performed, the perform(hudson.model.Run<?, ?>, hudson.FilePath, hudson.Launcher, hudson.model.TaskListener) method will be invoked.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TotalTestBuilder.DescriptorImpl Descriptor for TotalTestRunner.

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

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

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class com.compuware.jenkins.totaltest.AbstractTotalTestBuilderMigration

connectionId, hostPort, isMigrated

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
TotalTestBuilder(String connectionId, String credentialsId, String projectFolder, String testSuite, String jcl) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	getCcDB2() Returns whether Code Coverage main program is DB2(IKJEFT01).
String	getCcPgmType() Returns the Code Coverage main program type.
String	getCcRepo() Returns the name of the Code Coverage repository.
String	getCcSystem() Returns the Code Coverage system.
String	getCcTestId() Returns the Code Coverage test id.
String	getConnectionId() Gets the unique identifier of the 'Host connection'.
String	getCredentialsId() Returns the credential id of the user.
TotalTestBuilder.DescriptorImpl	getDescriptor()
String	getHlq() Returns the dataset high level qualifier
String	getJcl() Returns the name of the JCL file to use.
String	getProjectFolder() Returns the folder name containing the Total Test project.
String	getTestSuite() Returns the name of the test scenario or test suite to run.
boolean	isCcClearStats() Returns whether statistics should be cleared before the test
boolean	isDeleteTemp() Returns whether temporary file should be deleted.
boolean	isRecursive() Returns whether recursively checking for Unit Test projects
boolean	isUseStubs() Returns whether stubs are to be used.
void	perform(hudson.model.Run<?,?> build, hudson.FilePath workspaceFilePath, hudson.Launcher launcher, hudson.model.TaskListener listener)
void	setCcClearStats(boolean ccClearStats) Sets whether statistics should be clear before the test.
void	setCcDB2(boolean ccDB2) Set if the main program is DB2.
void	setCcPgmType(String ccType) Sets the Code Coverage main program type.
void	setCcRepo(String ccRepo) Sets the Code Coverage repository dataset name.
void	setCcSystem(String ccSystem) Sets the Code Coverage system.
void	setCcTestId(String ccTestId) Sets the Code Coverage test id.
void	setDeleteTemp(boolean deleteTemp) Sets whether temporary file should be deleted.
void	setHlq(String hlq) Sets the dataset high level qualifier,
void	setRecursive(boolean recursive) Sets whether should recursively check for Unit Test projects
void	setUseStubs(boolean useStubs) Sets if stubs are being used.
void	validateParameters(hudson.Launcher launcher, hudson.model.TaskListener listener, hudson.model.Item project) Validates the configuration parameters.

Methods inherited from class com.compuware.jenkins.totaltest.AbstractTotalTestBuilderMigration

getHostPort, isMigrated, jobLoaded, migrateConnectionInfo, readResolve, setHostPort

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, getRequiredMonitorService, perform, prebuild

Constructor Detail

TotalTestBuilder

@DataBoundConstructor
public TotalTestBuilder(String connectionId,
                                               String credentialsId,
                                               String projectFolder,
                                               String testSuite,
                                               String jcl)

Constructor

Parameters:

connectionId - The connection id for the selected connection

credentialsId - The user's credential id.

projectFolder - The name of the folder containing the Total Test project.

testSuite - The name of the test scenario or test suite to run.

jcl - The name of the JCL file to use.

Method Detail

getConnectionId

public String getConnectionId()

Gets the unique identifier of the 'Host connection'.

Returns:

String value of connectionId

getCredentialsId

public String getCredentialsId()

Returns the credential id of the user.

Returns:

The user's credential id.

getProjectFolder

public String getProjectFolder()

Returns the folder name containing the Total Test project.

Returns:

The name of the folder containing the Total Test project.

getTestSuite

public String getTestSuite()

Returns the name of the test scenario or test suite to run.

The test scenario or test suite must be in the specified project.

Returns:

The name of the test scenario or test suite to run.

getJcl

public String getJcl()

Returns the name of the JCL file to use.

The JCL file must be in the specified project.

Returns:

The name of the JCL file to use.

setCcRepo

@DataBoundSetter
public void setCcRepo(String ccRepo)

Sets the Code Coverage repository dataset name.

Parameters:

ccRepo - The Code Coverage repository name.

getCcRepo

public String getCcRepo()

Returns the name of the Code Coverage repository.

Returns:

The name of the Code Coverage repository.

setCcSystem

@DataBoundSetter
public void setCcSystem(String ccSystem)

Sets the Code Coverage system.

Parameters:

ccSystem - The Code Coverage system.

getCcSystem

public String getCcSystem()

Returns the Code Coverage system.

Returns:

The Code Coverage system.

setCcTestId

@DataBoundSetter
public void setCcTestId(String ccTestId)

Sets the Code Coverage test id.

Parameters:

ccTestId - The Code Coverage test id.

getCcTestId

public String getCcTestId()

Returns the Code Coverage test id.

Returns:

The Code Coverage test id.

setCcDB2

@DataBoundSetter
public void setCcDB2(boolean ccDB2)

Set if the main program is DB2.

This method is only here to support version 1.7 and below when ccDB2 was a checkbox.

Parameters:

ccDB2 - true if Code Coverage is for a DB2 program, otherwise false

getCcDB2

public boolean getCcDB2()

Returns whether Code Coverage main program is DB2(IKJEFT01).

Returns:

true indicates program is DB2, otherwise false

getCcPgmType

public String getCcPgmType()

Returns the Code Coverage main program type.

Returns:

The main program type for Code Coverage

setCcPgmType

@DataBoundSetter
public void setCcPgmType(String ccType)

Sets the Code Coverage main program type.

Parameters:

ccType - The Code Coverage main program type. Should be 'DB2', 'IMS", or 'TOTALTEST'.

setCcClearStats

@DataBoundSetter
public void setCcClearStats(boolean ccClearStats)

Sets whether statistics should be clear before the test.

Parameters:

ccClearStats - true if the statistics should be cleared before test, otherwise false

isCcClearStats

public boolean isCcClearStats()

Returns whether statistics should be cleared before the test

Returns:

true indicates stubs should be used, otherwise false

setUseStubs

@DataBoundSetter
public void setUseStubs(boolean useStubs)

Sets if stubs are being used.

Parameters:

useStubs - true if stubs are to be used, otherwise false

isUseStubs

public boolean isUseStubs()

Returns whether stubs are to be used.

Returns:

true indicates stubs should be used, otherwise false

setDeleteTemp

@DataBoundSetter
public void setDeleteTemp(boolean deleteTemp)

Sets whether temporary file should be deleted.

Parameters:

deleteTemp - true if temporary files should be deleted, otherwise false

isDeleteTemp

public boolean isDeleteTemp()

Returns whether temporary file should be deleted.

Returns:

true indicates temporary files should be deleted.

setHlq

@DataBoundSetter
public void setHlq(String hlq)

Sets the dataset high level qualifier,

Parameters:

hlq - High level qualifier for allocating datasets. Can be null

getHlq

public String getHlq()

Returns the dataset high level qualifier

Returns:

The high level qualifier for allocating datasets. null will be returned if no high level qualifier was specified.

setRecursive

@DataBoundSetter
public void setRecursive(boolean recursive)

Sets whether should recursively check for Unit Test projects

Parameters:

recursive - true if should recursively check for Unit Test, otherwise false

isRecursive

public boolean isRecursive()

Returns whether recursively checking for Unit Test projects

Returns:

true indicates temporary files should be deleted.

perform

public void perform(hudson.model.Run<?,?> build,
                    hudson.FilePath workspaceFilePath,
                    hudson.Launcher launcher,
                    hudson.model.TaskListener listener)
             throws hudson.AbortException

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

hudson.AbortException

getDescriptor

public TotalTestBuilder.DescriptorImpl getDescriptor()

Specified by:

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

Overrides:

getDescriptor in class hudson.tasks.Builder

validateParameters

public void validateParameters(hudson.Launcher launcher,
                               hudson.model.TaskListener listener,
                               hudson.model.Item project)

Validates the configuration parameters.

Parameters:

launcher - An instance of Launcher for launching the plugin.

listener - An instance of TaskListener for the build listener.

project - An instance of Item for the Jenkins project.