com.atlassian.bamboo.plugins.git

Class JGitOperationHelper

java.lang.Object

com.atlassian.bamboo.plugins.git.AbstractGitOperationHelper

com.atlassian.bamboo.plugins.git.JGitOperationHelper

All Implemented Interfaces:

GitOperationHelper

public class JGitOperationHelper
extends AbstractGitOperationHelper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	JGitOperationHelper.WithFetchConnectionCallback<E extends Throwable,T>
protected static interface	JGitOperationHelper.WithRepositoryCallback<E extends Throwable,V>
protected static interface	JGitOperationHelper.WithTransportCallback<E extends Throwable,T>

Field Summary

Fields inherited from class com.atlassian.bamboo.plugins.git.AbstractGitOperationHelper

accessData, buildLogger, CHANGESET_LIMIT, DEFAULT_TRANSFER_TIMEOUT, FQREF_PREFIXES, i18nResolver, trustedKeyHelper

Constructor Summary

Constructors

Constructor and Description
JGitOperationHelper(GitRepositoryAccessData accessData, BuildLogger buildLogger, com.atlassian.sal.api.message.I18nResolver i18nResolver, TrustedKeyHelper trustedKeyHelper)

Method Summary

Modifier and Type	Method and Description
String	checkout(File cacheDirectory, File sourceDirectory, String targetRevision, String previousRevision)
boolean	checkRevisionExistsInCacheRepository(File repositoryDirectory, String targetRevision)
String	commit(File sourceDirectory, String message, String committerName, String committerEmail, boolean stageModifications)
void	createBranch(File sourceDirectory, String branchName)
void	createLightweightTag(File sourceDirectory, String tagName, String revision)
protected org.eclipse.jgit.lib.Repository	createLocalRepository(File workingDirectory, File cacheDirectory)
BuildRepositoryChanges	extractCommits(File directory, String startingRevision, String endingRevision)
BuildRepositoryChanges	extractCommits(File cacheDirectory, String startingRevision, String endingRevision, String path)
BuildRepositoryChanges	extractCommitsBetweenBranches(File cacheDirectory, VcsBranch otherBranch, boolean limitChangeList)
void	fetch(File sourceDirectory, HashAndSource refAndHash, boolean useShallow)
void	fetch(File sourceDirectory, HashAndSource refAndHash, boolean useShallow, boolean fetchTagsByDefault)
void	fetch(File sourceDirectory, String targetRevision, boolean useShallow)
void	fetch(File sourceDirectory, String targetRevision, boolean useShallow, boolean fetchTagsByDefault)
Optional<String>	getBranchForSha(File sourceDirectory, String revision, String configuredBranch)
CommitContext	getCommit(File directory, String targetRevision) Gets the commit for the revision, given a working directory.
String	getCurrentBranch(File checkoutPath)
String	getCurrentRevision(File sourceDirectory)
List<VcsBranch>	getOpenBranches(GitRepositoryAccessData repositoryData, File workingDir)
protected String	getRevision(File sourceDirectory, String revision)
String	getShaOfRefIfExists(File sourceDirectory, String ref)
List<TagAndRevision>	getTagsForRepository(GitRepositoryAccessData accessData)
boolean	isAncestor(Path gitWorkspace, GitHash rev1, GitHash rev2) Returns true if you can reach rev1 by following parent relationship starting from rev2.
boolean	isClean(File sourceDirectory)
boolean	merge(File workspaceDir, String targetRevision, String committerName, String committerEmail)
Pair<Boolean,String>	mergeAndReturnHead(File workspaceDir, String currentRevision, String targetRevision, String committerName, String committerEmail)
HashAndSource	obtainLatestRevision()
Optional<GitHash>	obtainLatestRevision(File repositoryDirectory, GitRef ref, String path)
void	pushBranchOrTag(File sourceDirectory, String branchName)
void	pushRevision(File sourceDirectory, String revision, String currentBranch) Pushes arbitrary revision (refspec?) back to the upstream repo.
void	stageChanges(File sourceDirectory, Collection<String> filePaths)
protected <E extends Throwable,T> T	withFetchConnection(org.eclipse.jgit.lib.Repository repository, GitRepositoryAccessData accessData, JGitOperationHelper.WithFetchConnectionCallback<E,T> callback)
protected <E extends Throwable,T> T	withFetchConnection(org.eclipse.jgit.transport.Transport transport, JGitOperationHelper.WithFetchConnectionCallback<E,T> callback)
protected <E extends Throwable,T> T	withTransport(org.eclipse.jgit.lib.Repository repository, GitRepositoryAccessData accessData, JGitOperationHelper.WithTransportCallback<E,T> callback)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.plugins.git.GitOperationHelper

