pit

README

pit

WIP: This is very much still a work in progress, it will probably break.

pit is a smartish wrapper around go test. It's end goal will be to only run tests for those files/packages that have changed, and the packages that depend on the changed files/packages.

pit in its current state will run all tests in a package via go test -v -cover only if there are changed files.

pit was just easy to type, but the current working backronym for pit is private investigator for tests

License

MIT

Documentation

Overview

Package pit ...

Index

• type Failure
  • func (f *Failure) String() string
• type Package
  • func FindPackages(wd string) ([]*Package, error)
  • func (p *Package) Repository() (*git.Repository, error)
  • func (p *Package) RunTests(config *TestConfig) (*PackageTestResult, error)
• type PackageTest
• type PackageTestResult
• type TestConfig

Types

type Failure

type Failure struct {
	File    string `json:"filename"`
	Row     int    `json:"row"`
	Column  int    `json:"column"`
	Message string `json:"message"`
}

func (*Failure) String

func (f *Failure) String() string

type Package

type Package struct {
	Name        string
	Dir         string
	ImportPath  string
	SourceFiles []string
	TestFiles   []string
	// contains filtered or unexported fields
}

func FindPackages

func FindPackages(wd string) ([]*Package, error)

FindPackages returns a slice of Packages found in the passed directory.

func (*Package) Repository

func (p *Package) Repository() (*git.Repository, error)

Repository returns the git repository for the package

func (*Package) RunTests

func (p *Package) RunTests(config *TestConfig) (*PackageTestResult, error)

RunTests runs the packages test suite, checking if the package has tests and whether any files have been changed

type PackageTest

type PackageTest struct {
	Name     string        `json:"name"`
	Status   string        `json:"status"`
	Duration time.Duration `json:"duration"`
	Output   []string      `json:"ouput"`
}

type PackageTestResult

type PackageTestResult struct {
	Name     string         `json:"name"`
	Status   string         `json:"status"`
	Duration time.Duration  `json:"duration"`
	Coverage float32        `json:"coverage"`
	Summary  string         `json:"summary"`
	Tests    []*PackageTest `json:"tests"`
	Errors   []*Failure     `json:"errors"`
}

type TestConfig

type TestConfig struct {
	RunAll     bool
	CommitHash string
	Args       []string
}

TestConfig defines how a packages tests will be run