git

Documentation

Index

• func GetGitCommandEnvAndURL(repo, username, password string, sshPrivateKey string) (string, []string, error)
• func IsCommitSHA(sha string) bool
• func IsSSHURL(url string) bool
• func IsTruncatedCommitSHA(sha string) bool
• func NormalizeGitURL(repo string) string
• func TestRepo(repo, username, password string, sshPrivateKey string) error
• type Client
• type ClientFactory
  • func NewFactory() ClientFactory

Functions

func GetGitCommandEnvAndURL

func GetGitCommandEnvAndURL(repo, username, password string, sshPrivateKey string) (string, []string, error)

GetGitCommandEnvAndURL returns URL and env options for git operation

func IsCommitSHA

func IsCommitSHA(sha string) bool

IsCommitSHA returns whether or not a string is a 40 character SHA-1

func IsSSHURL

func IsSSHURL(url string) bool

IsSSHURL returns true if supplied URL is SSH URL

func IsTruncatedCommitSHA

func IsTruncatedCommitSHA(sha string) bool

IsTruncatedCommitSHA returns whether or not a string is a truncated SHA-1

func NormalizeGitURL

func NormalizeGitURL(repo string) string

NormalizeGitURL normalizes a git URL for lookup and storage

func TestRepo

func TestRepo(repo, username, password string, sshPrivateKey string) error

TestRepo tests if a repo exists and is accessible with the given credentials

Types

type Client

type Client interface {
	Root() string
	Init() error
	Fetch() error
	Checkout(revision string) error
	LsRemote(revision string) (string, error)
	LsFiles(path string) ([]string, error)
	CommitSHA() (string, error)
	Reset() error
}

Client is a generic git client interface

type ClientFactory

type ClientFactory interface {
	NewClient(repoURL, path, username, password, sshPrivateKey string) (Client, error)
}

ClientFactory is a factory of Git Clients Primarily used to support creation of mock git clients during unit testing

func NewFactory

func NewFactory() ClientFactory