SubMapOf

func SubMapOf(model any, expectedEntries ...MapEntries) TestDeep

SubMapOf operator compares the contents of a map against the non-zero values of model (if any) and the values of expectedEntries.

model must be the same type as compared data.

expectedEntries can be omitted, if no TestDeep operators are involved. If expectedEntries contains more than one item, all items are merged before their use, from left to right.

During a match, each map entry should be matched by an expected entry to succeed. But some expected entries can be missing from the compared map.

got := map[string]string{
  "foo": "test",
  "zip": "buzz",
}
td.Cmp(t, got, td.SubMapOf(
  map[string]string{
    "foo": "test",
    "bar": "wizz",
  },
  td.MapEntries{
    "zip": td.HasSuffix("zz"),
  }),
) // succeeds

td.Cmp(t, got, td.SubMapOf(
  map[string]string{
    "bar": "wizz",
  },
  td.MapEntries{
    "zip": td.HasSuffix("zz"),
  }),
) // fails, extra {"foo": "test"} in got

TypeBehind method returns the reflect.Type of model.

See also Map and SuperMapOf.

See also SubMapOf godoc.

Examples

Map example

	t := &testing.T{}

	got := map[string]int{"foo": 12, "bar": 42}

	ok := td.Cmp(t, got,
		td.SubMapOf(map[string]int{"bar": 42}, td.MapEntries{"foo": td.Lt(15), "zip": 666}),
		"checks map %v is included in expected keys/values", got)
	fmt.Println(ok)

	// Output:
	// true

TypedMap example

	t := &testing.T{}

	type MyMap map[string]int

	got := MyMap{"foo": 12, "bar": 42}

	ok := td.Cmp(t, got,
		td.SubMapOf(MyMap{"bar": 42}, td.MapEntries{"foo": td.Lt(15), "zip": 666}),
		"checks typed map %v is included in expected keys/values", got)
	fmt.Println(ok)

	ok = td.Cmp(t, &got,
		td.SubMapOf(&MyMap{"bar": 42}, td.MapEntries{"foo": td.Lt(15), "zip": 666}),
		"checks pointed typed map %v is included in expected keys/values", got)
	fmt.Println(ok)

	// Output:
	// true
	// true

CmpSubMapOf shortcut

func CmpSubMapOf(t TestingT, got, model any, expectedEntries MapEntries, args ...any) bool

CmpSubMapOf is a shortcut for:

td.Cmp(t, got, td.SubMapOf(model, expectedEntries), args...)

See above for details.

SubMapOf optional parameter expectedEntries is here mandatory. nil value should be passed to mimic its absence in original SubMapOf call.

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 CmpSubMapOf godoc.

Examples

Map example

	t := &testing.T{}

	got := map[string]int{"foo": 12, "bar": 42}

	ok := td.CmpSubMapOf(t, got, map[string]int{"bar": 42}, td.MapEntries{"foo": td.Lt(15), "zip": 666},
		"checks map %v is included in expected keys/values", got)
	fmt.Println(ok)

	// Output:
	// true

TypedMap example

	t := &testing.T{}

	type MyMap map[string]int

	got := MyMap{"foo": 12, "bar": 42}

	ok := td.CmpSubMapOf(t, got, MyMap{"bar": 42}, td.MapEntries{"foo": td.Lt(15), "zip": 666},
		"checks typed map %v is included in expected keys/values", got)
	fmt.Println(ok)

	ok = td.CmpSubMapOf(t, &got, &MyMap{"bar": 42}, td.MapEntries{"foo": td.Lt(15), "zip": 666},
		"checks pointed typed map %v is included in expected keys/values", got)
	fmt.Println(ok)

	// Output:
	// true
	// true

T.SubMapOf shortcut

func (t *T) SubMapOf(got, model any, expectedEntries MapEntries, args ...any) bool

SubMapOf is a shortcut for:

t.Cmp(got, td.SubMapOf(model, expectedEntries), args...)

See above for details.

SubMapOf optional parameter expectedEntries is here mandatory. nil value should be passed to mimic its absence in original SubMapOf call.

Returns true if the test is OK, false if it fails.

See also T.SubMapOf godoc.

Examples

Map example

	t := td.NewT(&testing.T{})

	got := map[string]int{"foo": 12, "bar": 42}

	ok := t.SubMapOf(got, map[string]int{"bar": 42}, td.MapEntries{"foo": td.Lt(15), "zip": 666},
		"checks map %v is included in expected keys/values", got)
	fmt.Println(ok)

	// Output:
	// true

TypedMap example

	t := td.NewT(&testing.T{})

	type MyMap map[string]int

	got := MyMap{"foo": 12, "bar": 42}

	ok := t.SubMapOf(got, MyMap{"bar": 42}, td.MapEntries{"foo": td.Lt(15), "zip": 666},
		"checks typed map %v is included in expected keys/values", got)
	fmt.Println(ok)

	ok = t.SubMapOf(&got, &MyMap{"bar": 42}, td.MapEntries{"foo": td.Lt(15), "zip": 666},
		"checks pointed typed map %v is included in expected keys/values", got)
	fmt.Println(ok)

	// Output:
	// true
	// true