org.jenkinsci.plugins.stashNotifier

Class StashNotifier

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Notifier

org.jenkinsci.plugins.stashNotifier.StashNotifier

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep, SimpleBuildStep

public class StashNotifier
extends Notifier
implements SimpleBuildStep

Notifies a configured Atlassian Bitbucket server instance of build results through the Bitbucket build API.

Only basic authentication is supported at the moment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StashNotifier.DescriptorImpl

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

Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_FIELD_LENGTH
static int	MAX_URL_FIELD_LENGTH

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
StashNotifier(String stashServerBaseUrl, String credentialsId, boolean ignoreUnverifiedSSLPeer, String commitSha1, String buildStatus, String buildName, boolean includeBuildNumberInKey, String projectKey, boolean prependParentProjectKey, boolean disableInprogressNotification, boolean considerUnstableAsSuccess)

Method Summary

Modifier and Type	Method and Description
protected org.apache.http.client.methods.HttpPost	createRequest(org.apache.http.HttpEntity stashBuildNotificationEntity, Item project, String commitSha1, String url) Returns the HTTP POST request ready to be sent to the Bitbucket build API for the given run and change set.
protected String	getBuildDescription(Run<?,?> run, StashBuildState state) Returns the description of the run used for the Bitbucket notification.
protected String	getBuildKey(Run<?,?> run, TaskListener listener) Returns the run key used in the Bitbucket notification.
String	getBuildName()
protected String	getBuildName(Run<?,?> run) Returns the build name to be pushed.
StashBuildState	getBuildStatus()
String	getCommitSha1()
String	getCredentialsId()
StashNotifier.DescriptorImpl	getDescriptor()
protected org.apache.http.impl.client.CloseableHttpClient	getHttpClient(PrintStream logger, Run<?,?> run, String stashServer) Returns the HttpClient through which the REST call is made.
boolean	getIgnoreUnverifiedSSLPeer()
boolean	getIncludeBuildNumberInKey()
boolean	getPrependParentProjectKey()
String	getProjectKey()
protected StashBuildState	getPushedBuildStatus(StashBuildState currentBuildStatus) Returns the build state to be pushed.
BuildStepMonitor	getRequiredMonitorService()
String	getStashServerBaseUrl()
boolean	isConsiderUnstableAsSuccess()
boolean	isDisableInprogressNotification()
protected Collection<String>	lookupCommitSha1s(Run run, FilePath workspace, TaskListener listener)
protected <C extends com.cloudbees.plugins.credentials.Credentials> List<C>	lookupCredentials(Class<C> type, Item item, org.acegisecurity.Authentication authentication, ArrayList<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements) Returns all credentials which are available to the specified Authentication for use by the specified Item.
protected <C extends com.cloudbees.plugins.credentials.Credentials> List<C>	lookupCredentials(Class<C> type, ItemGroup<?> itemGroup, org.acegisecurity.Authentication authentication, ArrayList<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements) Returns all credentials which are available to the specified Authentication for use by the specified Item.
protected NotificationResult	notifyStash(PrintStream logger, Run<?,?> run, String commitSha1, TaskListener listener, StashBuildState state) Notifies the configured Bitbucket server by POSTing the run results to the Bitbucket run API.
boolean	perform(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener)
void	perform(Run<?,?> run, FilePath workspace, Launcher launcher, TaskListener listener)
boolean	prebuild(AbstractBuild<?,?> build, BuildListener listener)

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform

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

getProjectAction, getProjectActions

Field Detail

MAX_FIELD_LENGTH

public static final int MAX_FIELD_LENGTH

See Also:

Constant Field Values

MAX_URL_FIELD_LENGTH

public static final int MAX_URL_FIELD_LENGTH

See Also:

Constant Field Values

Constructor Detail

StashNotifier

@DataBoundConstructor
public StashNotifier(String stashServerBaseUrl,
                                            String credentialsId,
                                            boolean ignoreUnverifiedSSLPeer,
                                            String commitSha1,
                                            String buildStatus,
                                            String buildName,
                                            boolean includeBuildNumberInKey,
                                            String projectKey,
                                            boolean prependParentProjectKey,
                                            boolean disableInprogressNotification,
                                            boolean considerUnstableAsSuccess)

Method Detail

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface BuildStep

isDisableInprogressNotification

public boolean isDisableInprogressNotification()

isConsiderUnstableAsSuccess

public boolean isConsiderUnstableAsSuccess()

getCredentialsId

public String getCredentialsId()

getStashServerBaseUrl

public String getStashServerBaseUrl()

getIgnoreUnverifiedSSLPeer

public boolean getIgnoreUnverifiedSSLPeer()

