com.atlassian.bamboo.plugins.git.v2

Class GitWorkingCopyManager

java.lang.Object

com.atlassian.bamboo.plugins.git.v2.AbstractGitExecutor

com.atlassian.bamboo.plugins.git.v2.GitWorkingCopyManager

All Implemented Interfaces:

MergingVcsWorkingCopyManager, NoContextVcsWorkingCopyManager, StatusProvidingVcsWorkingCopyManager, UpdatingVcsWorkingCopyManager, VcsWorkingCopyManager

public class GitWorkingCopyManager
extends AbstractGitExecutor
implements MergingVcsWorkingCopyManager, UpdatingVcsWorkingCopyManager, NoContextVcsWorkingCopyManager, StatusProvidingVcsWorkingCopyManager

Field Summary

Fields inherited from class com.atlassian.bamboo.plugins.git.v2.AbstractGitExecutor

buildDirectoryManager, customVariableContext, DEFAULT_BRANCH, i18nResolver, sshProxyService, trustedKeyHelper

Constructor Summary

Constructors

Constructor and Description

GitWorkingCopyManager(CapabilityContext capabilityContext, CredentialsAccessor credentialsAccessor, CustomVariableContext customVariableContext, BuildDirectoryManager buildDirectoryManager, com.atlassian.sal.api.message.I18nResolver i18nResolver, TrustedKeyHelper trustedKeyHelper, SshProxyService sshProxyService, BuildLoggerManager buildLoggerManager, VcsBranchIntegrationHelper branchIntegrationHelper)

Method Summary

Modifier and Type	Method and Description
boolean	canDoMerge()
VcsWorkingCopy	checkoutAndMerge(CommonContext commonContext, VcsRepositoryData vcsRepositoryData, VcsBranch targetBranch, PlanVcsRevisionData revisionOnTarget, VcsBranch sourceBranch, PlanVcsRevisionData sourceRevision, File targetPath) Checks out the targetBranch and merges sourceBranch to it.
VcsWorkingCopy	commitLocal(VcsWorkingCopy workingCopy, VcsRepositoryData vcsRepositoryData, String commitMessage) Create a local commit.
Set<Requirement>	getMergingRequirements() If executing merge imposes capability requirements on top of those returned by VcsExecutorWithRequirements#getRequirements(), return them here.
VcsWorkingCopy	getWorkingCopyInfo(VcsRepositoryData repositoryData, File checkoutPath) Provide repository working copy information for the given checkout path.
VcsWorkingCopy	retrieveSourceCode(CommonContext commonContext, VcsRepositoryData repositoryData, PlanVcsRevisionData targetRevision, File targetPath) Checkout or update a working copy to a revision.
void	stageChanges(VcsWorkingCopy workingCopy, VcsRepositoryData repositoryData, Collection<String> pathsToAdd) Stage changes for committing.
VcsWorkingCopy	updateRemote(VcsWorkingCopy workingCopy, VcsRepositoryData vcsRepositoryData, String commitMessage) Update remote repository.
VcsWorkingCopy	updateToLatestRevision(CommonContext commonContext, VcsRepositoryData repositoryData, File targetPath) Checkout or update a working copy to the latest revision.
VcsWorkingCopy	updateToLatestRevision(VcsRepositoryData repositoryData, File targetPath) Checkout or update a working copy to the latest revision.

Methods inherited from class com.atlassian.bamboo.plugins.git.v2.AbstractGitExecutor

getAccessData, getCacheDirectory, getCachePath, getGitCapability, getSharedCredentialsIdField, getSshCapability, getSubstitutedAccessData, getSubstitutedAccessDataBuilder, getWorkingDirectory, isUsingSharedCredentials, rethrowOrRemoveDirectory, substituteString

Methods inherited from class java.lang.Object

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

Constructor Detail

GitWorkingCopyManager

