Test results

Technical reference of Resultados de pruebas.

This API is used in Results.

Symbols

Symbol	Class	Description
ExecuteResult	`type`	Executed `ExecuteResult`.
StepResult	`type`	`StepResult` defines a public type of API.
ResponseSnapshot	`type`	`ResponseSnapshot` defines a public type of API.
BenchmarkResult	`type`	`BenchmarkResult` defines a public type of API.
BenchmarkStepResult	`type`	`BenchmarkStepResult` defines a public type of API.
BenchmarkAllocationSite	`type`	`BenchmarkAllocationSite` defines a public type of API.
MatchValue	`type`	`MatchValue` defines a public type of API.
HeaderMatchResult	`type`	`HeaderMatchResult` defines a public type of API.
BodyMatchResult	`type`	`BodyMatchResult` defines a public type of API.
BodyMatchFinding	`type`	`BodyMatchFinding` defines a public type of API.
BodyMatchDiff	`type`	`BodyMatchDiff` defines a public type of API.
JSONMatchFinding	`type`	`JSONMatchFinding` defines a public type of API.
ActionValueMatchResult	`type`	`ActionValueMatchResult` defines a public type of API.
ActionMatchResult	`type`	`ActionMatchResult` defines a public type of API.
StepResult.MarshalJSON	`func`	Serialize the value as JSON.
ExecuteResult.WriteOutput	`func`	Write `WriteOutput`.
ExecuteResult.Error	`func`	Returns the textual representation of the error.

ExecuteResult

Declaration:

gox

type ExecuteResult struct {
	File  string `json:"file,omitempty"`
	Name  string `json:"name,omitempty"`
	Mode  Mode   `json:"mode,omitempty"`
	Match bool   `json:"match"`
	Steps  []StepResult `json:"steps"`
	Output string       `json:"output,omitempty"`
	Benchmark *BenchmarkResult `json:"benchmark,omitempty"`
}

Executed ExecuteResult.

Fields

Field	Type	Description
`File`	`string`json: "file, omitempty" "	Associated file.
`Name`	`string`json: "name, omitempty" "	Name of the value.
`Mode`	`Mode`json: "mode, omitempty" "	Execution mode.
`Match`	`bool`json: "match" "	Result or expression of coincidence.
`Steps`	`[]StepResult`json: "steps" "	Public data associated with `Steps`.
`Output`	`string`json: "output, omitempty" "	Output produced.
`Benchmark`	`*BenchmarkResult`json: "Benchmark, omitempty" "	Public data associated with `Benchmark`.

StepResult

Declaration:

gox

type StepResult struct {
	Index  int    `json:"index"`
	Type   string `json:"type"`
	Method string `json:"method"`
	URL    string `json:"url"`
	Match  bool   `json:"match"`
	Response ResponseSnapshot `json:"response,omitempty"`
	Status  MatchValue        `json:"status,omitempty"`
	Headers HeaderMatchResult `json:"headers,omitempty"`
	Cookies HeaderMatchResult `json:"cookies,omitempty"`
	Body    BodyMatchResult   `json:"body,omitempty"`
	Action  ActionMatchResult `json:"action,omitempty"`
	Error string `json:"error,omitempty"`
	Benchmark BenchmarkStepResult `json:"benchmark,omitempty"`
}

StepResult defines a public type of API.

Fields

Field	Type	Description
`Index`	`int`json: "index" "	Public data associated with `Index`.
`Type`	`string`json: "type" "	Declared type.
`Method`	`string`json: "method" "	HTTP method or Action name.
`URL`	`string`json: "url" "	Structured request URL.
`Match`	`bool`json: "match" "	Result or expression of coincidence.
`Response`	`ResponseSnapshot`json: "response, omitempty" "	The associated response status.
`Status`	`MatchValue`json: "status, omitempty" "	Status of the operation.
`Headers`	`HeaderMatchResult`json: "heads, omitempty" "	Header collection.
`Cookies`	`HeaderMatchResult`json: "cookies, omitempty" "	Cookie collection.
`Body`	`BodyMatchResult`json: "body, omitempty" "	request body.
`Action`	`ActionMatchResult`json: "action, omitempty" "	Public data associated with `Action`.
`Error`	`string`json: "error, omitempty" "	Associated error.
`Benchmark`	`BenchmarkStepResult`json: "Benchmark, omitempty" "	Public data associated with `Benchmark`.

