testrun

Documentation

Index

• type List
  • func Unmarshal(input io.Reader) (List, error)
• type NfrResult
  • func (nfr *NfrResult) ExpectationWithUnit() string
  • func (nfr *NfrResult) SubjectWithUnit() string
• type NfrResultList
  • func UnmarshalNfrResults(input io.Reader) (NfrResultList, error)
• type TestRun
  • func UnmarshalSingle(input io.Reader) (TestRun, error)

Types

type List

type List struct {
	TestRuns []*TestRun
}

List is a list of TestRuns, used for index action

func Unmarshal

func Unmarshal(input io.Reader) (List, error)

Unmarshal unmarshals a list of TestRun records

type NfrResult

type NfrResult struct {
	ID          string `jsonapi:"primary,nfr_results"`
	Success     bool   `jsonapi:"attr,success"`
	Subject     string `jsonapi:"attr,subject"`
	SubjectUnit string `jsonapi:"attr,subject_unit"`
	Expectation string `jsonapi:"attr,expectation"`
	Type        string `jsonapi:"attr,nfr_type"`
	Disabled    bool   `jsonapi:"attr,disabled"`
	Filter      string `jsonapi:"attr,filter"`
	Metric      string `jsonapi:"attr,metric"`
}

NfrResult describes a NFR check result

func (*NfrResult) ExpectationWithUnit

func (nfr *NfrResult) ExpectationWithUnit() string

ExpectationWithUnit formats the expectation inclusing the subject's unit

func (*NfrResult) SubjectWithUnit

func (nfr *NfrResult) SubjectWithUnit() string

SubjectWithUnit formats the expectation inclusing the subject's unit

type NfrResultList

type NfrResultList struct {
	NfrResults []*NfrResult
}

NfrResultList is a list of NFR results

func UnmarshalNfrResults

func UnmarshalNfrResults(input io.Reader) (NfrResultList, error)

UnmarshalNfrResults unmarshals a list of NFR result records

type TestRun

type TestRun struct {
	ID        string `jsonapi:"primary,test_runs"`
	Scope     string `jsonapi:"attr,scope"`
	Title     string `jsonapi:"attr,title,omitempty"`
	Notes     string `jsonapi:"attr,notes,omitempty"`
	State     string `jsonapi:"attr,state,omitempty"`
	StartedBy string `jsonapi:"attr,started_by,omitempty"`
	StartedAt string `jsonapi:"attr,started_at,omitempty"`
	EndedAt   string `jsonapi:"attr,ended_at,omitempty"`

	// attributes for in progress
	EstimatedEnd string `jsonapi:"attr,estimated_end,omitempty"`
	Progress     int    `jsonapi:"attr,progress,omitempty"`
}

TestRun represents a single TestRun

func UnmarshalSingle

func UnmarshalSingle(input io.Reader) (TestRun, error)

UnmarshalSingle unmarshals a single TestRun records