testhelper

Documentation

Index

• Constants
• func AddWorktree(t *testing.T, repoPath string, worktreeName string)
• func AddWorktreeArgs(repoPath, worktreeName string) []string
• func AssertPathNotExists(t *testing.T, path string)
• func AuthorsEqual(a *gitalypb.CommitAuthor, b *gitalypb.CommitAuthor) bool
• func CaptureHookEnv(t *testing.T) (hookPath string, cleanup func())
• func CommitBlobWithName(t *testing.T, testRepoPath, blobID, fileName, commitMessage string) string
• func ConfigureGitalySSH()
• func ConfigureRuby() error
• func Context() (context.Context, func())
• func CreateCommit(t *testing.T, repoPath, branchName string, opts *CreateCommitOpts) string
• func CreateCommitInAlternateObjectDirectory(t *testing.T, repoPath, altObjectsDir string, cmd *exec.Cmd) (currentHead []byte)
• func CreateCommitOnNewBranch(t *testing.T, repoPath string) (string, string)
• func CreateLooseRef(t *testing.T, repoPath, refName string)
• func CreateRemoteBranch(t *testing.T, repoPath, remoteName, branchName, ref string)
• func CreateRepo(t testing.TB, storagePath string) (repo *gitalypb.Repository, repoPath, relativePath string)
• func CreateTag(t *testing.T, repoPath, tagName, targetID string, opts *CreateTagOpts) string
• func EnableGitProtocolV2Support() func()
• func FindLocalBranchCommitAuthorsEqual(a *gitalypb.FindLocalBranchCommitAuthor, ...) bool
• func FindLocalBranchResponsesEqual(a *gitalypb.FindLocalBranchResponse, b *gitalypb.FindLocalBranchResponse) bool
• func GetGitEnvData() (string, error)
• func GetGitObjectDirSize(t *testing.T, repoPath string) int64
• func GetGitPackfileDirSize(t *testing.T, repoPath string) int64
• func GetLocalhostListener(t testing.TB) (net.Listener, string)
• func GetRepositoryRefs(t *testing.T, repoPath string) string
• func GetTemporaryGitalySocketFileName() string
• func GitCommitEqual(a, b *gitalypb.GitCommit) error
• func GitObjectMustExist(t testing.TB, repoPath, sha string)
• func GitObjectMustNotExist(t testing.TB, repoPath, sha string)
• func GitalyServersMetadata(t *testing.T, serverSocketPath string) metadata.MD
• func GitlabTestStoragePath() string
• func InitBareRepo(t *testing.T) (*gitalypb.Repository, string, func())
• func InitRepoWithWorktree(t *testing.T) (*gitalypb.Repository, string, func())
• func MustHaveNoChildProcess()
• func MustReadFile(t *testing.T, filename string) []byte
• func MustRunCommand(t testing.TB, stdin io.Reader, name string, args ...string) []byte
• func NewTestGrpcServer(tb testing.TB, streamInterceptors []grpc.StreamServerInterceptor, ...) *grpc.Server
• func NewTestLogger(tb testing.TB) *log.Logger
• func NewTestObjectPoolName(t *testing.T) string
• func NewTestRepo(t testing.TB) (repo *gitalypb.Repository, repoPath string, cleanup func())
• func NewTestRepoWithWorktree(t *testing.T) (repo *gitalypb.Repository, repoPath string, cleanup func())
• func ReceiveEOFWithTimeout(errorFunc func() error) error
• func RemoteExists(t *testing.T, repoPath string, remoteName string) bool
• func RequireGrpcError(t *testing.T, err error, expectedCode codes.Code)
• func SetCtxGrpcMethod(ctx context.Context, method string) context.Context
• func TempDir(t *testing.T, prefix string) (string, func() error)
• func TestRepository() *gitalypb.Repository
• type Cleanup
• type ConfigFile
  • func ParseConfig(src io.Reader) (ConfigFile, error)
  • func (cf ConfigFile) GetValue(section, key string) (string, bool)
• type CreateCommitOpts
• type CreateTagOpts

Constants

const (
	TestRelativePath    = "gitlab-test.git"
	RepositoryAuthToken = "the-secret-token"
	DefaultStorageName  = "default"
)

TestRelativePath is the path inside its storage of the gitlab-test repo

Functions

func AddWorktree

func AddWorktree(t *testing.T, repoPath string, worktreeName string)

AddWorktree creates a worktree in the repository path for tests

func AddWorktreeArgs

func AddWorktreeArgs(repoPath, worktreeName string) []string

AddWorktreeArgs returns git command arguments for adding a worktree at the specified repo

func AssertPathNotExists

func AssertPathNotExists(t *testing.T, path string)

AssertPathNotExists asserts true if the path doesn't exist, false otherwise

func AuthorsEqual

