config

Documentation

Index

• func FLags() []cli.Flag
• type Config
  • func Load(ctx *cli.Context) (*Config, error)
  • func (c *Config) GetOutDir() string
  • func (c *Config) GetTestDirName() string
  • func (c *Config) ResolvePackageConflict()
• type Info
  • func OutputInfo(cfg *Config, testPath string) (*Info, error)
  • func (i *Info) Desc(n string) string
  • func (i *Info) FormatName(n string) string

Functions

func FLags

func FLags() []cli.Flag

FLags returns configuration flags.

Types

type Config

type Config struct {
	// Information about the package.
	Info *build.Package

	// URL where the test runner service is running.
	ServerURL string

	// This is absolute path to the root of the package being tested,
	Root string

	// The directory where test files stay.
	TestDirName string

	// Absolute path to the directory containing the tests
	TestPath string

	// This the absolute path of processed test directory.
	GeneratedTestPath string

	// This is import path for the processed test package
	// example   github.com/gernest/mad/madness/tests
	GeneratedTestPkg string

	// This is the name of the directory in which generated test files are saved.
	// Default is madness.
	OutputDirName string

	// Absolute path to the directory in which generated test files are save.
	OutputPath string

	// Import path pointing to the main package that will be compiled by gopherjs
	// example github.com/gernest/mad/madness
	OutputMainPkg string

	// WHen true it will compile the generated test packages with gopherjs The
	// default value is true.
	Build bool

	// This is a uuid v4 string which is generated for every test run. It is used
	// internally to collect test results through websocket.
	UUID string

	TestNames map[*Info]*tools.TestNames

	// Port is the port on which to run the websocket server.
	Port int

	// if true tells the runner to generate coverage profile.
	Cover bool

	// the name of the file containing the generated coverage profile.
	Coverfile string

	// UnitIndexPage this is the url to the index.html page of the generated unit
	// test package.
	UnitIndexPage string

	// This is the list of urls of index.html pages of the generated integration
	// unit test.
	IntegrationIndexPages []string

	// When true, this will output a lot of text to stdout. Also it will print
	// console output from the test package.
	Verbose bool

	// Time to wait before stoping tests execution.
	Timeout time.Duration

	DevtoolURL  string
	DevtoolPort int

	Covermode string

	// If true this will only generate the packages and print out whet the test
	// runner will do without building or executing the tests.
	Dry bool

	TestInfo []*Info

	ImportMap map[string]string

	Browsers []string

	JSON string

	//Run is the regular expression used to filter test function to run.
	Run *regexp.Regexp
}

Config contains configuration testails about the test running environment.

func Load

func Load(ctx *cli.Context) (*Config, error)

Load returns *Config instance with values populated from ctx.

func (*Config) GetOutDir

func (c *Config) GetOutDir() string

GetOutDir returns absolute path to the directory where generated output stays.

func (*Config) GetTestDirName

func (c *Config) GetTestDirName() string

GetTestDirName returns absolute path where the tests are.

func (*Config) ResolvePackageConflict

func (c *Config) ResolvePackageConflict()

type Info

type Info struct {

	// This is the absolute path to the generated package.
	OutputPath string

	// Relative path to the root of generated directory. So for instance if the
	// generation directory is /madness, and the package was generated to
	// /madness/tests/pkg
	// then RelativePath value will be tests/pkg.
	RelativePath string

	Package *build.Package

	//This is an alterative import path when there is name conflict.
	FixImport  string
	ImportPath string
}

Info contains information about a generated test package.

func OutputInfo

func OutputInfo(cfg *Config, testPath string) (*Info, error)

func (*Info) Desc

func (i *Info) Desc(n string) string

func (*Info) FormatName

func (i *Info) FormatName(n string) string