runscope

Documentation

Index

• Constants
• func ExampleMessage(cfg config.Configuration, data util.ExampleData) (cc.Message, error)
• func NewHandler() handlers.Handler
• func Normalize(cfg config.Configuration, hReq handlers.HandlerRequest) (cc.Message, error)
• type RunscopeOutMessage
  • func RunscopeOutMessageFromBytes(bytes []byte) (RunscopeOutMessage, error)
  • func (msg *RunscopeOutMessage) BucketURL() string
  • func (msg *RunscopeOutMessage) EnvironmentsURL() string
• type RunscopeOutRequest
• type RunscopeOutStatus

Constants

const (
	DisplayName      = "Runscope"
	HandlerKey       = "runscope"
	MessageDirection = "out"
	DocumentationURL = "https://www.runscope.com/docs/api-testing/notifications#webhook"
	MessageBodyType  = models.JSON
)

Functions

func ExampleMessage

func ExampleMessage(cfg config.Configuration, data util.ExampleData) (cc.Message, error)

func NewHandler

func NewHandler() handlers.Handler

func Normalize

func Normalize(cfg config.Configuration, hReq handlers.HandlerRequest) (cc.Message, error)

Types

type RunscopeOutMessage

type RunscopeOutMessage struct {
	Variables       any                  `json:"variables,omitempty"`
	TestID          string               `json:"test_id,omitempty"`
	TestName        string               `json:"test_name,omitempty"`
	TestRunID       string               `json:"test_run_id,omitempty"`
	TeamID          string               `json:"team_id,omitempty"`
	TeamName        string               `json:"team_name,omitempty"`
	EnvironmentUUID string               `json:"environment_uuid,omitempty"`
	EnvironmentName string               `json:"environment_name,omitempty"`
	BucketName      string               `json:"bucket_name,omitempty"`
	BucketKey       string               `json:"bucket_key,omitempty"`
	TestURL         string               `json:"test_url,omitempty"`
	TestRunURL      string               `json:"test_run_url,omitempty"`
	TriggerURL      string               `json:"trigger_url,omitempty"`
	Result          string               `json:"result,omitempty"`
	StartedAt       float64              `json:"started_at,omitempty"`
	FinishedAt      float64              `json:"finished_at,omitempty"`
	Agent           any                  `json:"agent,omitempty"`
	Region          string               `json:"region,omitempty"`
	RegionName      string               `json:"region_name,omitempty"`
	Requests        []RunscopeOutRequest `json:"requests,omitempty"`
}

func RunscopeOutMessageFromBytes

func RunscopeOutMessageFromBytes(bytes []byte) (RunscopeOutMessage, error)

func (*RunscopeOutMessage) BucketURL

func (msg *RunscopeOutMessage) BucketURL() string

func (*RunscopeOutMessage) EnvironmentsURL

func (msg *RunscopeOutMessage) EnvironmentsURL() string

type RunscopeOutRequest

type RunscopeOutRequest struct {
	URL                string            `json:"url,omitempty"`
	Variables          RunscopeOutStatus `json:"variables,omitempty"`
	Assertions         RunscopeOutStatus `json:"assertions,omitempty"`
	Scripts            RunscopeOutStatus `json:"scripts,omitempty"`
	Result             string            `json:"result,omitempty"`
	Method             string            `json:"method,omitempty"`
	ResponseTimeMs     int64             `json:"response_time_ms,omitempty"`
	ResponseSizeBytes  int64             `json:"response_size_bytes,omitempty"`
	ResponseStatusCode string            `json:"response_status_code,omitempty"`
	Note               string            `json:"note,omitempty"`
}

type RunscopeOutStatus

type RunscopeOutStatus struct {
	Fail  int64 `json:"fail,omitempty"`
	Total int64 `json:"total,omitempty"`
	Pass  int64 `json:"pass,omitempty"`
}