jacl

README

jacl

Just Another Comparison Library.

This is a small utility intended to ease verifying conditions for complex testing. It is an offshot from a much more extensive library at github.com/hackborn/jacl.

Documentation

Index

• func Run(target any, terms ...string) error
• func RunErr(have, want error) error
• func RunOpts(opts Opts, target any, terms ...string) error
• type Opts

Functions

func Run

func Run(target any, terms ...string) error

Run compares a list of terms against a target. Target can be anything. Terms are described by the grammar {term} = {path}{comparison_operator}{value} Where {path} is a "/" separated list of identifiers {comparison_operator} is "=" {value} is a string {path} identifiers can be either an integer to index slices, or a string for named fields. Example term: "0/Name=Ireland" where the target is a slice of structs that have a Name field.

Builtin keywords are supported for specific comparisons: "{type}" will compare against the type, i.e.

"{type}=Event" will be true if the type is named Event.

"{count}" will compare against the length of slices and maps, i.e.

"{count}=2" will be true if the value is a slice with length of 2.

func RunErr

func RunErr(have, want error) error

RunErr compares two errors, returning if they do not match. I use a soft definition of "match"; the errors can be different, it just checks if they are both nil or not. Ideally, error messages are not part of an API.

func RunOpts

func RunOpts(opts Opts, target any, terms ...string) error

RunOpts compares a list of terms against a target. Target can be anything. See Run docs for a decription of target and terms. Opts adds some configuration options, see Opts docs for a description.

Types

type Opts

type Opts struct {
	// If RawValues is true then the value tokens are left
	// completely unprocessed.
	// If it is false, then processing is applied:
	// * Two single quotes (”) are replaced with a double quote (").
	// Default is false.
	RawValues bool
}