de.silpion.jenkins.plugins.gitflow.proxy.gitclient

Class GitClientProxy

java.lang.Object

de.silpion.jenkins.plugins.gitflow.proxy.gitclient.GitClientProxy

public class GitClientProxy
extends Object

Proxy implementation for the Jenkins GitClient. Uses Reflections to implement version-dependant functions without causing compiler and/or runtime errors.

Author:

Marc Rohlfs, Silpion IT-Solutions GmbH - rohlfs@silpion.de

Field Summary

Fields

Modifier and Type	Field and Description
static hudson.util.VersionNumber	MINIMAL_VERSION_NUMBER

Constructor Summary

Constructors

Constructor and Description
GitClientProxy(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener, boolean dryRun) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	add(String filePattern) Stage files for commit.
void	checkoutBranch(String branch, String ref) Regardless of the current state of the workspace (whether there is some dirty files, etc) and the state of the repository (whether the branch of the specified name exists or not), when this method exits the following conditions hold: The branch of the specified name branch exists and points to the specified ref HEAD points to branch.
void	clean() Fully revert working copy to a clean state, i.e.
void	commit(String message) Commit staged files to the local repository.
void	deleteBranch(String name) Delete a local branch.
Set<hudson.plugins.git.Branch>	getBranches() Returns the existing local and remote branches.
org.eclipse.jgit.lib.ObjectId	getHeadRev(String branch) Returns the ref for the head commit of the specified remote branch.
List<String>	getRemoteBranchNamesContaining(String revspec) Find all the remote branches that include the given commit.
void	merge(org.eclipse.jgit.lib.ObjectId rev, org.eclipse.jgit.api.MergeCommand.FastForwardMode fastForwardMode, org.jenkinsci.plugins.gitclient.MergeCommand.Strategy strategy, GenericMergeCommand.StrategyOption strategyOption, boolean autoCommit) Merge the given revision to the current branch using the provided merge settings.
void	push(String remoteAlias, String refspec) Push local objects to a remote repository.
org.eclipse.jgit.lib.ObjectId	revParse(String revName) Retrieve commit object that is direct child for revName revision reference.
void	setGitflowActionName(String gitflowActionName) Set the name of the Gitflow action.
void	tag(String tagName, String comment) Create (or update) a tag.

Methods inherited from class java.lang.Object

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

Field Detail

MINIMAL_VERSION_NUMBER

public static final hudson.util.VersionNumber MINIMAL_VERSION_NUMBER

Constructor Detail

GitClientProxy

public GitClientProxy(hudson.model.AbstractBuild<?,?> build,
                      hudson.model.BuildListener listener,
                      boolean dryRun)
               throws IOException,
                      InterruptedException

Creates a new instance.

Parameters:

build - the build that is in progress.

listener - can be used to send any message.

dryRun - is the build dryRun or not.

Throws:

IOException - if the version of the Git or the Git Client plugin is not supported.

InterruptedException - if the build is interrupted during execution.

Method Detail

add

public void add(String filePattern)
         throws InterruptedException

Stage files for commit.

Parameters:

filePattern - the name/path pattern of the files to be staged.

Throws:

InterruptedException - if the build is interrupted during execution.

commit

public void commit(String message)
            throws InterruptedException

Commit staged files to the local repository.

Parameters:

message - the commit message.

Throws:

InterruptedException - if the build is interrupted during execution.

checkoutBranch

public void checkoutBranch(String branch,
                           String ref)
                    throws InterruptedException

Regardless of the current state of the workspace (whether there is some dirty files, etc) and the state of the repository (whether the branch of the specified name exists or not), when this method exits the following conditions hold:

• The branch of the specified name branch exists and points to the specified ref
• HEAD points to branch. IOW, the workspace is on the specified branch.
• Both index and workspace are the same tree with ref. (no dirty files and no staged changes, although this method will not touch untracked files in the workspace.)

The method's Javadoc has been copied from GitClient.checkoutBranch(String, String).

Parameters:

branch - the name of the branch.

ref - the start point for the branch - either a commit ref or a branch.