ResponseSnapshot

Declaration:

gox

type ResponseSnapshot struct {
	StatusCode int                 `json:"statusCode,omitempty"`
	Status     string              `json:"status,omitempty"`
	Headers    map[string][]string `json:"headers,omitempty"`
	Cookies    map[string]string   `json:"cookies,omitempty"`
	Body       string              `json:"body,omitempty"`
}

ResponseSnapshot defines a public type of API.

Fields

Field	Type	Description
`StatusCode`	`int`json: "statusCode, omitempty" "	HTTP status code.
`Status`	`string`json: "status, omitempty" "	Status of the operation.
`Headers`	`map[string][]string`json: "heads, omitempty" "	Header collection.
`Cookies`	`map[string]string`json: "cookies, omitempty" "	Cookie collection.
`Body`	`string`json: "body, omitempty" "	request body.

BenchmarkResult

Declaration:

gox

type BenchmarkResult struct {
	Warmup            int                       `json:"warmup"`
	Iterations        int                       `json:"iterations"`
	SampleRate        float64                   `json:"sampleRate"`
	AllocationSamples int                       `json:"allocationSamples"`
	DurationNS        int64                     `json:"durationNs"`
	NsPerOp           float64                   `json:"nsPerOp"`
	OpsPerSec         float64                   `json:"opsPerSec"`
	BytesSentPerOp    float64                   `json:"bytesSentPerOp"`
	BytesRecvPerOp    float64                   `json:"bytesReceivedPerOp"`
	HandlerAllocsOp   float64                   `json:"handler_allocs/op,omitempty"`
	HandlerBytesOp    float64                   `json:"handler_bytes/op,omitempty"`
	Status            map[int]int               `json:"status"`
	Errors            int                       `json:"errors"`
	AllocationSites   []BenchmarkAllocationSite `json:"allocationSites,omitempty"`
	Steps             []BenchmarkStepResult     `json:"steps,omitempty"`
}

BenchmarkResult defines a public type of API.

Fields

Field	Type	Description
`Warmup`	`int`json: "warmove" "	Public data associated with `Warmup`.
`Iterations`	`int`json: "iterations" "	Public data associated with `Iterations`.
`SampleRate`	`float64`json: "sampleRate" "	Public data associated with `SampleRate`.
`AllocationSamples`	`int`json: "allocationSamples" "	Public data associated with `AllocationSamples`.
`DurationNS`	`int64`json: "durationNs" "	Length recorded.
`NsPerOp`	`float64`json: "nsPerOp" "	Public data associated with `NsPerOp`.
`OpsPerSec`	`float64`json: "opsPerSec" "	Public data associated with `OpsPerSec`.
`BytesSentPerOp`	`float64`json: "bytesSentPerOp" "	Number of bytes.
`BytesRecvPerOp`	`float64`json: "bytesReceivedPerOp" "	Number of bytes.
`HandlerAllocsOp`	`float64`json: "handler _ allocs / op, omitempty" "	Associate Handler.
`HandlerBytesOp`	`float64`json: "handler _ bytes / op, omitempty" "	Associate Handler.
`Status`	`map[int]int`json: "status"	Status of the operation.
`Errors`	`int`json: "errors" "	Associated error.
`AllocationSites`	`[]BenchmarkAllocationSite`json: "allocationSites, omitempty" "	Public data associated with `AllocationSites`.
`Steps`	`[]BenchmarkStepResult`json: "steps, omitempty" "	Public data associated with `Steps`.

BenchmarkStepResult

Declaration:

gox

