gitgeneric

Documentation

Index

• Constants
• func ReadFileFromRevision(repoPath, revision, filePath string) ([]byte, error)
• type DatedTag
• type GitHandler
• type GoGit
  • func (g GoGit) Add(files []string, workingDir string) error
  • func (g GoGit) Branches(workingDir string) (branches []string, err error)
  • func (g GoGit) Checkout(username, password, basedBranch, newBranch, gitRepositoryPath string, ...) error
  • func (g GoGit) Clone(username, password, URL, workingDir string, withSubmodules *bool) error
  • func (g GoGit) Commit(user, email, message, workingDir string, signingKey string, passphrase string) error
  • func (g GoGit) GetChangedFiles(workingDir string) ([]string, error)
  • func (g GoGit) GetLatestCommitHash(workingDir string) (string, error)
  • func (g GoGit) IsLocalBranchPublished(baseBranch, workingBranch, username, password, workingDir string) (bool, error)
  • func (g GoGit) IsSimilarBranch(a, b, workingDir string) (bool, error)
  • func (g GoGit) NewBranch(branch, workingDir string) (bool, error)
  • func (g GoGit) NewTag(tag, message, workingDir string) (bool, error)
  • func (g GoGit) Pull(username, password, gitRepositoryPath, branch string, ...) error
  • func (g GoGit) Push(username string, password string, workingDir string, force bool) (bool, error)
  • func (g GoGit) PushBranch(branch string, username string, password string, workingDir string, force bool) error
  • func (g GoGit) PushTag(tag string, username string, password string, workingDir string, force bool) error
  • func (g GoGit) RemoteURLs(workingDir string) (map[string]string, error)
  • func (g GoGit) SanitizeBranchName(branch string) string
  • func (g GoGit) TagHashes(workingDir string) (hashes []string, err error)
  • func (g GoGit) TagRefs(workingDir string) (tags []DatedTag, err error)
  • func (g GoGit) Tags(workingDir string) (names []string, err error)
• type MockGit
  • func (m MockGit) RemoteURLs(workingDir string) (map[string]string, error)

Constants

const (
	DefaultRemoteReferenceName = "origin"
)

Functions

func ReadFileFromRevision

func ReadFileFromRevision(repoPath, revision, filePath string) ([]byte, error)

ReadFileFromRevision reads a file from a git repository at a given revision.

Types

type DatedTag

type DatedTag struct {
	When time.Time
	Name string
	Hash string
}

type GitHandler

type GitHandler interface {
	Add(files []string, workingDir string) error
	Checkout(username, password, branch, remoteBranch, workingDir string, forceReset bool) error
	Clone(username, password, URL, workingDir string, withSubmodules *bool) error
	Commit(user, email, message, workingDir string, signingKey string, passphrase string) error
	GetChangedFiles(workingDir string) ([]string, error)
	GetLatestCommitHash(workingDir string) (string, error)
	IsSimilarBranch(a, b, workingDir string) (bool, error)
	IsLocalBranchPublished(baseBranch, workingBranch, username, password, workingDir string) (bool, error)
	NewTag(tag, message, workingDir string) (bool, error)
	NewBranch(branch, workingDir string) (bool, error)
	Pull(username, password, gitRepositoryPath, branch string, singleBranch, forceReset bool) error
	Push(username string, password string, workingDir string, force bool) (bool, error)
	PushTag(tag string, username string, password string, workingDir string, force bool) error
	PushBranch(branch string, username string, password string, workingDir string, force bool) error
	RemoteURLs(workingDir string) (map[string]string, error)
	SanitizeBranchName(branch string) string
	Tags(workingDir string) (tags []string, err error)
	TagHashes(workingDir string) (hashes []string, err error)
	TagRefs(workingDir string) (refs []DatedTag, err error)
	Branches(workingDir string) (branches []string, err error)
}

type GoGit

type GoGit struct {
}

func (GoGit) Add

func (g GoGit) Add(files []string, workingDir string) error

Add run `git add`.

func (GoGit) Branches

func (g GoGit) Branches(workingDir string) (branches []string, err error)

Tags return a list of git tags ordered by latest commit time

