package thirdparty

import "github.com/mmcloughlin/avo/tests/thirdparty"

Package thirdparty executes integration tests based on third-party packages that use avo.

Index ¶

• type Context
• type GithubRepository
• func (r GithubRepository) CloneURL() string
• func (r GithubRepository) String() string
• type Package
• func (p *Package) ID() string
• func (p *Package) Steps(c *Context) []*Step
• func (p *Package) Validate() error
• type Packages
• func LoadPackages(r io.Reader) (Packages, error)
• func LoadPackagesFile(filename string) (Packages, error)
• func (p Packages) Validate() error
• type Step
• func (s *Step) Validate() error

Types ¶

type Context ¶

type Context struct {
	// Path to the avo version under test.
	AvoDirectory string

	// Path to the checked out third-party repository.
	RepositoryDirectory string
}

Context specifies execution environment parameters for a third-party test.

type GithubRepository ¶

type GithubRepository struct {
	Owner string `json:"owner"`
	Name  string `json:"name"`
}

GithubRepository specifies a repository on github.

func (GithubRepository) CloneURL ¶

func (r GithubRepository) CloneURL() string

CloneURL returns the git clone URL.

func (GithubRepository) String ¶

func (r GithubRepository) String() string

type Package ¶

type Package struct {
	// Repository the package belongs to. At the moment, all packages are
	// available on github.
	Repository GithubRepository `json:"repository"`

	// Version as a git sha, tag or branch.
	Version string `json:"version"`

	// Sub-package within the repository under test. All file path references
	// will be relative to this directory. If empty the root of the repository
	// is used.
	SubPackage string `json:"pkg"`

	// Path to the module file for the avo generator package. This is necessary
	// so the integration test can insert replace directives to point at the avo
	// version under test.
	Module string `json:"module"`

	// Setup steps. These run prior to the insertion of avo replace directives,
	// therefore should be used if it's necessary to initialize new go modules
	// within the repository.
	Setup []*Step `json:"setup"`

	// Steps to run the avo code generator.
	Generate []*Step `json:"generate"` // generate commands to run

	// Test steps. If empty, defaults to "go test ./...".
	Test []*Step `json:"test"`
}

Package defines an integration test based on a third-party package using avo.

func (*Package) ID ¶

func (p *Package) ID() string

ID returns an identifier for the package.

func (*Package) Steps ¶

func (p *Package) Steps(c *Context) []*Step

Steps generates the list of steps required to execute the integration test for this package. Context specifies execution environment parameters.

func (*Package) Validate ¶

func (p *Package) Validate() error

Validate package definition.

type Packages ¶

type Packages []*Package

Packages is a collection of third-party integration tests.

func LoadPackages ¶

func LoadPackages(r io.Reader) (Packages, error)

LoadPackages loads a list of package configurations from JSON format.

func LoadPackagesFile ¶

func LoadPackagesFile(filename string) (Packages, error)

LoadPackagesFile loads a list of package configurations from a JSON file.

func (Packages) Validate ¶

func (p Packages) Validate() error

Validate the package collection.

type Step ¶

type Step struct {
	Name             string   `json:"name"`
	WorkingDirectory string   `json:"dir"`
	Commands         []string `json:"commands"`
}

Step represents a set of commands to run as part of the testing plan for a third-party package.

func (*Step) Validate ¶

func (s *Step) Validate() error

Validate step parameters.

Source Files ¶

config.go