compiler

Documentation

Overview

Package compiler helps efficiently compile and cleanup your services in acceptance tests.

This is a small wrapper around the general releases/compiler. The binary created from this package will always be stored in a temporary folder.

To instrument a binary with coverage, the main entry point package must include a TestRunMain func (or similar )in a test file as per the example in internal/cmd/main_test.go. The work added to the compiler must set the WithCoverage flag to true.

For the resultant binary to produce a coverage report it needs to be called with these parameters: "-test.run", "^TestRunMain$", "-test.coverprofile", "your_coverage_name.out" and the service needs to be able to exit cleanly to flush the report. The helper function in testing/runner can make this easier.

Index

• type Parallel
  • func NewParallel(parallelism int) *Parallel
  • func (t *Parallel) Add(work Work)
  • func (t *Parallel) Cleanup()
  • func (t *Parallel) Dir() string
  • func (t *Parallel) Run(ctx context.Context) error
• type Work

Types

type Parallel

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

func NewParallel

func NewParallel(parallelism int) *Parallel

func (*Parallel) Add

func (t *Parallel) Add(work Work)

func (*Parallel) Cleanup

func (t *Parallel) Cleanup()

func (*Parallel) Dir

func (t *Parallel) Dir() string

func (*Parallel) Run

func (t *Parallel) Run(ctx context.Context) error

type Work

type Work = compiler.Work