Throws:

InterruptedException - if the build is interrupted during execution.

See Also:

GitClient.checkoutBranch(String, String)

push

public void push(String remoteAlias,
                 String refspec)
          throws InterruptedException

Push local objects to a remote repository.

Parameters:

remoteAlias - the alias for the remote repository.

refspec - specifies what local source ref to push to what remote target ref.

Throws:

InterruptedException - if the build is interrupted during execution.

merge

public void merge(org.eclipse.jgit.lib.ObjectId rev,
                  org.eclipse.jgit.api.MergeCommand.FastForwardMode fastForwardMode,
                  org.jenkinsci.plugins.gitclient.MergeCommand.Strategy strategy,
                  GenericMergeCommand.StrategyOption strategyOption,
                  boolean autoCommit)
           throws InterruptedException

Merge the given revision to the current branch using the provided merge settings.

Parameters:

rev - the revision to be merged.

fastForwardMode - the fast forward mode for the merge.

strategy - the merge strategy.

strategyOption - the option for the merge strategy.

autoCommit - sets the merge option --commit if true, otherwise sets the merge option --no-commit.

Throws:

InterruptedException - if the build is interrupted during execution.

clean

public void clean()
           throws InterruptedException

Fully revert working copy to a clean state, i.e. run both git-reset(1) --hard then git-clean(1) for working copy to match a fresh clone.

The method's Javadoc has been copied from GitClient.clean().

Throws:

InterruptedException - if the build is interrupted during execution.

See Also:

GitClient.clean()

deleteBranch

public void deleteBranch(String name)
                  throws InterruptedException

Delete a local branch.

Parameters:

name - the name of the branch.

Throws:

InterruptedException - if the build is interrupted during execution.

getBranches

public Set<hudson.plugins.git.Branch> getBranches()
                                           throws InterruptedException

Returns the existing local and remote branches.

Returns:

the existing local and remote branches.

Throws:

InterruptedException - if the build is interrupted during execution.

tag

public void tag(String tagName,
                String comment)
         throws InterruptedException

Create (or update) a tag. If tag already exist it gets updated (equivalent to git tag --force)

The method's Javadoc has been copied from GitClient.tag(String, String).

Parameters:

tagName - the name of the tag.

comment - the commit message for the tag.

Throws:

InterruptedException - if the build is interrupted during execution.

See Also:

GitClient.tag(String, String)

getHeadRev

public org.eclipse.jgit.lib.ObjectId getHeadRev(String branch)
                                         throws InterruptedException

Returns the ref for the head commit of the specified remote branch.

This method fixes/prevents a bug in the GitClient.getHeadRev(String, String) method: When the branch is provided with a simple branch name that contains slashes, the original method might mix up branches. E.g.: When looking for branch release/1.0, the head rev of hotfix/1.0 may be returned.

Parameters:

branch - the name of the branch.

Returns:

the ref for the head commit of the specified branch or null.

Throws:

InterruptedException - if the build is interrupted during execution.

revParse

public org.eclipse.jgit.lib.ObjectId revParse(String revName)
                                       throws InterruptedException

Retrieve commit object that is direct child for revName revision reference.

Parameters:

revName - a commit sha1 or tag/branch refname

Returns:

the commit object that is direct child for revName revision reference.

Throws:

InterruptedException - if the build is interrupted during execution.

See Also:

GitClient.revParse(String)

getRemoteBranchNamesContaining

public List<String> getRemoteBranchNamesContaining(String revspec)
                                            throws hudson.plugins.git.GitException,
                                                   InterruptedException

Find all the remote branches that include the given commit.

Parameters:

revspec - commit id to query for

Returns:

list of branches the specified commit belongs to

Throws:

hudson.plugins.git.GitException - on Git exceptions

InterruptedException - on thread interruption

See Also:

GitClient.getBranchesContaining(String, boolean)

setGitflowActionName

public void setGitflowActionName(String gitflowActionName)

Set the name of the Gitflow action.

Parameters:

gitflowActionName - the name of the Gitflow action.