testutil

Documentation

Overview

Package testutil contains functions intended only to be used during testing of ggman.

Functions in this package are not considered part of the stable interface. For this reason most functions are themselves untested.

Index

• Constants
• func CaseSensitive(t *testing.T) bool
• func CommitTestFiles(repo *git.Repository, files map[string]string) (*git.Worktree, plumbing.Hash)
• func NewTestRepo(t *testing.T) (clonePath string, repo *git.Repository)
• func NewTestRepoAt(clonePath, remote string) (repo *git.Repository)
• func ToOSPath(path string) (result string)
• func ToOSPaths(paths []string) []string

Constants

const AuthorEmail = "jane.doe@example.com"

AuthorEmail is the email to be used for email of the author of test git commit-likes.

const AuthorName = "Jane Doe"

AuthorName is the name to be used for authors of test git commit-likes.

Functions

func CaseSensitive

func CaseSensitive(t *testing.T) bool

CaseSensitive checks if temporary directories exist on a case-sensitive file system.

This function is untested due to unpredictability of runtime environment.

func CommitTestFiles

func CommitTestFiles(repo *git.Repository, files map[string]string) (*git.Worktree, plumbing.Hash)

CommitTestFiles makes a new commit in the repository repo. The commit will contain files with the names and content of the contained map. When the map is nil, a default dummy file will be used instead. The commit will appear to have been authored from a bogus author and have a bogus commit message.

The function returns the worktree of the repository and the commit hash produced

The files will be written out to disk. If an error occurs, panic() is called.

func NewTestRepo

func NewTestRepo(t *testing.T) (clonePath string, repo *git.Repository)

If something goes wrong, the function calls panic().

func NewTestRepoAt

func NewTestRepoAt(clonePath, remote string) (repo *git.Repository)

The 'remote' part of this function is untested.

func ToOSPath

func ToOSPath(path string) (result string)

ToOSPath turns a path that is separated via "/"s into a path separated by the current os-separator.

When path starts with "/", the path is guaranteed to contain a volume name.

func ToOSPaths

func ToOSPaths(paths []string) []string

ToOSPaths is like ToOSPath, but applies to each value in a slice or array. ToOSPaths modifies the slice in-place and returns it for convenience.

This function is untested.