test_explorer

type BaseRequest struct {
	Name string `json:"name"`
	File string `json:"file"`
}

type CallRecord struct {
	Pkg        string        `json:"pkg"`
	Func       string        `json:"func"`
	File       string        `json:"file"`
	Line       int           `json:"line"`  // 1-based
	Start      int64         `json:"start"` // relative to request begin, as nanoseconds
	End        int64         `json:"end"`
	Args       interface{}   `json:"args"`
	MockStatus MockStatus    `json:"mockStatus"`
	Error      string        `json:"error"`  // has error, may be empty
	Panic      bool          `json:"panic"`  // has panic
	Result     interface{}   `json:"result"` // keyed by name, if no name, a slice
	Log        interface{}   `json:"log"`    // log set within request
	Children   []*CallRecord `json:"children"`
}

type CoverageConfig struct {
	Disabled bool     `json:"disabled"`
	DiffWith string   `json:"diff_with"`
	Profile  string   `json:"profile"`
	Include  []string `json:"include"`
	Exclude  []string `json:"exclude"`
}

type DebugDestroyRequest struct {
	ID string `json:"id"`
}

type DebugPollRequest struct {
	ID string `json:"id"`
}

type DebugPollResponse struct {
	Events []*TestingItemEvent `json:"events"`
}

type DebugRequest struct {
	Item *TestingItem `json:"item"`
	Path []string     `json:"path"`
}

type DebugResponse struct {
	ID string `json:"id"`
}

type DestroySessionRequest struct {
	ID string `json:"id"`
}

type DetailRequest struct {
	*BaseRequest
	Line int `json:"line"`
}

type DetailResponse struct {
	Content string `json:"content"`
}

type Event string

type GoConfig struct {
	Min string `json:"min"`
	Max string `json:"max"`
}

type HideType string

type MockStatus string

type Options struct {
	// by default go
	DefaultGoCommand string
	GoCommand        string
	ProjectDir       string
	Exclude          []string
	Flags            []string
	Args             []string

	// can be true,false
	Coverage string
	// --coverage-profile string
	CoverageProfile  string
	CoverageDiffWith string

	Config string
	Port   string
	Bind   string

	LogConsole bool

	Verbose bool
}

type PollSessionRequest struct {
	ID string `json:"id"`
}

type PollSessionResult struct {
	Events []*TestingItemEvent `json:"events"`
}

type RootRecord struct {
	Start time.Time // the absolute begin time
	Root  *CallRecord
}

type RunContext struct {
	ProjectDir    string
	AbsProjectDir string
	File          string
	RelPath       string
	Name          string
	Stdout        io.Writer
	Stderr        io.Writer

	GoCmd      string
	BuildFlags []string

	Env  []string
	Args []string
}

type RunRequest struct {
	*BaseRequest
	Path    []string `json:"path"`
	Verbose bool     `json:"verbose"`
}

type RunResult struct {
	Status RunStatus `json:"status"`
	Msg    string    `json:"msg"`
}

type RunStatus string

type StartSessionRequest struct {
	Item  *TestingItem `json:"item"`
	Path  []string     `json:"path"`
	Debug bool         `json:"debug"`
	Trace bool         `json:"trace"`
}

type StartSessionResult struct {
	ID string `json:"id"`
}

type TestConfig struct {
	Go      *GoConfig              `json:"go"`
	GoCmd   string                 `json:"go_cmd"`
	Exclude []string               `json:"exclude"`
	Env     map[string]interface{} `json:"env"`

	// test flags passed to go test
	// common usages:
	//   -p=12            parallel programs
	//   -parallel=12     parallel test cases within the same test
	// according to our test, -p is more useful than -parallel
	Flags []string `json:"flags"`
	Args  []string `json:"args"`

	BypassGoFlags bool `json:"bypass_go_flags"`

	MockRules []string        `json:"mock_rules"`
	Xgo       *XgoConfig      `json:"xgo,omitempty"`
	Coverage  *CoverageConfig `json:"coverage,omitempty"`
}

type TestEvent struct {
	Time    time.Time // encodes as an RFC3339-format string
	Action  TestEventAction
	Package string
	Test    string
	Elapsed float64 // seconds
	Output  string
}

type TestEventAction string

type TestingItem struct {
	Key string `json:"key"`
	// base name, e.g.: subcase if full name is TestSomething/subcase
	Name string `json:"name"`
	// base case name, e.g.:  TestSomething
	BaseCaseName string `json:"baseCaseName"` // the base case's name
	// full name, e.g.: TestSomething/subcase
	NameUnderPkg string          `json:"nameUnderPkg"` // the name under pkg
	RelPath      string          `json:"relPath"`
	File         string          `json:"file"`
	Line         int             `json:"line"`
	Kind         TestingItemKind `json:"kind"`
	Error        string          `json:"error"`

	// only if Kind==dir
	// indicating any file ends with _test.go
	// go only
	HasTestGoFiles bool `json:"hasTestGoFiles"`

	// valid for Kind==dir,file
	// indicating any cases belongs to this item
	// go only
	HasTestCases bool              `json:"hasTestCases"`
	State        *TestingItemState `json:"state"`

	Children []*TestingItem `json:"children"`
}

type TestingItemEvent struct {
	Event        Event         `json:"event"`
	Item         *TestingItem  `json:"item"`
	Path         []string      `json:"path"`
	Status       RunStatus     `json:"status"`
	Msg          string        `json:"msg"`
	LogConsole   bool          `json:"logConsole"`
	TraceRecords []*CallRecord `json:"traceRecords"`
}

type TestingItemKind string

type TestingItemState struct {
	Selected  bool      `json:"selected"`
	Expanded  bool      `json:"expanded"`
	Status    RunStatus `json:"status"`
	Debugging bool      `json:"debugging"`
	Logs      string    `json:"logs"`
	HideType  HideType  `json:"hideType"`
}

type XgoConfig struct {
	AutoUpdate bool `json:"auto_update"`
}