gittest

Documentation

Index

• type CommitFileOpt
  • func WithAmend() CommitFileOpt
  • func WithMessage(msg string) CommitFileOpt
• type GitTestRepo
  • func NewTempRepo(t *testing.T) *GitTestRepo
  • func NewTempRepoWithGitHubServer(t *testing.T, serverURL string) *GitTestRepo
  • func (r *GitTestRepo) AddFile(t *testing.T, fp string)
  • func (r *GitTestRepo) AsAvGitRepo() *avgit.Repo
  • func (r *GitTestRepo) CheckoutBranch(t *testing.T, branch plumbing.ReferenceName) plumbing.ReferenceName
  • func (r *GitTestRepo) CheckoutCommit(t *testing.T, hash plumbing.Hash)
  • func (r *GitTestRepo) CommitFile(t *testing.T, filename string, body string, cfOpts ...CommitFileOpt) plumbing.Hash
  • func (r *GitTestRepo) CreateFile(t *testing.T, filename string, body string) string
  • func (r *GitTestRepo) CreateRef(t *testing.T, ref plumbing.ReferenceName)
  • func (r *GitTestRepo) CurrentBranch(t *testing.T) plumbing.ReferenceName
  • func (r *GitTestRepo) GetCommitAtRef(t *testing.T, name plumbing.ReferenceName) plumbing.Hash
  • func (r *GitTestRepo) GetCommits(t *testing.T, includedFromRef, excludedFromRef plumbing.ReferenceName) []plumbing.Hash
  • func (r *GitTestRepo) Git(t *testing.T, args ...string) string
  • func (r *GitTestRepo) IsWorkdirClean(t *testing.T) bool
  • func (r *GitTestRepo) MergeBase(t *testing.T, ref1, ref2 plumbing.ReferenceName) []plumbing.Hash
  • func (r *GitTestRepo) OpenDB(t *testing.T) *jsonfiledb.DB
  • func (r *GitTestRepo) WithCheckoutBranch(t *testing.T, branch plumbing.ReferenceName, f func())

Types

type CommitFileOpt

type CommitFileOpt func(*commitFileOpts)

func WithAmend

func WithAmend() CommitFileOpt

func WithMessage

func WithMessage(msg string) CommitFileOpt

type GitTestRepo

type GitTestRepo struct {
	RepoDir string
	GitDir  string
	GoGit   *git.Repository
}

func NewTempRepo

func NewTempRepo(t *testing.T) *GitTestRepo

NewTempRepo initializes a new git repository with reasonable defaults.

func NewTempRepoWithGitHubServer

func NewTempRepoWithGitHubServer(t *testing.T, serverURL string) *GitTestRepo

func (*GitTestRepo) AddFile

func (r *GitTestRepo) AddFile(t *testing.T, fp string)

func (*GitTestRepo) AsAvGitRepo

func (r *GitTestRepo) AsAvGitRepo() *avgit.Repo

func (*GitTestRepo) CheckoutBranch

func (r *GitTestRepo) CheckoutBranch(
	t *testing.T,
	branch plumbing.ReferenceName,
) plumbing.ReferenceName

CheckoutBranch checks out the specified branch and returns the original branch.

func (*GitTestRepo) CheckoutCommit

func (r *GitTestRepo) CheckoutCommit(t *testing.T, hash plumbing.Hash)

func (*GitTestRepo) CommitFile

func (r *GitTestRepo) CommitFile(
	t *testing.T,
	filename string,
	body string,
	cfOpts ...CommitFileOpt,
) plumbing.Hash

func (*GitTestRepo) CreateFile

func (r *GitTestRepo) CreateFile(t *testing.T, filename string, body string) string

func (*GitTestRepo) CreateRef

func (r *GitTestRepo) CreateRef(t *testing.T, ref plumbing.ReferenceName)

func (*GitTestRepo) CurrentBranch

func (r *GitTestRepo) CurrentBranch(t *testing.T) plumbing.ReferenceName

func (*GitTestRepo) GetCommitAtRef

func (r *GitTestRepo) GetCommitAtRef(t *testing.T, name plumbing.ReferenceName) plumbing.Hash

func (*GitTestRepo) GetCommits

func (r *GitTestRepo) GetCommits(
	t *testing.T,
	includedFromRef, excludedFromRef plumbing.ReferenceName,
) []plumbing.Hash

func (*GitTestRepo) Git

func (r *GitTestRepo) Git(t *testing.T, args ...string) string

func (*GitTestRepo) IsWorkdirClean

func (r *GitTestRepo) IsWorkdirClean(t *testing.T) bool

func (*GitTestRepo) MergeBase

func (r *GitTestRepo) MergeBase(t *testing.T, ref1, ref2 plumbing.ReferenceName) []plumbing.Hash

func (*GitTestRepo) OpenDB

func (r *GitTestRepo) OpenDB(t *testing.T) *jsonfiledb.DB

func (*GitTestRepo) WithCheckoutBranch

func (r *GitTestRepo) WithCheckoutBranch(t *testing.T, branch plumbing.ReferenceName, f func())

WithCheckoutBranch runs the given function after checking out the specified branch. It returns to the original branch after the function returns.