org.arquillian.pact.git

Class GitOperations

java.lang.Object

org.arquillian.pact.git.GitOperations

public class GitOperations
extends Object

Constructor Summary

Constructors

Constructor and Description
GitOperations()

Method Summary

Modifier and Type	Method and Description
org.eclipse.jgit.revwalk.RevCommit	addAndCommit(org.eclipse.jgit.api.Git git, String message) Add all files and commit them with given message.
org.eclipse.jgit.revwalk.RevCommit	addAndCommit(org.eclipse.jgit.api.Git git, String message, String author, String email) Add all files and commit them with given message.
org.eclipse.jgit.lib.Ref	checkoutBranch(org.eclipse.jgit.api.Git git, String branch) Checkout existing branch.
org.eclipse.jgit.lib.Ref	checkoutBranch(org.eclipse.jgit.api.Git git, String branch, String remote) Checkout existing branch.
org.eclipse.jgit.lib.Ref	checkoutTag(org.eclipse.jgit.api.Git git, String tag) Checkout existing tag.
org.eclipse.jgit.api.Git	cloneRepository(String remoteUrl, Path localPath) Clones a public remote git repository.
org.eclipse.jgit.api.Git	cloneRepository(String remoteUrl, Path localPath, String passphrase, Path privateKey) Clones a private remote git repository.
org.eclipse.jgit.api.Git	cloneRepository(String remoteUrl, Path localPath, String username, String password) Clones a private remote git repository.
org.eclipse.jgit.lib.Ref	createBranchAndCheckout(org.eclipse.jgit.api.Git git, String branch) Executes a checkout -b command using given branch.
org.eclipse.jgit.lib.Ref	createTag(org.eclipse.jgit.api.Git git, String name) Creates a tag.
boolean	hasAtLeastOneReference(org.eclipse.jgit.lib.Repository repo) Checks if a repo has been cloned correctly.
boolean	isLocalBranch(org.eclipse.jgit.api.Git git, String branch) Checks if given branch has been checkedout locally too.
boolean	isRemoteBranch(org.eclipse.jgit.api.Git git, String branch, String remote) Checks if given branch is remote.
boolean	isValidGitRepository(Path folder) Checks if given folder is a git repository
org.eclipse.jgit.api.Git	openGitRepository(Path path) Opens local git repository.
org.eclipse.jgit.api.PullResult	pullFromRepository(org.eclipse.jgit.api.Git git, String remote, String remoteBranch) Pull repository from current branch and remote branch with same name as current
org.eclipse.jgit.api.PullResult	pullFromRepository(org.eclipse.jgit.api.Git git, String remote, String remoteBranch, String passphrase, Path privateKey) Pull repository from current branch and remote branch with same name as current
org.eclipse.jgit.api.PullResult	pullFromRepository(org.eclipse.jgit.api.Git git, String remote, String remoteBranch, String username, String password) Pull repository from current branch and remote branch with same name as current
Iterable<org.eclipse.jgit.transport.PushResult>	pushToRepository(org.eclipse.jgit.api.Git git, String remote) Push all changes and tags to given remote.
Iterable<org.eclipse.jgit.transport.PushResult>	pushToRepository(org.eclipse.jgit.api.Git git, String remote, String passphrase, Path privateKey) Push all changes and tags to given remote.
Iterable<org.eclipse.jgit.transport.PushResult>	pushToRepository(org.eclipse.jgit.api.Git git, String remote, String username, String password) Push all changes and tags to given remote.

Methods inherited from class java.lang.Object

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

Constructor Detail

GitOperations

public GitOperations()

Method Detail

isValidGitRepository

public boolean isValidGitRepository(Path folder)

Checks if given folder is a git repository

Parameters:

folder - to check

Returns:

true if it is a git repository, false otherwise.

openGitRepository

public org.eclipse.jgit.api.Git openGitRepository(Path path)
                                           throws IOException

Opens local git repository.

Parameters:

path - of git repository

Returns:

Git instance

Throws:

IOException

checkoutTag

public org.eclipse.jgit.lib.Ref checkoutTag(org.eclipse.jgit.api.Git git,
                                            String tag)

Checkout existing tag.

Parameters:

git - instance.

tag - to move

Returns:

Ref to current branch

isLocalBranch

public boolean isLocalBranch(org.eclipse.jgit.api.Git git,
                             String branch)

Checks if given branch has been checkedout locally too.

Parameters:

git - instance.

branch - to check.

Returns:

True if it is local, false otherwise.

isRemoteBranch

public boolean isRemoteBranch(org.eclipse.jgit.api.Git git,
                              String branch,
                              String remote)

Checks if given branch is remote.

Parameters:

git - instance.

branch - to check.

remote - name.

Returns:

True if it is remote, false otherwise.

checkoutBranch

public org.eclipse.jgit.lib.Ref checkoutBranch(org.eclipse.jgit.api.Git git,
                                               String branch)

Checkout existing branch.

Parameters:

git - instance.

branch - to move

Returns:

Ref to current branch

checkoutBranch

