stdcrpcsnap

package
v0.0.102 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 13, 2025 License: MIT Imports: 13 Imported by: 0

Documentation

Overview

Package stdcrpcsnap provides snapshot testing for Connect RPC response.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func MessageSnapshotEq 

func MessageSnapshotEq(tb testing.TB, msg proto.Message, actOverwrites ...Overwrite)

MessageSnapshotEq compares the protobuf message against a snapshot. If the snapshot file doesn't exist it is created instead.

func ResponseSnapshotEq 

func ResponseSnapshotEq[O any](
	tb testing.TB, resp *connect.Response[O], err error, actOverwrites ...Overwrite,
)

ResponseSnapshotEq asserts that the snapshot equals the RPC response.

func SnapshotEq 

func SnapshotEq(tb testing.TB, actMsg []byte, actOverwrites ...Overwrite)

SnapshotEq compares the protobuf message against a snapshot. If the snapshot file doesn't exist it is created instead.

Types

type Overwrite 

type Overwrite struct {
	Path   string
	Value  any
	Assert func(v gjson.Result) bool
}

Overwrite allows a test case to overwrite part of the actual message before it is compared with the snapshot. This is useful for asserting data that changes by definition. It is a last-resort option and making sure the data is stable to begin with is preferred.

func PinResponseValue 

func PinResponseValue(atPath string, toValue any, assertActual ...func(v gjson.Result) bool) Overwrite

PinResponseValue is a helper that allows for dealing with response values that are not static so cannot be predicted for the snapshot value. The optional 'assertActual' can still assert the actual value even though it wouldn't match the snapshot.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.