test

README

test

A golang test library. It's essentially a light wrapper around all assertions from https://github.com/smartystreets/assertions.

Usage

package test

import (
	"testing"

	"go.viam.com/test"
)

func TestExample(t *testing.T) {
	test.That(t, 1, ShouldEqual, 1)
	test.That(t, 1, ShouldNotEqual, "1")
}

License

Copyright 2021-2022 Viam Inc.

Apache 2.0 - See LICENSE file

Documentation

Index

• Variables
• func ShouldNotResemble(actual interface{}, expected ...interface{}) string
• func ShouldNotResembleProto(actual interface{}, expected ...interface{}) string
• func ShouldResemble(actual interface{}, expected ...interface{}) string
• func ShouldResembleProto(actual interface{}, expected ...interface{}) string
• func That(tb testing.TB, actual interface{}, ...)

Variables

var (
	ShouldContain                = assertions.ShouldContain
	ShouldNotContain             = assertions.ShouldNotContain
	ShouldContainKey             = assertions.ShouldContainKey
	ShouldNotContainKey          = assertions.ShouldNotContainKey
	ShouldBeIn                   = assertions.ShouldBeIn
	ShouldNotBeIn                = assertions.ShouldNotBeIn
	ShouldBeEmpty                = assertions.ShouldBeEmpty
	ShouldNotBeEmpty             = assertions.ShouldNotBeEmpty
	ShouldHaveLength             = assertions.ShouldHaveLength
	ShouldEqual                  = assertions.ShouldEqual
	ShouldNotEqual               = assertions.ShouldNotEqual
	ShouldAlmostEqual            = assertions.ShouldAlmostEqual
	ShouldNotAlmostEqual         = assertions.ShouldNotAlmostEqual
	ShouldEqualJSON              = assertions.ShouldEqualJSON
	ShouldPointTo                = assertions.ShouldPointTo
	ShouldNotPointTo             = assertions.ShouldNotPointTo
	ShouldBeNil                  = assertions.ShouldBeNil
	ShouldNotBeNil               = assertions.ShouldNotBeNil
	ShouldBeTrue                 = assertions.ShouldBeTrue
	ShouldBeFalse                = assertions.ShouldBeFalse
	ShouldBeZeroValue            = assertions.ShouldBeZeroValue
	ShouldNotBeZeroValue         = assertions.ShouldNotBeZeroValue
	ShouldPanic                  = assertions.ShouldPanic
	ShouldNotPanic               = assertions.ShouldNotPanic
	ShouldPanicWith              = assertions.ShouldPanicWith
	ShouldNotPanicWith           = assertions.ShouldNotPanicWith
	ShouldBeGreaterThan          = assertions.ShouldBeGreaterThan
	ShouldBeGreaterThanOrEqualTo = assertions.ShouldBeGreaterThanOrEqualTo
	ShouldBeLessThan             = assertions.ShouldBeLessThan
	ShouldBeLessThanOrEqualTo    = assertions.ShouldBeLessThanOrEqualTo
	ShouldBeBetween              = assertions.ShouldBeBetween
	ShouldNotBeBetween           = assertions.ShouldNotBeBetween
	ShouldBeBetweenOrEqual       = assertions.ShouldBeBetweenOrEqual
	ShouldNotBeBetweenOrEqual    = assertions.ShouldNotBeBetweenOrEqual
	ShouldStartWith              = assertions.ShouldStartWith
	ShouldNotStartWith           = assertions.ShouldNotStartWith
	ShouldEndWith                = assertions.ShouldEndWith
	ShouldNotEndWith             = assertions.ShouldNotEndWith
	ShouldContainSubstring       = assertions.ShouldContainSubstring
	ShouldNotContainSubstring    = assertions.ShouldNotContainSubstring
	ShouldBeBlank                = assertions.ShouldBeBlank
	ShouldNotBeBlank             = assertions.ShouldNotBeBlank
	ShouldEqualWithout           = assertions.ShouldEqualWithout
	ShouldEqualTrimSpace         = assertions.ShouldEqualTrimSpace
	ShouldHappenBefore           = assertions.ShouldHappenBefore
	ShouldHappenOnOrBefore       = assertions.ShouldHappenOnOrBefore
	ShouldHappenAfter            = assertions.ShouldHappenAfter
	ShouldHappenOnOrAfter        = assertions.ShouldHappenOnOrAfter
	ShouldHappenBetween          = assertions.ShouldHappenBetween
	ShouldHappenOnOrBetween      = assertions.ShouldHappenOnOrBetween
	ShouldNotHappenOnOrBetween   = assertions.ShouldNotHappenOnOrBetween
	ShouldHappenWithin           = assertions.ShouldHappenWithin
	ShouldNotHappenWithin        = assertions.ShouldNotHappenWithin
	ShouldBeChronological        = assertions.ShouldBeChronological
	ShouldNotBeChronological     = assertions.ShouldNotBeChronological
	ShouldHaveSameTypeAs         = assertions.ShouldHaveSameTypeAs
	ShouldNotHaveSameTypeAs      = assertions.ShouldNotHaveSameTypeAs
	ShouldImplement              = assertions.ShouldImplement
	ShouldNotImplement           = assertions.ShouldNotImplement
	ShouldBeError                = assertions.ShouldBeError
	ShouldWrap                   = assertions.ShouldWrap
)

Functions

func ShouldNotResemble

func ShouldNotResemble(actual interface{}, expected ...interface{}) string

ShouldNotResemble receives exactly two parameters and does an inverse deep equal check (see reflect.DeepEqual)

func ShouldNotResembleProto

func ShouldNotResembleProto(actual interface{}, expected ...interface{}) string

ShouldNotResembleProto receives exactly two parameters and does an inverse proto equal check.

func ShouldResemble

func ShouldResemble(actual interface{}, expected ...interface{}) string

ShouldResemble receives exactly two parameters and does a deep equal check (see reflect.DeepEqual)

func ShouldResembleProto

func ShouldResembleProto(actual interface{}, expected ...interface{}) string

ShouldResembleProto receives exactly two parameters and does a proto equal check.

func That

func That(tb testing.TB, actual interface{}, assert func(actual interface{}, expected ...interface{}) string, expected ...interface{})