com.promyze.themis.jenkins

Class ThemisReportStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

com.promyze.themis.jenkins.ThemisReportStep

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<org.jenkinsci.plugins.workflow.steps.Step>

public class ThemisReportStep
extends org.jenkinsci.plugins.workflow.steps.Step

Pipeline step that sends report files (e.g., test coverage reports) to a Themis instance in a post-build action.

To add in a pipeline, use the keyword themisReport:

themisReport(instanceName: 'Some instance', sourceKey: 'key', reports: [[type: 'type', path: 'path']])

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ThemisReportStep.DescriptorImpl Descriptor for ThemisReportStep.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
ThemisReportStep(String instanceName, String sourceKey) Default constructor

Method Summary

Modifier and Type	Method and Description
List<Map<String,String>>	getReports()
boolean	isFailBuild()
void	setFailBuild(boolean failBuild)
void	setReports(List<Map<String,String>> reports) Sets the reports
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext context)

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ThemisReportStep

@DataBoundConstructor
public ThemisReportStep(String instanceName,
                                              String sourceKey)

Default constructor

Parameters:

instanceName - the name of the Themis instance to use, as specified in the Jenkins global configuration

sourceKey - the unique key of the source for which to send reports

Method Detail

getReports

public List<Map<String,String>> getReports()

Returns:

the reports as a list of map that contains the report type with ThemisReportAction.TYPE_KEY as key and the report path with ThemisReportAction.PATH_KEY as key

setReports

@DataBoundSetter
public void setReports(List<Map<String,String>> reports)

Sets the reports

Parameters:

reports - the reports as a list of map that contains the report type with ThemisReportAction.TYPE_KEY as key and the report path with ThemisReportAction.PATH_KEY as key

isFailBuild

public boolean isFailBuild()

Returns:

whether the build should fail if there is an error during the post build action

setFailBuild

@DataBoundSetter
public void setFailBuild(boolean failBuild)

Parameters:

failBuild - true if the build should fail

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                         throws Exception

Specified by:

start in class org.jenkinsci.plugins.workflow.steps.Step

Throws:

Exception