org.tap4j.plugin

Class TapPublisher

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

org.tap4j.plugin.TapPublisher

All Implemented Interfaces:

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

public class TapPublisher
extends hudson.tasks.Recorder
implements hudson.matrix.MatrixAggregatable, jenkins.tasks.SimpleBuildStep

Publishes TAP results in Jenkins builds.

Since:

1.0

Author:

Bruno P. Kinoshita - http://www.kinoshita.eti.br

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TapPublisher.DescriptorImpl

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

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

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

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
TapPublisher(String testResults, Boolean failIfNoResults, Boolean failedTestsMarkBuildAsFailure, Boolean outputTapToConsole, Boolean enableSubtests, Boolean discardOldReports, Boolean todoIsFailure, Boolean includeCommentDiagnostics, Boolean validateNumberOfTests, Boolean planRequired, Boolean verbose) Deprecated.
TapPublisher(String testResults, Boolean failIfNoResults, Boolean failedTestsMarkBuildAsFailure, Boolean outputTapToConsole, Boolean enableSubtests, Boolean discardOldReports, Boolean todoIsFailure, Boolean includeCommentDiagnostics, Boolean validateNumberOfTests, Boolean planRequired, Boolean verbose, Boolean showOnlyFailures) Deprecated.
TapPublisher(String testResults, Boolean failIfNoResults, Boolean failedTestsMarkBuildAsFailure, Boolean outputTapToConsole, Boolean enableSubtests, Boolean discardOldReports, Boolean todoIsFailure, Boolean includeCommentDiagnostics, Boolean validateNumberOfTests, Boolean planRequired, Boolean verbose, Boolean showOnlyFailures, Boolean stripSingleParents) Deprecated.
TapPublisher(String testResults, Boolean failIfNoResults, Boolean failedTestsMarkBuildAsFailure, Boolean outputTapToConsole, Boolean enableSubtests, Boolean discardOldReports, Boolean todoIsFailure, Boolean includeCommentDiagnostics, Boolean validateNumberOfTests, Boolean planRequired, Boolean verbose, Boolean showOnlyFailures, Boolean stripSingleParents, Boolean flattenTapResult) Deprecated.
TapPublisher(String testResults, Boolean failIfNoResults, Boolean failedTestsMarkBuildAsFailure, Boolean outputTapToConsole, Boolean enableSubtests, Boolean discardOldReports, Boolean todoIsFailure, Boolean includeCommentDiagnostics, Boolean validateNumberOfTests, Boolean planRequired, Boolean verbose, Boolean showOnlyFailures, Boolean stripSingleParents, Boolean flattenTapResult, Boolean skipIfBuildNotOk) Deprecated.
TapPublisher(String testResults, Boolean failIfNoResults, Boolean failedTestsMarkBuildAsFailure, Boolean outputTapToConsole, Boolean enableSubtests, Boolean discardOldReports, Boolean todoIsFailure, Boolean includeCommentDiagnostics, Boolean validateNumberOfTests, Boolean planRequired, Boolean verbose, Boolean showOnlyFailures, Boolean stripSingleParents, Boolean flattenTapResult, Boolean removeYamlIfCorrupted, Boolean skipIfBuildNotOk)

Method Summary

