com.xpandit.plugins.xrayjenkins.task

Class XrayImportBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Notifier

com.xpandit.plugins.xrayjenkins.task.XrayImportBuilder

All Implemented Interfaces:

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

public class XrayImportBuilder
extends hudson.tasks.Notifier
implements jenkins.tasks.SimpleBuildStep

This class is responsible for performing the Xray: Results Import Task development guidelines for compatibility: The class internal structure was modified in version 1.3.0 so the builder could be compatible with pipeline projects. When developing in this class, compatibility for pré-1.3.0 versions must be ensured. The following cases must always be considered: 1 - the job is being created in version 1.3.0 or higher and the deprecated fields must be populated for the case the user needs to perform a downgrade.

2 - the job was created on a pré-1.3.0 version, but has never been runned in 1.3.0 or higher versions. In this case, if the user opens the job configurations, the fields must be populated.

3 - the job was created on pré-1.3.0. blueprint String fields need to be populated with values on perform.

Any possible scenario must also be considered.

See Also:

XrayImportBuilderCompatibilityDelegate

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XrayImportBuilder.Descriptor

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

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 interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description

XrayImportBuilder(String serverInstance, String endpointName, String projectKey, String testEnvironments, String testPlanKey, String fixVersion, String importFilePath, String testExecKey, String revision, String importInfo, String testImportInfo, String inputInfoSwitcher, String inputTestInfoSwitcher, String importToSameExecution, String credentialId, String importInParallel) This constructor is compatible with pipelines projects

Method Summary

Modifier and Type	Method and Description
String	defaultFormats()
String	getCredentialId()
Map<String,String>	getDynamicFields()
com.xpandit.xray.model.Endpoint	getEndpoint()
String	getEndpointName()
String	getFixVersion()
String	getFormatName()
String	getFormatSuffix()
String	getImportFilePath()
String	getImportInfo()
String	getImportInParallel()
String	getImportToSameExecution()
String	getInputInfoSwitcher()
String	getInputTestInfoSwitcher()
String	getProjectKey()
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
String	getRevision()
String	getServerInstance()
String	getTestEnvironments()
String	getTestExecKey()
String	getTestImportInfo()
String	getTestPlanKey()
XrayInstance	getXrayInstance()
void	perform(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
void	setCredentialId(String credentialId)
void	setDynamicFields(Map<String,String> dynamicFields)
void	setEndpoint(com.xpandit.xray.model.Endpoint endpoint)
void	setEndpointName(String endpointName)
void	setFixVersion(String fixVersion)
void	setFormatSuffix(String formatSuffix)
void	setImportFilePath(String importFilePath)
void	setImportInfo(String importInfo)
void	setImportInParallel(String importInParallel)
void	setImportToSameExecution(String importToSameExecution)
void	setInputInfoSwitcher(String inputInfoSwitcher)
void	setProjectKey(String projectKey)
void	setRevision(String revision)
void	setServerInstance(String serverInstance)
void	setTestEnvironments(String testEnvironments)
void	setTestExecKey(String testExecKey)
void	setTestImportInfo(String testImportInfo)
void	setTestPlanKey(String testPlanKey)
void	setXrayInstance(XrayInstance xrayInstance)

Methods inherited from class hudson.tasks.Notifier

getDescriptor

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

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, perform, prebuild

Constructor Detail

XrayImportBuilder

@DataBoundConstructor
public XrayImportBuilder(String serverInstance,
                                               String endpointName,
                                               String projectKey,
                                               String testEnvironments,
                                               String testPlanKey,
                                               String fixVersion,
                                               String importFilePath,
                                               String testExecKey,
                                               String revision,
                                               String importInfo,
                                               String testImportInfo,
                                               String inputInfoSwitcher,
                                               String inputTestInfoSwitcher,
                                               String importToSameExecution,
                                               @Nullable
                                               String credentialId,
                                               String importInParallel)

This constructor is compatible with pipelines projects

"Anyway code run from Pipeline should take any configuration values as literal strings and make no attempt to perform variable substitution"

Parameters:

serverInstance - the server configuration id

endpointName - the endpoint to be used

projectKey - the project key

testEnvironments - the test environments

testPlanKey - the test plan key

fixVersion - the fix version

importFilePath - the path of the result file to be imported

testExecKey - the test execution key

revision - the revision

importInfo - the importation info file or json content

inputInfoSwitcher - filePath or fileContent switcher

credentialId -

See Also:

Writing Pipeline-Compatible Plugins

Method Detail

getDynamicFields

public Map<String,String> getDynamicFields()

setDynamicFields

@DataBoundSetter
public void setDynamicFields(Map<String,String> dynamicFields)

getXrayInstance

public XrayInstance getXrayInstance()

setXrayInstance

@DataBoundSetter
public void setXrayInstance(XrayInstance xrayInstance)

getEndpoint

public com.xpandit.xray.model.Endpoint getEndpoint()

setEndpoint

@DataBoundSetter
public void setEndpoint(com.xpandit.xray.model.Endpoint endpoint)

getFormatSuffix

public String getFormatSuffix()

getServerInstance

public String getServerInstance()

setServerInstance

public void setServerInstance(String serverInstance)

setFormatSuffix

public void setFormatSuffix(String formatSuffix)

getEndpointName

public String getEndpointName()

setEndpointName

public void setEndpointName(String endpointName)

getProjectKey

public String getProjectKey()

setProjectKey

public void setProjectKey(String projectKey)

getTestEnvironments

public String getTestEnvironments()

setTestEnvironments

public void setTestEnvironments(String testEnvironments)

getTestPlanKey

public String getTestPlanKey()

setTestPlanKey

public void setTestPlanKey(String testPlanKey)

getFixVersion

public String getFixVersion()

setFixVersion

public void setFixVersion(String fixVersion)

getImportFilePath

public String getImportFilePath()

setImportFilePath

public void setImportFilePath(String importFilePath)

getTestExecKey

public String getTestExecKey()

setTestExecKey

public void setTestExecKey(String testExecKey)

getRevision

public String getRevision()

setRevision

public void setRevision(String revision)

getImportInfo

public String getImportInfo()

setImportInfo

public void setImportInfo(String importInfo)

getImportToSameExecution

public String getImportToSameExecution()

setImportToSameExecution

public void setImportToSameExecution(String importToSameExecution)

getImportInParallel

public String getImportInParallel()

setImportInParallel

public void setImportInParallel(String importInParallel)

getCredentialId

public String getCredentialId()

setCredentialId

public void setCredentialId(String credentialId)

getFormatName

public String getFormatName()

getInputInfoSwitcher

public String getInputInfoSwitcher()

getInputTestInfoSwitcher

public String getInputTestInfoSwitcher()

setInputInfoSwitcher

public void setInputInfoSwitcher(String inputInfoSwitcher)

defaultFormats

public String defaultFormats()

perform

public void perform(@Nonnull
                    hudson.model.Run<?,?> build,
                    @Nonnull
                    hudson.FilePath workspace,
                    @Nonnull
                    hudson.Launcher launcher,
                    @Nonnull
                    hudson.model.TaskListener listener)
             throws InterruptedException,
                    IOException

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

InterruptedException

IOException

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface hudson.tasks.BuildStep

getTestImportInfo

public String getTestImportInfo()

setTestImportInfo

public void setTestImportInfo(String testImportInfo)