SubSetOf
func SubSetOf(expectedItems ...any) TestDeep
SubSetOf operator compares the contents of an array or a slice (or a
pointer on array/slice) ignoring duplicates and without taking care
of the order of items.
During a match, each array/slice item should be matched by an
expected item to succeed. But some expected items can be missing
from the compared array/slice.
td.Cmp(t, []int{1, 1}, td.SubSetOf(1, 2)) // succeeds
td.Cmp(t, []int{1, 1, 2}, td.SubSetOf(1, 3)) // fails, 2 is an extra item
// works with slices/arrays of any type
td.Cmp(t, personSlice, td.SubSetOf(
Person{Name: "Bob", Age: 32},
Person{Name: "Alice", Age: 26},
))
To flatten a non-[]any slice/array, use Flatten function
and so avoid boring and inefficient copies:
expected := []int{2, 1}
td.Cmp(t, []int{1, 1}, td.SubSetOf(td.Flatten(expected))) // succeeds
// = td.Cmp(t, []int{1, 1}, td.SubSetOf(2, 1))
exp1 := []int{2, 1}
exp2 := []int{5, 8}
td.Cmp(t, []int{1, 5, 1, 3, 3},
td.SubSetOf(td.Flatten(exp1), 3, td.Flatten(exp2))) // succeeds
// = td.Cmp(t, []int{1, 5, 1, 3, 3}, td.SubSetOf(2, 1, 3, 5, 8))
TypeBehind method can return a non-nil reflect.Type if all items
known non-interface types are equal, or if only interface types
are found (mostly issued from Isa) and they are equal.
See also NotAny, Set and SuperSetOf.
See also SubSetOf godoc.
Example
Base example
t := &testing.T{}
got := []int{1, 3, 5, 8, 8, 1, 2}
// Matches as all items are expected, ignoring duplicates
ok := td.Cmp(t, got, td.SubSetOf(1, 2, 3, 4, 5, 6, 7, 8),
"checks at least all items are present, in any order, ignoring duplicates")
fmt.Println(ok)
// Tries its best to not raise an error when a value can be matched
// by several SubSetOf entries
ok = td.Cmp(t, got, td.SubSetOf(td.Between(1, 4), 3, td.Between(2, 10), td.Gt(100)),
"checks at least all items are present, in any order, ignoring duplicates")
fmt.Println(ok)
// When expected is already a non-[]any slice, it cannot be
// flattened directly using expected... without copying it to a new
// []any slice, then use td.Flatten!
expected := []int{1, 2, 3, 4, 5, 6, 7, 8}
ok = td.Cmp(t, got, td.SubSetOf(td.Flatten(expected)),
"checks at least all expected items are present, in any order, ignoring duplicates")
fmt.Println(ok)
// Output:
// true
// true
// true
CmpSubSetOf shortcut
func CmpSubSetOf(t TestingT, got any, expectedItems []any, args ...any) bool
CmpSubSetOf is a shortcut for:
td.Cmp(t, got, td.SubSetOf(expectedItems...), args...)
See above for details.
Returns true if the test is OK, false if it fails.
If t is a *T then its Config field is inherited.
args… are optional and allow to name the test. This name is
used in case of failure to qualify the test. If len(args) > 1 and
the first item of args is a string and contains a ‘%’ rune then
fmt.Fprintf is used to compose the name, else args are passed to
fmt.Fprint. Do not forget it is the name of the test, not the
reason of a potential failure.
See also CmpSubSetOf godoc.
Example
Base example
t := &testing.T{}
got := []int{1, 3, 5, 8, 8, 1, 2}
// Matches as all items are expected, ignoring duplicates
ok := td.CmpSubSetOf(t, got, []any{1, 2, 3, 4, 5, 6, 7, 8},
"checks at least all items are present, in any order, ignoring duplicates")
fmt.Println(ok)
// Tries its best to not raise an error when a value can be matched
// by several SubSetOf entries
ok = td.CmpSubSetOf(t, got, []any{td.Between(1, 4), 3, td.Between(2, 10), td.Gt(100)},
"checks at least all items are present, in any order, ignoring duplicates")
fmt.Println(ok)
// When expected is already a non-[]any slice, it cannot be
// flattened directly using expected... without copying it to a new
// []any slice, then use td.Flatten!
expected := []int{1, 2, 3, 4, 5, 6, 7, 8}
ok = td.CmpSubSetOf(t, got, []any{td.Flatten(expected)},
"checks at least all expected items are present, in any order, ignoring duplicates")
fmt.Println(ok)
// Output:
// true
// true
// true
T.SubSetOf shortcut
func (t *T) SubSetOf(got any, expectedItems []any, args ...any) bool
SubSetOf is a shortcut for:
t.Cmp(got, td.SubSetOf(expectedItems...), args...)
See above for details.
Returns true if the test is OK, false if it fails.
args… are optional and allow to name the test. This name is
used in case of failure to qualify the test. If len(args) > 1 and
the first item of args is a string and contains a ‘%’ rune then
fmt.Fprintf is used to compose the name, else args are passed to
fmt.Fprint. Do not forget it is the name of the test, not the
reason of a potential failure.
See also T.SubSetOf godoc.
Example
Base example
t := td.NewT(&testing.T{})
got := []int{1, 3, 5, 8, 8, 1, 2}
// Matches as all items are expected, ignoring duplicates
ok := t.SubSetOf(got, []any{1, 2, 3, 4, 5, 6, 7, 8},
"checks at least all items are present, in any order, ignoring duplicates")
fmt.Println(ok)
// Tries its best to not raise an error when a value can be matched
// by several SubSetOf entries
ok = t.SubSetOf(got, []any{td.Between(1, 4), 3, td.Between(2, 10), td.Gt(100)},
"checks at least all items are present, in any order, ignoring duplicates")
fmt.Println(ok)
// When expected is already a non-[]any slice, it cannot be
// flattened directly using expected... without copying it to a new
// []any slice, then use td.Flatten!
expected := []int{1, 2, 3, 4, 5, 6, 7, 8}
ok = t.SubSetOf(got, []any{td.Flatten(expected)},
"checks at least all expected items are present, in any order, ignoring duplicates")
fmt.Println(ok)
// Output:
// true
// true
// true