Modifier and Type	Method and Description
hudson.matrix.MatrixAggregator	createAggregator(hudson.matrix.MatrixBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener)
Boolean	getDiscardOldReports()
Boolean	getEnableSubtests()
Boolean	getFailedTestsMarkBuildAsFailure()
Boolean	getFailIfNoResults()
Boolean	getFlattenTapResult()
Boolean	getIncludeCommentDiagnostics()
Boolean	getOutputTapToConsole()
Boolean	getPlanRequired()
hudson.model.Action	getProjectAction(hudson.model.AbstractProject<?,?> project)
Boolean	getRemoveYamlIfCorrupted()
static hudson.FilePath	getReportsDirectory(hudson.model.Run build) Gets the directory where the plug-in saves its TAP streams before processing them and displaying in the UI.
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
Boolean	getShowOnlyFailures()
Boolean	getSkipIfBuildNotOk()
Boolean	getStripSingleParents()
String	getTestResults()
Boolean	getTodoIsFailure()
Boolean	getValidateNumberOfTests()
Boolean	getVerbose()
void	perform(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
Object	readResolve()

Methods inherited from class hudson.tasks.Recorder

getDescriptor

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

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

getProjectActions, perform, prebuild

Constructor Detail

TapPublisher

@Deprecated
public TapPublisher(String testResults,
                                Boolean failIfNoResults,
                                Boolean failedTestsMarkBuildAsFailure,
                                Boolean outputTapToConsole,
                                Boolean enableSubtests,
                                Boolean discardOldReports,
                                Boolean todoIsFailure,
                                Boolean includeCommentDiagnostics,
                                Boolean validateNumberOfTests,
                                Boolean planRequired,
                                Boolean verbose)

Deprecated.

TapPublisher

@Deprecated
public TapPublisher(String testResults,
                                Boolean failIfNoResults,
                                Boolean failedTestsMarkBuildAsFailure,
                                Boolean outputTapToConsole,
                                Boolean enableSubtests,
                                Boolean discardOldReports,
                                Boolean todoIsFailure,
                                Boolean includeCommentDiagnostics,
                                Boolean validateNumberOfTests,
                                Boolean planRequired,
                                Boolean verbose,
                                Boolean showOnlyFailures)

Deprecated.

TapPublisher

@Deprecated
public TapPublisher(String testResults,
                                Boolean failIfNoResults,
                                Boolean failedTestsMarkBuildAsFailure,
                                Boolean outputTapToConsole,
                                Boolean enableSubtests,
                                Boolean discardOldReports,
                                Boolean todoIsFailure,
                                Boolean includeCommentDiagnostics,
                                Boolean validateNumberOfTests,
                                Boolean planRequired,
                                Boolean verbose,
                                Boolean showOnlyFailures,
                                Boolean stripSingleParents)

Deprecated.

TapPublisher

@Deprecated
public TapPublisher(String testResults,
                                Boolean failIfNoResults,
                                Boolean failedTestsMarkBuildAsFailure,
                                Boolean outputTapToConsole,
                                Boolean enableSubtests,
                                Boolean discardOldReports,
                                Boolean todoIsFailure,
                                Boolean includeCommentDiagnostics,
                                Boolean validateNumberOfTests,
                                Boolean planRequired,
                                Boolean verbose,
                                Boolean showOnlyFailures,
                                Boolean stripSingleParents,
                                Boolean flattenTapResult)

Deprecated.

TapPublisher

@Deprecated
public TapPublisher(String testResults,
                                Boolean failIfNoResults,
                                Boolean failedTestsMarkBuildAsFailure,
                                Boolean outputTapToConsole,
                                Boolean enableSubtests,
                                Boolean discardOldReports,
                                Boolean todoIsFailure,
                                Boolean includeCommentDiagnostics,
                                Boolean validateNumberOfTests,
                                Boolean planRequired,
                                Boolean verbose,
                                Boolean showOnlyFailures,
                                Boolean stripSingleParents,
                                Boolean flattenTapResult,
                                Boolean skipIfBuildNotOk)

Deprecated.

TapPublisher

@DataBoundConstructor
public TapPublisher(String testResults,
                                          Boolean failIfNoResults,
                                          Boolean failedTestsMarkBuildAsFailure,
                                          Boolean outputTapToConsole,
                                          Boolean enableSubtests,
                                          Boolean discardOldReports,
                                          Boolean todoIsFailure,
                                          Boolean includeCommentDiagnostics,
                                          Boolean validateNumberOfTests,
                                          Boolean planRequired,
                                          Boolean verbose,
                                          Boolean showOnlyFailures,
                                          Boolean stripSingleParents,
                                          Boolean flattenTapResult,
                                          Boolean removeYamlIfCorrupted,
                                          Boolean skipIfBuildNotOk)

Method Detail

readResolve

public Object readResolve()

getShowOnlyFailures

public Boolean getShowOnlyFailures()

getStripSingleParents

public Boolean getStripSingleParents()

getFailIfNoResults

public Boolean getFailIfNoResults()

Returns:

the failIfNoResults

getTestResults

public String getTestResults()

Returns:

the testResults

getFailedTestsMarkBuildAsFailure

public Boolean getFailedTestsMarkBuildAsFailure()

getOutputTapToConsole

public Boolean getOutputTapToConsole()

Returns:

the outputTapToConsole

getEnableSubtests

public Boolean getEnableSubtests()

Returns:

the enableSubtests

getDiscardOldReports

public Boolean getDiscardOldReports()

Returns:

the discardOldReports

getTodoIsFailure

public Boolean getTodoIsFailure()

Returns:

the todoIsFailure

getIncludeCommentDiagnostics

public Boolean getIncludeCommentDiagnostics()

Returns:

the includeCommentDiagnostics

getValidateNumberOfTests

public Boolean getValidateNumberOfTests()

getPlanRequired

public Boolean getPlanRequired()

getVerbose

public Boolean getVerbose()

getFlattenTapResult

public Boolean getFlattenTapResult()

getRemoveYamlIfCorrupted

public Boolean getRemoveYamlIfCorrupted()

getSkipIfBuildNotOk

public Boolean getSkipIfBuildNotOk()

getReportsDirectory

public static hudson.FilePath getReportsDirectory(hudson.model.Run build)

Gets the directory where the plug-in saves its TAP streams before processing them and displaying in the UI.

Adapted from JUnit Attachments Plug-in.

Parameters:

build - Jenkins build

Returns:

virtual directory (FilePath)

getProjectAction

public hudson.model.Action getProjectAction(hudson.model.AbstractProject<?,?> project)

Specified by:

getProjectAction in interface hudson.tasks.BuildStep

Overrides:

getProjectAction in class hudson.tasks.BuildStepCompatibilityLayer

perform

public void perform(@Nonnull
                    hudson.model.Run<?,?> run,
                    @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

createAggregator

public hudson.matrix.MatrixAggregator createAggregator(hudson.matrix.MatrixBuild build,
                                                       hudson.Launcher launcher,
                                                       hudson.model.BuildListener listener)

Specified by:

createAggregator in interface hudson.matrix.MatrixAggregatable