func (GoGit) Checkout

func (g GoGit) Checkout(username, password, basedBranch, newBranch, gitRepositoryPath string, forceReset bool) error

Checkout create and then uses a temporary git branch.

func (GoGit) Clone

func (g GoGit) Clone(username, password, URL, workingDir string, withSubmodules *bool) error

Clone run `git clone`.

func (GoGit) Commit

func (g GoGit) Commit(user, email, message, workingDir string, signingKey string, passphrase string) error

Commit run `git commit`.

func (GoGit) GetChangedFiles

func (g GoGit) GetChangedFiles(workingDir string) ([]string, error)

func (GoGit) GetLatestCommitHash

func (g GoGit) GetLatestCommitHash(workingDir string) (string, error)

GetLatestCommitHash returns the latest commit hash from the working directory

func (GoGit) IsLocalBranchPublished

func (g GoGit) IsLocalBranchPublished(baseBranch, workingBranch, username, password, workingDir string) (bool, error)

IsLocalBranchPublished checks if the local working branch, contains any changes which should be published.

• `git diff` is not yet supported by the go-git library. https://github.com/go-git/go-git/issues/36

We retrieve:

• the latest commit from the local working branch
• the latest commit from the base branch
• the latest commit from the remote working branch if it exists.

Based on those three information we decide if local changes should be published.

If local working branch == local base branch and no remote working branch => This means that base branch and working are similar so nothing need to be pushed

If local working branch == local base branch != remote working branch => This means that at some point the remote branch diverge from base branch

If local working branch == local base branch == remote working branch => This means that everything is up to date

returns true if both the remote and local reference are similar.

func (GoGit) IsSimilarBranch

func (g GoGit) IsSimilarBranch(a, b, workingDir string) (bool, error)

IsSimilarBranch checks that the last commits of the two branches are similar then return true if it's the case

func (GoGit) NewBranch

func (g GoGit) NewBranch(branch, workingDir string) (bool, error)

NewBranch create a tag then return a boolean to indicate if the tag was created or not.

func (GoGit) NewTag

func (g GoGit) NewTag(tag, message, workingDir string) (bool, error)

NewTag create a tag then return a boolean to indicate if the tag was created or not.

func (GoGit) Pull

func (g GoGit) Pull(username, password, gitRepositoryPath, branch string, singleBranch, forceReset bool) error

Pull run `git pull` on the local HEAD.

func (GoGit) Push

func (g GoGit) Push(username string, password string, workingDir string, force bool) (bool, error)

Push run `git push`. The function returns a boolean to indicate if the push needed a force push or not. and an error if something went wrong.

func (GoGit) PushBranch

func (g GoGit) PushBranch(branch string, username string, password string, workingDir string, force bool) error

PushBranch publish a single branch created locally

func (GoGit) PushTag

func (g GoGit) PushTag(tag string, username string, password string, workingDir string, force bool) error

PushTag publish a single tag created locally

func (GoGit) RemoteURLs

func (g GoGit) RemoteURLs(workingDir string) (map[string]string, error)

RemoteURLs returns the list of remote URLs

func (GoGit) SanitizeBranchName

func (g GoGit) SanitizeBranchName(branch string) string

SanitizeBranchName replace wrong character in the branch name

func (GoGit) TagHashes

func (g GoGit) TagHashes(workingDir string) (hashes []string, err error)

TagHashes returns a list of the commit hashes for git tags ordered by creation time

func (GoGit) TagRefs

func (g GoGit) TagRefs(workingDir string) (tags []DatedTag, err error)

TagRefs returns a list of git tags ordered by creation time

func (GoGit) Tags

func (g GoGit) Tags(workingDir string) (names []string, err error)

Tags returns a list of the names for git tags ordered by creation time

type MockGit

type MockGit struct {
	GitHandler // Ensure any unspecified method from this interface are still declared
	Remotes    map[string]string
	Err        error
}

MockGit is a stub implementation of the `GitHandler` interface to be used in our unit test suites.

func (MockGit) RemoteURLs

func (m MockGit) RemoteURLs(workingDir string) (map[string]string, error)