commit

Constructor Detail

JGitOperationHelper

public JGitOperationHelper(GitRepositoryAccessData accessData,
                           @NotNull
                           BuildLogger buildLogger,
                           @NotNull
                           com.atlassian.sal.api.message.I18nResolver i18nResolver,
                           @NotNull
                           TrustedKeyHelper trustedKeyHelper)

Method Detail

commit

@NotNull
public String commit(@NotNull
                              File sourceDirectory,
                              @NotNull
                              String message,
                              @NotNull
                              String committerName,
                              @NotNull
                              String committerEmail,
                              boolean stageModifications)
                       throws RepositoryException

Throws:

RepositoryException

stageChanges

public void stageChanges(@NotNull
                         File sourceDirectory,
                         @NotNull
                         Collection<String> filePaths)
                  throws RepositoryException

Throws:

RepositoryException

merge

public boolean merge(@NotNull
                     File workspaceDir,
                     @NotNull
                     String targetRevision,
                     @NotNull
                     String committerName,
                     @NotNull
                     String committerEmail)

mergeAndReturnHead

public Pair<Boolean,String> mergeAndReturnHead(@NotNull
                                               File workspaceDir,
                                               @NotNull
                                               String currentRevision,
                                               @NotNull
                                               String targetRevision,
                                               @NotNull
                                               String committerName,
                                               @NotNull
                                               String committerEmail)
                                        throws RepositoryException

Throws:

RepositoryException

pushRevision

public void pushRevision(@NotNull
                         File sourceDirectory,
                         @NotNull
                         String revision,
                         @Nullable
                         String currentBranch)
                  throws RepositoryException

Pushes arbitrary revision (refspec?) back to the upstream repo.

Throws:

RepositoryException

pushBranchOrTag

public void pushBranchOrTag(@NotNull
                            File sourceDirectory,
                            @NotNull
                            String branchName)
                     throws RepositoryException

Throws:

RepositoryException

checkout

@NotNull
public String checkout(@Nullable
                                File cacheDirectory,
                                @NotNull
                                File sourceDirectory,
                                @NotNull
                                String targetRevision,
                                @Nullable
                                String previousRevision)
                         throws RepositoryException

Throws:

RepositoryException

fetch

public void fetch(@NotNull
                  File sourceDirectory,
                  @NotNull
                  String targetRevision,
                  boolean useShallow,
                  boolean fetchTagsByDefault)
           throws RepositoryException

Throws:

RepositoryException

fetch

public void fetch(@NotNull
                  File sourceDirectory,
                  @NotNull
                  HashAndSource refAndHash,
                  boolean useShallow,
                  boolean fetchTagsByDefault)
           throws RepositoryException

Throws:

RepositoryException

fetch

public void fetch(@NotNull
                  File sourceDirectory,
                  @NotNull
                  String targetRevision,
                  boolean useShallow)
           throws RepositoryException

Throws:

RepositoryException

fetch

public void fetch(@NotNull
                  File sourceDirectory,
                  @NotNull
                  HashAndSource refAndHash,
                  boolean useShallow)
           throws RepositoryException

Throws:

RepositoryException

getCurrentRevision

@NotNull
public String getCurrentRevision(@NotNull
                                          File sourceDirectory)
                                   throws RepositoryException

Throws:

RepositoryException

getTagsForRepository

public List<TagAndRevision> getTagsForRepository(@NotNull
                                                 GitRepositoryAccessData accessData)
                                          throws RepositoryException

Throws:

RepositoryException

getCurrentBranch

public String getCurrentBranch(@NotNull
                               File checkoutPath)
                        throws RepositoryException

Throws:

RepositoryException

isClean

public boolean isClean(@NotNull
                       File sourceDirectory)
                throws RepositoryException

Throws:

RepositoryException

getRevision

protected String getRevision(File sourceDirectory,
                             @NotNull
                             String revision)
                      throws RepositoryException

Throws:

RepositoryException

getShaOfRefIfExists

@Nullable
public String getShaOfRefIfExists(@NotNull
                                            File sourceDirectory,
                                            @NotNull
                                            String ref)

obtainLatestRevision

@NotNull
public HashAndSource obtainLatestRevision()
                                            throws RepositoryException

Throws:

RepositoryException

getOpenBranches

@NotNull
public List<VcsBranch> getOpenBranches(@NotNull
                                                GitRepositoryAccessData repositoryData,
                                                File workingDir)
                                         throws RepositoryException

Throws:

RepositoryException

