test_explorer

Documentation

Index

• Constants
• func Main(args []string, opts *Options) error
• type BaseRequest
• type DebugDestroyRequest
• type DebugPollRequest
• type DebugPollResponse
• type DebugRequest
• type DebugResponse
• type DestroySessionRequest
• type DetailRequest
• type DetailResponse
• type Event
• type GoConfig
• type HideType
• type Options
• type PollSessionRequest
• type PollSessionResult
• type RunContext
• type RunRequest
• type RunResult
• type RunStatus
• type StartSessionRequest
• type StartSessionResult
• type TestConfig
  • func (c *TestConfig) CmdEnv() []string
  • func (c *TestConfig) GetGoCmd() string
• type TestEvent
• type TestEventAction
• type TestingItem
  • func (c *TestingItem) CloneSelf() *TestingItem
• type TestingItemEvent
• type TestingItemKind
  • func (c TestingItemKind) Order() int
• type TestingItemState
  • func (c *TestingItemState) Clone() *TestingItemState

Constants

const (
	TestingItemKind_Dir  = "dir"
	TestingItemKind_File = "file"
	TestingItemKind_Case = "case"
)

Functions

func Main

func Main(args []string, opts *Options) error

Types

type BaseRequest

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

type DebugDestroyRequest

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

type DebugPollRequest

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

type DebugPollResponse

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

type DebugRequest

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

type DebugResponse

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

type DestroySessionRequest

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

type DetailRequest

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

type DetailResponse

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

type Event

type Event string

const (
	Event_ItemStatus Event = "item_status"
	Event_MergeTree  Event = "merge_tree"
	Event_Output     Event = "output"
	Event_ErrorMsg   Event = "error_msg"
	Event_TestStart  Event = "test_start"
	Event_TestEnd    Event = "test_end"
)

type GoConfig

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

type HideType

type HideType string

const (
	HideType_None     HideType = ""
	HideType_All      HideType = "all"
	HideType_Children HideType = "children"
)

type Options

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

	Config string
	Port   string
	Bind   string

	LogConsole bool
}

type PollSessionRequest

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

type PollSessionResult

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

type RunContext

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

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

type RunResult

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

type RunStatus

type RunStatus string

const (
	RunStatus_NotRun  RunStatus = "not_run"
	RunStatus_Success RunStatus = "success"
	RunStatus_Fail    RunStatus = "fail"
	RunStatus_Error   RunStatus = "error"
	RunStatus_Running RunStatus = "running"
	RunStatus_Skip    RunStatus = "skip"
)

type StartSessionRequest

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

type StartSessionResult

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

type TestConfig

type TestConfig struct {
	Go      *GoConfig
	GoCmd   string
	Exclude []string
	Env     map[string]interface{}

	// 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
}

func (*TestConfig) CmdEnv

func (c *TestConfig) CmdEnv() []string

func (*TestConfig) GetGoCmd

func (c *TestConfig) GetGoCmd() string

type TestEvent

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

from go/cmd/test2json

type TestEventAction

type TestEventAction string

see https://pkg.go.dev/cmd/test2json#hdr-Output_Format

const (
	TestEventAction_Start  TestEventAction = "start"
	TestEventAction_Run    TestEventAction = "run"
	TestEventAction_Pass   TestEventAction = "pass"
	TestEventAction_Pause  TestEventAction = "pause"
	TestEventAction_Cont   TestEventAction = "cont"
	TestEventAction_Bench  TestEventAction = "bench"
	TestEventAction_Output TestEventAction = "output"
	TestEventAction_Fail   TestEventAction = "fail"
	TestEventAction_Skip   TestEventAction = "skip"
)

type TestingItem

type TestingItem struct {
	Key          string          `json:"key"`
	Name         string          `json:"name"`
	BaseCaseName string          `json:"baseCaseName"` // the base case's name
	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"`
}

func (*TestingItem) CloneSelf

func (c *TestingItem) CloneSelf() *TestingItem

clone excluding children

type TestingItemEvent

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"`
}

type TestingItemKind

type TestingItemKind string

func (TestingItemKind) Order

func (c TestingItemKind) Order() int

type TestingItemState

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"`
}

func (*TestingItemState) Clone

func (c *TestingItemState) Clone() *TestingItemState