testcfg

Documentation

Index

• Constants
• func Build(tb testing.TB, opts ...Option) config.Cfg
• func BuildBinary(tb testing.TB, targetDir, sourcePath string) string
• func BuildGitaly(tb testing.TB, cfg config.Cfg) string
• func BuildGitalyGit2Go(tb testing.TB, cfg config.Cfg) string
• func BuildGitalyHooks(tb testing.TB, cfg config.Cfg) string
• func BuildGitalyLFSSmudge(tb testing.TB, cfg config.Cfg) string
• func BuildGitalySSH(tb testing.TB, cfg config.Cfg) string
• func BuildGitalyWrapper(tb testing.TB, cfg config.Cfg) string
• func BuildPraefect(tb testing.TB, cfg config.Cfg) string
• func BuildWithRepo(tb testing.TB, opts ...Option) (config.Cfg, *gitalypb.Repository, string)
• func GitalyServersMetadataFromCfg(tb testing.TB, cfg config.Cfg) metadata.MD
• type GitalyCfgBuilder
  • func NewGitalyCfgBuilder(opts ...Option) GitalyCfgBuilder
  • func (gc *GitalyCfgBuilder) Build(tb testing.TB) config.Cfg
  • func (gc *GitalyCfgBuilder) BuildWithRepoAt(tb testing.TB, relativePath string) (config.Cfg, []*gitalypb.Repository)
• type Option
  • func WithBase(cfg config.Cfg) Option
  • func WithPackObjectsCacheEnabled() Option
  • func WithStorages(name string, names ...string) Option

Constants

const UnconfiguredSocketPath = "it is a stub to bypass Validate method"

UnconfiguredSocketPath is used to bypass config validation errors when building the configuration. The socket path is now known yet at the time of building the configuration and is substituted later when the service is actually spun up.

Functions

func Build

func Build(tb testing.TB, opts ...Option) config.Cfg

Build creates a minimal configuration setup with no options and returns it with cleanup function.

func BuildBinary

func BuildBinary(tb testing.TB, targetDir, sourcePath string) string

BuildBinary builds a Go binary once and copies it into the target directory. The source path can either be a ".go" file or a directory containing Go files. Returns the path to the executable in the destination directory.

func BuildGitaly

func BuildGitaly(tb testing.TB, cfg config.Cfg) string

BuildGitaly builds the gitaly binary and installs it into the binary directory. The gitaly binary embeds other binaries it needs to use when servicing requests. The packed binaries are not built prior to building this gitaly binary and thus cannot be guaranteed to be from the same build.

func BuildGitalyGit2Go

func BuildGitalyGit2Go(tb testing.TB, cfg config.Cfg) string

BuildGitalyGit2Go builds the gitaly-git2go command and installs it into the binary directory.

func BuildGitalyHooks

func BuildGitalyHooks(tb testing.TB, cfg config.Cfg) string

BuildGitalyHooks builds the gitaly-hooks command and installs it into the binary directory.

func BuildGitalyLFSSmudge

func BuildGitalyLFSSmudge(tb testing.TB, cfg config.Cfg) string

BuildGitalyLFSSmudge builds the gitaly-lfs-smudge command and installs it into the binary directory.

func BuildGitalySSH

func BuildGitalySSH(tb testing.TB, cfg config.Cfg) string

BuildGitalySSH builds the gitaly-ssh command and installs it into the binary directory.

func BuildGitalyWrapper

func BuildGitalyWrapper(tb testing.TB, cfg config.Cfg) string

BuildGitalyWrapper builds the gitaly-wrapper command and installs it into the binary directory.

func BuildPraefect

func BuildPraefect(tb testing.TB, cfg config.Cfg) string

BuildPraefect builds the praefect command and installs it into the binary directory.

func BuildWithRepo

func BuildWithRepo(tb testing.TB, opts ...Option) (config.Cfg, *gitalypb.Repository, string)

BuildWithRepo creates a minimal configuration setup with no options. It also clones test repository at the storage and returns it with the full path to the repository.

func GitalyServersMetadataFromCfg

func GitalyServersMetadataFromCfg(tb testing.TB, cfg config.Cfg) metadata.MD

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

Types

type GitalyCfgBuilder

type GitalyCfgBuilder struct {
	// contains filtered or unexported fields
}

GitalyCfgBuilder automates creation of the gitaly configuration and filesystem structure required.

func NewGitalyCfgBuilder

func NewGitalyCfgBuilder(opts ...Option) GitalyCfgBuilder

NewGitalyCfgBuilder returns gitaly configuration builder with configured set of options.

func (*GitalyCfgBuilder) Build

func (gc *GitalyCfgBuilder) Build(tb testing.TB) config.Cfg

Build setups required filesystem structure, creates and returns configuration of the gitaly service.

func (*GitalyCfgBuilder) BuildWithRepoAt

func (gc *GitalyCfgBuilder) BuildWithRepoAt(tb testing.TB, relativePath string) (config.Cfg, []*gitalypb.Repository)

BuildWithRepoAt setups required filesystem structure, creates and returns configuration of the gitaly service, clones test repository into each configured storage the provided relative path.

type Option

type Option func(*GitalyCfgBuilder)

Option is a configuration option for the builder.

func WithBase

func WithBase(cfg config.Cfg) Option

WithBase allows use cfg as a template for start building on top of. override parameter signals if settings of the cfg can be overridden or not (if setting has a default value it is considered "not configured" and can be set despite flag value).

func WithPackObjectsCacheEnabled

func WithPackObjectsCacheEnabled() Option

WithPackObjectsCacheEnabled enables the pack object cache.

func WithStorages

func WithStorages(name string, names ...string) Option

WithStorages allows to configure list of storages under this gitaly instance. All storages will have a test repository by default.