validationtest

Documentation

Overview

Package validationtest contains helper functions for testing purposes.

Index

• type Assertion
  • func Assert(t TestingT, err error) *Assertion
  • func (a *Assertion) IsViolation() *ViolationAssertion
  • func (a *Assertion) IsViolationList() *ViolationListAssertion
• type TestingT
• type ViolationAssertion
  • func (a *ViolationAssertion) Assert(assert func(tb testing.TB, violation validation.Violation)) *ViolationAssertion
  • func (a *ViolationAssertion) EqualTo(violation validation.Violation) *ViolationAssertion
  • func (a *ViolationAssertion) EqualToError(errString string) *ViolationAssertion
  • func (a *ViolationAssertion) WithError(err error) *ViolationAssertion
  • func (a *ViolationAssertion) WithMessage(message string) *ViolationAssertion
  • func (a *ViolationAssertion) WithPropertyPath(path string) *ViolationAssertion
• type ViolationAttributes
• type ViolationListAssertion
  • func (a *ViolationListAssertion) Assert(assert func(tb testing.TB, violations []validation.Violation)) *ViolationListAssertion
  • func (a *ViolationListAssertion) HasViolationAt(index int) *ViolationAssertion
  • func (a *ViolationListAssertion) WithAttributes(violations ...ViolationAttributes) *ViolationListAssertion
  • func (a *ViolationListAssertion) WithErrors(errs ...error) *ViolationListAssertion
  • func (a *ViolationListAssertion) WithLen(length int) *ViolationListAssertion
  • func (a *ViolationListAssertion) WithOneViolation() *ViolationAssertion

Types

type Assertion

type Assertion struct {
	// contains filtered or unexported fields
}

Assertion is a structure for testing an error for implementing validator violations.

func Assert

func Assert(t TestingT, err error) *Assertion

Assert creates a new Assertion for the error.

func (*Assertion) IsViolation

func (a *Assertion) IsViolation() *ViolationAssertion

IsViolation checks that err implements github.com/muonsoft/validation.Violation and returns ViolationAssertion for attributes assertions.

func (*Assertion) IsViolationList

func (a *Assertion) IsViolationList() *ViolationListAssertion

IsViolationList checks that err implements github.com/muonsoft/validation.IsViolationList and returns ViolationListAssertion for attributes assertions.

type TestingT

type TestingT interface {
	Helper()
	Error(args ...interface{})
	Errorf(format string, args ...interface{})
	Fatal(args ...interface{})
}

TestingT is an interface wrapper around testing.T.

type ViolationAssertion

type ViolationAssertion struct {
	// contains filtered or unexported fields
}

ViolationAssertion is a structure for testing violation attributes.

func (*ViolationAssertion) Assert

func (a *ViolationAssertion) Assert(
	assert func(tb testing.TB, violation validation.Violation),
) *ViolationAssertion

Assert is used for the client-side assertion of the violation by a callback function.

func (*ViolationAssertion) EqualTo

func (a *ViolationAssertion) EqualTo(violation validation.Violation) *ViolationAssertion

EqualTo checks that the tested assertion is equal to the expected one.

func (*ViolationAssertion) EqualToError

func (a *ViolationAssertion) EqualToError(errString string) *ViolationAssertion

EqualToError checks that violation rendered to an error is equal to the expected one.

func (*ViolationAssertion) WithError

func (a *ViolationAssertion) WithError(err error) *ViolationAssertion

WithError checks that violation has expected error.

func (*ViolationAssertion) WithMessage

func (a *ViolationAssertion) WithMessage(message string) *ViolationAssertion

WithMessage checks that violation has expected message.

func (*ViolationAssertion) WithPropertyPath

func (a *ViolationAssertion) WithPropertyPath(path string) *ViolationAssertion

WithPropertyPath checks that the tested violation has an expected property path.

type ViolationAttributes

type ViolationAttributes struct {
	Error        error
	Message      string
	PropertyPath string
}

ViolationAttributes are used to compare violation against expected values. An empty value is not compared.

type ViolationListAssertion

type ViolationListAssertion struct {
	// contains filtered or unexported fields
}

ViolationListAssertion is a structure for testing violation list attributes.

func (*ViolationListAssertion) Assert

func (a *ViolationListAssertion) Assert(
	assert func(tb testing.TB, violations []validation.Violation),
) *ViolationListAssertion

Assert is used for the client-side side assertion of violations by a callback function.

func (*ViolationListAssertion) HasViolationAt

func (a *ViolationListAssertion) HasViolationAt(index int) *ViolationAssertion

HasViolationAt checks that the violation list contains element at specific index and returns a ViolationAssertion to test it.

func (*ViolationListAssertion) WithAttributes

func (a *ViolationListAssertion) WithAttributes(violations ...ViolationAttributes) *ViolationListAssertion

WithAttributes checks that the violation list contains violations with the expected attributes in a given order. Empty values are not compared.

func (*ViolationListAssertion) WithErrors

func (a *ViolationListAssertion) WithErrors(errs ...error) *ViolationListAssertion

WithErrors checks that the violation list contains violations with specific codes in a given order.

func (*ViolationListAssertion) WithLen

func (a *ViolationListAssertion) WithLen(length int) *ViolationListAssertion

WithLen checks that the violation list has exact length.

func (*ViolationListAssertion) WithOneViolation

func (a *ViolationListAssertion) WithOneViolation() *ViolationAssertion

WithOneViolation checks that the violation list contains exactly one violation and returns a ViolationAssertion to test it.