checkRevisionExistsInCacheRepository

public boolean checkRevisionExistsInCacheRepository(@NotNull
                                                    File repositoryDirectory,
                                                    @NotNull
                                                    String targetRevision)
                                             throws IOException,
                                                    RepositoryException

Parameters:

repositoryDirectory - directory where repository is fetched

targetRevision - revision to find in repository

Returns:

true if revision found

Throws:

IOException - thrown when revision not found (MissingObjectException)

RepositoryException

extractCommitsBetweenBranches

public BuildRepositoryChanges extractCommitsBetweenBranches(File cacheDirectory,
                                                            VcsBranch otherBranch,
                                                            boolean limitChangeList)

createLocalRepository

protected org.eclipse.jgit.lib.Repository createLocalRepository(File workingDirectory,
                                                                @Nullable
                                                                File cacheDirectory)
                                                         throws IOException

Throws:

IOException

extractCommits

public BuildRepositoryChanges extractCommits(@NotNull
                                             File directory,
                                             @Nullable
                                             String startingRevision,
                                             @Nullable
                                             String endingRevision)
                                      throws RepositoryException

Throws:

RepositoryException

extractCommits

public BuildRepositoryChanges extractCommits(File cacheDirectory,
                                             @NotNull
                                             String startingRevision,
                                             String endingRevision,
                                             String path)
                                      throws RepositoryException

Throws:

RepositoryException

getBranchForSha

@NotNull
public Optional<String> getBranchForSha(@NotNull
                                                 File sourceDirectory,
                                                 String revision,
                                                 String configuredBranch)
                                          throws RepositoryException

Returns:

branch that contains sha and matches the name of configuredBranch

Throws:

RepositoryException

obtainLatestRevision

public Optional<GitHash> obtainLatestRevision(@NotNull
                                              File repositoryDirectory,
                                              GitRef ref,
                                              String path)

isAncestor

public boolean isAncestor(@NotNull
                          Path gitWorkspace,
                          @NotNull
                          GitHash rev1,
                          @NotNull
                          GitHash rev2)
                   throws RepositoryException

Description copied from interface: GitOperationHelper

Returns true if you can reach rev1 by following parent relationship starting from rev2.

Throws:

RepositoryException

createBranch

public void createBranch(@NotNull
                         File sourceDirectory,
                         @NotNull
                         String branchName)
                  throws RepositoryException

Throws:

RepositoryException

createLightweightTag

public void createLightweightTag(@NotNull
                                 File sourceDirectory,
                                 @NotNull
                                 String tagName,
                                 @NotNull
                                 String revision)
                          throws RepositoryException

Throws:

RepositoryException

getCommit

@NotNull
public CommitContext getCommit(File directory,
                                        String targetRevision)
                                 throws RepositoryException

Description copied from interface: GitOperationHelper

Gets the commit for the revision, given a working directory.

Throws:

RepositoryException - if the revision can't be found

withTransport

@Nullable
protected <E extends Throwable,T> T withTransport(@NotNull
                                                            org.eclipse.jgit.lib.Repository repository,
                                                            @NotNull
                                                            GitRepositoryAccessData accessData,
                                                            @NotNull
                                                            JGitOperationHelper.WithTransportCallback<E,T> callback)
                                                     throws E extends Throwable,
                                                            RepositoryException

Throws:

E extends Throwable

RepositoryException

withFetchConnection

protected <E extends Throwable,T> T withFetchConnection(@NotNull
                                                        org.eclipse.jgit.transport.Transport transport,
                                                        @NotNull
                                                        JGitOperationHelper.WithFetchConnectionCallback<E,T> callback)
                                                 throws E extends Throwable,
                                                        org.eclipse.jgit.errors.NotSupportedException,
                                                        org.eclipse.jgit.errors.TransportException

Throws:

E extends Throwable

org.eclipse.jgit.errors.NotSupportedException

org.eclipse.jgit.errors.TransportException

withFetchConnection

protected <E extends Throwable,T> T withFetchConnection(@NotNull
                                                        org.eclipse.jgit.lib.Repository repository,
                                                        @NotNull
                                                        GitRepositoryAccessData accessData,
                                                        @NotNull
                                                        JGitOperationHelper.WithFetchConnectionCallback<E,T> callback)
                                                 throws E extends Throwable,
                                                        RepositoryException,
                                                        org.eclipse.jgit.errors.NotSupportedException,
                                                        org.eclipse.jgit.errors.TransportException

Throws:

E extends Throwable

RepositoryException

org.eclipse.jgit.errors.NotSupportedException

org.eclipse.jgit.errors.TransportException