func AuthorsEqual(a *gitalypb.CommitAuthor, b *gitalypb.CommitAuthor) bool

AuthorsEqual tests if two `CommitAuthor`s are equal

func CaptureHookEnv

func CaptureHookEnv(t *testing.T) (hookPath string, cleanup func())

CaptureHookEnv creates a bogus 'update' Git hook to sniff out what environment variables get set for hooks.

func CommitBlobWithName

func CommitBlobWithName(t *testing.T, testRepoPath, blobID, fileName, commitMessage string) string

CommitBlobWithName will create a commit for the specified blob with the specified name. This enables testing situations where the filepath is not possible due to filesystem constraints (e.g. non-UTF characters). The commit ID is returned.

func ConfigureGitalySSH

func ConfigureGitalySSH()

ConfigureGitalySSH configures the gitaly-ssh command for tests

func ConfigureRuby

func ConfigureRuby() error

ConfigureRuby configures Ruby settings for test purposes at run time.

func Context

func Context() (context.Context, func())

Context returns a cancellable context.

func CreateCommit

func CreateCommit(t *testing.T, repoPath, branchName string, opts *CreateCommitOpts) string

CreateCommit makes a new empty commit and updates the named branch to point to it.

func CreateCommitInAlternateObjectDirectory

func CreateCommitInAlternateObjectDirectory(t *testing.T, repoPath, altObjectsDir string, cmd *exec.Cmd) (currentHead []byte)

CreateCommitInAlternateObjectDirectory runs a command such that its created objects will live in an alternate objects directory. It returns the current head after the command is run and the alternate objects directory path

func CreateCommitOnNewBranch

func CreateCommitOnNewBranch(t *testing.T, repoPath string) (string, string)

CreateCommitOnNewBranch creates a branch and a commit, returning the commit sha and the branch name respectivelyi

func CreateLooseRef

func CreateLooseRef(t *testing.T, repoPath, refName string)

CreateLooseRef creates a ref that points to master

func CreateRemoteBranch

func CreateRemoteBranch(t *testing.T, repoPath, remoteName, branchName, ref string)

CreateRemoteBranch creates a new remote branch

func CreateRepo

func CreateRepo(t testing.TB, storagePath string) (repo *gitalypb.Repository, repoPath, relativePath string)

CreateRepo creates a temporary directory for a repo, without initializing it

func CreateTag

func CreateTag(t *testing.T, repoPath, tagName, targetID string, opts *CreateTagOpts) string

CreateTag creates a new tag.

func EnableGitProtocolV2Support

func EnableGitProtocolV2Support() func()

EnableGitProtocolV2Support ensures that Git protocol v2 support is enabled, and replaces the git binary in config with an `env_git` wrapper that allows the protocol to be tested. It returns a function that restores the given settings.

Because we don't know how to get to that wrapper script from the current working directory, callers must create a symbolic link to the `env_git` file in their own `testdata` directories.

func FindLocalBranchCommitAuthorsEqual

func FindLocalBranchCommitAuthorsEqual(a *gitalypb.FindLocalBranchCommitAuthor, b *gitalypb.FindLocalBranchCommitAuthor) bool

FindLocalBranchCommitAuthorsEqual tests if two `FindLocalBranchCommitAuthor`s are equal

func FindLocalBranchResponsesEqual

func FindLocalBranchResponsesEqual(a *gitalypb.FindLocalBranchResponse, b *gitalypb.FindLocalBranchResponse) bool

FindLocalBranchResponsesEqual tests if two `FindLocalBranchResponse`s are equal

func GetGitEnvData

func GetGitEnvData() (string, error)

GetGitEnvData reads and returns the content of testGitEnv

func GetGitObjectDirSize

func GetGitObjectDirSize(t *testing.T, repoPath string) int64

GetGitObjectDirSize gets the number of 1k blocks of a git object directory

func GetGitPackfileDirSize

func GetGitPackfileDirSize(t *testing.T, repoPath string) int64

GetGitPackfileDirSize gets the number of 1k blocks of a git object directory

func GetLocalhostListener

func GetLocalhostListener(t testing.TB) (net.Listener, string)

GetLocalhostListener listens on the next available TCP port and returns the listener and the localhost address (host:port) string.

func GetRepositoryRefs

func GetRepositoryRefs(t *testing.T, repoPath string) string

GetRepositoryRefs gives a list of each repository ref as a string

func GetTemporaryGitalySocketFileName

func GetTemporaryGitalySocketFileName() string

GetTemporaryGitalySocketFileName will return a unique, useable socket file name

func GitCommitEqual

func GitCommitEqual(a, b *gitalypb.GitCommit) error

GitCommitEqual tests if two `GitCommit`s are equal

func GitObjectMustExist

func GitObjectMustExist(t testing.TB, repoPath, sha string)

