prefer NoError/Error over Nil/NotNil #12271

lunny · 2020-07-19T01:09:55Z

trashhalo commented

2020-07-19 01:09:55 +00:00

(Migrated from github.com)

replaces calls to require/assert Nil/NotNil to NoError/Error

NoError is for asserting no error was return
Error is for asserting an error was returned

Why is it important?

return Fail(t, fmt.Sprintf("Received unexpected error:\n%+v", err), msgAndArgs...)

return Fail(t, "An error is expected but got nil.", msgAndArgs...)

When these fail their message explicitly calls out that we were or were not expecting an error. This communicates the intent of the assertion.

replaces calls to require/assert Nil/NotNil to NoError/Error [NoError](https://godoc.org/github.com/stretchr/testify/require#NoError) is for asserting no error was return [Error](https://godoc.org/github.com/stretchr/testify/require#Error) is for asserting an error was returned ## Why is it important? ```golang return Fail(t, fmt.Sprintf("Received unexpected error:\n%+v", err), msgAndArgs...) ``` ```golang return Fail(t, "An error is expected but got nil.", msgAndArgs...) ``` When these fail their message explicitly calls out that we were or were not expecting an error. This communicates the intent of the assertion.