types

Documentation

Index

• Variables
• type Participant
  • func (obj *Participant) Validate() error
• type ParticipantToken
  • func ParseParticipantToken(token string) (*ParticipantToken, error)
  • func (t *ParticipantToken) String() string
• type Permission
• type TestPlan
  • func (obj *TestPlan) Validate() error
• type TestRunState
  • func WorseState(a TestRunState, b TestRunState) TestRunState
• type TestRunStatus
  • func (obj *TestRunStatus) Validate() error
• type Testcase
  • func (obj *Testcase) Validate() error
• type TestcaseRunResult
  • func (obj *TestcaseRunResult) Validate() error
• type TestcaseStatus
  • func (obj *TestcaseStatus) Validate() error

Variables

var AllPermissions = []Permission{
	PermissionNone,
	PermissionUserAdd,
	PermissionUserDelete,
	PermissionUserGrant,
	PermissionUserChpwd,
	PermissionUserList,
	PermissionSessionStart,
	PermissionSessionClose,
	PermissionSessionView,
	PermissionSessionContribute,
}

Types

type Participant

type Participant struct {
	Name string
}

func (*Participant) Validate

func (obj *Participant) Validate() error

type ParticipantToken

type ParticipantToken struct {
	SessionID     string
	ParticipantID string
}

func ParseParticipantToken

func ParseParticipantToken(token string) (*ParticipantToken, error)

func (*ParticipantToken) String

func (t *ParticipantToken) String() string

type Permission

type Permission string

const (
	PermissionNone              Permission = "none"
	PermissionUserAdd           Permission = "user.add"
	PermissionUserDelete        Permission = "user.delete"
	PermissionUserGrant         Permission = "user.grant"
	PermissionUserChpwd         Permission = "user.chpwd"
	PermissionUserList          Permission = "user.list"
	PermissionSessionStart      Permission = "session.start"
	PermissionSessionClose      Permission = "session.close"
	PermissionSessionView       Permission = "session.view"
	PermissionSessionContribute Permission = "session.contribute"
)

type TestPlan

type TestPlan struct {
	// ID is the globally unique ID of this testplan
	ID string
	// Name is the short description of the testplan
	Name string
	// Description is a long description
	Description string
	// Case lists the testcases of this plan
	Case []Testcase
}

func (*TestPlan) Validate

func (obj *TestPlan) Validate() error

type TestRunState

type TestRunState string

const (
	Passed    TestRunState = "passed"
	Undecided TestRunState = "undecided"
	Failed    TestRunState = "Failed"
)

func WorseState

func WorseState(a TestRunState, b TestRunState) TestRunState

type TestRunStatus

type TestRunStatus struct {
	// ID is the globally unique ID of this test run
	ID string
	// Name is a short description of this run
	Name string
	// Plan ID is the ID of the testplan being executed
	PlanID string
	// Status lists the status for each testcase of the plan
	Status []TestcaseStatus
	// State is the overall test run state
	State TestRunState
}

func (*TestRunStatus) Validate

func (obj *TestRunStatus) Validate() error

type Testcase

type Testcase struct {
	// ID of the testcase. Must be unique within the test suite.
	ID string
	// Name is the short description of the testcase
	Name string
	// Groups helps organize testcases
	Group string
	// Description is a long description
	Description string
	// Steps lists the individual steps a tester should perform
	Steps string
	// If true this testcase must pass for the suite to pass
	MustPass bool
	// MinTesterCount is the number of participants who need to run this test
	MinTesterCount uint32
}

func (*Testcase) Validate

func (obj *Testcase) Validate() error

type TestcaseRunResult

type TestcaseRunResult struct {
	// Participant who contributed this result
	Participant Participant
	// State denotes the success of a testcase
	State TestRunState
	// Comment is free text entered by the participant
	Comment string
}

func (*TestcaseRunResult) Validate

func (obj *TestcaseRunResult) Validate() error

type TestcaseStatus

type TestcaseStatus struct {
	// The testcase this run concerns
	Case Testcase
	// Claims mark testers who want to run a testcase
	Claim []Participant
	// Runs are completed testcase executions
	Result []TestcaseRunResult
	// State is the overall testcase success state
	State TestRunState
}

func (*TestcaseStatus) Validate

func (obj *TestcaseStatus) Validate() error