@Inject
public GitWorkingCopyManager(CapabilityContext capabilityContext,
                                     CredentialsAccessor credentialsAccessor,
                                     CustomVariableContext customVariableContext,
                                     BuildDirectoryManager buildDirectoryManager,
                                     com.atlassian.sal.api.message.I18nResolver i18nResolver,
                                     TrustedKeyHelper trustedKeyHelper,
                                     SshProxyService sshProxyService,
                                     BuildLoggerManager buildLoggerManager,
                                     VcsBranchIntegrationHelper branchIntegrationHelper)

Method Detail

getWorkingCopyInfo

@NotNull
public VcsWorkingCopy getWorkingCopyInfo(@NotNull
                                                  VcsRepositoryData repositoryData,
                                                  @NotNull
                                                  File checkoutPath)
                                           throws RepositoryException

Description copied from interface: StatusProvidingVcsWorkingCopyManager

Provide repository working copy information for the given checkout path.

Specified by:

getWorkingCopyInfo in interface StatusProvidingVcsWorkingCopyManager

Parameters:

repositoryData - configuration of the repository

checkoutPath - path, where repository was checked out

Returns:

working copy information

Throws:

RepositoryException - if any error occurs, or e.g. the path is not a valid checkout path for the repository

retrieveSourceCode

@NotNull
public VcsWorkingCopy retrieveSourceCode(@NotNull
                                                  CommonContext commonContext,
                                                  @NotNull
                                                  VcsRepositoryData repositoryData,
                                                  @NotNull
                                                  PlanVcsRevisionData targetRevision,
                                                  @NotNull
                                                  File targetPath)
                                           throws RepositoryException

Description copied from interface: VcsWorkingCopyManager

Checkout or update a working copy to a revision.

Specified by:

retrieveSourceCode in interface VcsWorkingCopyManager

Parameters:

commonContext - - a current build or deployment context

repositoryData - - configuration of a repository to checkout/update

targetRevision - - revision to check out or update to

targetPath - - workings copy's path. Note that some legacy implementation may ignore this parameter. (see FixedDirectoryWorkingCopyManager)

Returns:

object representing created/updated working copy

Throws:

RepositoryException

updateToLatestRevision

@NotNull
public VcsWorkingCopy updateToLatestRevision(@NotNull
                                                      CommonContext commonContext,
                                                      @NotNull
                                                      VcsRepositoryData repositoryData,
                                                      @NotNull
                                                      File targetPath)
                                               throws RepositoryException

Description copied from interface: VcsWorkingCopyManager

Checkout or update a working copy to the latest revision.

Specified by:

updateToLatestRevision in interface VcsWorkingCopyManager

Parameters:

commonContext - - a current build or deployment context

repositoryData - - configuration of a repository to checkout/update

targetPath - - workings copy's path. Note that some legacy implementation may ignore this parameter. (see FixedDirectoryWorkingCopyManager)

Returns:

object representing created/updated working copy

Throws:

RepositoryException

updateToLatestRevision

@NotNull
public VcsWorkingCopy updateToLatestRevision(@NotNull
                                                      VcsRepositoryData repositoryData,
                                                      @NotNull
                                                      File targetPath)
                                               throws RepositoryException

Description copied from interface: NoContextVcsWorkingCopyManager

Checkout or update a working copy to the latest revision.

Specified by:

updateToLatestRevision in interface NoContextVcsWorkingCopyManager

Parameters:

repositoryData - - configuration of a repository to checkout/update

targetPath - - workings copy's path. Note that some legacy implementation may ignore this parameter. (see FixedDirectoryWorkingCopyManager)

Returns:

object representing created/updated working copy

Throws:

RepositoryException

checkoutAndMerge

