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:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep

public class TestlabNotifier
extends hudson.tasks.Notifier

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

Author:

Marko Kanala, Meliora Ltd

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestlabNotifier.AdvancedSettings Optional job config block for advanced settings.
static class	TestlabNotifier.Cors Optional config block for CORS settings.
static class	TestlabNotifier.DescriptorImpl
static class	TestlabNotifier.IssuesSettings Optional job config block for issues.
static class	TestlabNotifier.Usingonpremise Optional job config block for on-premise settings.

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

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
TestlabNotifier(String projectKey, String testRunTitle, String testTargetTitle, String testEnvironmentTitle, TestlabNotifier.IssuesSettings issuesSettings, TestlabNotifier.AdvancedSettings advancedSettings) This annotation tells Hudson to call this constructor, with values from the configuration form page with matching parameter names.

Method Summary

Methods

Modifier and Type	Method and Description
TestlabNotifier.AdvancedSettings	getAdvancedSettings()
String	getApiKey()
String	getAssignToUser()
String	getCompanyId()
TestlabNotifier.DescriptorImpl	getDescriptor()
TestlabNotifier.IssuesSettings	getIssuesSettings()
String	getProjectKey()
hudson.tasks.BuildStepMonitor	getRequiredMonitorService() Declares the scope of the synchronization monitor this BuildStep expects from outside.
String	getTestCaseMappingField()
String	getTestEnvironmentTitle()
String	getTestRunTitle()
String	getTestTargetTitle()
TestlabNotifier.Usingonpremise	getUsingonpremise()
static boolean	isBlank(String s)
boolean	isMergeAsSingleIssue()
boolean	isReopenExisting()
boolean	needsToRunAfterFinalized() Return true if this Publisher needs to run after the build result is fully finalized.
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) Runs the step over the given build and reports the progress to the listener.
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

Constructor Detail

TestlabNotifier

@DataBoundConstructor
public TestlabNotifier(String projectKey,
                                    String testRunTitle,
                                    String testTargetTitle,
                                    String testEnvironmentTitle,
                                    TestlabNotifier.IssuesSettings issuesSettings,
                                    TestlabNotifier.AdvancedSettings advancedSettings)

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

Method Detail

getProjectKey

public String getProjectKey()

getTestRunTitle

public String getTestRunTitle()

getTestTargetTitle

public String getTestTargetTitle()

getTestEnvironmentTitle

public String getTestEnvironmentTitle()

getIssuesSettings

public TestlabNotifier.IssuesSettings getIssuesSettings()

isMergeAsSingleIssue

public boolean isMergeAsSingleIssue()

getAssignToUser

public String getAssignToUser()

isReopenExisting

public boolean isReopenExisting()

getAdvancedSettings

public TestlabNotifier.AdvancedSettings getAdvancedSettings()

getCompanyId

public String getCompanyId()

getApiKey

public String getApiKey()

getTestCaseMappingField

public String getTestCaseMappingField()

getUsingonpremise

public TestlabNotifier.Usingonpremise getUsingonpremise()

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 hudson.tasks.Publisher

Since:

1.153

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

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

Since:

1.319

perform

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

Runs the step over the given build and reports the progress to the listener. A plugin can contribute the action object to Actionable.getActions() so that a 'report' becomes a part of the persisted data of Build. This is how JUnit plugin attaches the test report to a build page, for example. Using the return value to indicate success/failure should be considered deprecated, and implementations are encouraged to throw AbortException to indicate a failure.

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Parameters:

build -

launcher -

listener -

Returns:

Throws:

InterruptedException

IOException

getDescriptor

public TestlabNotifier.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Publisher>

Overrides:

getDescriptor in class hudson.tasks.Notifier

isBlank

public static boolean isBlank(String s)

Returns:

true if trimmed String is empty

toString

public String toString()

Overrides:

toString in class Object