com.atlassian.bamboo.plugins.hg

Class HgCommandProcessor

java.lang.Object

com.atlassian.bamboo.plugins.hg.HgCommandProcessor

All Implemented Interfaces:

ProxyErrorReceiver, Serializable

public class HgCommandProcessor
extends Object
implements Serializable, ProxyErrorReceiver

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HgCommandProcessor.HgStringOutputHandler

Method Summary

Modifier and Type	Method and Description
void	checkHgExistenceInSystem(File workingDirectory) Checks whether mercurial exist in current system.
HgCommandBuilder	createCommandBuilder(String... commands)
Pair<ArrayList<CommitContext>,Integer>	getChangesetsSinceRevision(File workingDirectory, String branch, String previousRevision, String targetRevision, int maxCommitsToReturn) Returns list of commit extracted from hg log command.
String	getCurrentBranch(File checkoutPath)
CommitContext	getFirstCommit(File workingDirectory, String branchName)
List<CommitContext>	getHeads(File workingDirectory, String repositoryUrl, String branchName)
String	getLocalChangesetId(File workingDirectory) Returns 40char hash code of the current revision in repository.
String	getLocalTipInDirectory(File workingDirectory, String branch) Returns 40char hash code of the tip-most changeset in repository contained in workingDirectory (or it parents).
String	getRemoteTipForBranch(File workingDirectory, String repositoryUrl, String branch) Returns 40char hash code of the tip-most changeset in remote repository.
int	getTotalChangesetsCountSinceRevision(File workingDirectory, HgCommandBuilder commandBuilder) Returns total count of commits since previousRevision up to tip revision.
boolean	isWorkingCopyClean(File workingDirectory) Checks whether the directory is at clean state (no uncommitted changes).
boolean	merge(File workspace, String targetRevision)
void	reportProxyError(String message, Throwable exception)
void	runArchiveCommand(File destinationDirectory, File repository, String revision, String[] includePattern) Archives (exports) contents of specified revision, applying the optional include pattern.
void	runCloneCommand(File workingDirectory, String repositoryUrl, String revision) Clones remote repository into local directory.
void	runCommand(HgCommandBuilder commandBuilder, File workingDirectory)
void	runCommand(HgCommandBuilder commandBuilder, File workingDirectory, com.atlassian.bamboo.plugins.hg.HgCommandProcessor.HgOutputHandler outputHandler, com.google.common.collect.ImmutableMap<String,String> env)
void	runInitCommand(File workingDirectory) Creates .hg repository in a given directory.
void	runPullCommand(File workingDirectory, String repositoryUrl, String revision) Updates (pulls changesets from remote repository) workingDirectory to specified revision.
void	runUpdateCommand(File workingDirectory, String revision) Updates working copy in workingDirectory to specified revision.
protected String	sanitizeStderr(String stderr)
void	setSshCommand(String sshCommand)
void	setSshCompression(boolean sshCompression)
void	setSshKeyFile(String sshKeyFile)

Methods inherited from class java.lang.Object

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

Method Detail

checkHgExistenceInSystem

public void checkHgExistenceInSystem(@NotNull
                                     File workingDirectory)
                              throws RepositoryException

Checks whether mercurial exist in current system.

Parameters:

workingDirectory - specifies arbitrary directory.

Throws:

RepositoryException - when mercurial wasn't found in current system.

runInitCommand

public void runInitCommand(@NotNull
                           File workingDirectory)
                    throws RepositoryException

Creates .hg repository in a given directory.

Parameters:

workingDirectory - - directory in which we want to create empty repository.

Throws:

RepositoryException - when init command fails

merge

public boolean merge(@NotNull
                     File workspace,
                     @NotNull
                     String targetRevision)
              throws RepositoryException

Throws:

RepositoryException

runCloneCommand

public void runCloneCommand(@NotNull
                            File workingDirectory,
                            @NotNull
                            String repositoryUrl,
                            @Nullable
                            String revision)
                     throws RepositoryException

Clones remote repository into local directory. It doesn't update working copy - it just clones .hg directory. Use runUpdateCommand to fill working directory with repository working copy.

Parameters:

workingDirectory - specifies directory in which we want to clone remote repository. It has to be either empty directory or non existent.

repositoryUrl - specifies remote repository.

revision - specifies revision we want to clone to - especially it might point to a branch.

Throws:

RepositoryException - when clone command fails.

runPullCommand

public void runPullCommand(@NotNull
                           File workingDirectory,
                           @NotNull
                           String repositoryUrl,
                           @Nullable
                           String revision)
                    throws RepositoryException

Updates (pulls changesets from remote repository) workingDirectory to specified revision.

Parameters:

repositoryUrl - specifies remote repository to pull from.

workingDirectory - specifies directory we want to update.

revision - specifies revision we want to update/pull to.

Throws:

RepositoryException - when pull command fails.

runUpdateCommand

public void runUpdateCommand(@NotNull
                             File workingDirectory,
                             @Nullable
                             String revision)
                      throws RepositoryException

Updates working copy in workingDirectory to specified revision. It forces to clean up working copy (to avoid interactive merges etc).

Parameters:

workingDirectory - specifies directory we want to update. It must have hg repository.

revision - specifies revision we want to update to.

Throws:

RepositoryException - when update command fails.

runArchiveCommand

public void runArchiveCommand(@NotNull
                              File destinationDirectory,
                              @NotNull
                              File repository,
                              @Nullable
                              String revision,
                              @Nullable
                              String[] includePattern)
                       throws RepositoryException

