Skip to content

Return actual in output of field matcher #692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jhr22 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Return actual in output of field matcher #692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 41 additions & 39 deletions gstruct/fields.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,51 +14,53 @@ import (
"github.com/onsi/gomega/types"
)

//MatchAllFields succeeds if every field of a struct matches the field matcher associated with
//it, and every element matcher is matched.
// actual := struct{
// A int
// B []bool
// C string
// }{
// A: 5,
// B: []bool{true, false},
// C: "foo",
// }
// MatchAllFields succeeds if every field of a struct matches the field matcher associated with
// it, and every element matcher is matched.
//
// Expect(actual).To(MatchAllFields(Fields{
// "A": Equal(5),
// "B": ConsistOf(true, false),
// "C": Equal("foo"),
// }))
// actual := struct{
// A int
// B []bool
// C string
// }{
// A: 5,
// B: []bool{true, false},
// C: "foo",
// }
//
// Expect(actual).To(MatchAllFields(Fields{
// "A": Equal(5),
// "B": ConsistOf(true, false),
// "C": Equal("foo"),
// }))
func MatchAllFields(fields Fields) types.GomegaMatcher {
return &FieldsMatcher{
Fields: fields,
}
}

//MatchFields succeeds if each element of a struct matches the field matcher associated with
//it. It can ignore extra fields and/or missing fields.
// actual := struct{
// A int
// B []bool
// C string
// }{
// A: 5,
// B: []bool{true, false},
// C: "foo",
// }
// MatchFields succeeds if each element of a struct matches the field matcher associated with
// it. It can ignore extra fields and/or missing fields.
//
// actual := struct{
// A int
// B []bool
// C string
// }{
// A: 5,
// B: []bool{true, false},
// C: "foo",
// }
//
// Expect(actual).To(MatchFields(IgnoreExtras, Fields{
// "A": Equal(5),
// "B": ConsistOf(true, false),
// }))
// Expect(actual).To(MatchFields(IgnoreMissing, Fields{
// "A": Equal(5),
// "B": ConsistOf(true, false),
// "C": Equal("foo"),
// "D": Equal("extra"),
// }))
// Expect(actual).To(MatchFields(IgnoreExtras, Fields{
// "A": Equal(5),
// "B": ConsistOf(true, false),
// }))
// Expect(actual).To(MatchFields(IgnoreMissing, Fields{
// "A": Equal(5),
// "B": ConsistOf(true, false),
// "C": Equal("foo"),
// "D": Equal("extra"),
// }))
func MatchFields(options Options, fields Fields) types.GomegaMatcher {
return &FieldsMatcher{
Fields: fields,
Expand Down Expand Up @@ -129,7 +131,7 @@ func (m *FieldsMatcher) matchFields(actual interface{}) (errs []error) {
if nesting, ok := matcher.(errorsutil.NestingMatcher); ok {
return errorsutil.AggregateError(nesting.Failures())
}
return errors.New(matcher.FailureMessage(field))
return errors.New(matcher.FailureMessage(actual))
}
return nil
}()
Expand All @@ -152,7 +154,7 @@ func (m *FieldsMatcher) FailureMessage(actual interface{}) (message string) {
for i := range m.failures {
failures[i] = m.failures[i].Error()
}
return format.Message(reflect.TypeOf(actual).Name(),
return format.Message(actual,
fmt.Sprintf("to match fields: {\n%v\n}\n", strings.Join(failures, "\n")))
}

Expand Down
4 changes: 2 additions & 2 deletions gstruct/fields_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,10 @@ var _ = Describe("Struct", func() {
//we do a number of checks to make sure everything's included
m.Match(actual)
Expect(m.FailureMessage(actual)).Should(HavePrefix(
"Expected\n <string>: \nto match fields: {\n",
"Expected\n <struct>: \nto match fields: {\n",
))
Expect(m.FailureMessage(actual)).Should(ContainSubstring(
".A:\n Expected\n <string>: b\n to equal\n <string>: a\n",
".A:\n Expected\n <struct>: b\n to equal\n <string>: a\n",
))
Expect(m.FailureMessage(actual)).Should(ContainSubstring(
"missing expected field B\n",
Expand Down