aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/onsi/gomega/internal/assertion/assertion_test.go
blob: c03b7a320ce3c67bdd53ccba0a3a61342d08a851 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
package assertion_test

import (
	"errors"

	. "github.com/onsi/ginkgo"
	. "github.com/onsi/gomega"
	. "github.com/onsi/gomega/internal/assertion"
	"github.com/onsi/gomega/internal/fakematcher"
)

var _ = Describe("Assertion", func() {
	var (
		a                 *Assertion
		failureMessage    string
		failureCallerSkip int
		matcher           *fakematcher.FakeMatcher
	)

	input := "The thing I'm testing"

	var fakeFailHandler = func(message string, callerSkip ...int) {
		failureMessage = message
		if len(callerSkip) == 1 {
			failureCallerSkip = callerSkip[0]
		}
	}

	BeforeEach(func() {
		matcher = &fakematcher.FakeMatcher{}
		failureMessage = ""
		failureCallerSkip = 0
		a = New(input, fakeFailHandler, 1)
	})

	Context("when called", func() {
		It("should pass the provided input value to the matcher", func() {
			a.Should(matcher)

			Ω(matcher.ReceivedActual).Should(Equal(input))
			matcher.ReceivedActual = ""

			a.ShouldNot(matcher)

			Ω(matcher.ReceivedActual).Should(Equal(input))
			matcher.ReceivedActual = ""

			a.To(matcher)

			Ω(matcher.ReceivedActual).Should(Equal(input))
			matcher.ReceivedActual = ""

			a.ToNot(matcher)

			Ω(matcher.ReceivedActual).Should(Equal(input))
			matcher.ReceivedActual = ""

			a.NotTo(matcher)

			Ω(matcher.ReceivedActual).Should(Equal(input))
		})
	})

	Context("when the matcher succeeds", func() {
		BeforeEach(func() {
			matcher.MatchesToReturn = true
			matcher.ErrToReturn = nil
		})

		Context("and a positive assertion is being made", func() {
			It("should not call the failure callback", func() {
				a.Should(matcher)
				Ω(failureMessage).Should(Equal(""))
			})

			It("should be true", func() {
				Ω(a.Should(matcher)).Should(BeTrue())
			})
		})

		Context("and a negative assertion is being made", func() {
			It("should call the failure callback", func() {
				a.ShouldNot(matcher)
				Ω(failureMessage).Should(Equal("negative: The thing I'm testing"))
				Ω(failureCallerSkip).Should(Equal(3))
			})

			It("should be false", func() {
				Ω(a.ShouldNot(matcher)).Should(BeFalse())
			})
		})
	})

	Context("when the matcher fails", func() {
		BeforeEach(func() {
			matcher.MatchesToReturn = false
			matcher.ErrToReturn = nil
		})

		Context("and a positive assertion is being made", func() {
			It("should call the failure callback", func() {
				a.Should(matcher)
				Ω(failureMessage).Should(Equal("positive: The thing I'm testing"))
				Ω(failureCallerSkip).Should(Equal(3))
			})

			It("should be false", func() {
				Ω(a.Should(matcher)).Should(BeFalse())
			})
		})

		Context("and a negative assertion is being made", func() {
			It("should not call the failure callback", func() {
				a.ShouldNot(matcher)
				Ω(failureMessage).Should(Equal(""))
			})

			It("should be true", func() {
				Ω(a.ShouldNot(matcher)).Should(BeTrue())
			})
		})
	})

	Context("When reporting a failure", func() {
		BeforeEach(func() {
			matcher.MatchesToReturn = false
			matcher.ErrToReturn = nil
		})

		Context("and there is an optional description", func() {
			It("should append the description to the failure message", func() {
				a.Should(matcher, "A description")
				Ω(failureMessage).Should(Equal("A description\npositive: The thing I'm testing"))
				Ω(failureCallerSkip).Should(Equal(3))
			})
		})

		Context("and there are multiple arguments to the optional description", func() {
			It("should append the formatted description to the failure message", func() {
				a.Should(matcher, "A description of [%d]", 3)
				Ω(failureMessage).Should(Equal("A description of [3]\npositive: The thing I'm testing"))
				Ω(failureCallerSkip).Should(Equal(3))
			})
		})
	})

	Context("When the matcher returns an error", func() {
		BeforeEach(func() {
			matcher.ErrToReturn = errors.New("Kaboom!")
		})

		Context("and a positive assertion is being made", func() {
			It("should call the failure callback", func() {
				matcher.MatchesToReturn = true
				a.Should(matcher)
				Ω(failureMessage).Should(Equal("Kaboom!"))
				Ω(failureCallerSkip).Should(Equal(3))
			})
		})

		Context("and a negative assertion is being made", func() {
			It("should call the failure callback", func() {
				matcher.MatchesToReturn = false
				a.ShouldNot(matcher)
				Ω(failureMessage).Should(Equal("Kaboom!"))
				Ω(failureCallerSkip).Should(Equal(3))
			})
		})

		It("should always be false", func() {
			Ω(a.Should(matcher)).Should(BeFalse())
			Ω(a.ShouldNot(matcher)).Should(BeFalse())
		})
	})

	Context("when there are extra parameters", func() {
		It("(a simple example)", func() {
			Ω(func() (string, int, error) {
				return "foo", 0, nil
			}()).Should(Equal("foo"))
		})

		Context("when the parameters are all nil or zero", func() {
			It("should invoke the matcher", func() {
				matcher.MatchesToReturn = true
				matcher.ErrToReturn = nil

				var typedNil []string
				a = New(input, fakeFailHandler, 1, 0, nil, typedNil)

				result := a.Should(matcher)
				Ω(result).Should(BeTrue())
				Ω(matcher.ReceivedActual).Should(Equal(input))

				Ω(failureMessage).Should(BeZero())
			})
		})

		Context("when any of the parameters are not nil or zero", func() {
			It("should call the failure callback", func() {
				matcher.MatchesToReturn = false
				matcher.ErrToReturn = nil

				a = New(input, fakeFailHandler, 1, errors.New("foo"))
				result := a.Should(matcher)
				Ω(result).Should(BeFalse())
				Ω(matcher.ReceivedActual).Should(BeZero(), "The matcher doesn't even get called")
				Ω(failureMessage).Should(ContainSubstring("foo"))
				failureMessage = ""

				a = New(input, fakeFailHandler, 1, nil, 1)
				result = a.ShouldNot(matcher)
				Ω(result).Should(BeFalse())
				Ω(failureMessage).Should(ContainSubstring("1"))
				failureMessage = ""

				a = New(input, fakeFailHandler, 1, nil, 0, []string{"foo"})
				result = a.To(matcher)
				Ω(result).Should(BeFalse())
				Ω(failureMessage).Should(ContainSubstring("foo"))
				failureMessage = ""

				a = New(input, fakeFailHandler, 1, nil, 0, []string{"foo"})
				result = a.ToNot(matcher)
				Ω(result).Should(BeFalse())
				Ω(failureMessage).Should(ContainSubstring("foo"))
				failureMessage = ""

				a = New(input, fakeFailHandler, 1, nil, 0, []string{"foo"})
				result = a.NotTo(matcher)
				Ω(result).Should(BeFalse())
				Ω(failureMessage).Should(ContainSubstring("foo"))
				Ω(failureCallerSkip).Should(Equal(3))
			})
		})
	})

	Context("Making an assertion without a registered fail handler", func() {
		It("should panic", func() {
			defer func() {
				e := recover()
				RegisterFailHandler(Fail)
				if e == nil {
					Fail("expected a panic to have occurred")
				}
			}()

			RegisterFailHandler(nil)
			Ω(true).Should(BeTrue())
		})
	})
})