getCommitSha1

public String getCommitSha1()

getBuildStatus

public StashBuildState getBuildStatus()

getBuildName

public String getBuildName()

getIncludeBuildNumberInKey

public boolean getIncludeBuildNumberInKey()

getProjectKey

public String getProjectKey()

getPrependParentProjectKey

public boolean getPrependParentProjectKey()

prebuild

public boolean prebuild(AbstractBuild<?,?> build,
                        BuildListener listener)

Specified by:

prebuild in interface BuildStep

Overrides:

prebuild in class BuildStepCompatibilityLayer

perform

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

Specified by:

perform in interface BuildStep

Overrides:

perform 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

lookupCommitSha1s

protected Collection<String> lookupCommitSha1s(Run run,
                                               FilePath workspace,
                                               TaskListener listener)

getHttpClient

protected org.apache.http.impl.client.CloseableHttpClient getHttpClient(PrintStream logger,
                                                                        Run<?,?> run,
                                                                        String stashServer)
                                                                 throws Exception

Returns the HttpClient through which the REST call is made. Uses an unsafe TrustStrategy in case the user specified a HTTPS URL and set the ignoreUnverifiedSSLPeer flag.

Throws:

Exception

getDescriptor

public StashNotifier.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<Publisher>

Overrides:

getDescriptor in class Notifier

notifyStash

protected NotificationResult notifyStash(PrintStream logger,
                                         Run<?,?> run,
                                         String commitSha1,
                                         TaskListener listener,
                                         StashBuildState state)
                                  throws Exception

Notifies the configured Bitbucket server by POSTing the run results to the Bitbucket run API.

Parameters:

logger - the logger to use

run - the run to notify Bitbucket of

commitSha1 - the SHA1 of the run commit

listener - the run listener for logging

state - the state of the build as defined by the Bitbucket API.

Throws:

Exception

lookupCredentials

protected <C extends com.cloudbees.plugins.credentials.Credentials> List<C> lookupCredentials(Class<C> type,
                                                                                              Item item,
                                                                                              org.acegisecurity.Authentication authentication,
                                                                                              ArrayList<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements)

Returns all credentials which are available to the specified Authentication for use by the specified Item.

Type Parameters:

C - the credentials type.

Parameters:

type - the type of credentials to get.

authentication - the authentication.

item - the item.

domainRequirements - the credential domains to match.

Returns:

the list of credentials.

lookupCredentials

protected <C extends com.cloudbees.plugins.credentials.Credentials> List<C> lookupCredentials(Class<C> type,
                                                                                              ItemGroup<?> itemGroup,
                                                                                              org.acegisecurity.Authentication authentication,
                                                                                              ArrayList<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements)

Returns all credentials which are available to the specified Authentication for use by the specified Item.

Type Parameters:

C - the credentials type.

Parameters:

type - the type of credentials to get.

authentication - the authentication.

itemGroup - the item group.

domainRequirements - the credential domains to match.

Returns:

the list of credentials.

getPushedBuildStatus

protected StashBuildState getPushedBuildStatus(StashBuildState currentBuildStatus)

Returns the build state to be pushed. This will select the specifically overwritten build state or the current build state else.

Parameters:

currentBuildStatus - the state of the current build

Returns:

the selected build state

createRequest

protected org.apache.http.client.methods.HttpPost createRequest(org.apache.http.HttpEntity stashBuildNotificationEntity,
                                                                Item project,
                                                                String commitSha1,
                                                                String url)
                                                         throws org.apache.http.auth.AuthenticationException

Returns the HTTP POST request ready to be sent to the Bitbucket build API for the given run and change set.

Parameters:

stashBuildNotificationEntity - a entity containing the parameters for Bitbucket

commitSha1 - the SHA1 of the commit that was built

url -

Returns:

the HTTP POST request to the Bitbucket build API

Throws:

org.apache.http.auth.AuthenticationException

getBuildKey

protected String getBuildKey(Run<?,?> run,
                             TaskListener listener)

Returns the run key used in the Bitbucket notification. Includes the run number depending on the user setting.

Parameters:

run - the run to notify Bitbucket of

Returns:

the run key for the Bitbucket notification

getBuildName

protected String getBuildName(Run<?,?> run)

Returns the build name to be pushed. This will select the specifically overwritten build name or get the build name from the Run.

Parameters:

run - the run to notify Bitbucket of

Returns:

the selected build state

getBuildDescription

protected String getBuildDescription(Run<?,?> run,
                                     StashBuildState state)

Returns the description of the run used for the Bitbucket notification. Uses the run description provided by the Jenkins job, if available.

Parameters:

run - the run to be described

state - the state of the run

Returns:

the description of the run