Collection
Asserting Slices And Maps
Assertions
All links point to https://pkg.go.dev/github.com/go-openapi/testify/v2
This domain exposes 19 functionalities. Generic assertions are marked with a .
- Contains
- ElementsMatch
- ElementsMatchT[E comparable]
- Len
- MapContainsT[Map ~map[K]V, K comparable, V any]
- MapNotContainsT[Map ~map[K]V, K comparable, V any]
- NotContains
- NotElementsMatch
- NotElementsMatchT[E comparable]
- NotSubset
- SeqContainsT[E comparable]
- SeqNotContainsT[E comparable]
- SliceContainsT[Slice ~[]E, E comparable]
- SliceNotContainsT[Slice ~[]E, E comparable]
- SliceNotSubsetT[Slice ~[]E, E comparable]
- SliceSubsetT[Slice ~[]E, E comparable]
- StringContainsT[ADoc, EDoc Text]
- StringNotContainsT[ADoc, EDoc Text]
- Subset
Contains
Contains asserts that the specified string, list(array, slice…) or map contains the specified substring or element.
| Signature | Usage |
|---|---|
assert.Contains(t T, s any, contains any, msgAndArgs ...any) bool | package-level function |
assert.Containsf(t T, s any, contains any, msg string, args ...any) bool | formatted variant |
assert.(*Assertions).Contains(s any, contains any) bool | method variant |
assert.(*Assertions).Containsf(s any, contains any, msg string, args ..any) | method formatted variant |
| Signature | Usage |
|---|---|
require.Contains(t T, s any, contains any, msgAndArgs ...any) bool | package-level function |
require.Containsf(t T, s any, contains any, msg string, args ...any) bool | formatted variant |
require.(*Assertions).Contains(s any, contains any) bool | method variant |
require.(*Assertions).Containsf(s any, contains any, msg string, args ..any) | method formatted variant |
| Signature | Usage |
|---|---|
assertions.Contains(t T, s any, contains any, msgAndArgs ...any) bool | internal implementation |
Source: github.com/go-openapi/testify/v2/internal/assertions#Contains
ElementsMatch
ElementsMatch asserts that the specified listA(array, slice…) is equal to specified listB(array, slice…) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should match.
| Signature | Usage |
|---|---|
assert.ElementsMatch(t T, listA any, listB any, msgAndArgs ...any) (ok bool) | package-level function |
assert.ElementsMatchf(t T, listA any, listB any, msg string, args ...any) (ok bool) | formatted variant |
assert.(*Assertions).ElementsMatch(listA any, listB any) (ok bool) | method variant |
assert.(*Assertions).ElementsMatchf(listA any, listB any, msg string, args ..any) | method formatted variant |
| Signature | Usage |
|---|---|
require.ElementsMatch(t T, listA any, listB any, msgAndArgs ...any) (ok bool) | package-level function |
require.ElementsMatchf(t T, listA any, listB any, msg string, args ...any) (ok bool) | formatted variant |
require.(*Assertions).ElementsMatch(listA any, listB any) (ok bool) | method variant |
require.(*Assertions).ElementsMatchf(listA any, listB any, msg string, args ..any) | method formatted variant |
| Signature | Usage |
|---|---|
assertions.ElementsMatch(t T, listA any, listB any, msgAndArgs ...any) (ok bool) | internal implementation |
Source: github.com/go-openapi/testify/v2/internal/assertions#ElementsMatch
ElementsMatchT[E comparable]
ElementsMatchT asserts that the specified listA(array, slice…) is equal to specified listB(array, slice…) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should match.
| Signature | Usage |
|---|---|
assert.ElementsMatchT[E comparable](t T, listA []E, listB []E, msgAndArgs ...any) bool | package-level function |
assert.ElementsMatchTf[E comparable](t T, listA []E, listB []E, msg string, args ...any) bool | formatted variant |
| Signature | Usage |
|---|---|
require.ElementsMatchT[E comparable](t T, listA []E, listB []E, msgAndArgs ...any) bool | package-level function |
require.ElementsMatchTf[E comparable](t T, listA []E, listB []E, msg string, args ...any) bool | formatted variant |
| Signature | Usage |
|---|---|
assertions.ElementsMatchT[E comparable](t T, listA []E, listB []E, msgAndArgs ...any) bool | internal implementation |
Source: github.com/go-openapi/testify/v2/internal/assertions#ElementsMatchT
Len
Len asserts that the specified object has specific length.
Len also fails if the object has a type that len() does not accept.
The asserted object can be a string, a slice, a map, an array, pointer to array or a channel.
| Signature | Usage |
|---|---|
assert.Len(t T, object any, length int, msgAndArgs ...any) bool | package-level function |
assert.Lenf(t T, object any, length int, msg string, args ...any) bool | formatted variant |
assert.(*Assertions).Len(object any, length int) bool | method variant |
assert.(*Assertions).Lenf(object any, length int, msg string, args ..any) | method formatted variant |
| Signature | Usage |
|---|---|
require.Len(t T, object any, length int, msgAndArgs ...any) bool | package-level function |
require.Lenf(t T, object any, length int, msg string, args ...any) bool | formatted variant |
require.(*Assertions).Len(object any, length int) bool | method variant |
require.(*Assertions).Lenf(object any, length int, msg string, args ..any) | method formatted variant |
| Signature | Usage |
|---|---|
assertions.Len(t T, object any, length int, msgAndArgs ...any) bool | internal implementation |
Source: github.com/go-openapi/testify/v2/internal/assertions#Len
Note
(proposal for enhancement) this does not currently support iterators, or collection objects that have a Len() method.
MapContainsT[Map ~map[K]V, K comparable, V any]
MapContainsT asserts that the specified map contains a key.
Go native comparable types are explained there: comparable-types.
| Signature | Usage |
|---|---|
assert.MapContainsT[Map ~map[K]V, K comparable, V any](t T, m Map, key K, msgAndArgs ...any) bool | package-level function |
assert.MapContainsTf[Map ~map[K]V, K comparable, V any](t T, m Map, key K, msg string, args ...any) bool | formatted variant |
| Signature | Usage |
|---|---|
require.MapContainsT[Map ~map[K]V, K comparable, V any](t T, m Map, key K, msgAndArgs ...any) bool | package-level function |
require.MapContainsTf[Map ~map[K]V, K comparable, V any](t T, m Map, key K, msg string, args ...any) bool | formatted variant |
| Signature | Usage |
|---|---|
assertions.MapContainsT[Map ~map[K]V, K comparable, V any](t T, m Map, key K, msgAndArgs ...any) bool | internal implementation |
Source: github.com/go-openapi/testify/v2/internal/assertions#MapContainsT
MapNotContainsT[Map ~map[K]V, K comparable, V any]
MapNotContainsT asserts that the specified map does not contain a key.
| Signature | Usage |
|---|---|
assert.MapNotContainsT[Map ~map[K]V, K comparable, V any](t T, m Map, key K, msgAndArgs ...any) bool | package-level function |
assert.MapNotContainsTf[Map ~map[K]V, K comparable, V any](t T, m Map, key K, msg string, args ...any) bool | formatted variant |
| Signature | Usage |
|---|---|
require.MapNotContainsT[Map ~map[K]V, K comparable, V any](t T, m Map, key K, msgAndArgs ...any) bool | package-level function |
require.MapNotContainsTf[Map ~map[K]V, K comparable, V any](t T, m Map, key K, msg string, args ...any) bool | formatted variant |
| Signature | Usage |
|---|---|
assertions.MapNotContainsT[Map ~map[K]V, K comparable, V any](t T, m Map, key K, msgAndArgs ...any) bool | internal implementation |
Source: github.com/go-openapi/testify/v2/internal/assertions#MapNotContainsT
NotContains
NotContains asserts that the specified string, list(array, slice…) or map does NOT contain the specified substring or element.
| Signature | Usage |
|---|---|
assert.NotContains(t T, s any, contains any, msgAndArgs ...any) bool | package-level function |
assert.NotContainsf(t T, s any, contains any, msg string, args ...any) bool | formatted variant |
assert.(*Assertions).NotContains(s any, contains any) bool | method variant |
assert.(*Assertions).NotContainsf(s any, contains any, msg string, args ..any) | method formatted variant |
| Signature | Usage |
|---|---|
require.NotContains(t T, s any, contains any, msgAndArgs ...any) bool | package-level function |
require.NotContainsf(t T, s any, contains any, msg string, args ...any) bool | formatted variant |
require.(*Assertions).NotContains(s any, contains any) bool | method variant |
require.(*Assertions).NotContainsf(s any, contains any, msg string, args ..any) | method formatted variant |
| Signature | Usage |
|---|---|
assertions.NotContains(t T, s any, contains any, msgAndArgs ...any) bool | internal implementation |
Source: github.com/go-openapi/testify/v2/internal/assertions#NotContains
NotElementsMatch
NotElementsMatch asserts that the specified listA(array, slice…) is NOT equal to specified listB(array, slice…) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should not match. This is an inverse of ElementsMatch.
| Signature | Usage |
|---|---|
assert.NotElementsMatch(t T, listA any, listB any, msgAndArgs ...any) (ok bool) | package-level function |
assert.NotElementsMatchf(t T, listA any, listB any, msg string, args ...any) (ok bool) | formatted variant |
assert.(*Assertions).NotElementsMatch(listA any, listB any) (ok bool) | method variant |
assert.(*Assertions).NotElementsMatchf(listA any, listB any, msg string, args ..any) | method formatted variant |
| Signature | Usage |
|---|---|
require.NotElementsMatch(t T, listA any, listB any, msgAndArgs ...any) (ok bool) | package-level function |
require.NotElementsMatchf(t T, listA any, listB any, msg string, args ...any) (ok bool) | formatted variant |
require.(*Assertions).NotElementsMatch(listA any, listB any) (ok bool) | method variant |
require.(*Assertions).NotElementsMatchf(listA any, listB any, msg string, args ..any) | method formatted variant |
| Signature | Usage |
|---|---|
assertions.NotElementsMatch(t T, listA any, listB any, msgAndArgs ...any) (ok bool) | internal implementation |
Source: github.com/go-openapi/testify/v2/internal/assertions#NotElementsMatch
NotElementsMatchT[E comparable]
NotElementsMatchT asserts that the specified listA(array, slice…) is NOT equal to specified listB(array, slice…) ignoring the order of the elements. If there are duplicate elements, the number of appearances of each of them in both lists should not match. This is an inverse of ElementsMatch.
| Signature | Usage |
|---|---|
assert.NotElementsMatchT[E comparable](t T, listA []E, listB []E, msgAndArgs ...any) (ok bool) | package-level function |
assert.NotElementsMatchTf[E comparable](t T, listA []E, listB []E, msg string, args ...any) (ok bool) | formatted variant |
| Signature | Usage |
|---|---|
require.NotElementsMatchT[E comparable](t T, listA []E, listB []E, msgAndArgs ...any) (ok bool) | package-level function |
require.NotElementsMatchTf[E comparable](t T, listA []E, listB []E, msg string, args ...any) (ok bool) | formatted variant |
| Signature | Usage |
|---|---|
assertions.NotElementsMatchT[E comparable](t T, listA []E, listB []E, msgAndArgs ...any) (ok bool) | internal implementation |
Source: github.com/go-openapi/testify/v2/internal/assertions#NotElementsMatchT
NotSubset
NotSubset asserts that the list (array, slice, or map) does NOT contain all elements given in the subset (array, slice, or map). Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated.
| Signature | Usage |
|---|---|
assert.NotSubset(t T, list any, subset any, msgAndArgs ...any) (ok bool) | package-level function |
assert.NotSubsetf(t T, list any, subset any, msg string, args ...any) (ok bool) | formatted variant |
assert.(*Assertions).NotSubset(list any, subset any) (ok bool) | method variant |
assert.(*Assertions).NotSubsetf(list any, subset any, msg string, args ..any) | method formatted variant |
| Signature | Usage |
|---|---|
require.NotSubset(t T, list any, subset any, msgAndArgs ...any) (ok bool) | package-level function |
require.NotSubsetf(t T, list any, subset any, msg string, args ...any) (ok bool) | formatted variant |
require.(*Assertions).NotSubset(list any, subset any) (ok bool) | method variant |
require.(*Assertions).NotSubsetf(list any, subset any, msg string, args ..any) | method formatted variant |
| Signature | Usage |
|---|---|
assertions.NotSubset(t T, list any, subset any, msgAndArgs ...any) (ok bool) | internal implementation |
Source: github.com/go-openapi/testify/v2/internal/assertions#NotSubset
SeqContainsT[E comparable]
SeqContainsT asserts that the specified iterator contains a comparable element.
The sequence may not be consumed entirely: the iteration stops as soon as the specified element is found.
Go native comparable types are explained there: comparable-types.
| Signature | Usage |
|---|---|
assert.SeqContainsT[E comparable](t T, iter iter.Seq[E], element E, msgAndArgs ...any) bool | package-level function |
assert.SeqContainsTf[E comparable](t T, iter iter.Seq[E], element E, msg string, args ...any) bool | formatted variant |
| Signature | Usage |
|---|---|
require.SeqContainsT[E comparable](t T, iter iter.Seq[E], element E, msgAndArgs ...any) bool | package-level function |
require.SeqContainsTf[E comparable](t T, iter iter.Seq[E], element E, msg string, args ...any) bool | formatted variant |
| Signature | Usage |
|---|---|
assertions.SeqContainsT[E comparable](t T, iter iter.Seq[E], element E, msgAndArgs ...any) bool | internal implementation |
Source: github.com/go-openapi/testify/v2/internal/assertions#SeqContainsT
SeqNotContainsT[E comparable]
SeqNotContainsT asserts that the specified iterator does not contain a comparable element.
See SeqContainsT.
| Signature | Usage |
|---|---|
assert.SeqNotContainsT[E comparable](t T, iter iter.Seq[E], element E, msgAndArgs ...any) bool | package-level function |
assert.SeqNotContainsTf[E comparable](t T, iter iter.Seq[E], element E, msg string, args ...any) bool | formatted variant |
| Signature | Usage |
|---|---|
require.SeqNotContainsT[E comparable](t T, iter iter.Seq[E], element E, msgAndArgs ...any) bool | package-level function |
require.SeqNotContainsTf[E comparable](t T, iter iter.Seq[E], element E, msg string, args ...any) bool | formatted variant |
| Signature | Usage |
|---|---|
assertions.SeqNotContainsT[E comparable](t T, iter iter.Seq[E], element E, msgAndArgs ...any) bool | internal implementation |
Source: github.com/go-openapi/testify/v2/internal/assertions#SeqNotContainsT
SliceContainsT[Slice ~[]E, E comparable]
SliceContainsT asserts that the specified slice contains a comparable element.
Go native comparable types are explained there: comparable-types.
| Signature | Usage |
|---|---|
assert.SliceContainsT[Slice ~[]E, E comparable](t T, s Slice, element E, msgAndArgs ...any) bool | package-level function |
assert.SliceContainsTf[Slice ~[]E, E comparable](t T, s Slice, element E, msg string, args ...any) bool | formatted variant |
| Signature | Usage |
|---|---|
require.SliceContainsT[Slice ~[]E, E comparable](t T, s Slice, element E, msgAndArgs ...any) bool | package-level function |
require.SliceContainsTf[Slice ~[]E, E comparable](t T, s Slice, element E, msg string, args ...any) bool | formatted variant |
| Signature | Usage |
|---|---|
assertions.SliceContainsT[Slice ~[]E, E comparable](t T, s Slice, element E, msgAndArgs ...any) bool | internal implementation |
Source: github.com/go-openapi/testify/v2/internal/assertions#SliceContainsT
SliceNotContainsT[Slice ~[]E, E comparable]
SliceNotContainsT asserts that the specified slice does not contain a comparable element.
See SliceContainsT.
| Signature | Usage |
|---|---|
assert.SliceNotContainsT[Slice ~[]E, E comparable](t T, s Slice, element E, msgAndArgs ...any) bool | package-level function |
assert.SliceNotContainsTf[Slice ~[]E, E comparable](t T, s Slice, element E, msg string, args ...any) bool | formatted variant |
| Signature | Usage |
|---|---|
require.SliceNotContainsT[Slice ~[]E, E comparable](t T, s Slice, element E, msgAndArgs ...any) bool | package-level function |
require.SliceNotContainsTf[Slice ~[]E, E comparable](t T, s Slice, element E, msg string, args ...any) bool | formatted variant |
| Signature | Usage |
|---|---|
assertions.SliceNotContainsT[Slice ~[]E, E comparable](t T, s Slice, element E, msgAndArgs ...any) bool | internal implementation |
Source: github.com/go-openapi/testify/v2/internal/assertions#SliceNotContainsT
SliceNotSubsetT[Slice ~[]E, E comparable]
SliceNotSubsetT asserts that a slice of comparable elements does not contain all the elements given in the subset.
| Signature | Usage |
|---|---|
assertions.SliceNotSubsetT[Slice ~[]E, E comparable](t T, list Slice, subset Slice, msgAndArgs ...any) (ok bool) | internal implementation |
Source: github.com/go-openapi/testify/v2/internal/assertions#SliceNotSubsetT
SliceSubsetT[Slice ~[]E, E comparable]
SliceSubsetT asserts that a slice of comparable elements contains all the elements given in the subset.
| Signature | Usage |
|---|---|
assertions.SliceSubsetT[Slice ~[]E, E comparable](t T, list Slice, subset Slice, msgAndArgs ...any) (ok bool) | internal implementation |
Source: github.com/go-openapi/testify/v2/internal/assertions#SliceSubsetT
StringContainsT[ADoc, EDoc Text]
StringContainsT asserts that a string contains the specified substring.
Strings may be go strings or []byte according to the type constraint Text.
| Signature | Usage |
|---|---|
assert.StringContainsT[ADoc, EDoc Text](t T, str ADoc, substring EDoc, msgAndArgs ...any) bool | package-level function |
assert.StringContainsTf[ADoc, EDoc Text](t T, str ADoc, substring EDoc, msg string, args ...any) bool | formatted variant |
| Signature | Usage |
|---|---|
require.StringContainsT[ADoc, EDoc Text](t T, str ADoc, substring EDoc, msgAndArgs ...any) bool | package-level function |
require.StringContainsTf[ADoc, EDoc Text](t T, str ADoc, substring EDoc, msg string, args ...any) bool | formatted variant |
| Signature | Usage |
|---|---|
assertions.StringContainsT[ADoc, EDoc Text](t T, str ADoc, substring EDoc, msgAndArgs ...any) bool | internal implementation |
Source: github.com/go-openapi/testify/v2/internal/assertions#StringContainsT
StringNotContainsT[ADoc, EDoc Text]
StringNotContainsT asserts that a string does not contain the specified substring.
See StringContainsT.
| Signature | Usage |
|---|---|
assert.StringNotContainsT[ADoc, EDoc Text](t T, str ADoc, substring EDoc, msgAndArgs ...any) bool | package-level function |
assert.StringNotContainsTf[ADoc, EDoc Text](t T, str ADoc, substring EDoc, msg string, args ...any) bool | formatted variant |
| Signature | Usage |
|---|---|
require.StringNotContainsT[ADoc, EDoc Text](t T, str ADoc, substring EDoc, msgAndArgs ...any) bool | package-level function |
require.StringNotContainsTf[ADoc, EDoc Text](t T, str ADoc, substring EDoc, msg string, args ...any) bool | formatted variant |
| Signature | Usage |
|---|---|
assertions.StringNotContainsT[ADoc, EDoc Text](t T, str ADoc, substring EDoc, msgAndArgs ...any) bool | internal implementation |
Source: github.com/go-openapi/testify/v2/internal/assertions#StringNotContainsT
Subset
Subset asserts that the list (array, slice, or map) contains all elements given in the subset (array, slice, or map).
Map elements are key-value pairs unless compared with an array or slice where only the map key is evaluated.
nil values are considered as empty sets.
| Signature | Usage |
|---|---|
assert.Subset(t T, list any, subset any, msgAndArgs ...any) (ok bool) | package-level function |
assert.Subsetf(t T, list any, subset any, msg string, args ...any) (ok bool) | formatted variant |
assert.(*Assertions).Subset(list any, subset any) (ok bool) | method variant |
assert.(*Assertions).Subsetf(list any, subset any, msg string, args ..any) | method formatted variant |
| Signature | Usage |
|---|---|
require.Subset(t T, list any, subset any, msgAndArgs ...any) (ok bool) | package-level function |
require.Subsetf(t T, list any, subset any, msg string, args ...any) (ok bool) | formatted variant |
require.(*Assertions).Subset(list any, subset any) (ok bool) | method variant |
require.(*Assertions).Subsetf(list any, subset any, msg string, args ..any) | method formatted variant |
| Signature | Usage |
|---|---|
assertions.Subset(t T, list any, subset any, msgAndArgs ...any) (ok bool) | internal implementation |
Source: github.com/go-openapi/testify/v2/internal/assertions#Subset
Generated with github.com/go-openapi/testify/codegen/v2