courier

README

courier

courier is a E2E testing framework for gRPC Under Development

Documentation

Index

• func InvokeService(config *Config) (func() error, error)
• func InvokeSimpleService(config *SimpleConfig) (func() error, error)
• type Config
• type SimpleConfig

Functions

func InvokeService

func InvokeService(config *Config) (func() error, error)

func InvokeSimpleService

func InvokeSimpleService(config *SimpleConfig) (func() error, error)

Types

type Config

type Config struct {
	MakeDir           string
	MakeBuildTarget   string
	ServiceBinaryPath string
	ServiceName       string
	GRPCPort          int
	Envs              []string
	Verbose           bool
	CoverageDir       string

	// ServiceReadyProbe is a customer function which probes the service
	// until the service is ready.
	ServiceReadyProbe func(*Config)
}

Config defines make-based configuration.

type SimpleConfig

type SimpleConfig struct {
	// Directory to change.
	Chdir string
	// Command to invoke service.
	ServiceCmd string
	// Args to pass when invoking the service.
	ServiceArgs []string
	// Environments variables
	Envs []string
	// Redirect the output from the service to standard out/err.
	Verbose bool
	// Function to probe if the service is ready.
	// This function must retry probing until the service is ready.
	ReadyProbe func()
}

SimpleConfig provides a simple configuration without any steps to build service binary.