snapshot

README

go-snapshot-testing

Package snapshot provides snapshot testing functionality, similar in concept to Jest for Javascript. to update snapshots, please set the UPDATE_SNAPSHOT environment variable to "1"

UPDATE_SNAPSHOTS=1 go test ./...

Documentation

Index

• Constants
• func AssertMatchesSnapshot(t *testing.T, snapshotName string, actualSnapshot *SnapshotType)
• type SnapshotDataType
• type SnapshotType
  • func NewImageSnapshot(img image.Image) *SnapshotType
  • func NewTextSnapshot(text string) *SnapshotType

Constants

const (
	CI_MODE_ENV_VAR = "CI_MODE"
)

const UpdateSnapshotEnvVariableName = "UPDATE_SNAPSHOTS"

Functions

func AssertMatchesSnapshot

func AssertMatchesSnapshot(t *testing.T, snapshotName string, actualSnapshot *SnapshotType)

Types

type SnapshotDataType

type SnapshotDataType string

const (
	SnapshotDataTypeText  SnapshotDataType = "TEXT"
	SnapshotDataTypeImage SnapshotDataType = "IMAGE"
)

type SnapshotType

type SnapshotType struct {
	DataType   SnapshotDataType
	Value      string
	OnBadMatch func(t *testing.T, expected string) error `json:"-"`
}

func NewImageSnapshot

func NewImageSnapshot(img image.Image) *SnapshotType

func NewTextSnapshot

func NewTextSnapshot(text string) *SnapshotType