com.xpandit.plugins.xrayjenkins.task

Class XrayExportBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

com.xpandit.plugins.xrayjenkins.task.XrayExportBuilder

All Implemented Interfaces:

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

public class XrayExportBuilder
extends hudson.tasks.Builder
implements jenkins.tasks.SimpleBuildStep

This class is responsible for performing the Xray: Cucumber Features Export 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:

XrayExportBuilderCompatibilityDelegate

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XrayExportBuilder.Descriptor

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
XrayExportBuilder(String serverInstance, String issues, String filter, String filePath, String credentialId) Constructor used in pipelines projects "Anyway code run from Pipeline should take any configuration values as literal strings and make no attempt to perform variable substitution"

Method Summary

Modifier and Type	Method and Description
String	getCredentialId()
Map<String,String>	getFields()
String	getFilePath()
String	getFilter()
String	getIssues()
String	getServerInstance()
XrayInstance	getXrayInstance()
void	perform(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
void	setCredentialId(String credentialId)
void	setFields(Map<String,String> fields)
void	setFilePath(String filePath)
void	setFilter(String filter)
void	setIssues(String issues)
void	setServerInstance(String serverInstance)
void	setXrayInstance(XrayInstance xrayInstance)

Methods inherited from class hudson.tasks.Builder

all, getDescriptor, 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

XrayExportBuilder

@DataBoundConstructor
public XrayExportBuilder(String serverInstance,
                                               String issues,
                                               String filter,
                                               String filePath,
                                               String credentialId)

Constructor used in 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

issues - the issues to export

filter - the saved filter id

filePath - the file path to export

See Also:

Writing Pipeline-Compatible Plugins

Method Detail

perform

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

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

IOException

getServerInstance

public String getServerInstance()

setServerInstance

public void setServerInstance(String serverInstance)

getIssues

public String getIssues()

setIssues

public void setIssues(String issues)

getFilter

public String getFilter()

setFilter

public void setFilter(String filter)

getFilePath

public String getFilePath()

setFilePath

public void setFilePath(String filePath)

getCredentialId

public String getCredentialId()

setCredentialId

public void setCredentialId(String credentialId)

getXrayInstance

public XrayInstance getXrayInstance()

setXrayInstance

@DataBoundSetter
public void setXrayInstance(XrayInstance xrayInstance)

getFields

public Map<String,String> getFields()

setFields

@DataBoundSetter
public void setFields(Map<String,String> fields)