@NotNull
public VcsWorkingCopy checkoutAndMerge(@NotNull
                                                CommonContext commonContext,
                                                @NotNull
                                                VcsRepositoryData vcsRepositoryData,
                                                @NotNull
                                                VcsBranch targetBranch,
                                                @NotNull
                                                PlanVcsRevisionData revisionOnTarget,
                                                @NotNull
                                                VcsBranch sourceBranch,
                                                @NotNull
                                                PlanVcsRevisionData sourceRevision,
                                                @NotNull
                                                File targetPath)
                                         throws RepositoryException

Description copied from interface: MergingVcsWorkingCopyManager

Checks out the targetBranch and merges sourceBranch to it. Depending on the vcs type, this can create local commit.

Specified by:

checkoutAndMerge in interface MergingVcsWorkingCopyManager

vcsRepositoryData - configuration of the repository. Note that the following parameters override branch stored in repository data.

targetBranch - - target branch (branch to checkout and merge to)

revisionOnTarget - - revision to checkout and merge to

sourceBranch - - branch to merge from

sourceRevision - - revision to merge from

targetPath - - workings copy's path

Returns:

state of the working copy, including new revision if applicable

Throws:

RepositoryException

canDoMerge

public boolean canDoMerge()

Specified by:

canDoMerge in interface MergingVcsWorkingCopyManager

Returns:

true if merges are possible (i.e. required capabilities are present)

getMergingRequirements

@NotNull
public Set<Requirement> getMergingRequirements()

Description copied from interface: MergingVcsWorkingCopyManager

If executing merge imposes capability requirements on top of those returned by VcsExecutorWithRequirements#getRequirements(), return them here.

Specified by:

getMergingRequirements in interface MergingVcsWorkingCopyManager

stageChanges

public void stageChanges(@NotNull
                         VcsWorkingCopy workingCopy,
                         @NotNull
                         VcsRepositoryData repositoryData,
                         @NotNull
                         Collection<String> pathsToAdd)
                  throws RepositoryException

Description copied from interface: UpdatingVcsWorkingCopyManager

Stage changes for committing. If staging is not required or supported by repository, this method should do nothing.

Staging logic may differ between repository types. As an example, in Git it is necessary to stage added, modified and removed files before committing. In Mercurial on the other hand, only added and removed files need to be staged (modified files will be committed regardless, as they are considered tracked by the VCS).

Specified by:

stageChanges in interface UpdatingVcsWorkingCopyManager

Parameters:

workingCopy - workspace to perform the staging

repositoryData - configuration of repository

pathsToAdd - paths, relative to working copy directory, to stage for committing; if empty, all modified files from working copy directory should be staged

Throws:

RepositoryException

commitLocal

@NotNull
public VcsWorkingCopy commitLocal(@NotNull
                                           VcsWorkingCopy workingCopy,
                                           @NotNull
                                           VcsRepositoryData vcsRepositoryData,
                                           @NotNull
                                           String commitMessage)
                                    throws RepositoryException

Description copied from interface: UpdatingVcsWorkingCopyManager

Create a local commit. The exact meaning of this operation depends on repository type. In particular, it can be no-op for certain repository types, for example SVN. Intended use: creating a private revision that can be used later in the build.

Specified by:

commitLocal in interface UpdatingVcsWorkingCopyManager

Returns:

updated state of local working copy

Throws:

RepositoryException

updateRemote

@NotNull
public VcsWorkingCopy updateRemote(@NotNull
                                            VcsWorkingCopy workingCopy,
                                            @NotNull
                                            VcsRepositoryData vcsRepositoryData,
                                            @Nullable
                                            String commitMessage)
                                     throws RepositoryException

Description copied from interface: UpdatingVcsWorkingCopyManager

Update remote repository. The exact meaning of this operation depends on repository type. In DVCS case this should push pre-existing local commit to remote repository. In traditional vcs, like Subversion, this should execute commit operation. Intended use: publishing changes to the world.

Specified by:

updateRemote in interface UpdatingVcsWorkingCopyManager

commitMessage - - implementors are free to ignore this parameter.

Returns:

updated state of local working copy

Throws:

RepositoryException