org.jenkinsci.plugins.pretestedintegration

Class AbstractSCMBridge

java.lang.Object

org.jenkinsci.plugins.pretestedintegration.AbstractSCMBridge

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<AbstractSCMBridge>

Direct Known Subclasses:

GitBridge

public abstract class AbstractSCMBridge
extends Object
implements hudson.model.Describable<AbstractSCMBridge>, hudson.ExtensionPoint

Abstract class representing an SCM bridge.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
protected String	branch The integration branch.
IntegrationStrategy	integrationStrategy The integration strategy.

Constructor Summary

Constructors

Constructor and Description
AbstractSCMBridge(IntegrationStrategy integrationStrategy) Constructor for the SCM bridge.

Method Summary

Methods

Modifier and Type	Method and Description
static hudson.DescriptorExtensionList<AbstractSCMBridge,SCMBridgeDescriptor<AbstractSCMBridge>>	all()
void	commit(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) Pushes changes to the integration branch.
void	deleteIntegratedBranch(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) Deletes the integrated branch.
abstract void	ensureBranch(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener, String branch) Make sure the SCM is checked out on the given branch.
static List<IntegrationStrategyDescriptor<?>>	getBehaviours()
String	getBranch()
hudson.model.Descriptor<AbstractSCMBridge>	getDescriptor()
static List<SCMBridgeDescriptor<?>>	getDescriptors()
String	getExpandedBranch(hudson.EnvVars environment)
hudson.model.Result	getRequiredResult()
abstract void	handlePostBuild(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) Called after the build has run.
void	isApplicable(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener) Determines if we should prepare a workspace for integration.
protected void	mergeChanges(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) Integrates the commit into the integration branch.
void	prepareWorkspace(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) Called after the SCM plugin has updated the workspace with remote changes.
void	updateBuildDescription(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) Updates the description of the Jenkins build.
void	validateConfiguration(hudson.model.AbstractProject<?,?> project) Validates the configuration of the Jenkins Job.

Methods inherited from class java.lang.Object

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

Field Detail

branch

protected String branch

The integration branch. This is the branch into which pretested commits will be merged.

integrationStrategy

public final IntegrationStrategy integrationStrategy

The integration strategy. This is the strategy applied to merge pretested commits into the integration branch.

Constructor Detail

AbstractSCMBridge

public AbstractSCMBridge(IntegrationStrategy integrationStrategy)

Constructor for the SCM bridge.

Parameters:

integrationStrategy - The integration strategy to apply when merging commits.

Method Detail

commit

public void commit(hudson.model.AbstractBuild<?,?> build,
          hudson.Launcher launcher,
          hudson.model.BuildListener listener)
            throws CommitFailedException

Pushes changes to the integration branch.

Parameters:

build - The Build

launcher - The Launcher

listener - The BuildListener

Throws:

CommitFailedException

deleteIntegratedBranch

public void deleteIntegratedBranch(hudson.model.AbstractBuild<?,?> build,
                          hudson.Launcher launcher,
                          hudson.model.BuildListener listener)
                            throws BranchDeletionFailedException,
                                   NothingToDoException,
                                   UnsupportedConfigurationException

Deletes the integrated branch.

Parameters:

build - The Build

launcher - The Launcher

listener - The BuildListener

Throws:

BranchDeletionFailedException

NothingToDoException

UnsupportedConfigurationException

ensureBranch

public abstract void ensureBranch(hudson.model.AbstractBuild<?,?> build,
                hudson.Launcher launcher,
                hudson.model.BuildListener listener,
                String branch)
                           throws EstablishingWorkspaceFailedException

Make sure the SCM is checked out on the given branch.

Parameters:

build - The Build

launcher - The Launcher

listener - The BuildListener

branch - The branch to check out

Throws:

EstablishingWorkspaceFailedException

handlePostBuild

public abstract void handlePostBuild(hudson.model.AbstractBuild<?,?> build,
                   hudson.Launcher launcher,
                   hudson.model.BuildListener listener)
                              throws IOException

Called after the build has run. If the build was successful, the changes should be committed, otherwise the workspace is reset.

Parameters:

build - The Build

launcher - The Launcher

listener - The BuildListener

Throws:

IOException - A repository could not be reached.

isApplicable

public void isApplicable(hudson.model.AbstractBuild<?,?> build,
                hudson.model.BuildListener listener)
                  throws NothingToDoException,
                         UnsupportedConfigurationException

Determines if we should prepare a workspace for integration. If not we throw a NothingToDoException

Parameters:

build - The Build

listener - The BuildListener

Throws:

NothingToDoException

UnsupportedConfigurationException

mergeChanges

protected void mergeChanges(hudson.model.AbstractBuild<?,?> build,
                hudson.Launcher launcher,
                hudson.model.BuildListener listener)
                     throws NothingToDoException,
                            IntegrationFailedException,
                            UnsupportedConfigurationException

Integrates the commit into the integration branch. Uses the selected IntegrationStrategy.

Parameters:

build - The Build

launcher - The Launcher

listener - The BuildListener

Throws:

NothingToDoException

IntegrationFailedException

UnsupportedConfigurationException

prepareWorkspace

public void prepareWorkspace(hudson.model.AbstractBuild<?,?> build,
                    hudson.Launcher launcher,
                    hudson.model.BuildListener listener)
                      throws EstablishingWorkspaceFailedException,
                             NothingToDoException,
                             IntegrationFailedException,
                             UnsupportedConfigurationException

Called after the SCM plugin has updated the workspace with remote changes. Afterwards, the workspace must be ready to perform builds and tests. The integration branch must be checked out, and the given commit must be merged in.

Parameters:

build - The Build

launcher - The Launcher

listener - The BuildListener

Throws:

IntegrationFailedException

EstablishingWorkspaceFailedException

NothingToDoException

UnsupportedConfigurationException

updateBuildDescription

public void updateBuildDescription(hudson.model.AbstractBuild<?,?> build,
                          hudson.Launcher launcher,
                          hudson.model.BuildListener listener)
                            throws NothingToDoException,
                                   UnsupportedConfigurationException

Updates the description of the Jenkins build.

Parameters:

build - The Build

launcher - The Launcher

listener - The BuildListener

Throws:

NothingToDoException

UnsupportedConfigurationException

validateConfiguration

public void validateConfiguration(hudson.model.AbstractProject<?,?> project)
                           throws UnsupportedConfigurationException

Validates the configuration of the Jenkins Job. Throws an exception when the configuration is invalid.

Parameters:

project - The Project

Throws:

UnsupportedConfigurationException

all

public static hudson.DescriptorExtensionList<AbstractSCMBridge,SCMBridgeDescriptor<AbstractSCMBridge>> all()

Returns:

all the SCM Bridge Descriptors

getBehaviours

public static List<IntegrationStrategyDescriptor<?>> getBehaviours()

Returns:

all the Integration Strategy Descriptors

getDescriptor

public hudson.model.Descriptor<AbstractSCMBridge> getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<AbstractSCMBridge>

getDescriptors

public static List<SCMBridgeDescriptor<?>> getDescriptors()

Returns:

all the SCM Bridge Descriptors

getBranch

public String getBranch()

Returns:

The Integration Branch name

getExpandedBranch

public String getExpandedBranch(hudson.EnvVars environment)

Parameters:

environment - The environment to expand the branch in

Returns:

The Integration Branch name, expanded using given EnvVars.

getRequiredResult

public hudson.model.Result getRequiredResult()

Returns:

The required result