smoketest

Documentation

Index

• type RunSmokeTestOptions
• type SmokeTestRequest
• type SmokeTestResults
  • func RunSmokeTest(ctx context.Context, opts RunSmokeTestOptions) (SmokeTestResults, error)
• type Status

Types

type RunSmokeTestOptions

type RunSmokeTestOptions struct {
	FromEndpoint       string
	ToEndpoint         string
	ToEndpointToken    string
	Timeout            time.Duration
	MaxSessionIDLength int
	UserAgent          string
}

RunSmokeTestOptions are options to runs smoke test

type SmokeTestRequest

type SmokeTestRequest struct {
	Endpoint           string        `json:"endpoint"`
	Token              string        `json:"token"`
	MaxSessionIDLength int           `json:"max_session_id_length"`
	Timeout            time.Duration `json:"timeout"`
}

type SmokeTestResults

type SmokeTestResults struct {
	FromEndpoint    string  `json:"from_endpoint"`
	ToEndpoint      string  `json:"to_endpoint"`
	LatencyMilliSec float64 `json:"latency"`
	Status          Status  `json:"status"`
}

func RunSmokeTest

func RunSmokeTest(ctx context.Context, opts RunSmokeTestOptions) (SmokeTestResults, error)

RunsmokeTest runs smoke test and returns smoke test results to caller

type Status

type Status int

const (
	StatusUnknown Status = 0
	StatusSuccess Status = 1
	StatusFailed  Status = 2
	StatusTimeout Status = 3
	StatusError   Status = 4
)