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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GitBridge.DescriptorImpl

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)
GitBridge(IntegrationStrategy integrationStrategy, String branch, String repoName)

Method Summary

Methods

Modifier and Type	Method and Description
hudson.plugins.git.util.BuildData	checkAndDetermineRelevantBuildData(List<hudson.plugins.git.util.BuildData> data) Checks a list of git build data for current build and extracts the relevant build data related to the Integration repository configuration.
void	commit(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
void	deleteIntegratedBranch(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
protected Commit<?>	determineIntegrationHead(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.TaskListener listener) Override this to associate an integrated commit with a pointer with the starting point before merge.
void	ensureBranch(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener, String branch)
String	getBranch()
String	getRepoName()
String	getRevId()
hudson.FilePath	getWorkingDirectory()
int	git(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.TaskListener listener, OutputStream out, String... cmds) Invoke a command with mercurial
int	git(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.TaskListener listener, String... cmds) Invoke a command with git
void	handlePostBuild(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) This is called after the build has run.
void	isApplicable(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener) Method that determines if we should prepare workspace for integration.
hudson.FilePath	resolveWorkspace(hudson.model.AbstractBuild<?,?> build, hudson.model.TaskListener listener)
void	setRepoName(String repoName)
void	setWorkingDirectory(hudson.FilePath workingDirectory)
protected void	update(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.TaskListener listener)
void	updateBuildDescription(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
void	validateConfiguration(hudson.model.AbstractProject<?,?> project)

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

all, getBehaviours, getDescriptor, getDescriptors, getRequiredResult, mergeChanges, nextCommit, 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 repoName)

GitBridge

public GitBridge(IntegrationStrategy integrationStrategy,
         String branch)

Method Detail

getBranch

public String getBranch()

Overrides:

getBranch in class AbstractSCMBridge

getRevId

public String getRevId()

setWorkingDirectory

public void setWorkingDirectory(hudson.FilePath workingDirectory)

getWorkingDirectory

public hudson.FilePath getWorkingDirectory()

git

public int git(hudson.model.AbstractBuild<?,?> build,
      hudson.Launcher launcher,
      hudson.model.TaskListener listener,
      String... cmds)
        throws IOException,
               InterruptedException

Invoke a command with git

Parameters:

build -

launcher -

listener -

cmds -

Returns:

The exitcode of command

Throws:

IOException

InterruptedException

git

public int git(hudson.model.AbstractBuild<?,?> build,
      hudson.Launcher launcher,
      hudson.model.TaskListener listener,
      OutputStream out,
      String... cmds)
        throws IOException,
               InterruptedException

Invoke a command with mercurial

Parameters:

build -

launcher -

listener -

cmds -

out -

Returns:

The exitcode of command

Throws:

IOException

InterruptedException

ensureBranch

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

Specified by:

ensureBranch in class AbstractSCMBridge

Throws:

EstablishWorkspaceException

update

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

Throws:

IOException

InterruptedException

commit

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

Overrides:

commit in class AbstractSCMBridge

Throws:

CommitChangesFailureException

checkAndDetermineRelevantBuildData

public hudson.plugins.git.util.BuildData checkAndDetermineRelevantBuildData(List<hudson.plugins.git.util.BuildData> data)
                                                                     throws NothingToDoException,
                                                                            UnsupportedConfigurationException

Checks a list of git build data for current build and extracts the relevant build data related to the Integration repository configuration.

• Checks extract only build data belonging to the integration repository
• Check ensures that identical git build data are narrowed down to different sets as MultScm and the Git plugin may sometimes contribute with several identical sets
• Checks ensure that only one relevant set is supplied, or else we fail in case om ambiguity.

TODO: Currently there is no check for branch complies with branch specifier, or that commits (if not given branches) are heads. See JENKINS-25542, JENKINS-25512, JENKINS-24909

Parameters:

data - - git build data

Returns:

Throws:

NothingToDoException - if none of the git build data matches chosen integration repository

UnsupportedConfigurationException - if there is ambiguity about which git build data set to chose to integrate

isApplicable

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

Description copied from class: AbstractSCMBridge

Method that determines if we should prepare workspace for integration. If not we throw the nothing to do exception

Overrides:

isApplicable in class AbstractSCMBridge

Throws:

NothingToDoException

UnsupportedConfigurationException

deleteIntegratedBranch

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

Overrides:

deleteIntegratedBranch in class AbstractSCMBridge

Throws:

DeleteIntegratedBranchException

NothingToDoException

UnsupportedConfigurationException

updateBuildDescription

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

Overrides:

updateBuildDescription in class AbstractSCMBridge

Throws:

NothingToDoException

UnsupportedConfigurationException

resolveWorkspace

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

Throws:

InterruptedException

IOException

determineIntegrationHead

protected Commit<?> determineIntegrationHead(hudson.model.AbstractBuild<?,?> build,
                                 hudson.Launcher launcher,
                                 hudson.model.TaskListener listener)

Description copied from class: AbstractSCMBridge

Override this to associate an integrated commit with a pointer with the starting point before merge. This is used to roll back in case of integraion failure

Overrides:

determineIntegrationHead in class AbstractSCMBridge

Returns:

getRepoName

public String getRepoName()

Returns:

the remoteName

setRepoName

public void setRepoName(String repoName)

Parameters:

repoName - the remoteName to set

validateConfiguration

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

Overrides:

validateConfiguration in class AbstractSCMBridge

Throws:

UnsupportedConfigurationException

handlePostBuild

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

Description copied from class: AbstractSCMBridge

This is called after the build has run. If the build was successful, the changes should be committed, otherwise the workspace is cleared as before the changes

Specified by:

handlePostBuild in class AbstractSCMBridge

Parameters:

build - The status of the build.

Throws:

IOException - A repository could not be reached.