type BenchmarkStepResult struct {
	Index             int                       `json:"index"`
	Type              string                    `json:"type"`
	Method            string                    `json:"method,omitempty"`
	URL               string                    `json:"url,omitempty"`
	Iterations        int                       `json:"iterations"`
	AllocationSamples int                       `json:"allocationSamples"`
	DurationNS        int64                     `json:"durationNs"`
	NsPerOp           float64                   `json:"nsPerOp"`
	OpsPerSec         float64                   `json:"opsPerSec"`
	BytesSentPerOp    float64                   `json:"bytesSentPerOp"`
	BytesRecvPerOp    float64                   `json:"bytesReceivedPerOp"`
	HandlerAllocsOp   float64                   `json:"handler_allocs/op,omitempty"`
	HandlerBytesOp    float64                   `json:"handler_bytes/op,omitempty"`
	AllocationSites   []BenchmarkAllocationSite `json:"allocationSites,omitempty"`
	Status            map[int]int               `json:"status"`
	Errors            int                       `json:"errors"`
	Error             string                    `json:"error,omitempty"`
}

BenchmarkStepResult defines a public type of API.

Fields

Field	Type	Description
`Index`	`int`json: "index" "	Public data associated with `Index`.
`Type`	`string`json: "type" "	Declared type.
`Method`	`string`json: "method, omitempty" "	HTTP method or Action name.
`URL`	`string`json: "url, omitempty" "	Structured request URL.
`Iterations`	`int`json: "iterations" "	Public data associated with `Iterations`.
`AllocationSamples`	`int`json: "allocationSamples" "	Public data associated with `AllocationSamples`.
`DurationNS`	`int64`json: "durationNs" "	Length recorded.
`NsPerOp`	`float64`json: "nsPerOp" "	Public data associated with `NsPerOp`.
`OpsPerSec`	`float64`json: "opsPerSec" "	Public data associated with `OpsPerSec`.
`BytesSentPerOp`	`float64`json: "bytesSentPerOp" "	Number of bytes.
`BytesRecvPerOp`	`float64`json: "bytesReceivedPerOp" "	Number of bytes.
`HandlerAllocsOp`	`float64`json: "handler _ allocs / op, omitempty" "	Associate Handler.
`HandlerBytesOp`	`float64`json: "handler _ bytes / op, omitempty" "	Associate Handler.
`AllocationSites`	`[]BenchmarkAllocationSite`json: "allocationSites, omitempty" "	Public data associated with `AllocationSites`.
`Status`	`map[int]int`json: "status"	Status of the operation.
`Errors`	`int`json: "errors" "	Associated error.
`Error`	`string`json: "error, omitempty" "	Associated error.

BenchmarkAllocationSite

Declaration:

gox

type BenchmarkAllocationSite struct {
	File   string `json:"file"`
	Line   int    `json:"line"`
	Name   string `json:"name,omitempty"`
	Allocs uint64 `json:"allocs"`
	Bytes  uint64 `json:"bytes"`
}

BenchmarkAllocationSite defines a public type of API.

Fields

Field	Type	Description
`File`	`string`json: "file" "	Associated file.
`Line`	`int`json: "line" "	Associated code line.
`Name`	`string`json: "name, omitempty" "	Name of the value.
`Allocs`	`uint64`json: "allocs" "	Public data associated with `Allocs`.
`Bytes`	`uint64`json: "bytes" "	Number of bytes.

MatchValue

Declaration:

gox

type MatchValue struct {
	Expected any    `json:"expected"`
	Response any    `json:"response"`
	Match    bool   `json:"match"`
	Rule     string `json:"rule,omitempty"`
	Message  string `json:"message,omitempty"`
}

MatchValue defines a public type of API.

Fields

Field	Type	Description
`Expected`	`any`json: "expected" "	Expected type or value.
`Response`	`any`json: "response" "	The associated response status.
`Match`	`bool`json: "match" "	Result or expression of coincidence.
`Rule`	`string`json: "rule, omitempty" "	Public data associated with `Rule`.
`Message`	`string`json: "message, omitempty" "	A descriptive message.

HeaderMatchResult

Declaration:

gox

type HeaderMatchResult struct {
	Rule   string                `json:"rule,omitempty"`
	Match  bool                  `json:"match"`
	Fields map[string]MatchValue `json:"fields,omitempty"`
}

HeaderMatchResult defines a public type of API.

Fields

Field	Type	Description
`Rule`	`string`json: "rule, omitempty" "	Public data associated with `Rule`.
`Match`	`bool`json: "match" "	Result or expression of coincidence.
`Fields`	`map[string]MatchValue`json: "fields, omitempty" "	Text fields.

