testhelper

Documentation

Index

• Constants
• func AssertGrpcError(t *testing.T, err error, expectedCode codes.Code, containsText string)
• func AuthorsEqual(a *pb.CommitAuthor, b *pb.CommitAuthor) bool
• func ConfigureRuby()
• func ConfigureTestStorage()
• func Context() (context.Context, func())
• func FindLocalBranchCommitAuthorsEqual(a *pb.FindLocalBranchCommitAuthor, b *pb.FindLocalBranchCommitAuthor) bool
• func FindLocalBranchResponsesEqual(a *pb.FindLocalBranchResponse, b *pb.FindLocalBranchResponse) bool
• func GetTemporaryGitalySocketFileName() string
• func GitCommitEqual(a, b *pb.GitCommit) error
• func GitalyServersMetadata(t *testing.T, serverSocketPath string) metadata.MD
• func GitlabTestStoragePath() string
• func MustHaveNoChildProcess()
• func MustReadFile(t *testing.T, filename string) []byte
• func MustRunCommand(t *testing.T, stdin io.Reader, name string, args ...string) []byte
• func NewTestGrpcServer(t *testing.T, streamInterceptors []grpc.StreamServerInterceptor, ...) *grpc.Server
• func NewTestLogger(t *testing.T) *log.Logger
• func NewTestRepo(t *testing.T) (repo *pb.Repository, repoPath string, cleanup func())
• func NewTestRepoWithWorktree(t *testing.T) (repo *pb.Repository, repoPath string, cleanup func())
• func TestRepository() *pb.Repository

Constants

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

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

Functions

func AssertGrpcError

func AssertGrpcError(t *testing.T, err error, expectedCode codes.Code, containsText string)

AssertGrpcError asserts the passed err is of the same code as expectedCode. Optionally, it can assert the error contains the text of containsText if the latter is not an empty string.

func AuthorsEqual

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

AuthorsEqual tests if two `CommitAuthor`s are equal

func ConfigureRuby

func ConfigureRuby()

ConfigureRuby configures Ruby settings for test purposes at run time.

func ConfigureTestStorage

func ConfigureTestStorage()

ConfigureTestStorage adds a storage entry to Config pointing to the path of the gitlab-test repo.

func Context

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

Context returns a cancellable context.

func FindLocalBranchCommitAuthorsEqual

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

FindLocalBranchCommitAuthorsEqual tests if two `FindLocalBranchCommitAuthor`s are equal

func FindLocalBranchResponsesEqual

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

FindLocalBranchResponsesEqual tests if two `FindLocalBranchResponse`s are equal

func GetTemporaryGitalySocketFileName

func GetTemporaryGitalySocketFileName() string

GetTemporaryGitalySocketFileName will return a unique, useable socket file name

func GitCommitEqual

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

GitCommitEqual tests if two `GitCommit`s are equal

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 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.T, 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(t *testing.T, streamInterceptors []grpc.StreamServerInterceptor, unaryInterceptors []grpc.UnaryServerInterceptor) *grpc.Server

NewTestGrpcServer creates a GRPC Server for testing purposes

func NewTestLogger

func NewTestLogger(t *testing.T) *log.Logger

NewTestLogger created a logrus hook which can be used with testing logs

func NewTestRepo

func NewTestRepo(t *testing.T) (repo *pb.Repository, repoPath string, cleanup func())

NewTestRepo creates a bare copy of the test repository.

func NewTestRepoWithWorktree

func NewTestRepoWithWorktree(t *testing.T) (repo *pb.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 TestRepository

func TestRepository() *pb.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.