v1

Documentation

Overview

Package v1 implements the v1 of the k6's REST API

Index

• func NewHandler(cs *ControlSurface) http.Handler
• type Check
  • func NewCheck(c *lib.Check) Check
• type ControlSurface
• type Error
  • func (e Error) Error() string
• type ErrorResponse
• type Group
  • func FlattenGroup(g *Group) []*Group
  • func NewGroup(g *lib.Group, parent *Group) *Group
  • func (g *Group) SetToManyReferenceIDs(name string, ids []string) error
  • func (g *Group) SetToOneReferenceID(name, id string) error
• type Metric
  • func NewMetric(m *metrics.Metric, t time.Duration) Metric
• type MetricsJSONAPI
  • func (m MetricsJSONAPI) Metrics() []Metric
• type NullMetricType
  • func (t NullMetricType) MarshalJSON() ([]byte, error)
  • func (t *NullMetricType) UnmarshalJSON(data []byte) error
• type NullSetupData
• type NullValueType
  • func (t NullValueType) MarshalJSON() ([]byte, error)
  • func (t *NullValueType) UnmarshalJSON(data []byte) error
• type SetupData
• type Status
• type StatusJSONAPI
  • func NewStatusJSONAPI(s Status) StatusJSONAPI
  • func (s StatusJSONAPI) Status() Status

Functions

func NewHandler

func NewHandler(cs *ControlSurface) http.Handler

NewHandler returns the top handler for the v1 REST APIs

Types

type Check

type Check struct {
	ID     string `json:"id" yaml:"id"`
	Path   string `json:"path" yaml:"path"`
	Name   string `json:"name" yaml:"name"`
	Passes int64  `json:"passes" yaml:"passes"`
	Fails  int64  `json:"fails" yaml:"fails"`
}

Check represents a k6's check in a k6 REST API

func NewCheck

func NewCheck(c *lib.Check) Check

NewCheck constructs a new v1.Check struct that is used for a check representation in a k6 REST API

type ControlSurface

type ControlSurface struct {
	RunCtx        context.Context
	Samples       chan metrics.SampleContainer
	MetricsEngine *engine.MetricsEngine
	Scheduler     *execution.Scheduler
	RunState      *lib.TestRunState
}

ControlSurface includes the methods the REST API can use to control and communicate with the rest of k6.

type Error

type Error struct {
	Status string `json:"status,omitempty"`
	Title  string `json:"title,omitempty"`
	Detail string `json:"detail,omitempty"`
}

Error is an api error

func (Error) Error

func (e Error) Error() string

type ErrorResponse

type ErrorResponse struct {
	Errors []Error `json:"errors"`
}

ErrorResponse is a struct wrapper around multiple errors

type Group

type Group struct {
	ID     string  `json:"-" yaml:"id"`
	Path   string  `json:"path" yaml:"path"`
	Name   string  `json:"name" yaml:"name"`
	Checks []Check `json:"checks" yaml:"checks"`

	Parent   *Group   `json:"-" yaml:"-"`
	ParentID string   `json:"-" yaml:"parent-id"`
	Groups   []*Group `json:"-" yaml:"-"`
	GroupIDs []string `json:"-" yaml:"group-ids"`
}

Group represents a k6's group in a k6 REST API

func FlattenGroup

func FlattenGroup(g *Group) []*Group

FlattenGroup flattens a group and all its subgroups into a slice of groups

func NewGroup

func NewGroup(g *lib.Group, parent *Group) *Group

NewGroup constructs a new v1.Group struct that is used for a group representation in a k6 REST API

func (*Group) SetToManyReferenceIDs

func (g *Group) SetToManyReferenceIDs(name string, ids []string) error

SetToManyReferenceIDs sets to-many relations (groups) for a group

func (*Group) SetToOneReferenceID

func (g *Group) SetToOneReferenceID(name, id string) error

SetToOneReferenceID sets to-one relation (parent) for a group

type Metric

type Metric struct {
	Name string `json:"-" yaml:"name"`

	Type     NullMetricType `json:"type" yaml:"type"`
	Contains NullValueType  `json:"contains" yaml:"contains"`
	Tainted  null.Bool      `json:"tainted" yaml:"tainted"`

	Sample map[string]float64 `json:"sample" yaml:"sample"`
}

Metric represents a metric that is being collected by k6.

func NewMetric

func NewMetric(m *metrics.Metric, t time.Duration) Metric

NewMetric constructs a new v1.Metric struct that is used for a metric representation in a k6 REST API

type MetricsJSONAPI

type MetricsJSONAPI struct {
	Data []metricData `json:"data"`
}

MetricsJSONAPI is JSON API envelop for metrics

func (MetricsJSONAPI) Metrics

func (m MetricsJSONAPI) Metrics() []Metric

Metrics extract the []v1.Metric from the JSON API envelop

type NullMetricType

type NullMetricType struct {
	Type  metrics.MetricType
	Valid bool
}

NullMetricType a nullable metric struct

func (NullMetricType) MarshalJSON

func (t NullMetricType) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (*NullMetricType) UnmarshalJSON

func (t *NullMetricType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface.

type NullSetupData

type NullSetupData struct {
	SetupData
	Data any `json:"data,omitempty" yaml:"data"`
}

NullSetupData is wrapper around null to satisfy jsonapi

type NullValueType

type NullValueType struct {
	Type  metrics.ValueType
	Valid bool
}

NullValueType a nullable metric value struct

func (NullValueType) MarshalJSON

func (t NullValueType) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (*NullValueType) UnmarshalJSON

func (t *NullValueType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface.

type SetupData

type SetupData struct {
	Data any `json:"data" yaml:"data"`
}

SetupData is just a simple wrapper to satisfy jsonapi

type Status

type Status struct {
	Status lib.ExecutionStatus `json:"status" yaml:"status"`

	Paused  null.Bool `json:"paused" yaml:"paused"`
	VUs     null.Int  `json:"vus" yaml:"vus"`
	VUsMax  null.Int  `json:"vus-max" yaml:"vus-max"`
	Stopped bool      `json:"stopped" yaml:"stopped"`
	Running bool      `json:"running" yaml:"running"`
	Tainted bool      `json:"tainted" yaml:"tainted"`
}

Status represents the current status of the test run.

type StatusJSONAPI

type StatusJSONAPI struct {
	Data statusData `json:"data"`
}

StatusJSONAPI is JSON API envelop for metrics

func NewStatusJSONAPI

func NewStatusJSONAPI(s Status) StatusJSONAPI

NewStatusJSONAPI creates the JSON API status envelop

func (StatusJSONAPI) Status

func (s StatusJSONAPI) Status() Status

Status extract the v1.Status from the JSON API envelop