summaryrefslogtreecommitdiff
path: root/vendor/github.com/onsi/gomega/gbytes/buffer_test.go
blob: 9d4e8279de2889d859683393483e21306af473d5 (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
package gbytes_test

import (
	"io"
	"time"

	. "github.com/onsi/gomega/gbytes"

	"bytes"

	. "github.com/onsi/ginkgo"
	. "github.com/onsi/gomega"
)

type SlowReader struct {
	R io.Reader
	D time.Duration
}

func (s SlowReader) Read(p []byte) (int, error) {
	time.Sleep(s.D)
	return s.R.Read(p)
}

var _ = Describe("Buffer", func() {
	var buffer *Buffer

	BeforeEach(func() {
		buffer = NewBuffer()
	})

	Describe("dumping the entire contents of the buffer", func() {
		It("should return everything that's been written", func() {
			buffer.Write([]byte("abc"))
			buffer.Write([]byte("def"))
			Expect(buffer.Contents()).Should(Equal([]byte("abcdef")))

			Expect(buffer).Should(Say("bcd"))
			Expect(buffer.Contents()).Should(Equal([]byte("abcdef")))
		})
	})

	Describe("creating a buffer with bytes", func() {
		It("should create the buffer with the cursor set to the beginning", func() {
			buffer := BufferWithBytes([]byte("abcdef"))
			Expect(buffer.Contents()).Should(Equal([]byte("abcdef")))
			Expect(buffer).Should(Say("abc"))
			Expect(buffer).ShouldNot(Say("abc"))
			Expect(buffer).Should(Say("def"))
		})
	})

	Describe("creating a buffer that wraps a reader", func() {
		Context("for a well-behaved reader", func() {
			It("should buffer the contents of the reader", func() {
				reader := bytes.NewBuffer([]byte("abcdef"))
				buffer := BufferReader(reader)
				Eventually(buffer).Should(Say("abc"))
				Expect(buffer).ShouldNot(Say("abc"))
				Eventually(buffer).Should(Say("def"))
				Eventually(buffer.Closed).Should(BeTrue())
			})
		})

		Context("for a slow reader", func() {
			It("should allow Eventually to time out", func() {
				slowReader := SlowReader{
					R: bytes.NewBuffer([]byte("abcdef")),
					D: time.Second,
				}
				buffer := BufferReader(slowReader)
				failures := InterceptGomegaFailures(func() {
					Eventually(buffer, 100*time.Millisecond).Should(Say("abc"))
				})
				Expect(failures).ShouldNot(BeEmpty())

				fastReader := SlowReader{
					R: bytes.NewBuffer([]byte("abcdef")),
					D: time.Millisecond,
				}
				buffer = BufferReader(fastReader)
				Eventually(buffer, 100*time.Millisecond).Should(Say("abc"))
				Eventually(buffer.Closed).Should(BeTrue())
			})
		})
	})

	Describe("reading from a buffer", func() {
		It("should read the current contents of the buffer", func() {
			buffer := BufferWithBytes([]byte("abcde"))

			dest := make([]byte, 3)
			n, err := buffer.Read(dest)
			Expect(err).ShouldNot(HaveOccurred())
			Expect(n).Should(Equal(3))
			Expect(string(dest)).Should(Equal("abc"))

			dest = make([]byte, 3)
			n, err = buffer.Read(dest)
			Expect(err).ShouldNot(HaveOccurred())
			Expect(n).Should(Equal(2))
			Expect(string(dest[:n])).Should(Equal("de"))

			n, err = buffer.Read(dest)
			Expect(err).Should(Equal(io.EOF))
			Expect(n).Should(Equal(0))
		})

		Context("after the buffer has been closed", func() {
			It("returns an error", func() {
				buffer := BufferWithBytes([]byte("abcde"))

				buffer.Close()

				dest := make([]byte, 3)
				n, err := buffer.Read(dest)
				Expect(err).Should(HaveOccurred())
				Expect(n).Should(Equal(0))
			})
		})
	})

	Describe("detecting regular expressions", func() {
		It("should fire the appropriate channel when the passed in pattern matches, then close it", func(done Done) {
			go func() {
				time.Sleep(10 * time.Millisecond)
				buffer.Write([]byte("abcde"))
			}()

			A := buffer.Detect("%s", "a.c")
			B := buffer.Detect("def")

			var gotIt bool
			select {
			case gotIt = <-A:
			case <-B:
				Fail("should not have gotten here")
			}

			Expect(gotIt).Should(BeTrue())
			Eventually(A).Should(BeClosed())

			buffer.Write([]byte("f"))
			Eventually(B).Should(Receive())
			Eventually(B).Should(BeClosed())

			close(done)
		})

		It("should fast-forward the buffer upon detection", func(done Done) {
			buffer.Write([]byte("abcde"))
			<-buffer.Detect("abc")
			Expect(buffer).ShouldNot(Say("abc"))
			Expect(buffer).Should(Say("de"))
			close(done)
		})

		It("should only fast-forward the buffer when the channel is read, and only if doing so would not rewind it", func(done Done) {
			buffer.Write([]byte("abcde"))
			A := buffer.Detect("abc")
			time.Sleep(20 * time.Millisecond) //give the goroutine a chance to detect and write to the channel
			Expect(buffer).Should(Say("abcd"))
			<-A
			Expect(buffer).ShouldNot(Say("d"))
			Expect(buffer).Should(Say("e"))
			Eventually(A).Should(BeClosed())
			close(done)
		})

		It("should be possible to cancel a detection", func(done Done) {
			A := buffer.Detect("abc")
			B := buffer.Detect("def")
			buffer.CancelDetects()
			buffer.Write([]byte("abcdef"))
			Eventually(A).Should(BeClosed())
			Eventually(B).Should(BeClosed())

			Expect(buffer).Should(Say("bcde"))
			<-buffer.Detect("f")
			close(done)
		})
	})

	Describe("closing the buffer", func() {
		It("should error when further write attempts are made", func() {
			_, err := buffer.Write([]byte("abc"))
			Expect(err).ShouldNot(HaveOccurred())

			buffer.Close()

			_, err = buffer.Write([]byte("def"))
			Expect(err).Should(HaveOccurred())

			Expect(buffer.Contents()).Should(Equal([]byte("abc")))
		})

		It("should be closed", func() {
			Expect(buffer.Closed()).Should(BeFalse())

			buffer.Close()

			Expect(buffer.Closed()).Should(BeTrue())
		})
	})
})