• Stars
    star
    133
  • Rank 262,797 (Top 6 %)
  • Language
    Go
  • License
    MIT License
  • Created over 8 years ago
  • Updated 17 days ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A simple assertion library using Go generics

A simple assertion library using Go generics

PkgGoDev CI Go Report Card Slack chat

This library is inspired by testify/require, but with a significantly reduced API surface based on empirical use of that package.

It also provides much nicer diff output, eg.

=== RUN   TestFail
    assert_test.go:14: Expected values to be equal:
         assert.Data{
        -  Str: "foo",
        +  Str: "far",
           Num: 10,
         }
--- FAIL: TestFail (0.00s)

API

Import then use as assert:

import "github.com/alecthomas/assert/v2"

This library has the following API. For all functions, msgAndArgs is used to format error messages using the fmt package.

// Equal asserts that "expected" and "actual" are equal using google/go-cmp.
//
// If they are not, a diff of the Go representation of the values will be displayed.
func Equal[T comparable](t testing.TB, expected, actual T, msgAndArgs ...interface{})

// NotEqual asserts that "expected" is not equal to "actual" using google/go-cmp.
//
// If they are equal the expected value will be displayed.
func NotEqual[T comparable](t testing.TB, expected, actual T, msgAndArgs ...interface{})

// Zero asserts that a value is its zero value.
func Zero[T comparable](t testing.TB, value T, msgAndArgs ...interface{})

// NotZero asserts that a value is not its zero value.
func NotZero[T comparable](t testing.TB, value T, msgAndArgs ...interface{})

// Contains asserts that "haystack" contains "needle".
func Contains(t testing.TB, haystack string, needle string, msgAndArgs ...interface{})

// NotContains asserts that "haystack" does not contain "needle".
func NotContains(t testing.TB, haystack string, needle string, msgAndArgs ...interface{})

// EqualError asserts that either an error is non-nil and that its message is what is expected,
// or that error is nil if the expected message is empty.
func EqualError(t testing.TB, err error, errString string, msgAndArgs...interface{})

// Error asserts that an error is not nil.
func Error(t testing.TB, err error, msgAndArgs ...interface{})

// NoError asserts that an error is nil.
func NoError(t testing.TB, err error, msgAndArgs ...interface{})

// IsError asserts than any error in "err"'s tree matches "target".
func IsError(t testing.TB, err, target error, msgAndArgs ...interface{})

// NotIsError asserts than no error in "err"'s tree matches "target".
func NotIsError(t testing.TB, err, target error, msgAndArgs ...interface{})

// Panics asserts that the given function panics.
func Panics(t testing.TB, fn func(), msgAndArgs ...interface{})

// NotPanics asserts that the given function does not panic.
func NotPanics(t testing.TB, fn func(), msgAndArgs ...interface{})

// Compare two values for equality and return true or false.
func Compare[T any](t testing.TB, x, y T) bool

// True asserts that an expression is true.
func True(t testing.TB, ok bool, msgAndArgs ...interface{})

// False asserts that an expression is false.
func False(t testing.TB, ok bool, msgAndArgs ...interface{})

Evaluation process

Our empircal data of testify usage comes from a monorepo with around 50K lines of tests.

These are the usage counts for all testify functions, normalised to the base (not Printf()) non-negative(not No(t)?) case for each core function.

2240 Error
1314 Equal
 219 True
 210 Nil
 167 Empty
 107 Contains
  79 Len
  61 False
  24 EqualValues
  20 EqualError
  17 Zero
  15 Fail
  15 ElementsMatch
   9 Panics
   7 IsType
   6 FileExists
   4 JSONEq
   3 PanicsWithValue
   3 Eventually

The decision for each function was:

Keep

  • Error(t, err) -> frequently used, keep
  • Equal(t, expected, actual) -> frequently used, keep but make type safe
  • True(t, expr) -> frequently used, keep
  • False(t, expr) -> frequently used, keep
  • Empty(t, thing) -> require.Equal(t, len(thing), 0)
  • Contains(t, haystack string, needle string) - the only variant used in our codebase, keep as concrete type
  • Zero(t, value) -> make type safe, keep
  • Panics(t, f) -> useful, keep
  • EqualError(t, a, b) -> useful, keep
  • Nil(t, value) -> frequently used, keep