GitObjectMustExist is a test assertion that fails unless the git repo in repoPath contains sha

func GitObjectMustNotExist

func GitObjectMustNotExist(t testing.TB, repoPath, sha string)

GitObjectMustNotExist is a test assertion that fails unless the git repo in repoPath contains sha

func GitalyServersMetadata

func GitalyServersMetadata(t *testing.T, serverSocketPath string) metadata.MD

GitalyServersMetadata returns a metadata pair for gitaly-servers to be used in inter-gitaly operations.

func GitlabTestStoragePath

func GitlabTestStoragePath() string

GitlabTestStoragePath returns the storage path to the gitlab-test repo.

func InitBareRepo

func InitBareRepo(t *testing.T) (*gitalypb.Repository, string, func())

InitBareRepo creates a new bare repository

func InitRepoWithWorktree

func InitRepoWithWorktree(t *testing.T) (*gitalypb.Repository, string, func())

InitRepoWithWorktree creates a new repository with a worktree

func MustHaveNoChildProcess

func MustHaveNoChildProcess()

MustHaveNoChildProcess panics if it finds a running or finished child process. It waits for 2 seconds for processes to be cleaned up by other goroutines.

func MustReadFile

func MustReadFile(t *testing.T, filename string) []byte

MustReadFile returns the content of a file or fails at once.

func MustRunCommand

func MustRunCommand(t testing.TB, stdin io.Reader, name string, args ...string) []byte

MustRunCommand runs a command with an optional standard input and returns the standard output, or fails.

func NewTestGrpcServer

func NewTestGrpcServer(tb testing.TB, streamInterceptors []grpc.StreamServerInterceptor, unaryInterceptors []grpc.UnaryServerInterceptor) *grpc.Server

NewTestGrpcServer creates a GRPC Server for testing purposes

func NewTestLogger

func NewTestLogger(tb testing.TB) *log.Logger

NewTestLogger created a logrus hook

func NewTestObjectPoolName

func NewTestObjectPoolName(t *testing.T) string

NewTestObjectPoolName returns a random pool repository name.

func NewTestRepo

func NewTestRepo(t testing.TB) (repo *gitalypb.Repository, repoPath string, cleanup func())

NewTestRepo creates a bare copy of the test repository.

func NewTestRepoWithWorktree

func NewTestRepoWithWorktree(t *testing.T) (repo *gitalypb.Repository, repoPath string, cleanup func())

NewTestRepoWithWorktree creates a copy of the test repository with a worktree. This is allows you to run normal 'non-bare' Git commands.

func ReceiveEOFWithTimeout

func ReceiveEOFWithTimeout(errorFunc func() error) error

ReceiveEOFWithTimeout reads to the end of the stream and will throw an error if a deadlock is suspected

func RemoteExists

func RemoteExists(t *testing.T, repoPath string, remoteName string) bool

RemoteExists tests if the repository at repoPath has a Git remote named remoteName.

func RequireGrpcError

func RequireGrpcError(t *testing.T, err error, expectedCode codes.Code)

RequireGrpcError asserts the passed err is of the same code as expectedCode.

func SetCtxGrpcMethod

func SetCtxGrpcMethod(ctx context.Context, method string) context.Context

SetCtxGrpcMethod will set the gRPC context value for the proper key responsible for an RPC full method name. This directly corresponds to the gRPC function responsible for extracting the method: https://godoc.org/google.golang.org/grpc#Method

func TempDir

func TempDir(t *testing.T, prefix string) (string, func() error)

TempDir is a wrapper around ioutil.TempDir that provides a cleanup function. The returned temp directory will be created in the directory specified by environment variable TEST_TEMP_DIR_PATH. If that variable is unset, the relative folder "./testdata/tmp" to this source file will be used.

func TestRepository

func TestRepository() *gitalypb.Repository

TestRepository returns the `Repository` object for the gitlab-test repo. Tests should be calling this function instead of cloning the repo themselves. Tests that involve modifications to the repo should copy/clone the repo via the `Repository` returned from this function.

Types

type Cleanup

type Cleanup func()

Cleanup functions should be called in a defer statement immediately after they are returned from a test helper

type ConfigFile

type ConfigFile map[string][]string

ConfigFile allows access to the different sections of a git config file

func ParseConfig

func ParseConfig(src io.Reader) (ConfigFile, error)

ParseConfig will attempt to parse a config file into sections

func (ConfigFile) GetValue

func (cf ConfigFile) GetValue(section, key string) (string, bool)

GetValue will return the value for a configuration line int the specified section for the provided key

type CreateCommitOpts

type CreateCommitOpts struct {
	Message  string
	ParentID string
}

CreateCommitOpts holds extra options for CreateCommit.

type CreateTagOpts

type CreateTagOpts struct {
	Message string
	Force   bool
}

CreateTagOpts holds extra options for CreateTag.