BodyMatchResult

Declaration:

gox

type BodyMatchResult struct {
	Rule     string            `json:"rule,omitempty"`
	Expected any               `json:"expected,omitempty"`
	Response any               `json:"response,omitempty"`
	Match    bool              `json:"match"`
	Message  string            `json:"message,omitempty"`
	Rules    []BodyMatchResult `json:"rules,omitempty"`
	Findings     []BodyMatchFinding `json:"findings,omitempty"`
	JSONFindings []JSONMatchFinding `json:"json_findings,omitempty"`
	Diff         *BodyMatchDiff     `json:"diff,omitempty"`
}

BodyMatchResult defines a public type of API.

Fields

Field	Type	Description
`Rule`	`string`json: "rule, omitempty" "	Public data associated with `Rule`.
`Expected`	`any`json: "expected, omitempty" "	Expected type or value.
`Response`	`any`json: "response, omitempty" "	The associated response status.
`Match`	`bool`json: "match" "	Result or expression of coincidence.
`Message`	`string`json: "message, omitempty" "	A descriptive message.
`Rules`	`[]BodyMatchResult`json: "rules, omitempty" "	Rules set.
`Findings`	`[]BodyMatchFinding`json: "findings, omitempty" "	Public data associated with `Findings`.
`JSONFindings`	`[]JSONMatchFinding`json: "json _ findings, omitempty" "	Public data associated with `JSONFindings`.
`Diff`	`*BodyMatchDiff`json: "diff, omitempty" "	Public data associated with `Diff`.

BodyMatchFinding

Declaration:

gox

type BodyMatchFinding struct {
	Pattern string `json:"pattern,omitempty"`
	Found   bool   `json:"found"`
	Line    int    `json:"line,omitempty"`
	Column  int    `json:"column,omitempty"`
	Offset  int    `json:"offset,omitempty"`
	Snippet string `json:"snippet,omitempty"`
}

BodyMatchFinding defines a public type of API.

Fields

Field	Type	Description
`Pattern`	`string`json: "pattern, omitempty" "	Pattern used for coincidence.
`Found`	`bool`json: "found" "	Public data associated with `Found`.
`Line`	`int`json: "line, omitempty" "	Associated code line.
`Column`	`int`json: "column, omitempty" "	Public data associated with `Column`.
`Offset`	`int`json: "offset, omitempty" "	Public data associated with `Offset`.
`Snippet`	`string`json: "snippet, omitempty" "	Public data associated with `Snippet`.

BodyMatchDiff

Declaration:

gox

type BodyMatchDiff struct {
	Line            int    `json:"line,omitempty"`
	Column          int    `json:"column,omitempty"`
	Offset          int    `json:"offset,omitempty"`
	ExpectedSnippet string `json:"expected_snippet,omitempty"`
	ResponseSnippet string `json:"response_snippet,omitempty"`
}

BodyMatchDiff defines a public type of API.

Fields

Field	Type	Description
`Line`	`int`json: "line, omitempty" "	Associated code line.
`Column`	`int`json: "column, omitempty" "	Public data associated with `Column`.
`Offset`	`int`json: "offset, omitempty" "	Public data associated with `Offset`.
`ExpectedSnippet`	`string`json: "expected _ snippet, omitempty" "	Public data associated with `ExpectedSnippet`.
`ResponseSnippet`	`string`json: "response _ snippet, omitempty" "	Public data associated with `ResponseSnippet`.

JSONMatchFinding

Declaration:

gox

type JSONMatchFinding struct {
	Path     string `json:"path,omitempty"`
	Expected any    `json:"expected,omitempty"`
	Response any    `json:"response,omitempty"`
	Found    bool   `json:"found"`
	Match    bool   `json:"match"`
	Message  string `json:"message,omitempty"`
}

JSONMatchFinding defines a public type of API.

Fields

Field	Type	Description
`Path`	`string`json: "path, omitempty" "	Route used.
`Expected`	`any`json: "expected, omitempty" "	Expected type or value.
`Response`	`any`json: "response, omitempty" "	The associated response status.
`Found`	`bool`json: "found" "	Public data associated with `Found`.
`Match`	`bool`json: "match" "	Result or expression of coincidence.
`Message`	`string`json: "message, omitempty" "	A descriptive message.