Archives (exports) contents of specified revision, applying the optional include pattern.

Parameters:

destinationDirectory - specifies directory to export to

repository - hg repository to export from.

revision - specifies revision we want to export.

includePattern - set of include patterns

Throws:

RepositoryException - when update command fails.

getTotalChangesetsCountSinceRevision

public int getTotalChangesetsCountSinceRevision(@NotNull
                                                File workingDirectory,
                                                @NotNull
                                                HgCommandBuilder commandBuilder)
                                         throws RepositoryException

Returns total count of commits since previousRevision up to tip revision. If no previousRevision is specified then it returns all hg logged changes.

Parameters:

workingDirectory - specifies directory contained by hg repository.

Returns:

number of commits in workingDirectory since previousRevision

Throws:

RepositoryException - when hg repository is not found or parsing log file failed.

getHeads

public List<CommitContext> getHeads(@NotNull
                                    File workingDirectory,
                                    @NotNull
                                    String repositoryUrl,
                                    @Nullable
                                    String branchName)
                             throws RepositoryException

Throws:

RepositoryException

getFirstCommit

@NotNull
public CommitContext getFirstCommit(@NotNull
                                             File workingDirectory,
                                             @Nullable
                                             String branchName)
                                      throws RepositoryException

Throws:

RepositoryException

getChangesetsSinceRevision

@NotNull
public Pair<ArrayList<CommitContext>,Integer> getChangesetsSinceRevision(@NotNull
                                                                                  File workingDirectory,
                                                                                  @NotNull
                                                                                  String branch,
                                                                                  @Nullable
                                                                                  String previousRevision,
                                                                                  @Nullable
                                                                                  String targetRevision,
                                                                                  int maxCommitsToReturn)
                                                                           throws RepositoryException

Returns list of commit extracted from hg log command. It returns no more than the specified amount of changesets, and it returns commits since previousRevision up to tip revision. If no previousRevision is specified then it returns all changes.

Parameters:

workingDirectory - specifies directory contained by hg repository.

previousRevision - specifies the starting point of changeset history we are interested in.

targetRevision - the latest revision we are interested in or tip if null

maxCommitsToReturn - the maximum amount of changesets to be reported

Returns:

list of commits in workingDirectory since previousRevision and the total number of changesets between these two revisions. The total number includes the skipped commits, if any.

Throws:

RepositoryException - when hg repository is not found or parsing log file failed.

getRemoteTipForBranch

@NotNull
public String getRemoteTipForBranch(@NotNull
                                             File workingDirectory,
                                             @NotNull
                                             String repositoryUrl,
                                             @Nullable
                                             String branch)
                                      throws RepositoryException

Returns 40char hash code of the tip-most changeset in remote repository.

Parameters:

workingDirectory - specifies where to run clone command from.

repositoryUrl - specifies remote repository.

branch - specifies which branch to check (might be null, which means "default" branch).

Returns:

40char tip hash.

Throws:

RepositoryException - when clone command fails.

getLocalTipInDirectory

@NotNull
public String getLocalTipInDirectory(@NotNull
                                              File workingDirectory,
                                              @Nullable
                                              String branch)
                                       throws RepositoryException

Returns 40char hash code of the tip-most changeset in repository contained in workingDirectory (or it parents).

Parameters:

workingDirectory - directory contained by hg repository.

branch - specifies which branch tip we want to retrieve.

Returns:

40char tip hash.

Throws:

RepositoryException - when workingDirectory is not versioned by hg repository.

getLocalChangesetId

@NotNull
public String getLocalChangesetId(@NotNull
                                           File workingDirectory)
                                    throws RepositoryException

Returns 40char hash code of the current revision in repository.

Parameters:

workingDirectory - directory contained by hg repository

Returns:

40char hash of current changeset

Throws:

RepositoryException - when workingDirectory is not versioned by hg repository.

isWorkingCopyClean

public boolean isWorkingCopyClean(@NotNull
                                  File workingDirectory)
                           throws RepositoryException

Checks whether the directory is at clean state (no uncommitted changes).

Parameters:

workingDirectory - directory into which Mercurial repository was checked out

Returns:

true if there are no uncommitted changes for the repository.

Throws:

RepositoryException - on any error

createCommandBuilder

public HgCommandBuilder createCommandBuilder(String... commands)

reportProxyError

public void reportProxyError(String message,
                             Throwable exception)

Specified by:

reportProxyError in interface ProxyErrorReceiver

getCurrentBranch

public String getCurrentBranch(File checkoutPath)
                        throws RepositoryException

Throws:

RepositoryException

runCommand

public void runCommand(@NotNull
                       HgCommandBuilder commandBuilder,
                       @NotNull
                       File workingDirectory)
                throws RepositoryException

Throws:

RepositoryException

sanitizeStderr

@Nullable
protected String sanitizeStderr(@Nullable
                                          String stderr)

runCommand

public void runCommand(@NotNull
                       HgCommandBuilder commandBuilder,
                       @NotNull
                       File workingDirectory,
                       @NotNull
                       com.atlassian.bamboo.plugins.hg.HgCommandProcessor.HgOutputHandler outputHandler,
                       @Nullable
                       com.google.common.collect.ImmutableMap<String,String> env)
                throws RepositoryException

Throws:

RepositoryException

setSshCommand

public void setSshCommand(String sshCommand)

setSshKeyFile

public void setSshKeyFile(String sshKeyFile)

setSshCompression

public void setSshCompression(boolean sshCompression)