Package org.tap4j.plugin

Class TapPublisher

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

org.tap4j.plugin.TapPublisher

All Implemented Interfaces:

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

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

Publishes TAP results in Jenkins builds.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TapPublisher.DescriptorImpl

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

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor

Description

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	Description
hudson.matrix.MatrixAggregator	createAggregator(hudson.matrix.MatrixBuild build, Launcher launcher, BuildListener listener)
Boolean	getDiscardOldReports()
Boolean	getEnableSubtests()
Boolean	getFailedTestsMarkBuildAsFailure()
Boolean	getFailIfNoResults()
Boolean	getFlattenTapResult()
Boolean	getIncludeCommentDiagnostics()
Boolean	getOutputTapToConsole()
Boolean	getPlanRequired()
Action	getProjectAction(AbstractProject<?,?> project)
Boolean	getRemoveYamlIfCorrupted()
static FilePath	getReportsDirectory(Run<?,?> build)	Gets the directory where the plug-in saves its TAP streams before processing them and displaying in the UI.
BuildStepMonitor	getRequiredMonitorService()
Boolean	getShowOnlyFailures()
Boolean	getSkipIfBuildNotOk()
Boolean	getStripSingleParents()
String	getTestResults()
Boolean	getTodoIsFailure()
Boolean	getValidateNumberOfTests()
Boolean	getVerbose()
void	perform(Run<?,?> run, FilePath workspace, Launcher launcher, TaskListener listener)
Object	readResolve()	To prevent serialization issues after fields have been added or removed.

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

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, perform, requiresWorkspace

Constructor Details

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 Details

readResolve

public Object readResolve()

To prevent serialization issues after fields have been added or removed. e.g. https://issues.jenkins.io/browse/JENKINS-72558.

Returns:

The instance

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 FilePath getReportsDirectory(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 Action getProjectAction(AbstractProject<?,?> project)

Specified by:

getProjectAction in interface BuildStep

Overrides:

getProjectAction in class BuildStepCompatibilityLayer

perform

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

Specified by:

perform in interface SimpleBuildStep

Throws:

InterruptedException

IOException

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface BuildStep

createAggregator

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

Specified by:

createAggregator in interface hudson.matrix.MatrixAggregatable