cuetest

Documentation

Overview

Package testing is a helper package for test packages in the CUE project. As such it should only be imported in _test.go files.

Index

• Variables
• func Condition(cond string) (bool, error)
• func IssueSkip(t *testing.T, s string)

Variables

var FormatTxtar = os.Getenv(envFormatTxtar) != ""

FormatTxtar ensures that .cue files in txtar test archives are well formatted, updating the archive as required prior to running a test.

var Long = os.Getenv(envLong) != ""

Long determines whether long tests should be run. It is controlled by setting CUE_LONG to a non-empty string like "true". Note that it is not the equivalent of not supplying -short.

var UpdateGoldenFiles = os.Getenv(envUpdate) != ""

UpdateGoldenFiles determines whether testscript scripts should update txtar archives in the event of cmp failures. It is controlled by setting CUE_UPDATE to a non-empty string like "true". It corresponds to testscript.Params.UpdateGoldenFiles; see its docs for details.

Functions

func Condition

func Condition(cond string) (bool, error)

Condition adds support for CUE-specific testscript conditions within testscript scripts. Supported conditions include:

[long] - evalutates to true when the long build tag is specified

golang.org/issue/N - evaluates to true unless CUE_NON_ISSUES is set to a regexp that matches the condition, i.e. golang.org/issue/N in this case

cuelang.org/issue/N - evaluates to true unless CUE_NON_ISSUES is set to a regexp that matches the condition, i.e. cuelang.org/issue/N in this case

func IssueSkip

func IssueSkip(t *testing.T, s string)

IssueSkip causes the test t to be skipped unless the issue identified by s is deemed to be a non-issue by CUE_NON_ISSUES.