Not keeping, replace with ...

  • ElementsMatch(t, a, b) - use peterrk/slices or stdlib sort support once it lands.
  • IsType(t, a, b) -> require.Equal(t, reflect.TypeOf(a).String(), reflect.TypeOf(b).String())
  • FileExists() -> very little use, drop
  • JSONEq() -> very little use, drop
  • PanicsWithValue() -> very little use, drop
  • Eventually() -> very little use, drop
  • Contains(t, haystack []T, needle T) - very little use, replace with
  • Contains(t, haystack map[K]V, needle K) - very little use, drop
  • Len(t, v, n) -> cannot be implemented as a single function with genericsEqual(t, len(v), n)
  • EqualValues() - Equal(t, TYPE(a), TYPE(b))
  • Fail() -> t.Fatal()

More Repositories

1

chroma

A general purpose syntax highlighter in pure Go
Go
4,182
star
2

gometalinter

DEPRECATED: Use https://github.com/golangci/golangci-lint
Go
3,521
star
3

kingpin

CONTRIBUTIONS ONLY: A Go (golang) command line and flag parser
Go
3,444
star
4

participle

A parser library for Go
Go
3,310
star
5

entityx

EntityX - A fast, type-safe C++ Entity-Component system
C++
2,170
star
6

kong

Kong is a command-line parser for Go
Go
1,825
star
7

voluptuous

CONTRIBUTIONS ONLY: Voluptuous, despite the name, is a Python data validation library.
Python
1,793
star
8

go_serialization_benchmarks

Benchmarks of Go serialization methods
Go
1,527
star
9

jsonschema

Maintenance has moved to https://github.com/invopop/jsonschema
Go
751
star
10

pawk

PAWK - A Python line processor (like AWK)
Python
508
star
11

gozmq

Go (golang) bindings for the 0mq (zmq, zeromq) C API
Go
469
star
12

log4go

Logging package similar to log4j for the Go programming language
Go
309
star
13

ondir

OnDir is a small program to automate tasks specific to certain directories
C
195
star
14

mph

Minimal Perfect Hashing for Go
Go
165
star
15

repr

Python's repr() for Go
Go
154
star
16

importmagic

A Python library for finding unresolved symbols in Python code, and the corresponding imports
Python
120
star
17

units

Helpful unit multipliers and functions for Go
Go
119
star
18

gorx

A package and tool providing Reactive eXtensions for Go.
Go
94
star
19

devtodo2

DevTodo the Second
Go
89
star
20

template

Fork of Go's text/template adding newline elision
Go
56
star
21

binary

General purpose binary encoder/decoder
Go
47
star
22

SublimeLinter-contrib-gometalinter

SublimeLinter plugin for gometalinter
Python
47
star
23

hcl

Parsing, encoding and decoding of HCL to and from Go types and an AST.
Go
45
star
24

localcache

Local file-based atomic cache manager
Go
41
star
25

gobundle

DEPRECATED: I recommend https://github.com/GeertJohan/go.rice
Go
39
star
26

geoip

A pure Go interface to the free MaxMind GeoIP database
Go
38
star
27

unsafeslice

Unsafe zero-copy slice casts for Go
Go
37
star
28

SublimePythonImportMagic

This Sublime Text 2 plugin attempts to automatically manage Python imports.
Python
33
star
29

inject

Guice-ish dependency injection for Go.
Go
31
star
30

sequel

Sequel - A Go <-> SQL mapping package
Go
26
star
31

multiplex

This Go package multiplexes streams over a single underlying transport io.ReadWriteCloser.
Go
25
star
32

tuplespace

A RESTful tuple space server
Go
21
star
33

mango-kong

Mango (man page generator) integration for Kong
Go
20
star
34

langx

Language experimentation.
Go
20
star
35

atomic

Type-safe atomic values for Go
Go
19
star
36

go-rpcgen

