goldentest

Documentation

Index

• type ForMarshaling
• type Test
  • func (t *Test) UnmarshalYAML(n *yaml.Node) error
  • func (t *Test) Upgrade(ctx context.Context) (model.ValidatorUpgrader, error)
  • func (t *Test) Validate() error
• type VarValue
  • func (i *VarValue) UnmarshalYAML(n *yaml.Node) error
  • func (i *VarValue) Validate() error
• type WithHeader

Types

type ForMarshaling

type ForMarshaling Test

This absurdity is a workaround for a bug github.com/go-yaml/yaml/issues/817 in the YAML library. We want to inline a Test in a WithHeader when marshaling. But the bug prevents that, because anything that implements Unmarshaler cannot be inlined. As a workaround, we create a new type with the same fields but without the Unmarshal method.

type Test

type Test struct {
	// Pos is the YAML file location where this object started.
	Pos model.ConfigPos `yaml:"-"`

	Inputs      []*VarValue `yaml:"inputs,omitempty"`
	BuiltinVars []*VarValue `yaml:"builtin_vars,omitempty"`
	// Features configures which features to use depending on goldentest API version.
	Features features.Features `yaml:"-"`
}

Test represents a parsed test.yaml describing test configs.

func (*Test) UnmarshalYAML

func (t *Test) UnmarshalYAML(n *yaml.Node) error

UnmarshalYAML implements yaml.Unmarshaler.

func (*Test) Upgrade

func (t *Test) Upgrade(ctx context.Context) (model.ValidatorUpgrader, error)

Upgrade implements model.ValidatorUpgrader.

func (*Test) Validate

func (t *Test) Validate() error

Validate implements model.Validator.

type VarValue

type VarValue struct {
	// Pos is the YAML file location where this object started.
	Pos model.ConfigPos `yaml:"-"`

	Name  model.String `yaml:"name"`
	Value model.String `yaml:"value"`
}

VarValue represents one of the parsed "input" fields from the inputs.yaml file.

func (*VarValue) UnmarshalYAML

func (i *VarValue) UnmarshalYAML(n *yaml.Node) error

UnmarshalYAML implements yaml.Unmarshaler.

func (*VarValue) Validate

func (i *VarValue) Validate() error

type WithHeader

type WithHeader header.With[*ForMarshaling]

This absurdity is a workaround for a bug github.com/go-yaml/yaml/issues/817 in the YAML library. We want to inline a Test in a WithHeader when marshaling. But the bug prevents that, because anything that implements Unmarshaler cannot be inlined. As a workaround, we create a new type with the same fields but without the Unmarshal method.