org.jenkinsci.plugins.githubautostatus

Class BuildStatusAction

java.lang.Object

hudson.model.InvisibleAction

org.jenkinsci.plugins.githubautostatus.BuildStatusAction

All Implemented Interfaces:

Action, ModelObject

public class BuildStatusAction
extends InvisibleAction

Keeps track of build status for each stage in a build, and provides mechanisms for notifying various subscribers as stages and jobs are completed.

Author:

Jeff Pearce (jxpearce@godaddy.com)

Constructor Summary

Constructors

Constructor and Description
BuildStatusAction(Run<?,?> run, String targetUrl, List<BuildStageModel> stageList) Construct a BuildStatusAction

Method Summary

Modifier and Type	Method and Description
void	addBuildStatus(String stageName) Sends pending notifications for the start of a stage
void	addGenericNofifier(BuildNotifier notifier)
void	addGithubNotifier(GithubNotificationConfig config) Attempts to add a GitHub notifier
void	addInfluxDbNotifier(InfluxDbNotifierConfig influxDbNotifierConfig) Attempts to add an influx db notifier
void	addStatsdNotifier(StatsdNotifierConfig statsdNotifierConfig) Attempts to add an Statsd notifier
void	close() Cleans up by sending "complete" status to any steps that are currently pending.
String	getBranchName()
String	getJobName()
String	getRepoName()
String	getRepoOwner()
boolean	isIsDeclarativePipeline() Sets flag indicating whether notifications are for a declarative pipeline
void	sendNonStageError(String nodeName) Sends notifications for an error that happens outside of a stage
void	sendNotifications(BuildNotifier notifier) Sends all saved notifications to a notifier
void	setBranchName(String branchName)
void	setIsDeclarativePipeline(boolean isDeclarativePipeline)
void	setRepoName(String repoName)
void	setRepoOwner(String repoOwner)
void	updateBuildStatusForJob(BuildState buildState, Map<String,Object> parameters) Sends notifications for final build status
void	updateBuildStatusForStage(String nodeName, BuildState buildState) Sends notifications for a completed stage
void	updateBuildStatusForStage(String nodeName, BuildState buildState, long time) Sends notifications for a completed stage

Methods inherited from class hudson.model.InvisibleAction

getDisplayName, getIconFileName, getUrlName

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildStatusAction

public BuildStatusAction(Run<?,?> run,
                         String targetUrl,
                         List<BuildStageModel> stageList)

Construct a BuildStatusAction

Parameters:

run - the build

targetUrl - link back to Jenkins

stageList - list of stages if known

Method Detail

getJobName

public String getJobName()

getRepoOwner

public String getRepoOwner()

setRepoOwner

public void setRepoOwner(String repoOwner)

getRepoName

public String getRepoName()

setRepoName

public void setRepoName(String repoName)

getBranchName

public String getBranchName()

setBranchName

public void setBranchName(String branchName)

close

public void close()

Cleans up by sending "complete" status to any steps that are currently pending. Needed because some complex jobs, particularly using down

isIsDeclarativePipeline

public boolean isIsDeclarativePipeline()

Sets flag indicating whether notifications are for a declarative pipeline

Returns:

if pipeline is declarative or not

setIsDeclarativePipeline

public void setIsDeclarativePipeline(boolean isDeclarativePipeline)

addGithubNotifier

public void addGithubNotifier(GithubNotificationConfig config)

Attempts to add a GitHub notifier

Parameters:

config - GitHub notifier config

addInfluxDbNotifier

public void addInfluxDbNotifier(InfluxDbNotifierConfig influxDbNotifierConfig)

Attempts to add an influx db notifier

Parameters:

influxDbNotifierConfig - influx db notifier config

addStatsdNotifier

public void addStatsdNotifier(StatsdNotifierConfig statsdNotifierConfig)

Attempts to add an Statsd notifier

Parameters:

statsdNotifierConfig - Statsd notifier config

addGenericNofifier

public void addGenericNofifier(BuildNotifier notifier)

sendNotifications

public void sendNotifications(BuildNotifier notifier)

Sends all saved notifications to a notifier

Parameters:

notifier - notifier to send to

addBuildStatus

public void addBuildStatus(String stageName)

Sends pending notifications for the start of a stage

Parameters:

stageName - stage name

updateBuildStatusForStage

public void updateBuildStatusForStage(String nodeName,
                                      BuildState buildState,
                                      long time)

Sends notifications for a completed stage

Parameters:

nodeName - node name

buildState - build state

time - stage time

updateBuildStatusForStage

public void updateBuildStatusForStage(String nodeName,
                                      BuildState buildState)

Sends notifications for a completed stage

Parameters:

nodeName - node name

buildState - build state

updateBuildStatusForJob

public void updateBuildStatusForJob(BuildState buildState,
                                    Map<String,Object> parameters)

Sends notifications for final build status

Parameters:

buildState - final build state

parameters - build parameters

sendNonStageError

public void sendNonStageError(String nodeName)

Sends notifications for an error that happens outside of a stage

Parameters:

nodeName - name of node that failed