Package fi.meliora.testlab.ext.jenkins

Class TestlabNotifier

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Notifier

fi.meliora.testlab.ext.jenkins.TestlabNotifier

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep, SimpleBuildStep

public class TestlabNotifier
extends Notifier
implements SimpleBuildStep

A post build action to publish test results to Meliora Testlab.

Author:

Meliora Ltd

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TestlabNotifier.AdvancedSettings	Optional job config block for advanced settings.
static final class	TestlabNotifier.Cors	Optional config block for CORS settings.
static final class	TestlabNotifier.DescriptorImpl
static final class	TestlabNotifier.ImportTestCases	Deprecated.
static final class	TestlabNotifier.IssuesSettings	Optional job config block for issues.
static final class	TestlabNotifier.PublishRobot	Optional job config block for Robot Framework support.
static final class	TestlabNotifier.PublishTap	Optional job config block for TAP support.
static final class	TestlabNotifier.RulesetSettings	Optional job config block for ruleset settings.
static final class	TestlabNotifier.Usingonpremise	Optional job config block for on-premise settings.

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
static final String	DEFAULT_AUTOMATIONSOURCE
static final String	DEFAULT_DESCRIPTION_TEMPLATE

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
TestlabNotifier(String projectKey, String ruleset, TestlabNotifier.RulesetSettings rulesetSettings, String description, String parameters, TestlabNotifier.PublishRobot publishRobot, TestlabNotifier.PublishTap publishTap, TestlabNotifier.AdvancedSettings advancedSettings)	This annotation tells Hudson to call this constructor, with values from the configuration form page with matching parameter names.

Method Summary

Modifier and Type	Method	Description
protected boolean	doPerform(Run<?,?> build, FilePath workspace, TaskListener listener)	Execute our logic.
TestlabNotifier.AdvancedSettings	getAdvancedSettings()
String	getAutomationSource()
String	getDescription()
TestlabNotifier.DescriptorImpl	getDescriptor()
String	getParameters()
String	getProjectKey()
TestlabNotifier.PublishRobot	getPublishRobot()
TestlabNotifier.PublishTap	getPublishTap()
BuildStepMonitor	getRequiredMonitorService()	Declares the scope of the synchronization monitor this BuildStep expects from outside.
String	getRuleset()
TestlabNotifier.RulesetSettings	getRulesetSettings()
static boolean	isBlank(String s)
boolean	needsToRunAfterFinalized()	Return true if this Publisher needs to run after the build result is fully finalized.
boolean	perform(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener)
void	perform(Run<?,?> run, FilePath workspace, EnvVars env, Launcher launcher, TaskListener listener)
protected Object	readResolve()
void	setAdvancedSettings(TestlabNotifier.AdvancedSettings advancedSettings)
void	setAutomationSource(String automationSource)
void	setDescription(String description)
void	setParameters(String parameters)
void	setPublishRobot(TestlabNotifier.PublishRobot publishRobot)
void	setPublishTap(TestlabNotifier.PublishTap publishTap)
void	setRuleset(String ruleset)
void	setRulesetSettings(TestlabNotifier.RulesetSettings rulesetSettings)
String	toString()

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, prebuild

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, perform, requiresWorkspace

Field Details

DEFAULT_DESCRIPTION_TEMPLATE

public static final String DEFAULT_DESCRIPTION_TEMPLATE

See Also:

• Constant Field Values

DEFAULT_AUTOMATIONSOURCE

public static final String DEFAULT_AUTOMATIONSOURCE

See Also:

• Constant Field Values

Constructor Details

TestlabNotifier

@DataBoundConstructor
public TestlabNotifier(String projectKey,
 String ruleset,
 TestlabNotifier.RulesetSettings rulesetSettings,
 String description,
 String parameters,
 TestlabNotifier.PublishRobot publishRobot,
 TestlabNotifier.PublishTap publishTap,
 TestlabNotifier.AdvancedSettings advancedSettings)

This annotation tells Hudson to call this constructor, with values from the configuration form page with matching parameter names.

Method Details

getProjectKey

public String getProjectKey()

getRuleset

public String getRuleset()

setRuleset

@DataBoundSetter
public void setRuleset(String ruleset)

getRulesetSettings

public TestlabNotifier.RulesetSettings getRulesetSettings()

setRulesetSettings

@DataBoundSetter
public void setRulesetSettings(TestlabNotifier.RulesetSettings rulesetSettings)

getAutomationSource

public String getAutomationSource()

setAutomationSource

@DataBoundSetter
public void setAutomationSource(String automationSource)

getDescription

public String getDescription()

setDescription

@DataBoundSetter
public void setDescription(String description)

getParameters

public String getParameters()

setParameters

@DataBoundSetter
public void setParameters(String parameters)

getPublishRobot

public TestlabNotifier.PublishRobot getPublishRobot()

setPublishRobot

@DataBoundSetter
public void setPublishRobot(TestlabNotifier.PublishRobot publishRobot)

getPublishTap

public TestlabNotifier.PublishTap getPublishTap()

setPublishTap

@DataBoundSetter
public void setPublishTap(TestlabNotifier.PublishTap publishTap)

getAdvancedSettings

public TestlabNotifier.AdvancedSettings getAdvancedSettings()

setAdvancedSettings

@DataBoundSetter
public void setAdvancedSettings(TestlabNotifier.AdvancedSettings advancedSettings)

readResolve

protected Object readResolve()

needsToRunAfterFinalized

public boolean needsToRunAfterFinalized()

Return true if this Publisher needs to run after the build result is fully finalized.

The execution of normal Publishers are considered within a part of the build. This allows publishers to mark the build as a failure, or to include their execution time in the total build time.

So normally, that is the preferrable behavior, but in a few cases this is problematic. One of such cases is when a publisher needs to trigger other builds, which in turn need to see this build as a completed build. Those plugins that need to do this can return true from this method, so that the perform(hudson.model.AbstractBuild, hudson.Launcher, hudson.model.BuildListener) method is called after the build is marked as completed.

When Publisher behaves this way, note that they can no longer change the build status anymore.

Overrides:

needsToRunAfterFinalized in class Publisher

Since:

1.153

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Declares the scope of the synchronization monitor this BuildStep expects from outside.

Specified by:

getRequiredMonitorService in interface BuildStep

Since:

1.319

perform

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

Specified by:

perform in interface SimpleBuildStep

Throws:

InterruptedException

IOException

perform

public boolean perform(AbstractBuild<?,?> build,
 Launcher launcher,
 BuildListener listener)
                throws InterruptedException,
IOException

Specified by:

perform in interface BuildStep

Overrides:

perform in class BuildStepCompatibilityLayer

Throws:

InterruptedException

IOException

doPerform

protected boolean doPerform(Run<?,?> build,
 FilePath workspace,
 TaskListener listener)
                     throws IOException,
InterruptedException

Execute our logic. Should throw AbortException for graceful and polite errors.

Throws:

IOException

InterruptedException

getDescriptor

public TestlabNotifier.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<Publisher>

Overrides:

getDescriptor in class Notifier

isBlank

public static boolean isBlank(String s)

Returns:

true if trimmed String is empty

toString

public String toString()

Overrides:

toString in class Object