public org.eclipse.jgit.lib.Ref checkoutBranch(org.eclipse.jgit.api.Git git,
                                               String branch,
                                               String remote)

Checkout existing branch.

Parameters:

git - instance.

branch - to move

remote - repository name

Returns:

Ref to current branch

createBranchAndCheckout

public org.eclipse.jgit.lib.Ref createBranchAndCheckout(org.eclipse.jgit.api.Git git,
                                                        String branch)

Executes a checkout -b command using given branch.

Parameters:

git - instance.

branch - to create and checkout.

Returns:

Ref to current branch.

addAndCommit

public org.eclipse.jgit.revwalk.RevCommit addAndCommit(org.eclipse.jgit.api.Git git,
                                                       String message)

Add all files and commit them with given message. This is equivalent as doing git add . git commit -m "message".

Parameters:

git - instance.

message - of the commit.

Returns:

RevCommit of this commit.

addAndCommit

public org.eclipse.jgit.revwalk.RevCommit addAndCommit(org.eclipse.jgit.api.Git git,
                                                       String message,
                                                       String author,
                                                       String email)

Add all files and commit them with given message. This is equivalent as doing git add . git commit -m "message".

Parameters:

git - instance.

message - of the commit.

author - of the commit.

email - of author of the commit.

Returns:

RevCommit of this commit.

pullFromRepository

public org.eclipse.jgit.api.PullResult pullFromRepository(org.eclipse.jgit.api.Git git,
                                                          String remote,
                                                          String remoteBranch)

Pull repository from current branch and remote branch with same name as current

Parameters:

git - instance.

remote - to be used.

remoteBranch - to use.

pushToRepository

public Iterable<org.eclipse.jgit.transport.PushResult> pushToRepository(org.eclipse.jgit.api.Git git,
                                                                        String remote)

Push all changes and tags to given remote.

Parameters:

git - instance.

remote - to be used.

Returns:

List of all results of given push.

pushToRepository

public Iterable<org.eclipse.jgit.transport.PushResult> pushToRepository(org.eclipse.jgit.api.Git git,
                                                                        String remote,
                                                                        String username,
                                                                        String password)

Push all changes and tags to given remote.

Parameters:

git - instance.

remote - to be used.

username - to login.

password - to login.

Returns:

List of all results of given push.

createTag

public org.eclipse.jgit.lib.Ref createTag(org.eclipse.jgit.api.Git git,
                                          String name)

Creates a tag.

Parameters:

git - instance.

name - of the tag.

Returns:

Ref created to tag.

pushToRepository

public Iterable<org.eclipse.jgit.transport.PushResult> pushToRepository(org.eclipse.jgit.api.Git git,
                                                                        String remote,
                                                                        String passphrase,
                                                                        Path privateKey)

Push all changes and tags to given remote.

Parameters:

git - instance.

remote - to be used.

passphrase - to access private key.

privateKey - file location.

Returns:

List of all results of given push.

pullFromRepository

public org.eclipse.jgit.api.PullResult pullFromRepository(org.eclipse.jgit.api.Git git,
                                                          String remote,
                                                          String remoteBranch,
                                                          String username,
                                                          String password)

Pull repository from current branch and remote branch with same name as current

Parameters:

git - instance.

remote - to be used.

remoteBranch - to use.

username - to connect

password - to connect

pullFromRepository

public org.eclipse.jgit.api.PullResult pullFromRepository(org.eclipse.jgit.api.Git git,
                                                          String remote,
                                                          String remoteBranch,
                                                          String passphrase,
                                                          Path privateKey)

Pull repository from current branch and remote branch with same name as current

Parameters:

git - instance.

remote - to be used.

remoteBranch - to use.

passphrase - to access private key.

privateKey - file location.

cloneRepository

public org.eclipse.jgit.api.Git cloneRepository(String remoteUrl,
                                                Path localPath)

Clones a public remote git repository. Caller is responsible of closing git repository.

Parameters:

remoteUrl - to connect.

localPath - where to clone the repo.

Returns:

Git instance. Caller is responsible to close the connection.

cloneRepository

public org.eclipse.jgit.api.Git cloneRepository(String remoteUrl,
                                                Path localPath,
                                                String username,
                                                String password)

Clones a private remote git repository. Caller is responsible of closing git repository.

Parameters:

remoteUrl - to connect.

localPath - where to clone the repo.

username - to connect

password - to connect

Returns:

Git instance. Caller is responsible to close the connection.

cloneRepository

public org.eclipse.jgit.api.Git cloneRepository(String remoteUrl,
                                                Path localPath,
                                                String passphrase,
                                                Path privateKey)

Clones a private remote git repository. Caller is responsible of closing git repository.

Parameters:

remoteUrl - to connect.

localPath - where to clone the repo.

passphrase - to access private key.

privateKey - file location. If null default (~.ssh/id_rsa) location is used.

Returns:

Git instance. Caller is responsible to close the connection.

hasAtLeastOneReference

public boolean hasAtLeastOneReference(org.eclipse.jgit.lib.Repository repo)

Checks if a repo has been cloned correctly.

Parameters:

repo - to check

Returns:

true if has been cloned correctly, false otherwise