package matchers_test import ( "encoding/json" . "github.com/onsi/ginkgo" . "github.com/onsi/gomega" . "github.com/onsi/gomega/matchers" ) var _ = Describe("MatchJSONMatcher", func() { Context("When passed stringifiables", func() { It("should succeed if the JSON matches", func() { Expect("{}").Should(MatchJSON("{}")) Expect(`{"a":1}`).Should(MatchJSON(`{"a":1}`)) Expect(`{ "a":1 }`).Should(MatchJSON(`{"a":1}`)) Expect(`{"a":1, "b":2}`).Should(MatchJSON(`{"b":2, "a":1}`)) Expect(`{"a":1}`).ShouldNot(MatchJSON(`{"b":2, "a":1}`)) Expect(`{"a":"a", "b":"b"}`).ShouldNot(MatchJSON(`{"a":"a", "b":"b", "c":"c"}`)) Expect(`{"a":"a", "b":"b", "c":"c"}`).ShouldNot(MatchJSON(`{"a":"a", "b":"b"}`)) Expect(`{"a":null, "b":null}`).ShouldNot(MatchJSON(`{"c":"c", "d":"d"}`)) Expect(`{"a":null, "b":null, "c":null}`).ShouldNot(MatchJSON(`{"a":null, "b":null, "d":null}`)) }) It("should work with byte arrays", func() { Expect([]byte("{}")).Should(MatchJSON([]byte("{}"))) Expect("{}").Should(MatchJSON([]byte("{}"))) Expect([]byte("{}")).Should(MatchJSON("{}")) }) It("should work with json.RawMessage", func() { Expect([]byte(`{"a": 1}`)).Should(MatchJSON(json.RawMessage(`{"a": 1}`))) }) }) When("a key mismatch is found", func() { It("reports the first found mismatch", func() { subject := MatchJSONMatcher{JSONToMatch: `5`} actual := `7` subject.Match(actual) failureMessage := subject.FailureMessage(`7`) Expect(failureMessage).ToNot(ContainSubstring("first mismatched key")) subject = MatchJSONMatcher{JSONToMatch: `{"a": 1, "b.g": {"c": 2, "1": ["hello", "see ya"]}}`} actual = `{"a": 1, "b.g": {"c": 2, "1": ["hello", "goodbye"]}}` subject.Match(actual) failureMessage = subject.FailureMessage(actual) Expect(failureMessage).To(ContainSubstring(`first mismatched key: "b.g"."1"[1]`)) }) }) When("the expected is not valid JSON", func() { It("should error and explain why", func() { success, err := (&MatchJSONMatcher{JSONToMatch: `{}`}).Match(`oops`) Expect(success).Should(BeFalse()) Expect(err).Should(HaveOccurred()) Expect(err.Error()).Should(ContainSubstring("Actual 'oops' should be valid JSON")) }) }) When("the actual is not valid JSON", func() { It("should error and explain why", func() { success, err := (&MatchJSONMatcher{JSONToMatch: `oops`}).Match(`{}`) Expect(success).Should(BeFalse()) Expect(err).Should(HaveOccurred()) Expect(err.Error()).Should(ContainSubstring("Expected 'oops' should be valid JSON")) }) }) When("the expected is neither a string nor a stringer nor a byte array", func() { It("should error", func() { success, err := (&MatchJSONMatcher{JSONToMatch: 2}).Match("{}") Expect(success).Should(BeFalse()) Expect(err).Should(HaveOccurred()) Expect(err.Error()).Should(ContainSubstring("MatchJSONMatcher matcher requires a string, stringer, or []byte. Got expected:\n : 2")) success, err = (&MatchJSONMatcher{JSONToMatch: nil}).Match("{}") Expect(success).Should(BeFalse()) Expect(err).Should(HaveOccurred()) Expect(err.Error()).Should(ContainSubstring("MatchJSONMatcher matcher requires a string, stringer, or []byte. Got expected:\n : nil")) }) }) When("the actual is neither a string nor a stringer nor a byte array", func() { It("should error", func() { success, err := (&MatchJSONMatcher{JSONToMatch: "{}"}).Match(2) Expect(success).Should(BeFalse()) Expect(err).Should(HaveOccurred()) Expect(err.Error()).Should(ContainSubstring("MatchJSONMatcher matcher requires a string, stringer, or []byte. Got actual:\n : 2")) success, err = (&MatchJSONMatcher{JSONToMatch: "{}"}).Match(nil) Expect(success).Should(BeFalse()) Expect(err).Should(HaveOccurred()) Expect(err.Error()).Should(ContainSubstring("MatchJSONMatcher matcher requires a string, stringer, or []byte. Got actual:\n : nil")) }) }) It("shows negated failure message", func() { failuresMessages := InterceptGomegaFailures(func() { Expect("1").ToNot(MatchJSON("1")) }) Expect(failuresMessages).To(Equal([]string{"Expected\n : 1\nnot to match JSON of\n : 1"})) }) })