org.jenkinsci.plugins.pretestedintegration.scm.git

Class GitBridge

java.lang.Object

org.jenkinsci.plugins.pretestedintegration.AbstractSCMBridge

org.jenkinsci.plugins.pretestedintegration.scm.git.GitBridge

All Implemented Interfaces:

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

public class GitBridge
extends AbstractSCMBridge

The Git SCM Bridge.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GitBridge.DescriptorImpl Descriptor implementation for GitBridge

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class org.jenkinsci.plugins.pretestedintegration.AbstractSCMBridge

branch, integrationStrategy

Constructor Summary

Constructors

Constructor and Description
GitBridge(IntegrationStrategy integrationStrategy, String branch, String repositoryName) Constructor for GitBridge.

Method Summary

Methods

Modifier and Type	Method and Description
void	commit(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) Pushes changes to the integration branch.
int	countCommits(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener) Counts the commits in the relevant BuildData
void	deleteIntegratedBranch(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) Deletes the integrated branch.
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.
hudson.plugins.git.util.BuildData	findRelevantBuildData(hudson.model.AbstractBuild<?,?> build, hudson.model.TaskListener listener) Retrieves the BuildData for the given build relevant to the Integration Repository.
protected hudson.plugins.git.GitSCM	findScm(hudson.model.AbstractBuild<?,?> build, hudson.model.TaskListener listener) Returns the Git SCM for the relevant build data.
String	getBranch()
String	getExpandedBranch(hudson.EnvVars environment)
String	getRepoName()
hudson.FilePath	getWorkingDirectory()
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.
hudson.FilePath	resolveWorkspace(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener) Returns the workspace
void	setRepoName(String repositoryName)
void	setWorkingDirectory(hudson.FilePath workingDirectory)
protected void	update(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) Pulls in the remote branch
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 org.jenkinsci.plugins.pretestedintegration.AbstractSCMBridge

all, getBehaviours, getDescriptor, getDescriptors, getRequiredResult, mergeChanges, prepareWorkspace

Methods inherited from class java.lang.Object

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

Constructor Detail

GitBridge

@DataBoundConstructor
public GitBridge(IntegrationStrategy integrationStrategy,
                              String branch,
                              String repositoryName)

Constructor for GitBridge. DataBound for use in the UI.

Parameters:

integrationStrategy - The selected IntegrationStrategy

branch - The Integration Branch name

repositoryName - The Integration Repository name

Method Detail

findScm

protected hudson.plugins.git.GitSCM findScm(hudson.model.AbstractBuild<?,?> build,
                                hudson.model.TaskListener listener)
                                     throws InterruptedException,
                                            NothingToDoException,
                                            UnsupportedConfigurationException

Returns the Git SCM for the relevant build data.

Parameters:

build - The Build

listener - The BuildListener

Returns:

the Git SCM for the relevant build data.

Throws:

InterruptedException - When no matching SCMs are found

NothingToDoException - When no relevant BuildData is found.

UnsupportedConfigurationException - When multiple, ambiguous relevant BuildDatas are found.

ensureBranch

public 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.

Specified by:

ensureBranch in class AbstractSCMBridge

Parameters:

build - The Build

launcher - The Launcher

listener - The BuildListener

branch - The branch to check out

Throws:

EstablishingWorkspaceFailedException

update

protected void update(hudson.model.AbstractBuild<?,?> build,
          hudson.Launcher launcher,
          hudson.model.BuildListener listener)
               throws IOException,
                      InterruptedException

Pulls in the remote branch

Parameters:

build - The Build

launcher - The Launcher

listener - The Listener

Throws:

IOException

InterruptedException

commit

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

Pushes changes to the integration branch.

Overrides:

commit in class AbstractSCMBridge

Parameters:

build - The Build

launcher - The Launcher

listener - The BuildListener

Throws:

CommitFailedException

findRelevantBuildData

public hudson.plugins.git.util.BuildData findRelevantBuildData(hudson.model.AbstractBuild<?,?> build,
                                                      hudson.model.TaskListener listener)
                                                        throws NothingToDoException,
                                                               UnsupportedConfigurationException

Retrieves the BuildData for the given build relevant to the Integration Repository.

• Extracts only BuildData belonging to the Integration repository
• Ensures that identical BuildData are narrowed down to different sets as MultiScm and the Git plugin may sometimes contribute with several identical sets
• Ensures that only one relevant set is supplied. It throws in case om ambiguity.

For a visualized example of several BuilData: See 'docs/More_than_1_gitBuild_data.png' TODO: We don't check that the branch complies with the branch specifier, or that commits are heads. See JENKINS-25542, JENKINS-25512, JENKINS-24909

Parameters:

build - The Build

listener - The TaskListener

Returns:

The relevant BuildData

Throws:

NothingToDoException - If no relevant BuildData was found.

UnsupportedConfigurationException - If multiple, ambiguous BuildDatas were found.

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

Overrides:

isApplicable in class AbstractSCMBridge

Parameters:

build - The Build

listener - The BuildListener

Throws:

NothingToDoException

UnsupportedConfigurationException

deleteIntegratedBranch

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

Deletes the integrated branch.

Overrides:

deleteIntegratedBranch in class AbstractSCMBridge

Parameters:

build - The Build

launcher - The Launcher

listener - The BuildListener

Throws:

BranchDeletionFailedException

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.

Overrides:

updateBuildDescription in class AbstractSCMBridge

Parameters:

build - The Build

launcher - The Launcher

listener - The BuildListener

Throws:

NothingToDoException

UnsupportedConfigurationException

resolveWorkspace

public hudson.FilePath resolveWorkspace(hudson.model.AbstractBuild<?,?> build,
                               hudson.model.BuildListener listener)
                                 throws InterruptedException,
                                        IOException

Returns the workspace

Parameters:

build - The Build

listener - The Listener

Returns:

a FilePath representing the workspace

Throws:

InterruptedException

IOException

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.

Overrides:

validateConfiguration in class AbstractSCMBridge

Parameters:

project - The Project

Throws:

UnsupportedConfigurationException

countCommits

public int countCommits(hudson.model.AbstractBuild<?,?> build,
               hudson.model.BuildListener listener)
                 throws IOException,
                        InterruptedException

Counts the commits in the relevant BuildData

Parameters:

build - The Build

listener - The Listener

Returns:

the amount of commits

Throws:

IOException

InterruptedException

handlePostBuild

public 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.

Specified by:

handlePostBuild in class AbstractSCMBridge

Parameters:

build - The Build

launcher - The Launcher

listener - The BuildListener

Throws:

IOException - A repository could not be reached.

getBranch

public String getBranch()

Overrides:

getBranch in class AbstractSCMBridge

Returns:

The Integration Branch name

getExpandedBranch

public String getExpandedBranch(hudson.EnvVars environment)

Overrides:

getExpandedBranch in class AbstractSCMBridge

Parameters:

environment - The environment to expand the branch in

Returns:

The Integration Branch name, expanded using given EnvVars.

setWorkingDirectory

public void setWorkingDirectory(hudson.FilePath workingDirectory)

Parameters:

workingDirectory - the workingDirectory to set

getWorkingDirectory

public hudson.FilePath getWorkingDirectory()

Returns:

the workingDirectory

getRepoName

public String getRepoName()

Returns:

the repositoryName

setRepoName

public void setRepoName(String repositoryName)

Parameters:

repositoryName - the repositoryName to set