ActionValueMatchResult

Declaration:

gox

type ActionValueMatchResult struct {
	Rule         string                `json:"rule,omitempty"`
	Expected     any                   `json:"expected,omitempty"`
	Response     any                   `json:"response,omitempty"`
	Match        bool                  `json:"match"`
	Fields       map[string]MatchValue `json:"fields,omitempty"`
	JSONFindings []JSONMatchFinding    `json:"json_findings,omitempty"`
	Message      string                `json:"message,omitempty"`
}

ActionValueMatchResult defines a public type of API.

Fields

Field	Type	Description
`Rule`	`string`json: "rule, omitempty" "	Public data associated with `Rule`.
`Expected`	`any`json: "expected, omitempty" "	Expected type or value.
`Response`	`any`json: "response, omitempty" "	The associated response status.
`Match`	`bool`json: "match" "	Result or expression of coincidence.
`Fields`	`map[string]MatchValue`json: "fields, omitempty" "	Text fields.
`JSONFindings`	`[]JSONMatchFinding`json: "json _ findings, omitempty" "	Public data associated with `JSONFindings`.
`Message`	`string`json: "message, omitempty" "	A descriptive message.

ActionMatchResult

Declaration:

gox

type ActionMatchResult struct {
	Error  ActionValueMatchResult `json:"error,omitempty"`
	Result ActionValueMatchResult `json:"result,omitempty"`
	Match  bool                   `json:"match"`
}

ActionMatchResult defines a public type of API.

Fields

Field	Type	Description
`Error`	`ActionValueMatchResult`json: "error, omitempty" "	Associated error.
`Result`	`ActionValueMatchResult`json: "result, omitempty" "	Associated outcome.
`Match`	`bool`json: "match" "	Result or expression of coincidence.

StepResult.MarshalJSON

Declaration:

gox

func (s StepResult) MarshalJSON() ([]byte, error)

Serialize the value as JSON.

Returns

Return	Type	Description
`value`	`[]byte`	Result collection; can be `nil` when there are no values.
`err`	`error`	`nil` if the operation ends correctly; otherwise, the error produced.

Behavior

The operation returns an error when it cannot complete the above contract.

Errors

MarshalJSON returns an error when the arguments, the status of the receiver or the underlying operation make it impossible to complete the call.

Usage syntax

gox

value, err := stepResult.MarshalJSON()

ExecuteResult.WriteOutput

Declaration:

gox

func (r ExecuteResult) WriteOutput(path string) error

Write WriteOutput.

Parameters

Parameter	Type	Description
`path`	`string`	Type value `string` required by the operation.

Returns

Return	Type	Description
`err`	`error`	`nil` if the operation ends correctly; otherwise, the error produced.

Behavior

The operation returns an error when it cannot complete the above contract.

Errors

WriteOutput returns an error when the arguments, the status of the receiver or the underlying operation make it impossible to complete the call.

Usage syntax

gox

err := executeResult.WriteOutput(value)

ExecuteResult.Error

Declaration:

gox

func (r ExecuteResult) Error() string

Returns the textual representation of the error.

Returns

Return	Type	Description
`value`	`string`	Textual value produced by the operation; its zero value is an empty string.

Usage syntax

gox

value := executeResult.Error()

Next step

Continue with Exported API reserved for runtime.

Runtime API

Test results

Symbols

ExecuteResult

Fields

StepResult

Fields

ResponseSnapshot

Fields

BenchmarkResult

Fields

BenchmarkStepResult

Fields

BenchmarkAllocationSite

Fields

MatchValue

Fields

HeaderMatchResult

Fields

BodyMatchResult

Fields

BodyMatchFinding

Fields

BodyMatchDiff

Fields

JSONMatchFinding

Fields

ActionValueMatchResult

Fields

ActionMatchResult

Fields

StepResult.MarshalJSON

Returns

Behavior

Errors

Usage syntax

ExecuteResult.WriteOutput

Parameters

Returns

Behavior

Errors

Usage syntax

ExecuteResult.Error

Returns

Usage syntax

See also

Next step