Package de.tracetronic.jenkins.plugins.ecutest.report.atx

Class ATXPublisher

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

de.tracetronic.jenkins.plugins.ecutest.report.AbstractReportPublisher

de.tracetronic.jenkins.plugins.ecutest.report.atx.ATXPublisher

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep, SimpleBuildStep

public class ATXPublisher
extends AbstractReportPublisher

Publisher providing the generation and upload of ATXReports to test.guide.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ATXPublisher.DescriptorImpl	DescriptorImpl for ATXPublisher.

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

Publisher.DescriptorExtensionListImpl

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

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

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

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	URL_NAME	The URL name to ATXZipReports holding by AbstractATXAction.

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
ATXPublisher(String atxName)	Instantiates a new ATXPublisher.

Method Summary

Modifier and Type	Method	Description
ATXInstallation	getAtxInstallation()
String	getAtxName()
ATXInstallation	getInstallation()	Gets the ATXInstallation by descriptor and name.
ATXInstallation	getInstallation(EnvVars envVars)	Gets the ATXInstallation by descriptor and expanded name.
String	getUrlName()	Gets the URL name that will be used for archiving and linking the reports.
boolean	isFailOnOffline()
boolean	isInjectBuildVars()
boolean	isUsePersistedSettings()
void	performReport(Run<?,?> run, FilePath workspace, Launcher launcher, TaskListener listener)	Performs the report-specific post-build operations.
void	setAtxInstallation(ATXInstallation atxInstallation)	Sets the ATX installation and the derived name.
void	setFailOnOffline(boolean failOnOffline)
void	setInjectBuildVars(boolean injectBuildVars)
void	setUsePersistedSettings(boolean usePersistedSettings)

Methods inherited from class de.tracetronic.jenkins.plugins.ecutest.report.AbstractReportPublisher

canContinue, configureToolInstallation, getArchiveTarget, getArchiving, getDescriptor, getDirectorySize, getFileSize, getFirstReportFile, getKeepAll, getLogger, getProjectReportFiles, getReportDir, getReportDirs, getReportFiles, getReportFiles, getRequiredMonitorService, getSettingsDir, getToolClient, getToolDescriptor, getToolInstallation, getWorkspace, getWorkspaceDir, isAllowMissing, isArchiving, isDownstream, isETRunning, isKeepAll, isRunOnFailed, isSkipped, perform, randomId, removePreviousReports, setAllowMissing, setArchiving, setDownstream, setKeepAll, setReportDir, setRunOnFailed, setWorkspace

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

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, perform, requiresWorkspace

Field Detail

URL_NAME

protected static final String URL_NAME

The URL name to ATXZipReports holding by AbstractATXAction.

See Also:

Constant Field Values

Constructor Detail

ATXPublisher

@DataBoundConstructor
public ATXPublisher(@Nonnull
                    String atxName)

Instantiates a new ATXPublisher.

Parameters:

atxName - the tool name identifying the ATXInstallation to be used

Method Detail

getAtxName

@Nonnull
public String getAtxName()

getAtxInstallation

public ATXInstallation getAtxInstallation()

setAtxInstallation

@DataBoundSetter
public void setAtxInstallation(ATXInstallation atxInstallation)

Sets the ATX installation and the derived name.

Parameters:

atxInstallation - the ATX installation

isFailOnOffline

public boolean isFailOnOffline()

setFailOnOffline

@DataBoundSetter
public void setFailOnOffline(boolean failOnOffline)

isUsePersistedSettings

public boolean isUsePersistedSettings()

setUsePersistedSettings

@DataBoundSetter
public void setUsePersistedSettings(boolean usePersistedSettings)

isInjectBuildVars

public boolean isInjectBuildVars()

setInjectBuildVars

@DataBoundSetter
public void setInjectBuildVars(boolean injectBuildVars)

performReport

public void performReport(Run<?,?> run,
                          FilePath workspace,
                          Launcher launcher,
                          TaskListener listener)
                   throws InterruptedException,
                          IOException,
                          ETPluginException

Description copied from class: AbstractReportPublisher

Performs the report-specific post-build operations.

Specified by:

performReport in class AbstractReportPublisher

Parameters:

run - the run

workspace - the workspace

launcher - the launcher

listener - the listener

Throws:

InterruptedException - the interrupted exception

IOException - signals that an I/O exception has occurred

ETPluginException - in case of report operation errors

getInstallation

@CheckForNull
public ATXInstallation getInstallation()

Gets the ATXInstallation by descriptor and name.

Returns:

the ATXInstallation

getInstallation

@CheckForNull
public ATXInstallation getInstallation(EnvVars envVars)

Gets the ATXInstallation by descriptor and expanded name.

Parameters:

envVars - the environment variables

Returns:

the ATXInstallation

getUrlName

public String getUrlName()

Description copied from class: AbstractReportPublisher

Gets the URL name that will be used for archiving and linking the reports.

Specified by:

getUrlName in class AbstractReportPublisher

Returns:

the URL name