peridot/vendor/github.com/stretchr/testify/require/doc.go

30 lines
856 B
Go
Raw Normal View History

2022-07-07 20:11:50 +00:00
// Package require implements the same assertions as the `assert` package but
// stops test execution when a test fails.
//
// # Example Usage
2022-07-07 20:11:50 +00:00
//
// The following is a complete example using require in a standard test function:
//
// import (
// "testing"
// "github.com/stretchr/testify/require"
// )
2022-07-07 20:11:50 +00:00
//
// func TestSomething(t *testing.T) {
2022-07-07 20:11:50 +00:00
//
// var a string = "Hello"
// var b string = "Hello"
2022-07-07 20:11:50 +00:00
//
// require.Equal(t, a, b, "The two words should be the same.")
2022-07-07 20:11:50 +00:00
//
// }
//
// # Assertions
2022-07-07 20:11:50 +00:00
//
// The `require` package have same global functions as in the `assert` package,
// but instead of returning a boolean result they call `t.FailNow()`.
//
// Every assertion function also takes an optional string message as the final argument,
// allowing custom error messages to be appended to the message the assertion method outputs.
package require