Categorygithub.com/smarty/assertionsinternaloglematchers
package
1.16.0
Repository: https://github.com/smarty/assertions.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
6
Dependents
1
Files
860 SLOC

# README

GoDoc

oglematchers is a package for the Go programming language containing a set of matchers, useful in a testing or mocking framework, inspired by and mostly compatible with Google Test for C++ and Google JS Test. The package is used by the ogletest testing framework and oglemock mocking framework, which may be more directly useful to you, but can be generically used elsewhere as well.

A "matcher" is simply an object with a Matches method defining a set of golang values matched by the matcher, and a Description method describing that set. For example, here are some matchers:

// Numbers
Equals(17.13)
LessThan(19)

// Strings
Equals("taco")
HasSubstr("burrito")
MatchesRegex("t.*o")

// Combining matchers
AnyOf(LessThan(17), GreaterThan(19))

There are lots more; see here for a reference. You can also add your own simply by implementing the oglematchers.Matcher interface.

Installation

First, make sure you have installed Go 1.0.2 or newer. See here for instructions.

Use the following command to install oglematchers and keep it up to date:

go get -u github.com/smarty/assertions/internal/oglematchers

Documentation

See here for documentation. Alternatively, you can install the package and then use godoc:

godoc github.com/smarty/assertions/internal/oglematchers

# Functions

AnyOf accepts a set of values S and returns a matcher that follows the algorithm below when considering a candidate c: 1.
Return a matcher that matches arrays slices with at least one element that matches the supplied argument.
DeepEquals returns a matcher that matches based on 'deep equality', as defined by the reflect package.
Equals(x) returns a matcher that matches values v such that v and x are equivalent.
GreaterOrEqual returns a matcher that matches integer, floating point, or strings values v such that v >= x.
GreaterThan returns a matcher that matches integer, floating point, or strings values v such that v > x.
LessOrEqual returns a matcher that matches integer, floating point, or strings values v such that v <= x.
LessThan returns a matcher that matches integer, floating point, or strings values v such that v < x.
NewFatalError creates a FatalError struct with the supplied error text.
Not returns a matcher that inverts the set of values matched by the wrapped matcher.

# Structs

FatalError is an implementation of the error interface that may be returned from matchers, indicating the error should be propagated.

# Interfaces

A Matcher is some predicate implicitly defining a set of values that it matches.