Generates Go RPC server and client boilerplate for interfaces.
Go
17
star
37

go-check-sumtype

A simple utility for running exhaustiveness checks on Go "sum types."
Go
17
star
38

SublimeFoldPythonDocstrings

Automatically folds Python docstrings longer than 1 line.
Python
16
star
39

oink

Oink is a Python to Javascript translator.
Python
15
star
40

protobuf

A Protobuf IDL parser for Go
Go
13
star
41

entityx_python

Python bindings for EntityX
C++
13
star
42

kong-yaml

Go
13
star
43

colour

Quake-style colour formatting for Unix terminals
Go
12
star
44

shreq

This utility verifies all commands used by a shell script against an allow list
Go
11
star
45

app

Modular application framework for Go.
Go
11
star
46

kdl

Go parser for KDL
Go
10
star
47

bit

Bit - A simple yet powerful build tool
Go
10
star
48

vheap

Fast, persistent, mmapped, virtual heap.
Go
8
star
49

types

Useful generic types for Go
Go
8
star
50

errors

A simple errors package for Go
Go
8
star
51

rapid

RESTful API Daemons (and Clients) for Go
Go
7
star
52

kong-hcl

Go
7
star
53

genh

genh is an opinionated tool for generating request-handler boilerplate for Go
Go
7
star
54

ReactiveDataStructures

Reactive data structures for Swift based on RxSwift
Swift
7
star
55

lunatic-go

Lunatic bindings for (Tiny)Go
Go
6
star
56

chrysalis

Chrysalis - Source to a 2D Platformer from 1994
C++
6
star
57

dotfiles

My dotfiles.
Vim Script
6
star
58

bootstrap

Go application bootstrapping
Go
6
star
59

devtodo

DevTodo (legacy)
C
6
star
60

waffle

Waffle - A Dependency-Injection-based application framework for Python
Python
5
star
61

waitgroup

Like sync.WaitGroup and ergroup.Group had a baby.
Go
5
star
62

esfmt

An opinionated, zero-configuration formatter for ES/TS/ESX/TSX
Go
5
star
63

flam

flam /flæm/ noun, verb, flammed, flam⋅ming. Informal. –noun 1. a deception or trick. 2. a falsehood; lie. –verb (used with object), verb (used without object) 3. to deceive; delude; cheat.
Python
5
star
64

expr

Runtime evaluation of Go-like expressions
Go
4
star
65

simplenotefs

simplenotefs
Python
4
star
66

concurrency

Types and functions for managing concurrency in Go.
Go
4
star
67

porpoise

Porpoise - A Redis-based analytics framework
Python
4
star
68

replaylog

A type safe implementation of an op replay log
Go
3
star
69

cly

A Python module for adding powerful text-based consoles to your application.
Python
3
star
70

SublimeLinter-contrib-errcheck

SublimeLinter integration for the Go errcheck utility
Python
3
star
71

wit-go

A partial WIT parser and code generator for Go
Go
3
star
72

SublimeLinter-contrib-golang-cilint

DEPRECATED: Use https://github.com/cixtor/SublimeLinter-golangcilint
Python
2
star
73

aspect

Lightweight Aspect-oriented Module for Python
Python
2
star
74

Cache.swift

A flexible RAM and disk-backed cache for Swift
Swift
2
star
75

gptcc

Add Conventional Commits to commit messages using ChatGPT
Shell
2
star
76

WaveGrowl.app

Wave notifications via Growl on Mac
Python
2
star
77

cut

Core Utilities - A set of core utility classes for Python.
Python
2
star
78

kong-toml

Kong configuration loader for TOML
Shell
2
star
79

rest

Go
2
star
80

prototemplate

Process Protocol Buffer definitions with text templates and JavaScript functions
Go
2
star
81

webservice

A webservice dispatcher for Go
Go
1
star
82

pathways

Pathways - An opinionated RESTful web service framework for Go
Go
1
star
83

cktphotography.com

Christine Knight Thomas Photography (website)
JavaScript
1
star
84

psmap

Persistent static maps for Go
Go
1
star