blob: c829d2b0648ab7c10e55ab006a677776c1c94062 [file] [log] [blame]
Russ Cox7c9e2c22008-09-12 16:42:53 -07001// Copyright 2009 The Go Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style
3// license that can be found in the LICENSE file.
4
Rob Piked3c61fc2011-03-16 10:12:25 -07005package bufio_test
Russ Cox7c9e2c22008-09-12 16:42:53 -07006
7import (
Rob Piked3c61fc2011-03-16 10:12:25 -07008 . "bufio"
Robert Griesemer5a1d3322009-12-15 15:33:31 -08009 "bytes"
Brad Fitzpatrickdc71ace2013-03-21 19:59:49 -070010 "errors"
Robert Griesemer5a1d3322009-12-15 15:33:31 -080011 "fmt"
12 "io"
Adam Langley6392fc72011-04-13 15:12:28 -040013 "io/ioutil"
Robert Griesemer5a1d3322009-12-15 15:33:31 -080014 "strings"
15 "testing"
16 "testing/iotest"
Robert Griesemer7b6bc3e2014-04-10 21:46:00 -070017 "time"
Rob Pike30aa7012011-11-08 15:40:58 -080018 "unicode/utf8"
Russ Cox7c9e2c22008-09-12 16:42:53 -070019)
20
Russ Cox7c9e2c22008-09-12 16:42:53 -070021// Reads from a reader and rot13s the result.
Rob Pike33f3ed72009-01-15 16:22:57 -080022type rot13Reader struct {
Robert Griesemer5a1d3322009-12-15 15:33:31 -080023 r io.Reader
Russ Cox7c9e2c22008-09-12 16:42:53 -070024}
25
Rob Pikec8b47c62009-05-08 11:22:57 -070026func newRot13Reader(r io.Reader) *rot13Reader {
Robert Griesemer5a1d3322009-12-15 15:33:31 -080027 r13 := new(rot13Reader)
28 r13.r = r
29 return r13
Russ Cox7c9e2c22008-09-12 16:42:53 -070030}
31
Russ Coxc2049d22011-11-01 22:04:37 -040032func (r13 *rot13Reader) Read(p []byte) (int, error) {
Robin Eklindf36a53c2013-01-07 11:15:53 +110033 n, err := r13.r.Read(p)
Russ Cox7c9e2c22008-09-12 16:42:53 -070034 for i := 0; i < n; i++ {
Robert Griesemer5a1d3322009-12-15 15:33:31 -080035 c := p[i] | 0x20 // lowercase byte
Russ Coxbe869ba2009-05-18 13:31:56 -070036 if 'a' <= c && c <= 'm' {
Robert Griesemer40621d52009-11-09 12:07:39 -080037 p[i] += 13
Russ Coxbe869ba2009-05-18 13:31:56 -070038 } else if 'n' <= c && c <= 'z' {
Robert Griesemer40621d52009-11-09 12:07:39 -080039 p[i] -= 13
Russ Cox7c9e2c22008-09-12 16:42:53 -070040 }
41 }
Rui Ueyamaa219ff22014-07-29 17:56:28 -070042 return n, err
Russ Cox7c9e2c22008-09-12 16:42:53 -070043}
44
Russ Coxbe869ba2009-05-18 13:31:56 -070045// Call ReadByte to accumulate the text of a file
46func readBytes(buf *Reader) string {
Robert Griesemer5a1d3322009-12-15 15:33:31 -080047 var b [1000]byte
48 nb := 0
Russ Coxbe869ba2009-05-18 13:31:56 -070049 for {
Robin Eklindf36a53c2013-01-07 11:15:53 +110050 c, err := buf.ReadByte()
51 if err == io.EOF {
Robert Griesemer40621d52009-11-09 12:07:39 -080052 break
Russ Coxbe869ba2009-05-18 13:31:56 -070053 }
Robin Eklindf36a53c2013-01-07 11:15:53 +110054 if err == nil {
Graham Millerf795bdb2011-06-27 16:12:04 -040055 b[nb] = c
56 nb++
Robin Eklindf36a53c2013-01-07 11:15:53 +110057 } else if err != iotest.ErrTimeout {
58 panic("Data: " + err.Error())
Russ Coxbe869ba2009-05-18 13:31:56 -070059 }
Russ Coxbe869ba2009-05-18 13:31:56 -070060 }
Robert Griesemer5a1d3322009-12-15 15:33:31 -080061 return string(b[0:nb])
Russ Coxbe869ba2009-05-18 13:31:56 -070062}
63
64func TestReaderSimple(t *testing.T) {
Robert Griesemer5a1d3322009-12-15 15:33:31 -080065 data := "hello world"
Brad Fitzpatricka18f4ab2014-01-27 11:05:01 -080066 b := NewReader(strings.NewReader(data))
Russ Coxbe869ba2009-05-18 13:31:56 -070067 if s := readBytes(b); s != "hello world" {
Robert Griesemer40621d52009-11-09 12:07:39 -080068 t.Errorf("simple hello world test failed: got %q", s)
Russ Coxbe869ba2009-05-18 13:31:56 -070069 }
70
Brad Fitzpatricka18f4ab2014-01-27 11:05:01 -080071 b = NewReader(newRot13Reader(strings.NewReader(data)))
Russ Coxbe869ba2009-05-18 13:31:56 -070072 if s := readBytes(b); s != "uryyb jbeyq" {
Rob Pike1959c3a2010-09-23 13:48:56 +100073 t.Errorf("rot13 hello world test failed: got %q", s)
Russ Coxbe869ba2009-05-18 13:31:56 -070074 }
75}
76
Rob Pike33f3ed72009-01-15 16:22:57 -080077type readMaker struct {
Robert Griesemer5a1d3322009-12-15 15:33:31 -080078 name string
79 fn func(io.Reader) io.Reader
Russ Cox7c9e2c22008-09-12 16:42:53 -070080}
Robert Griesemer646a2c52009-11-04 17:04:21 -080081
82var readMakers = []readMaker{
Robert Griesemer34788912010-10-22 10:06:33 -070083 {"full", func(r io.Reader) io.Reader { return r }},
84 {"byte", iotest.OneByteReader},
85 {"half", iotest.HalfReader},
86 {"data+err", iotest.DataErrReader},
Graham Millerf795bdb2011-06-27 16:12:04 -040087 {"timeout", iotest.TimeoutReader},
Russ Coxbe2edb52009-03-03 08:39:12 -080088}
Russ Cox7c9e2c22008-09-12 16:42:53 -070089
Russ Cox4b409282009-08-27 11:20:15 -070090// Call ReadString (which ends up calling everything else)
Russ Cox7c9e2c22008-09-12 16:42:53 -070091// to accumulate the text of a file.
Rob Pike01712ae2009-05-08 11:52:39 -070092func readLines(b *Reader) string {
Robert Griesemer5a1d3322009-12-15 15:33:31 -080093 s := ""
Russ Cox7c9e2c22008-09-12 16:42:53 -070094 for {
Robin Eklindf36a53c2013-01-07 11:15:53 +110095 s1, err := b.ReadString('\n')
96 if err == io.EOF {
Robert Griesemer40621d52009-11-09 12:07:39 -080097 break
Russ Cox7c9e2c22008-09-12 16:42:53 -070098 }
Robin Eklindf36a53c2013-01-07 11:15:53 +110099 if err != nil && err != iotest.ErrTimeout {
100 panic("GetLines: " + err.Error())
Russ Cox7c9e2c22008-09-12 16:42:53 -0700101 }
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800102 s += s1
Russ Cox7c9e2c22008-09-12 16:42:53 -0700103 }
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800104 return s
Russ Cox7c9e2c22008-09-12 16:42:53 -0700105}
106
Russ Cox7c9e2c22008-09-12 16:42:53 -0700107// Call Read to accumulate the text of a file
Rob Pike01712ae2009-05-08 11:52:39 -0700108func reads(buf *Reader, m int) string {
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800109 var b [1000]byte
110 nb := 0
Russ Cox7c9e2c22008-09-12 16:42:53 -0700111 for {
Robin Eklindf36a53c2013-01-07 11:15:53 +1100112 n, err := buf.Read(b[nb : nb+m])
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800113 nb += n
Robin Eklindf36a53c2013-01-07 11:15:53 +1100114 if err == io.EOF {
Robert Griesemer40621d52009-11-09 12:07:39 -0800115 break
Russ Cox7c9e2c22008-09-12 16:42:53 -0700116 }
117 }
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800118 return string(b[0:nb])
Russ Cox7c9e2c22008-09-12 16:42:53 -0700119}
120
Rob Pike33f3ed72009-01-15 16:22:57 -0800121type bufReader struct {
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800122 name string
123 fn func(*Reader) string
Russ Coxbe2edb52009-03-03 08:39:12 -0800124}
Russ Cox7c9e2c22008-09-12 16:42:53 -0700125
Robert Griesemer646a2c52009-11-04 17:04:21 -0800126var bufreaders = []bufReader{
Robert Griesemer34788912010-10-22 10:06:33 -0700127 {"1", func(b *Reader) string { return reads(b, 1) }},
128 {"2", func(b *Reader) string { return reads(b, 2) }},
129 {"3", func(b *Reader) string { return reads(b, 3) }},
130 {"4", func(b *Reader) string { return reads(b, 4) }},
131 {"5", func(b *Reader) string { return reads(b, 5) }},
132 {"7", func(b *Reader) string { return reads(b, 7) }},
133 {"bytes", readBytes},
134 {"lines", readLines},
Robert Griesemer646a2c52009-11-04 17:04:21 -0800135}
136
Rob Pike64776da2011-12-13 15:07:17 -0800137const minReadBufferSize = 16
138
Robert Griesemer646a2c52009-11-04 17:04:21 -0800139var bufsizes = []int{
Shawn Smith4d239bc2014-01-01 22:26:22 +1100140 0, minReadBufferSize, 23, 32, 46, 64, 93, 128, 1024, 4096,
Russ Coxbe2edb52009-03-03 08:39:12 -0800141}
Russ Cox7c9e2c22008-09-12 16:42:53 -0700142
Rob Pike01712ae2009-05-08 11:52:39 -0700143func TestReader(t *testing.T) {
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800144 var texts [31]string
145 str := ""
146 all := ""
Russ Cox7c9e2c22008-09-12 16:42:53 -0700147 for i := 0; i < len(texts)-1; i++ {
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800148 texts[i] = str + "\n"
149 all += texts[i]
150 str += string(i%26 + 'a')
Russ Cox7c9e2c22008-09-12 16:42:53 -0700151 }
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800152 texts[len(texts)-1] = all
Russ Cox983f06b2008-10-07 12:31:31 -0700153
Russ Cox7c9e2c22008-09-12 16:42:53 -0700154 for h := 0; h < len(texts); h++ {
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800155 text := texts[h]
Rob Pike33f3ed72009-01-15 16:22:57 -0800156 for i := 0; i < len(readMakers); i++ {
Russ Cox7c9e2c22008-09-12 16:42:53 -0700157 for j := 0; j < len(bufreaders); j++ {
Russ Cox7c9e2c22008-09-12 16:42:53 -0700158 for k := 0; k < len(bufsizes); k++ {
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800159 readmaker := readMakers[i]
160 bufreader := bufreaders[j]
161 bufsize := bufsizes[k]
Brad Fitzpatricka18f4ab2014-01-27 11:05:01 -0800162 read := readmaker.fn(strings.NewReader(text))
Rob Pikebb7b1a12012-02-08 13:07:13 +1100163 buf := NewReaderSize(read, bufsize)
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800164 s := bufreader.fn(buf)
Russ Cox7c9e2c22008-09-12 16:42:53 -0700165 if s != text {
Russ Cox0f83fa32008-11-24 15:17:47 -0800166 t.Errorf("reader=%s fn=%s bufsize=%d want=%q got=%q",
Robert Griesemer40621d52009-11-09 12:07:39 -0800167 readmaker.name, bufreader.name, bufsize, text, s)
Russ Cox7c9e2c22008-09-12 16:42:53 -0700168 }
169 }
170 }
171 }
172 }
173}
174
Robert Griesemer7b6bc3e2014-04-10 21:46:00 -0700175type zeroReader struct{}
176
177func (zeroReader) Read(p []byte) (int, error) {
178 return 0, nil
179}
180
181func TestZeroReader(t *testing.T) {
182 var z zeroReader
183 r := NewReader(z)
184
185 c := make(chan error)
186 go func() {
187 _, err := r.ReadByte()
188 c <- err
189 }()
190
191 select {
192 case err := <-c:
193 if err == nil {
194 t.Error("error expected")
195 } else if err != io.ErrNoProgress {
196 t.Error("unexpected error:", err)
197 }
198 case <-time.After(time.Second):
199 t.Error("test timed out (endless loop in ReadByte?)")
200 }
201}
202
Robert Griesemer5876cb02009-08-06 12:05:16 -0700203// A StringReader delivers its data one string segment at a time via Read.
204type StringReader struct {
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800205 data []string
206 step int
Robert Griesemer5876cb02009-08-06 12:05:16 -0700207}
208
Russ Coxc2049d22011-11-01 22:04:37 -0400209func (r *StringReader) Read(p []byte) (n int, err error) {
Robert Griesemer5876cb02009-08-06 12:05:16 -0700210 if r.step < len(r.data) {
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800211 s := r.data[r.step]
Russ Coxd86ab012010-10-26 21:52:54 -0700212 n = copy(p, s)
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800213 r.step++
Robert Griesemer5876cb02009-08-06 12:05:16 -0700214 } else {
Russ Coxc2049d22011-11-01 22:04:37 -0400215 err = io.EOF
Robert Griesemer5876cb02009-08-06 12:05:16 -0700216 }
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800217 return
Robert Griesemer5876cb02009-08-06 12:05:16 -0700218}
219
220func readRuneSegments(t *testing.T, segments []string) {
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800221 got := ""
222 want := strings.Join(segments, "")
223 r := NewReader(&StringReader{data: segments})
Robert Griesemer5876cb02009-08-06 12:05:16 -0700224 for {
Russ Cox9f6d0362011-10-25 22:23:34 -0700225 r, _, err := r.ReadRune()
Robert Griesemer5876cb02009-08-06 12:05:16 -0700226 if err != nil {
Russ Coxc2049d22011-11-01 22:04:37 -0400227 if err != io.EOF {
Robert Griesemer40621d52009-11-09 12:07:39 -0800228 return
Robert Griesemer5876cb02009-08-06 12:05:16 -0700229 }
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800230 break
Robert Griesemer5876cb02009-08-06 12:05:16 -0700231 }
Russ Cox9f6d0362011-10-25 22:23:34 -0700232 got += string(r)
Robert Griesemer5876cb02009-08-06 12:05:16 -0700233 }
234 if got != want {
Robert Griesemer40621d52009-11-09 12:07:39 -0800235 t.Errorf("segments=%v got=%s want=%s", segments, got, want)
Robert Griesemer5876cb02009-08-06 12:05:16 -0700236 }
237}
238
Robert Griesemer646a2c52009-11-04 17:04:21 -0800239var segmentList = [][]string{
Robert Griesemer34788912010-10-22 10:06:33 -0700240 {},
241 {""},
242 {"日", "本語"},
243 {"\u65e5", "\u672c", "\u8a9e"},
244 {"\U000065e5", "\U0000672c", "\U00008a9e"},
245 {"\xe6", "\x97\xa5\xe6", "\x9c\xac\xe8\xaa\x9e"},
246 {"Hello", ", ", "World", "!"},
247 {"Hello", ", ", "", "World", "!"},
Robert Griesemer5876cb02009-08-06 12:05:16 -0700248}
249
250func TestReadRune(t *testing.T) {
251 for _, s := range segmentList {
Robert Griesemer40621d52009-11-09 12:07:39 -0800252 readRuneSegments(t, s)
Robert Griesemer5876cb02009-08-06 12:05:16 -0700253 }
254}
255
Rob Pikeacb695f2010-09-12 17:40:27 +1000256func TestUnreadRune(t *testing.T) {
Rob Pikeacb695f2010-09-12 17:40:27 +1000257 segments := []string{"Hello, world:", "日本語"}
Rob Pikeacb695f2010-09-12 17:40:27 +1000258 r := NewReader(&StringReader{data: segments})
Robert Griesemer8bd92422014-04-09 14:19:13 -0700259 got := ""
260 want := strings.Join(segments, "")
Rob Pikeacb695f2010-09-12 17:40:27 +1000261 // Normal execution.
262 for {
Russ Cox9f6d0362011-10-25 22:23:34 -0700263 r1, _, err := r.ReadRune()
Rob Pikeacb695f2010-09-12 17:40:27 +1000264 if err != nil {
Russ Coxc2049d22011-11-01 22:04:37 -0400265 if err != io.EOF {
Robert Griesemer8bd92422014-04-09 14:19:13 -0700266 t.Error("unexpected error on ReadRune:", err)
Rob Pikeacb695f2010-09-12 17:40:27 +1000267 }
268 break
269 }
Russ Cox9f6d0362011-10-25 22:23:34 -0700270 got += string(r1)
Robert Griesemer8bd92422014-04-09 14:19:13 -0700271 // Put it back and read it again.
Rob Pikeacb695f2010-09-12 17:40:27 +1000272 if err = r.UnreadRune(); err != nil {
Robert Griesemer8bd92422014-04-09 14:19:13 -0700273 t.Fatal("unexpected error on UnreadRune:", err)
Rob Pikeacb695f2010-09-12 17:40:27 +1000274 }
Russ Cox9f6d0362011-10-25 22:23:34 -0700275 r2, _, err := r.ReadRune()
Rob Pikeacb695f2010-09-12 17:40:27 +1000276 if err != nil {
Robert Griesemer8bd92422014-04-09 14:19:13 -0700277 t.Fatal("unexpected error reading after unreading:", err)
Rob Pikeacb695f2010-09-12 17:40:27 +1000278 }
Russ Cox9f6d0362011-10-25 22:23:34 -0700279 if r1 != r2 {
Robert Griesemer8bd92422014-04-09 14:19:13 -0700280 t.Fatalf("incorrect rune after unread: got %c, want %c", r1, r2)
Rob Pikeacb695f2010-09-12 17:40:27 +1000281 }
282 }
Robert Griesemer8bd92422014-04-09 14:19:13 -0700283 if got != want {
284 t.Errorf("got %q, want %q", got, want)
Rob Pikeacb695f2010-09-12 17:40:27 +1000285 }
286}
287
Shawn Smith4d239bc2014-01-01 22:26:22 +1100288func TestUnreadByte(t *testing.T) {
Shawn Smith4d239bc2014-01-01 22:26:22 +1100289 segments := []string{"Hello, ", "world"}
290 r := NewReader(&StringReader{data: segments})
Robert Griesemer8bd92422014-04-09 14:19:13 -0700291 got := ""
292 want := strings.Join(segments, "")
Shawn Smith4d239bc2014-01-01 22:26:22 +1100293 // Normal execution.
294 for {
295 b1, err := r.ReadByte()
296 if err != nil {
297 if err != io.EOF {
Robert Griesemer8bd92422014-04-09 14:19:13 -0700298 t.Error("unexpected error on ReadByte:", err)
Shawn Smith4d239bc2014-01-01 22:26:22 +1100299 }
300 break
301 }
302 got += string(b1)
Robert Griesemer8bd92422014-04-09 14:19:13 -0700303 // Put it back and read it again.
Shawn Smith4d239bc2014-01-01 22:26:22 +1100304 if err = r.UnreadByte(); err != nil {
Robert Griesemer8bd92422014-04-09 14:19:13 -0700305 t.Fatal("unexpected error on UnreadByte:", err)
Shawn Smith4d239bc2014-01-01 22:26:22 +1100306 }
307 b2, err := r.ReadByte()
308 if err != nil {
Robert Griesemer8bd92422014-04-09 14:19:13 -0700309 t.Fatal("unexpected error reading after unreading:", err)
Shawn Smith4d239bc2014-01-01 22:26:22 +1100310 }
311 if b1 != b2 {
Robert Griesemer8bd92422014-04-09 14:19:13 -0700312 t.Fatalf("incorrect byte after unread: got %q, want %q", b1, b2)
Shawn Smith4d239bc2014-01-01 22:26:22 +1100313 }
314 }
315 if got != want {
Robert Griesemer8bd92422014-04-09 14:19:13 -0700316 t.Errorf("got %q, want %q", got, want)
317 }
318}
319
320func TestUnreadByteMultiple(t *testing.T) {
321 segments := []string{"Hello, ", "world"}
322 data := strings.Join(segments, "")
323 for n := 0; n <= len(data); n++ {
324 r := NewReader(&StringReader{data: segments})
325 // Read n bytes.
326 for i := 0; i < n; i++ {
327 b, err := r.ReadByte()
328 if err != nil {
329 t.Fatalf("n = %d: unexpected error on ReadByte: %v", n, err)
330 }
331 if b != data[i] {
332 t.Fatalf("n = %d: incorrect byte returned from ReadByte: got %q, want %q", n, b, data[i])
333 }
334 }
335 // Unread one byte if there is one.
336 if n > 0 {
337 if err := r.UnreadByte(); err != nil {
338 t.Errorf("n = %d: unexpected error on UnreadByte: %v", n, err)
339 }
340 }
341 // Test that we cannot unread any further.
342 if err := r.UnreadByte(); err == nil {
343 t.Errorf("n = %d: expected error on UnreadByte", n)
344 }
Shawn Smith4d239bc2014-01-01 22:26:22 +1100345 }
346}
347
Robert Griesemer9144d872014-04-25 09:46:07 -0600348func TestUnreadByteOthers(t *testing.T) {
Robert Henckef999e142014-04-29 12:44:40 -0400349 // A list of readers to use in conjunction with UnreadByte.
Robert Griesemer9144d872014-04-25 09:46:07 -0600350 var readers = []func(*Reader, byte) ([]byte, error){
351 (*Reader).ReadBytes,
352 (*Reader).ReadSlice,
353 func(r *Reader, delim byte) ([]byte, error) {
354 data, err := r.ReadString(delim)
355 return []byte(data), err
356 },
357 // ReadLine doesn't fit the data/pattern easily
358 // so we leave it out. It should be covered via
359 // the ReadSlice test since ReadLine simply calls
360 // ReadSlice, and it's that function that handles
361 // the last byte.
362 }
363
364 // Try all readers with UnreadByte.
365 for rno, read := range readers {
366 // Some input data that is longer than the minimum reader buffer size.
367 const n = 10
368 var buf bytes.Buffer
369 for i := 0; i < n; i++ {
370 buf.WriteString("abcdefg")
371 }
372
373 r := NewReaderSize(&buf, minReadBufferSize)
374 readTo := func(delim byte, want string) {
375 data, err := read(r, delim)
376 if err != nil {
377 t.Fatalf("#%d: unexpected error reading to %c: %v", rno, delim, err)
378 }
379 if got := string(data); got != want {
380 t.Fatalf("#%d: got %q, want %q", rno, got, want)
381 }
382 }
383
384 // Read the data with occasional UnreadByte calls.
385 for i := 0; i < n; i++ {
386 readTo('d', "abcd")
387 for j := 0; j < 3; j++ {
388 if err := r.UnreadByte(); err != nil {
389 t.Fatalf("#%d: unexpected error on UnreadByte: %v", rno, err)
390 }
391 readTo('d', "d")
392 }
393 readTo('g', "efg")
394 }
395
396 // All data should have been read.
397 _, err := r.ReadByte()
398 if err != io.EOF {
399 t.Errorf("#%d: got error %v; want EOF", rno, err)
400 }
401 }
402}
403
Rob Pikeacb695f2010-09-12 17:40:27 +1000404// Test that UnreadRune fails if the preceding operation was not a ReadRune.
405func TestUnreadRuneError(t *testing.T) {
406 buf := make([]byte, 3) // All runes in this test are 3 bytes long
407 r := NewReader(&StringReader{data: []string{"日本語日本語日本語"}})
408 if r.UnreadRune() == nil {
409 t.Error("expected error on UnreadRune from fresh buffer")
410 }
411 _, _, err := r.ReadRune()
412 if err != nil {
413 t.Error("unexpected error on ReadRune (1):", err)
414 }
415 if err = r.UnreadRune(); err != nil {
416 t.Error("unexpected error on UnreadRune (1):", err)
417 }
418 if r.UnreadRune() == nil {
419 t.Error("expected error after UnreadRune (1)")
420 }
421 // Test error after Read.
422 _, _, err = r.ReadRune() // reset state
423 if err != nil {
424 t.Error("unexpected error on ReadRune (2):", err)
425 }
426 _, err = r.Read(buf)
427 if err != nil {
428 t.Error("unexpected error on Read (2):", err)
429 }
430 if r.UnreadRune() == nil {
431 t.Error("expected error after Read (2)")
432 }
433 // Test error after ReadByte.
434 _, _, err = r.ReadRune() // reset state
435 if err != nil {
436 t.Error("unexpected error on ReadRune (2):", err)
437 }
Robert Griesemer8a23c002014-07-16 16:29:51 -0700438 for range buf {
Rob Pikeacb695f2010-09-12 17:40:27 +1000439 _, err = r.ReadByte()
440 if err != nil {
441 t.Error("unexpected error on ReadByte (2):", err)
442 }
443 }
444 if r.UnreadRune() == nil {
445 t.Error("expected error after ReadByte")
446 }
447 // Test error after UnreadByte.
448 _, _, err = r.ReadRune() // reset state
449 if err != nil {
450 t.Error("unexpected error on ReadRune (3):", err)
451 }
452 _, err = r.ReadByte()
453 if err != nil {
454 t.Error("unexpected error on ReadByte (3):", err)
455 }
456 err = r.UnreadByte()
457 if err != nil {
458 t.Error("unexpected error on UnreadByte (3):", err)
459 }
460 if r.UnreadRune() == nil {
461 t.Error("expected error after UnreadByte (3)")
462 }
Egon Elbre0b2da602014-07-18 09:25:59 -0700463 // Test error after ReadSlice.
464 _, _, err = r.ReadRune() // reset state
465 if err != nil {
466 t.Error("unexpected error on ReadRune (4):", err)
467 }
468 _, err = r.ReadSlice(0)
469 if err != io.EOF {
470 t.Error("unexpected error on ReadSlice (4):", err)
471 }
472 if r.UnreadRune() == nil {
473 t.Error("expected error after ReadSlice (4)")
474 }
Rob Pikeacb695f2010-09-12 17:40:27 +1000475}
476
Rob Pikee4393452010-09-24 12:28:14 +1000477func TestUnreadRuneAtEOF(t *testing.T) {
478 // UnreadRune/ReadRune should error at EOF (was a bug; used to panic)
479 r := NewReader(strings.NewReader("x"))
480 r.ReadRune()
481 r.ReadRune()
482 r.UnreadRune()
483 _, _, err := r.ReadRune()
484 if err == nil {
485 t.Error("expected error at EOF")
Russ Coxc2049d22011-11-01 22:04:37 -0400486 } else if err != io.EOF {
Rob Pikee4393452010-09-24 12:28:14 +1000487 t.Error("expected EOF; got", err)
488 }
489}
490
Rob Pike8c9944d2010-03-05 14:03:17 -0800491func TestReadWriteRune(t *testing.T) {
492 const NRune = 1000
493 byteBuf := new(bytes.Buffer)
494 w := NewWriter(byteBuf)
495 // Write the runes out using WriteRune
496 buf := make([]byte, utf8.UTFMax)
Russ Cox9f6d0362011-10-25 22:23:34 -0700497 for r := rune(0); r < NRune; r++ {
498 size := utf8.EncodeRune(buf, r)
499 nbytes, err := w.WriteRune(r)
Rob Pike8c9944d2010-03-05 14:03:17 -0800500 if err != nil {
Russ Cox9f6d0362011-10-25 22:23:34 -0700501 t.Fatalf("WriteRune(0x%x) error: %s", r, err)
Rob Pike8c9944d2010-03-05 14:03:17 -0800502 }
503 if nbytes != size {
Russ Cox9f6d0362011-10-25 22:23:34 -0700504 t.Fatalf("WriteRune(0x%x) expected %d, got %d", r, size, nbytes)
Rob Pike8c9944d2010-03-05 14:03:17 -0800505 }
506 }
507 w.Flush()
508
509 r := NewReader(byteBuf)
510 // Read them back with ReadRune
Russ Cox9f6d0362011-10-25 22:23:34 -0700511 for r1 := rune(0); r1 < NRune; r1++ {
512 size := utf8.EncodeRune(buf, r1)
Rob Pike8c9944d2010-03-05 14:03:17 -0800513 nr, nbytes, err := r.ReadRune()
Russ Cox9f6d0362011-10-25 22:23:34 -0700514 if nr != r1 || nbytes != size || err != nil {
515 t.Fatalf("ReadRune(0x%x) got 0x%x,%d not 0x%x,%d (err=%s)", r1, nr, nbytes, r1, size, err)
Rob Pike8c9944d2010-03-05 14:03:17 -0800516 }
517 }
518}
519
Rob Pike01712ae2009-05-08 11:52:39 -0700520func TestWriter(t *testing.T) {
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800521 var data [8192]byte
Russ Cox7c9e2c22008-09-12 16:42:53 -0700522
Russ Cox7c9e2c22008-09-12 16:42:53 -0700523 for i := 0; i < len(data); i++ {
Robert Griesemer40621d52009-11-09 12:07:39 -0800524 data[i] = byte(' ' + i%('~'-' '))
Russ Cox7c9e2c22008-09-12 16:42:53 -0700525 }
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800526 w := new(bytes.Buffer)
Russ Cox7c9e2c22008-09-12 16:42:53 -0700527 for i := 0; i < len(bufsizes); i++ {
528 for j := 0; j < len(bufsizes); j++ {
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800529 nwrite := bufsizes[i]
530 bs := bufsizes[j]
Russ Cox983f06b2008-10-07 12:31:31 -0700531
Russ Coxbe869ba2009-05-18 13:31:56 -0700532 // Write nwrite bytes using buffer size bs.
533 // Check that the right amount makes it out
534 // and that the data is correct.
Russ Cox7c9e2c22008-09-12 16:42:53 -0700535
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800536 w.Reset()
Rob Pikebb7b1a12012-02-08 13:07:13 +1100537 buf := NewWriterSize(w, bs)
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800538 context := fmt.Sprintf("nwrite=%d bufsize=%d", nwrite, bs)
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800539 n, e1 := buf.Write(data[0:nwrite])
Russ Coxbe869ba2009-05-18 13:31:56 -0700540 if e1 != nil || n != nwrite {
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800541 t.Errorf("%s: buf.Write %d = %d, %v", context, nwrite, n, e1)
542 continue
Russ Coxbe869ba2009-05-18 13:31:56 -0700543 }
Rob Pikebb7b1a12012-02-08 13:07:13 +1100544 if e := buf.Flush(); e != nil {
Robert Griesemer40621d52009-11-09 12:07:39 -0800545 t.Errorf("%s: buf.Flush = %v", context, e)
Russ Coxbe869ba2009-05-18 13:31:56 -0700546 }
Russ Cox983f06b2008-10-07 12:31:31 -0700547
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800548 written := w.Bytes()
Russ Coxbe869ba2009-05-18 13:31:56 -0700549 if len(written) != nwrite {
Robert Griesemer40621d52009-11-09 12:07:39 -0800550 t.Errorf("%s: %d bytes written", context, len(written))
Russ Coxbe869ba2009-05-18 13:31:56 -0700551 }
552 for l := 0; l < len(written); l++ {
553 if written[i] != data[i] {
Rob Pike1ce62452010-12-07 16:42:54 -0500554 t.Errorf("wrong bytes written")
555 t.Errorf("want=%q", data[0:len(written)])
556 t.Errorf("have=%q", written)
Russ Cox7c9e2c22008-09-12 16:42:53 -0700557 }
558 }
559 }
560 }
561}
562
Russ Coxbe869ba2009-05-18 13:31:56 -0700563// Check that write errors are returned properly.
564
565type errorWriterTest struct {
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800566 n, m int
Russ Coxc2049d22011-11-01 22:04:37 -0400567 err error
568 expect error
Russ Coxbe869ba2009-05-18 13:31:56 -0700569}
570
Russ Coxc2049d22011-11-01 22:04:37 -0400571func (w errorWriterTest) Write(p []byte) (int, error) {
Robert Griesemer40621d52009-11-09 12:07:39 -0800572 return len(p) * w.n / w.m, w.err
Russ Coxbe869ba2009-05-18 13:31:56 -0700573}
574
Robert Griesemer646a2c52009-11-04 17:04:21 -0800575var errorWriterTests = []errorWriterTest{
Robert Griesemer34788912010-10-22 10:06:33 -0700576 {0, 1, nil, io.ErrShortWrite},
577 {1, 2, nil, io.ErrShortWrite},
578 {1, 1, nil, nil},
Russ Coxfd34e782011-11-13 22:42:42 -0500579 {0, 1, io.ErrClosedPipe, io.ErrClosedPipe},
580 {1, 2, io.ErrClosedPipe, io.ErrClosedPipe},
581 {1, 1, io.ErrClosedPipe, io.ErrClosedPipe},
Russ Coxbe869ba2009-05-18 13:31:56 -0700582}
583
584func TestWriteErrors(t *testing.T) {
Russ Coxca6a0fe2009-09-15 09:41:59 -0700585 for _, w := range errorWriterTests {
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800586 buf := NewWriter(w)
Russ Cox9750adb2010-02-25 16:01:29 -0800587 _, e := buf.Write([]byte("hello world"))
Russ Coxbe869ba2009-05-18 13:31:56 -0700588 if e != nil {
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800589 t.Errorf("Write hello to %v: %v", w, e)
590 continue
Russ Coxbe869ba2009-05-18 13:31:56 -0700591 }
Brad Fitzpatrickdc71ace2013-03-21 19:59:49 -0700592 // Two flushes, to verify the error is sticky.
593 for i := 0; i < 2; i++ {
594 e = buf.Flush()
595 if e != w.expect {
596 t.Errorf("Flush %d/2 %v: got %v, wanted %v", i+1, w, e, w.expect)
597 }
Russ Coxbe869ba2009-05-18 13:31:56 -0700598 }
599 }
600}
601
Rob Pike01712ae2009-05-08 11:52:39 -0700602func TestNewReaderSizeIdempotent(t *testing.T) {
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800603 const BufSize = 1000
Brad Fitzpatricka18f4ab2014-01-27 11:05:01 -0800604 b := NewReaderSize(strings.NewReader("hello world"), BufSize)
Rob Pikeee196952009-04-06 21:42:14 -0700605 // Does it recognize itself?
Rob Pikebb7b1a12012-02-08 13:07:13 +1100606 b1 := NewReaderSize(b, BufSize)
Rob Pikeee196952009-04-06 21:42:14 -0700607 if b1 != b {
Robert Griesemer40621d52009-11-09 12:07:39 -0800608 t.Error("NewReaderSize did not detect underlying Reader")
Rob Pikeee196952009-04-06 21:42:14 -0700609 }
610 // Does it wrap if existing buffer is too small?
Rob Pikebb7b1a12012-02-08 13:07:13 +1100611 b2 := NewReaderSize(b, 2*BufSize)
Rob Pikeee196952009-04-06 21:42:14 -0700612 if b2 == b {
Robert Griesemer40621d52009-11-09 12:07:39 -0800613 t.Error("NewReaderSize did not enlarge buffer")
Rob Pikeee196952009-04-06 21:42:14 -0700614 }
615}
616
Rob Pike01712ae2009-05-08 11:52:39 -0700617func TestNewWriterSizeIdempotent(t *testing.T) {
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800618 const BufSize = 1000
Rob Pikebb7b1a12012-02-08 13:07:13 +1100619 b := NewWriterSize(new(bytes.Buffer), BufSize)
Rob Pikeee196952009-04-06 21:42:14 -0700620 // Does it recognize itself?
Rob Pikebb7b1a12012-02-08 13:07:13 +1100621 b1 := NewWriterSize(b, BufSize)
Rob Pikeee196952009-04-06 21:42:14 -0700622 if b1 != b {
Robert Griesemer40621d52009-11-09 12:07:39 -0800623 t.Error("NewWriterSize did not detect underlying Writer")
Rob Pikeee196952009-04-06 21:42:14 -0700624 }
625 // Does it wrap if existing buffer is too small?
Rob Pikebb7b1a12012-02-08 13:07:13 +1100626 b2 := NewWriterSize(b, 2*BufSize)
Rob Pikeee196952009-04-06 21:42:14 -0700627 if b2 == b {
Robert Griesemer40621d52009-11-09 12:07:39 -0800628 t.Error("NewWriterSize did not enlarge buffer")
Rob Pikeee196952009-04-06 21:42:14 -0700629 }
630}
Rob Pike2495c142009-08-03 18:28:05 -0700631
632func TestWriteString(t *testing.T) {
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800633 const BufSize = 8
634 buf := new(bytes.Buffer)
Rob Pikebb7b1a12012-02-08 13:07:13 +1100635 b := NewWriterSize(buf, BufSize)
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800636 b.WriteString("0") // easy
637 b.WriteString("123456") // still easy
638 b.WriteString("7890") // easy after flush
639 b.WriteString("abcdefghijklmnopqrstuvwxy") // hard
640 b.WriteString("z")
Rob Piked3c61fc2011-03-16 10:12:25 -0700641 if err := b.Flush(); err != nil {
642 t.Error("WriteString", err)
Rob Pike2495c142009-08-03 18:28:05 -0700643 }
Robert Griesemer5a1d3322009-12-15 15:33:31 -0800644 s := "01234567890abcdefghijklmnopqrstuvwxyz"
Rob Piked5be41f2009-09-16 15:15:00 -0700645 if string(buf.Bytes()) != s {
Robert Griesemer40621d52009-11-09 12:07:39 -0800646 t.Errorf("WriteString wants %q gets %q", s, string(buf.Bytes()))
Rob Pike2495c142009-08-03 18:28:05 -0700647 }
648}
Russ Cox041d9782010-06-02 16:17:18 -0700649
650func TestBufferFull(t *testing.T) {
Rob Pike64776da2011-12-13 15:07:17 -0800651 const longString = "And now, hello, world! It is the time for all good men to come to the aid of their party"
Rob Pikebb7b1a12012-02-08 13:07:13 +1100652 buf := NewReaderSize(strings.NewReader(longString), minReadBufferSize)
Rob Pike64776da2011-12-13 15:07:17 -0800653 line, err := buf.ReadSlice('!')
654 if string(line) != "And now, hello, " || err != ErrBufferFull {
Russ Cox041d9782010-06-02 16:17:18 -0700655 t.Errorf("first ReadSlice(,) = %q, %v", line, err)
656 }
Rob Pike64776da2011-12-13 15:07:17 -0800657 line, err = buf.ReadSlice('!')
658 if string(line) != "world!" || err != nil {
Russ Cox041d9782010-06-02 16:17:18 -0700659 t.Errorf("second ReadSlice(,) = %q, %v", line, err)
660 }
661}
Nigel Tao27e24902010-08-04 09:44:02 +1000662
663func TestPeek(t *testing.T) {
664 p := make([]byte, 10)
Rob Pike64776da2011-12-13 15:07:17 -0800665 // string is 16 (minReadBufferSize) long.
Rob Pikebb7b1a12012-02-08 13:07:13 +1100666 buf := NewReaderSize(strings.NewReader("abcdefghijklmnop"), minReadBufferSize)
Nigel Tao27e24902010-08-04 09:44:02 +1000667 if s, err := buf.Peek(1); string(s) != "a" || err != nil {
668 t.Fatalf("want %q got %q, err=%v", "a", string(s), err)
669 }
670 if s, err := buf.Peek(4); string(s) != "abcd" || err != nil {
671 t.Fatalf("want %q got %q, err=%v", "abcd", string(s), err)
672 }
Shawn Smith4d239bc2014-01-01 22:26:22 +1100673 if _, err := buf.Peek(-1); err != ErrNegativeCount {
674 t.Fatalf("want ErrNegativeCount got %v", err)
675 }
djherbis14bf9c82016-01-29 00:32:00 -0800676 if s, err := buf.Peek(32); string(s) != "abcdefghijklmnop" || err != ErrBufferFull {
677 t.Fatalf("want %q, ErrBufFull got %q, err=%v", "abcdefghijklmnop", string(s), err)
Nigel Tao27e24902010-08-04 09:44:02 +1000678 }
679 if _, err := buf.Read(p[0:3]); string(p[0:3]) != "abc" || err != nil {
680 t.Fatalf("want %q got %q, err=%v", "abc", string(p[0:3]), err)
681 }
682 if s, err := buf.Peek(1); string(s) != "d" || err != nil {
683 t.Fatalf("want %q got %q, err=%v", "d", string(s), err)
684 }
685 if s, err := buf.Peek(2); string(s) != "de" || err != nil {
686 t.Fatalf("want %q got %q, err=%v", "de", string(s), err)
687 }
688 if _, err := buf.Read(p[0:3]); string(p[0:3]) != "def" || err != nil {
689 t.Fatalf("want %q got %q, err=%v", "def", string(p[0:3]), err)
690 }
691 if s, err := buf.Peek(4); string(s) != "ghij" || err != nil {
692 t.Fatalf("want %q got %q, err=%v", "ghij", string(s), err)
693 }
Rob Pike64776da2011-12-13 15:07:17 -0800694 if _, err := buf.Read(p[0:]); string(p[0:]) != "ghijklmnop" || err != nil {
695 t.Fatalf("want %q got %q, err=%v", "ghijklmnop", string(p[0:minReadBufferSize]), err)
Nigel Tao27e24902010-08-04 09:44:02 +1000696 }
697 if s, err := buf.Peek(0); string(s) != "" || err != nil {
698 t.Fatalf("want %q got %q, err=%v", "", string(s), err)
699 }
Russ Coxc2049d22011-11-01 22:04:37 -0400700 if _, err := buf.Peek(1); err != io.EOF {
Nigel Tao27e24902010-08-04 09:44:02 +1000701 t.Fatalf("want EOF got %v", err)
702 }
Brad Fitzpatrick88f8af12012-02-16 10:15:36 +1100703
704 // Test for issue 3022, not exposing a reader's error on a successful Peek.
705 buf = NewReaderSize(dataAndEOFReader("abcd"), 32)
706 if s, err := buf.Peek(2); string(s) != "ab" || err != nil {
707 t.Errorf(`Peek(2) on "abcd", EOF = %q, %v; want "ab", nil`, string(s), err)
708 }
709 if s, err := buf.Peek(4); string(s) != "abcd" || err != nil {
710 t.Errorf(`Peek(4) on "abcd", EOF = %q, %v; want "abcd", nil`, string(s), err)
711 }
712 if n, err := buf.Read(p[0:5]); string(p[0:n]) != "abcd" || err != nil {
713 t.Fatalf("Read after peek = %q, %v; want abcd, EOF", p[0:n], err)
714 }
715 if n, err := buf.Read(p[0:1]); string(p[0:n]) != "" || err != io.EOF {
716 t.Fatalf(`second Read after peek = %q, %v; want "", EOF`, p[0:n], err)
717 }
718}
719
720type dataAndEOFReader string
721
722func (r dataAndEOFReader) Read(p []byte) (int, error) {
723 return copy(p, r), io.EOF
Nigel Tao27e24902010-08-04 09:44:02 +1000724}
Rob Pike52e3c992010-10-13 17:12:43 -0700725
726func TestPeekThenUnreadRune(t *testing.T) {
727 // This sequence used to cause a crash.
728 r := NewReader(strings.NewReader("x"))
729 r.ReadRune()
730 r.Peek(1)
731 r.UnreadRune()
732 r.ReadRune() // Used to panic here
733}
Adam Langley6392fc72011-04-13 15:12:28 -0400734
735var testOutput = []byte("0123456789abcdefghijklmnopqrstuvwxy")
736var testInput = []byte("012\n345\n678\n9ab\ncde\nfgh\nijk\nlmn\nopq\nrst\nuvw\nxy")
737var testInputrn = []byte("012\r\n345\r\n678\r\n9ab\r\ncde\r\nfgh\r\nijk\r\nlmn\r\nopq\r\nrst\r\nuvw\r\nxy\r\n\n\r\n")
738
739// TestReader wraps a []byte and returns reads of a specific length.
740type testReader struct {
741 data []byte
742 stride int
743}
744
Russ Coxc2049d22011-11-01 22:04:37 -0400745func (t *testReader) Read(buf []byte) (n int, err error) {
Adam Langley6392fc72011-04-13 15:12:28 -0400746 n = t.stride
747 if n > len(t.data) {
748 n = len(t.data)
749 }
750 if n > len(buf) {
751 n = len(buf)
752 }
753 copy(buf, t.data)
754 t.data = t.data[n:]
755 if len(t.data) == 0 {
Russ Coxc2049d22011-11-01 22:04:37 -0400756 err = io.EOF
Adam Langley6392fc72011-04-13 15:12:28 -0400757 }
758 return
759}
760
761func testReadLine(t *testing.T, input []byte) {
762 //for stride := 1; stride < len(input); stride++ {
763 for stride := 1; stride < 2; stride++ {
764 done := 0
765 reader := testReader{input, stride}
Rob Pikebb7b1a12012-02-08 13:07:13 +1100766 l := NewReaderSize(&reader, len(input)+1)
Adam Langley6392fc72011-04-13 15:12:28 -0400767 for {
768 line, isPrefix, err := l.ReadLine()
769 if len(line) > 0 && err != nil {
770 t.Errorf("ReadLine returned both data and error: %s", err)
771 }
772 if isPrefix {
773 t.Errorf("ReadLine returned prefix")
774 }
775 if err != nil {
Russ Coxc2049d22011-11-01 22:04:37 -0400776 if err != io.EOF {
Adam Langley6392fc72011-04-13 15:12:28 -0400777 t.Fatalf("Got unknown error: %s", err)
778 }
779 break
780 }
781 if want := testOutput[done : done+len(line)]; !bytes.Equal(want, line) {
782 t.Errorf("Bad line at stride %d: want: %x got: %x", stride, want, line)
783 }
784 done += len(line)
785 }
786 if done != len(testOutput) {
787 t.Errorf("ReadLine didn't return everything: got: %d, want: %d (stride: %d)", done, len(testOutput), stride)
788 }
789 }
790}
791
792func TestReadLine(t *testing.T) {
793 testReadLine(t, testInput)
794 testReadLine(t, testInputrn)
795}
796
797func TestLineTooLong(t *testing.T) {
Rob Pike64776da2011-12-13 15:07:17 -0800798 data := make([]byte, 0)
799 for i := 0; i < minReadBufferSize*5/2; i++ {
800 data = append(data, '0'+byte(i%10))
801 }
Brad Fitzpatricka18f4ab2014-01-27 11:05:01 -0800802 buf := bytes.NewReader(data)
Rob Pikebb7b1a12012-02-08 13:07:13 +1100803 l := NewReaderSize(buf, minReadBufferSize)
Adam Langley6392fc72011-04-13 15:12:28 -0400804 line, isPrefix, err := l.ReadLine()
Rob Pike64776da2011-12-13 15:07:17 -0800805 if !isPrefix || !bytes.Equal(line, data[:minReadBufferSize]) || err != nil {
806 t.Errorf("bad result for first line: got %q want %q %v", line, data[:minReadBufferSize], err)
Adam Langley6392fc72011-04-13 15:12:28 -0400807 }
Rob Pike64776da2011-12-13 15:07:17 -0800808 data = data[len(line):]
Adam Langley6392fc72011-04-13 15:12:28 -0400809 line, isPrefix, err = l.ReadLine()
Rob Pike64776da2011-12-13 15:07:17 -0800810 if !isPrefix || !bytes.Equal(line, data[:minReadBufferSize]) || err != nil {
811 t.Errorf("bad result for second line: got %q want %q %v", line, data[:minReadBufferSize], err)
Adam Langley6392fc72011-04-13 15:12:28 -0400812 }
Rob Pike64776da2011-12-13 15:07:17 -0800813 data = data[len(line):]
Adam Langley6392fc72011-04-13 15:12:28 -0400814 line, isPrefix, err = l.ReadLine()
Rob Pike64776da2011-12-13 15:07:17 -0800815 if isPrefix || !bytes.Equal(line, data[:minReadBufferSize/2]) || err != nil {
816 t.Errorf("bad result for third line: got %q want %q %v", line, data[:minReadBufferSize/2], err)
Adam Langley6392fc72011-04-13 15:12:28 -0400817 }
818 line, isPrefix, err = l.ReadLine()
819 if isPrefix || err == nil {
820 t.Errorf("expected no more lines: %x %s", line, err)
821 }
822}
823
824func TestReadAfterLines(t *testing.T) {
Rob Pike64776da2011-12-13 15:07:17 -0800825 line1 := "this is line1"
826 restData := "this is line2\nthis is line 3\n"
Brad Fitzpatricka18f4ab2014-01-27 11:05:01 -0800827 inbuf := bytes.NewReader([]byte(line1 + "\n" + restData))
Adam Langley6392fc72011-04-13 15:12:28 -0400828 outbuf := new(bytes.Buffer)
829 maxLineLength := len(line1) + len(restData)/2
Rob Pikebb7b1a12012-02-08 13:07:13 +1100830 l := NewReaderSize(inbuf, maxLineLength)
Adam Langley6392fc72011-04-13 15:12:28 -0400831 line, isPrefix, err := l.ReadLine()
832 if isPrefix || err != nil || string(line) != line1 {
833 t.Errorf("bad result for first line: isPrefix=%v err=%v line=%q", isPrefix, err, string(line))
834 }
835 n, err := io.Copy(outbuf, l)
836 if int(n) != len(restData) || err != nil {
837 t.Errorf("bad result for Read: n=%d err=%v", n, err)
838 }
839 if outbuf.String() != restData {
840 t.Errorf("bad result for Read: got %q; expected %q", outbuf.String(), restData)
841 }
842}
843
844func TestReadEmptyBuffer(t *testing.T) {
Rob Pikebb7b1a12012-02-08 13:07:13 +1100845 l := NewReaderSize(new(bytes.Buffer), minReadBufferSize)
Adam Langley6392fc72011-04-13 15:12:28 -0400846 line, isPrefix, err := l.ReadLine()
Russ Coxc2049d22011-11-01 22:04:37 -0400847 if err != io.EOF {
Adam Langley6392fc72011-04-13 15:12:28 -0400848 t.Errorf("expected EOF from ReadLine, got '%s' %t %s", line, isPrefix, err)
849 }
850}
851
852func TestLinesAfterRead(t *testing.T) {
Brad Fitzpatricka18f4ab2014-01-27 11:05:01 -0800853 l := NewReaderSize(bytes.NewReader([]byte("foo")), minReadBufferSize)
Adam Langley6392fc72011-04-13 15:12:28 -0400854 _, err := ioutil.ReadAll(l)
855 if err != nil {
856 t.Error(err)
857 return
858 }
859
860 line, isPrefix, err := l.ReadLine()
Russ Coxc2049d22011-11-01 22:04:37 -0400861 if err != io.EOF {
Adam Langley6392fc72011-04-13 15:12:28 -0400862 t.Errorf("expected EOF from ReadLine, got '%s' %t %s", line, isPrefix, err)
863 }
864}
Andrew Gerrand56f94842011-08-25 08:44:12 +1000865
Brad Fitzpatrickbd43eac2011-11-02 08:30:50 -0700866func TestReadLineNonNilLineOrError(t *testing.T) {
867 r := NewReader(strings.NewReader("line 1\n"))
868 for i := 0; i < 2; i++ {
869 l, _, err := r.ReadLine()
870 if l != nil && err != nil {
871 t.Fatalf("on line %d/2; ReadLine=%#v, %v; want non-nil line or Error, but not both",
872 i+1, l, err)
873 }
874 }
875}
876
Andrew Gerrand56f94842011-08-25 08:44:12 +1000877type readLineResult struct {
878 line []byte
879 isPrefix bool
Russ Coxc2049d22011-11-01 22:04:37 -0400880 err error
Andrew Gerrand56f94842011-08-25 08:44:12 +1000881}
882
883var readLineNewlinesTests = []struct {
Rob Pike64776da2011-12-13 15:07:17 -0800884 input string
885 expect []readLineResult
Andrew Gerrand56f94842011-08-25 08:44:12 +1000886}{
Rob Pike64776da2011-12-13 15:07:17 -0800887 {"012345678901234\r\n012345678901234\r\n", []readLineResult{
888 {[]byte("012345678901234"), true, nil},
Andrew Gerrand56f94842011-08-25 08:44:12 +1000889 {nil, false, nil},
Rob Pike64776da2011-12-13 15:07:17 -0800890 {[]byte("012345678901234"), true, nil},
Andrew Gerrand56f94842011-08-25 08:44:12 +1000891 {nil, false, nil},
Russ Coxc2049d22011-11-01 22:04:37 -0400892 {nil, false, io.EOF},
Andrew Gerrand56f94842011-08-25 08:44:12 +1000893 }},
Rob Pike64776da2011-12-13 15:07:17 -0800894 {"0123456789012345\r012345678901234\r", []readLineResult{
895 {[]byte("0123456789012345"), true, nil},
896 {[]byte("\r012345678901234"), true, nil},
Andrew Gerrand56f94842011-08-25 08:44:12 +1000897 {[]byte("\r"), false, nil},
Russ Coxc2049d22011-11-01 22:04:37 -0400898 {nil, false, io.EOF},
Andrew Gerrand56f94842011-08-25 08:44:12 +1000899 }},
900}
901
902func TestReadLineNewlines(t *testing.T) {
903 for _, e := range readLineNewlinesTests {
Rob Pike64776da2011-12-13 15:07:17 -0800904 testReadLineNewlines(t, e.input, e.expect)
Andrew Gerrand56f94842011-08-25 08:44:12 +1000905 }
906}
907
Rob Pike64776da2011-12-13 15:07:17 -0800908func testReadLineNewlines(t *testing.T, input string, expect []readLineResult) {
Rob Pikebb7b1a12012-02-08 13:07:13 +1100909 b := NewReaderSize(strings.NewReader(input), minReadBufferSize)
Andrew Gerrand56f94842011-08-25 08:44:12 +1000910 for i, e := range expect {
911 line, isPrefix, err := b.ReadLine()
Matthew Dempsky46811d22013-01-07 10:03:49 +1100912 if !bytes.Equal(line, e.line) {
Andrew Gerrand56f94842011-08-25 08:44:12 +1000913 t.Errorf("%q call %d, line == %q, want %q", input, i, line, e.line)
914 return
915 }
916 if isPrefix != e.isPrefix {
917 t.Errorf("%q call %d, isPrefix == %v, want %v", input, i, isPrefix, e.isPrefix)
918 return
919 }
920 if err != e.err {
921 t.Errorf("%q call %d, err == %v, want %v", input, i, err, e.err)
922 return
923 }
924 }
925}
Michael Chatene289a2b2012-09-27 16:31:03 +1000926
Michael Chaten2a4818d2012-10-19 11:22:51 +1100927func createTestInput(n int) []byte {
928 input := make([]byte, n)
Michael Chatene289a2b2012-09-27 16:31:03 +1000929 for i := range input {
930 // 101 and 251 are arbitrary prime numbers.
931 // The idea is to create an input sequence
932 // which doesn't repeat too frequently.
933 input[i] = byte(i % 251)
934 if i%101 == 0 {
935 input[i] ^= byte(i / 101)
936 }
937 }
Michael Chaten2a4818d2012-10-19 11:22:51 +1100938 return input
939}
940
941func TestReaderWriteTo(t *testing.T) {
942 input := createTestInput(8192)
Brad Fitzpatricka18f4ab2014-01-27 11:05:01 -0800943 r := NewReader(onlyReader{bytes.NewReader(input)})
Michael Chatene289a2b2012-09-27 16:31:03 +1000944 w := new(bytes.Buffer)
945 if n, err := r.WriteTo(w); err != nil || n != int64(len(input)) {
946 t.Fatalf("r.WriteTo(w) = %d, %v, want %d, nil", n, err, len(input))
947 }
948
949 for i, val := range w.Bytes() {
950 if val != input[i] {
951 t.Errorf("after write: out[%d] = %#x, want %#x", i, val, input[i])
952 }
953 }
954}
955
956type errorWriterToTest struct {
957 rn, wn int
958 rerr, werr error
959 expected error
960}
961
962func (r errorWriterToTest) Read(p []byte) (int, error) {
963 return len(p) * r.rn, r.rerr
964}
965
966func (w errorWriterToTest) Write(p []byte) (int, error) {
967 return len(p) * w.wn, w.werr
968}
969
970var errorWriterToTests = []errorWriterToTest{
971 {1, 0, nil, io.ErrClosedPipe, io.ErrClosedPipe},
972 {0, 1, io.ErrClosedPipe, nil, io.ErrClosedPipe},
973 {0, 0, io.ErrUnexpectedEOF, io.ErrClosedPipe, io.ErrClosedPipe},
974 {0, 1, io.EOF, nil, nil},
975}
976
977func TestReaderWriteToErrors(t *testing.T) {
978 for i, rw := range errorWriterToTests {
979 r := NewReader(rw)
980 if _, err := r.WriteTo(rw); err != rw.expected {
981 t.Errorf("r.WriteTo(errorWriterToTests[%d]) = _, %v, want _,%v", i, err, rw.expected)
982 }
983 }
984}
985
Michael Chaten2a4818d2012-10-19 11:22:51 +1100986func TestWriterReadFrom(t *testing.T) {
987 ws := []func(io.Writer) io.Writer{
Nigel Tao0ba5ec52012-10-20 13:02:29 +1100988 func(w io.Writer) io.Writer { return onlyWriter{w} },
Michael Chaten2a4818d2012-10-19 11:22:51 +1100989 func(w io.Writer) io.Writer { return w },
990 }
991
992 rs := []func(io.Reader) io.Reader{
993 iotest.DataErrReader,
994 func(r io.Reader) io.Reader { return r },
995 }
996
997 for ri, rfunc := range rs {
998 for wi, wfunc := range ws {
999 input := createTestInput(8192)
1000 b := new(bytes.Buffer)
1001 w := NewWriter(wfunc(b))
Brad Fitzpatricka18f4ab2014-01-27 11:05:01 -08001002 r := rfunc(bytes.NewReader(input))
Michael Chaten2a4818d2012-10-19 11:22:51 +11001003 if n, err := w.ReadFrom(r); err != nil || n != int64(len(input)) {
1004 t.Errorf("ws[%d],rs[%d]: w.ReadFrom(r) = %d, %v, want %d, nil", wi, ri, n, err, len(input))
1005 continue
1006 }
Andrew Gerrand93c6d0e2013-07-25 11:29:13 +10001007 if err := w.Flush(); err != nil {
1008 t.Errorf("Flush returned %v", err)
1009 continue
1010 }
Michael Chaten2a4818d2012-10-19 11:22:51 +11001011 if got, want := b.String(), string(input); got != want {
1012 t.Errorf("ws[%d], rs[%d]:\ngot %q\nwant %q\n", wi, ri, got, want)
1013 }
1014 }
1015 }
1016}
1017
1018type errorReaderFromTest struct {
1019 rn, wn int
1020 rerr, werr error
1021 expected error
1022}
1023
1024func (r errorReaderFromTest) Read(p []byte) (int, error) {
1025 return len(p) * r.rn, r.rerr
1026}
1027
1028func (w errorReaderFromTest) Write(p []byte) (int, error) {
1029 return len(p) * w.wn, w.werr
1030}
1031
1032var errorReaderFromTests = []errorReaderFromTest{
1033 {0, 1, io.EOF, nil, nil},
1034 {1, 1, io.EOF, nil, nil},
1035 {0, 1, io.ErrClosedPipe, nil, io.ErrClosedPipe},
1036 {0, 0, io.ErrClosedPipe, io.ErrShortWrite, io.ErrClosedPipe},
1037 {1, 0, nil, io.ErrShortWrite, io.ErrShortWrite},
1038}
1039
1040func TestWriterReadFromErrors(t *testing.T) {
1041 for i, rw := range errorReaderFromTests {
1042 w := NewWriter(rw)
1043 if _, err := w.ReadFrom(rw); err != rw.expected {
1044 t.Errorf("w.ReadFrom(errorReaderFromTests[%d]) = _, %v, want _,%v", i, err, rw.expected)
1045 }
1046 }
1047}
1048
Nigel Taoe55fdff2012-10-19 16:32:00 +11001049// TestWriterReadFromCounts tests that using io.Copy to copy into a
1050// bufio.Writer does not prematurely flush the buffer. For example, when
1051// buffering writes to a network socket, excessive network writes should be
1052// avoided.
1053func TestWriterReadFromCounts(t *testing.T) {
1054 var w0 writeCountingDiscard
1055 b0 := NewWriterSize(&w0, 1234)
1056 b0.WriteString(strings.Repeat("x", 1000))
1057 if w0 != 0 {
1058 t.Fatalf("write 1000 'x's: got %d writes, want 0", w0)
1059 }
1060 b0.WriteString(strings.Repeat("x", 200))
1061 if w0 != 0 {
1062 t.Fatalf("write 1200 'x's: got %d writes, want 0", w0)
1063 }
Nigel Tao0ba5ec52012-10-20 13:02:29 +11001064 io.Copy(b0, onlyReader{strings.NewReader(strings.Repeat("x", 30))})
Nigel Taoe55fdff2012-10-19 16:32:00 +11001065 if w0 != 0 {
1066 t.Fatalf("write 1230 'x's: got %d writes, want 0", w0)
1067 }
Nigel Tao0ba5ec52012-10-20 13:02:29 +11001068 io.Copy(b0, onlyReader{strings.NewReader(strings.Repeat("x", 9))})
Nigel Taoe55fdff2012-10-19 16:32:00 +11001069 if w0 != 1 {
1070 t.Fatalf("write 1239 'x's: got %d writes, want 1", w0)
1071 }
1072
1073 var w1 writeCountingDiscard
1074 b1 := NewWriterSize(&w1, 1234)
1075 b1.WriteString(strings.Repeat("x", 1200))
1076 b1.Flush()
1077 if w1 != 1 {
1078 t.Fatalf("flush 1200 'x's: got %d writes, want 1", w1)
1079 }
1080 b1.WriteString(strings.Repeat("x", 89))
1081 if w1 != 1 {
1082 t.Fatalf("write 1200 + 89 'x's: got %d writes, want 1", w1)
1083 }
Nigel Tao0ba5ec52012-10-20 13:02:29 +11001084 io.Copy(b1, onlyReader{strings.NewReader(strings.Repeat("x", 700))})
Nigel Taoe55fdff2012-10-19 16:32:00 +11001085 if w1 != 1 {
1086 t.Fatalf("write 1200 + 789 'x's: got %d writes, want 1", w1)
1087 }
Nigel Tao0ba5ec52012-10-20 13:02:29 +11001088 io.Copy(b1, onlyReader{strings.NewReader(strings.Repeat("x", 600))})
Nigel Taoe55fdff2012-10-19 16:32:00 +11001089 if w1 != 2 {
1090 t.Fatalf("write 1200 + 1389 'x's: got %d writes, want 2", w1)
1091 }
1092 b1.Flush()
1093 if w1 != 3 {
1094 t.Fatalf("flush 1200 + 1389 'x's: got %d writes, want 3", w1)
1095 }
1096}
1097
1098// A writeCountingDiscard is like ioutil.Discard and counts the number of times
1099// Write is called on it.
1100type writeCountingDiscard int
1101
1102func (w *writeCountingDiscard) Write(p []byte) (int, error) {
1103 *w++
1104 return len(p), nil
1105}
1106
Russ Coxf0d9ccb2012-12-10 17:25:31 -05001107type negativeReader int
1108
1109func (r *negativeReader) Read([]byte) (int, error) { return -1, nil }
1110
1111func TestNegativeRead(t *testing.T) {
1112 // should panic with a description pointing at the reader, not at itself.
1113 // (should NOT panic with slice index error, for example.)
1114 b := NewReader(new(negativeReader))
1115 defer func() {
1116 switch err := recover().(type) {
1117 case nil:
1118 t.Fatal("read did not panic")
1119 case error:
1120 if !strings.Contains(err.Error(), "reader returned negative count from Read") {
Rob Pike55ad7b92013-02-20 12:14:31 -08001121 t.Fatalf("wrong panic: %v", err)
Russ Coxf0d9ccb2012-12-10 17:25:31 -05001122 }
1123 default:
1124 t.Fatalf("unexpected panic value: %T(%v)", err, err)
1125 }
1126 }()
1127 b.Read(make([]byte, 100))
1128}
1129
Brad Fitzpatrickdc71ace2013-03-21 19:59:49 -07001130var errFake = errors.New("fake error")
1131
1132type errorThenGoodReader struct {
1133 didErr bool
1134 nread int
1135}
1136
1137func (r *errorThenGoodReader) Read(p []byte) (int, error) {
1138 r.nread++
1139 if !r.didErr {
1140 r.didErr = true
1141 return 0, errFake
1142 }
1143 return len(p), nil
1144}
1145
1146func TestReaderClearError(t *testing.T) {
1147 r := &errorThenGoodReader{}
1148 b := NewReader(r)
1149 buf := make([]byte, 1)
1150 if _, err := b.Read(nil); err != nil {
1151 t.Fatalf("1st nil Read = %v; want nil", err)
1152 }
1153 if _, err := b.Read(buf); err != errFake {
1154 t.Fatalf("1st Read = %v; want errFake", err)
1155 }
1156 if _, err := b.Read(nil); err != nil {
1157 t.Fatalf("2nd nil Read = %v; want nil", err)
1158 }
1159 if _, err := b.Read(buf); err != nil {
1160 t.Fatalf("3rd Read with buffer = %v; want nil", err)
1161 }
1162 if r.nread != 2 {
1163 t.Errorf("num reads = %d; want 2", r.nread)
1164 }
1165}
1166
Andrew Gerrand93c6d0e2013-07-25 11:29:13 +10001167// Test for golang.org/issue/5947
1168func TestWriterReadFromWhileFull(t *testing.T) {
1169 buf := new(bytes.Buffer)
1170 w := NewWriterSize(buf, 10)
1171
1172 // Fill buffer exactly.
1173 n, err := w.Write([]byte("0123456789"))
1174 if n != 10 || err != nil {
1175 t.Fatalf("Write returned (%v, %v), want (10, nil)", n, err)
1176 }
1177
1178 // Use ReadFrom to read in some data.
1179 n2, err := w.ReadFrom(strings.NewReader("abcdef"))
1180 if n2 != 6 || err != nil {
Rui Ueyamafa445842014-03-22 17:40:17 -07001181 t.Fatalf("ReadFrom returned (%v, %v), want (6, nil)", n2, err)
Andrew Gerrand93c6d0e2013-07-25 11:29:13 +10001182 }
1183}
1184
Rui Ueyama4ffc7992014-03-24 11:48:34 -07001185type emptyThenNonEmptyReader struct {
1186 r io.Reader
1187 n int
1188}
1189
1190func (r *emptyThenNonEmptyReader) Read(p []byte) (int, error) {
1191 if r.n <= 0 {
1192 return r.r.Read(p)
1193 }
1194 r.n--
1195 return 0, nil
1196}
1197
1198// Test for golang.org/issue/7611
1199func TestWriterReadFromUntilEOF(t *testing.T) {
1200 buf := new(bytes.Buffer)
1201 w := NewWriterSize(buf, 5)
1202
1203 // Partially fill buffer
1204 n, err := w.Write([]byte("0123"))
1205 if n != 4 || err != nil {
1206 t.Fatalf("Write returned (%v, %v), want (4, nil)", n, err)
1207 }
1208
1209 // Use ReadFrom to read in some data.
1210 r := &emptyThenNonEmptyReader{r: strings.NewReader("abcd"), n: 3}
1211 n2, err := w.ReadFrom(r)
1212 if n2 != 4 || err != nil {
1213 t.Fatalf("ReadFrom returned (%v, %v), want (4, nil)", n2, err)
1214 }
1215 w.Flush()
1216 if got, want := string(buf.Bytes()), "0123abcd"; got != want {
1217 t.Fatalf("buf.Bytes() returned %q, want %q", got, want)
1218 }
1219}
1220
1221func TestWriterReadFromErrNoProgress(t *testing.T) {
1222 buf := new(bytes.Buffer)
1223 w := NewWriterSize(buf, 5)
1224
1225 // Partially fill buffer
1226 n, err := w.Write([]byte("0123"))
1227 if n != 4 || err != nil {
1228 t.Fatalf("Write returned (%v, %v), want (4, nil)", n, err)
1229 }
1230
1231 // Use ReadFrom to read in some data.
1232 r := &emptyThenNonEmptyReader{r: strings.NewReader("abcd"), n: 100}
1233 n2, err := w.ReadFrom(r)
1234 if n2 != 0 || err != io.ErrNoProgress {
1235 t.Fatalf("buf.Bytes() returned (%v, %v), want (0, io.ErrNoProgress)", n2, err)
1236 }
1237}
1238
Russ Cox0794dce2016-10-17 21:08:48 -04001239func TestReadZero(t *testing.T) {
1240 for _, size := range []int{100, 2} {
1241 t.Run(fmt.Sprintf("bufsize=%d", size), func(t *testing.T) {
1242 r := io.MultiReader(strings.NewReader("abc"), &emptyThenNonEmptyReader{r: strings.NewReader("def"), n: 1})
1243 br := NewReaderSize(r, size)
1244 want := func(s string, wantErr error) {
1245 p := make([]byte, 50)
1246 n, err := br.Read(p)
1247 if err != wantErr || n != len(s) || string(p[:n]) != s {
1248 t.Fatalf("read(%d) = %q, %v, want %q, %v", len(p), string(p[:n]), err, s, wantErr)
1249 }
1250 t.Logf("read(%d) = %q, %v", len(p), string(p[:n]), err)
1251 }
1252 want("abc", nil)
1253 want("", nil)
1254 want("def", nil)
1255 want("", io.EOF)
1256 })
1257 }
1258}
1259
Brad Fitzpatrickede9aa92013-08-10 19:22:19 -07001260func TestReaderReset(t *testing.T) {
1261 r := NewReader(strings.NewReader("foo foo"))
1262 buf := make([]byte, 3)
1263 r.Read(buf)
1264 if string(buf) != "foo" {
1265 t.Errorf("buf = %q; want foo", buf)
1266 }
1267 r.Reset(strings.NewReader("bar bar"))
1268 all, err := ioutil.ReadAll(r)
1269 if err != nil {
1270 t.Fatal(err)
1271 }
1272 if string(all) != "bar bar" {
1273 t.Errorf("ReadAll = %q; want bar bar", all)
1274 }
1275}
1276
1277func TestWriterReset(t *testing.T) {
1278 var buf1, buf2 bytes.Buffer
1279 w := NewWriter(&buf1)
1280 w.WriteString("foo")
1281 w.Reset(&buf2) // and not flushed
1282 w.WriteString("bar")
1283 w.Flush()
1284 if buf1.String() != "" {
1285 t.Errorf("buf1 = %q; want empty", buf1.String())
1286 }
1287 if buf2.String() != "bar" {
1288 t.Errorf("buf2 = %q; want bar", buf2.String())
1289 }
1290}
1291
Brad Fitzpatrickee2ecc42015-01-02 10:02:15 -08001292func TestReaderDiscard(t *testing.T) {
1293 tests := []struct {
1294 name string
1295 r io.Reader
1296 bufSize int // 0 means 16
1297 peekSize int
1298
1299 n int // input to Discard
1300
1301 want int // from Discard
1302 wantErr error // from Discard
1303
1304 wantBuffered int
1305 }{
1306 {
1307 name: "normal case",
1308 r: strings.NewReader("abcdefghijklmnopqrstuvwxyz"),
1309 peekSize: 16,
1310 n: 6,
1311 want: 6,
1312 wantBuffered: 10,
1313 },
1314 {
1315 name: "discard causing read",
1316 r: strings.NewReader("abcdefghijklmnopqrstuvwxyz"),
1317 n: 6,
1318 want: 6,
1319 wantBuffered: 10,
1320 },
1321 {
1322 name: "discard all without peek",
1323 r: strings.NewReader("abcdefghijklmnopqrstuvwxyz"),
1324 n: 26,
1325 want: 26,
1326 wantBuffered: 0,
1327 },
1328 {
1329 name: "discard more than end",
1330 r: strings.NewReader("abcdefghijklmnopqrstuvwxyz"),
1331 n: 27,
1332 want: 26,
1333 wantErr: io.EOF,
1334 wantBuffered: 0,
1335 },
1336 // Any error from filling shouldn't show up until we
1337 // get past the valid bytes. Here we return we return 5 valid bytes at the same time
1338 // as an error, but test that we don't see the error from Discard.
1339 {
1340 name: "fill error, discard less",
1341 r: newScriptedReader(func(p []byte) (n int, err error) {
1342 if len(p) < 5 {
1343 panic("unexpected small read")
1344 }
1345 return 5, errors.New("5-then-error")
1346 }),
1347 n: 4,
1348 want: 4,
1349 wantErr: nil,
1350 wantBuffered: 1,
1351 },
1352 {
1353 name: "fill error, discard equal",
1354 r: newScriptedReader(func(p []byte) (n int, err error) {
1355 if len(p) < 5 {
1356 panic("unexpected small read")
1357 }
1358 return 5, errors.New("5-then-error")
1359 }),
1360 n: 5,
1361 want: 5,
1362 wantErr: nil,
1363 wantBuffered: 0,
1364 },
1365 {
1366 name: "fill error, discard more",
1367 r: newScriptedReader(func(p []byte) (n int, err error) {
1368 if len(p) < 5 {
1369 panic("unexpected small read")
1370 }
1371 return 5, errors.New("5-then-error")
1372 }),
1373 n: 6,
1374 want: 5,
1375 wantErr: errors.New("5-then-error"),
1376 wantBuffered: 0,
1377 },
1378 // Discard of 0 shouldn't cause a read:
1379 {
1380 name: "discard zero",
1381 r: newScriptedReader(), // will panic on Read
1382 n: 0,
1383 want: 0,
1384 wantErr: nil,
1385 wantBuffered: 0,
1386 },
1387 {
1388 name: "discard negative",
1389 r: newScriptedReader(), // will panic on Read
1390 n: -1,
1391 want: 0,
1392 wantErr: ErrNegativeCount,
1393 wantBuffered: 0,
1394 },
1395 }
1396 for _, tt := range tests {
1397 br := NewReaderSize(tt.r, tt.bufSize)
1398 if tt.peekSize > 0 {
1399 peekBuf, err := br.Peek(tt.peekSize)
1400 if err != nil {
1401 t.Errorf("%s: Peek(%d): %v", tt.name, tt.peekSize, err)
1402 continue
1403 }
1404 if len(peekBuf) != tt.peekSize {
1405 t.Errorf("%s: len(Peek(%d)) = %v; want %v", tt.name, tt.peekSize, len(peekBuf), tt.peekSize)
1406 continue
1407 }
1408 }
1409 discarded, err := br.Discard(tt.n)
1410 if ge, we := fmt.Sprint(err), fmt.Sprint(tt.wantErr); discarded != tt.want || ge != we {
1411 t.Errorf("%s: Discard(%d) = (%v, %v); want (%v, %v)", tt.name, tt.n, discarded, ge, tt.want, we)
1412 continue
1413 }
1414 if bn := br.Buffered(); bn != tt.wantBuffered {
1415 t.Errorf("%s: after Discard, Buffered = %d; want %d", tt.name, bn, tt.wantBuffered)
1416 }
1417 }
1418
1419}
1420
Brad Fitzpatrick6128ff82017-11-01 19:00:05 +00001421func TestReaderSize(t *testing.T) {
1422 if got, want := NewReader(nil).Size(), DefaultBufSize; got != want {
1423 t.Errorf("NewReader's Reader.Size = %d; want %d", got, want)
1424 }
1425 if got, want := NewReaderSize(nil, 1234).Size(), 1234; got != want {
1426 t.Errorf("NewReaderSize's Reader.Size = %d; want %d", got, want)
1427 }
1428}
1429
1430func TestWriterSize(t *testing.T) {
1431 if got, want := NewWriter(nil).Size(), DefaultBufSize; got != want {
1432 t.Errorf("NewWriter's Writer.Size = %d; want %d", got, want)
1433 }
1434 if got, want := NewWriterSize(nil, 1234).Size(), 1234; got != want {
1435 t.Errorf("NewWriterSize's Writer.Size = %d; want %d", got, want)
1436 }
1437}
1438
Michael Chatene289a2b2012-09-27 16:31:03 +10001439// An onlyReader only implements io.Reader, no matter what other methods the underlying implementation may have.
1440type onlyReader struct {
Brad Fitzpatrickb00e4772014-02-27 10:48:36 -08001441 io.Reader
Michael Chatene289a2b2012-09-27 16:31:03 +10001442}
1443
1444// An onlyWriter only implements io.Writer, no matter what other methods the underlying implementation may have.
1445type onlyWriter struct {
Brad Fitzpatrickb00e4772014-02-27 10:48:36 -08001446 io.Writer
Michael Chatene289a2b2012-09-27 16:31:03 +10001447}
1448
Brad Fitzpatrickee2ecc42015-01-02 10:02:15 -08001449// A scriptedReader is an io.Reader that executes its steps sequentially.
1450type scriptedReader []func(p []byte) (n int, err error)
1451
1452func (sr *scriptedReader) Read(p []byte) (n int, err error) {
1453 if len(*sr) == 0 {
1454 panic("too many Read calls on scripted Reader. No steps remain.")
1455 }
1456 step := (*sr)[0]
1457 *sr = (*sr)[1:]
1458 return step(p)
1459}
1460
1461func newScriptedReader(steps ...func(p []byte) (n int, err error)) io.Reader {
1462 sr := scriptedReader(steps)
1463 return &sr
1464}
1465
Michael Chatene289a2b2012-09-27 16:31:03 +10001466func BenchmarkReaderCopyOptimal(b *testing.B) {
1467 // Optimal case is where the underlying reader implements io.WriterTo
Dmitriy Vyukov0ad2cd02014-01-23 15:13:21 -05001468 srcBuf := bytes.NewBuffer(make([]byte, 8192))
1469 src := NewReader(srcBuf)
1470 dstBuf := new(bytes.Buffer)
1471 dst := onlyWriter{dstBuf}
Michael Chatene289a2b2012-09-27 16:31:03 +10001472 for i := 0; i < b.N; i++ {
Dmitriy Vyukov0ad2cd02014-01-23 15:13:21 -05001473 srcBuf.Reset()
1474 src.Reset(srcBuf)
1475 dstBuf.Reset()
Michael Chatene289a2b2012-09-27 16:31:03 +10001476 io.Copy(dst, src)
1477 }
1478}
1479
1480func BenchmarkReaderCopyUnoptimal(b *testing.B) {
1481 // Unoptimal case is where the underlying reader doesn't implement io.WriterTo
Dmitriy Vyukov0ad2cd02014-01-23 15:13:21 -05001482 srcBuf := bytes.NewBuffer(make([]byte, 8192))
1483 src := NewReader(onlyReader{srcBuf})
1484 dstBuf := new(bytes.Buffer)
1485 dst := onlyWriter{dstBuf}
Michael Chatene289a2b2012-09-27 16:31:03 +10001486 for i := 0; i < b.N; i++ {
Dmitriy Vyukov0ad2cd02014-01-23 15:13:21 -05001487 srcBuf.Reset()
1488 src.Reset(onlyReader{srcBuf})
1489 dstBuf.Reset()
Michael Chatene289a2b2012-09-27 16:31:03 +10001490 io.Copy(dst, src)
1491 }
1492}
1493
1494func BenchmarkReaderCopyNoWriteTo(b *testing.B) {
Dmitriy Vyukov0ad2cd02014-01-23 15:13:21 -05001495 srcBuf := bytes.NewBuffer(make([]byte, 8192))
1496 srcReader := NewReader(srcBuf)
1497 src := onlyReader{srcReader}
1498 dstBuf := new(bytes.Buffer)
1499 dst := onlyWriter{dstBuf}
Michael Chatene289a2b2012-09-27 16:31:03 +10001500 for i := 0; i < b.N; i++ {
Dmitriy Vyukov0ad2cd02014-01-23 15:13:21 -05001501 srcBuf.Reset()
1502 srcReader.Reset(srcBuf)
1503 dstBuf.Reset()
Michael Chatene289a2b2012-09-27 16:31:03 +10001504 io.Copy(dst, src)
1505 }
1506}
Michael Chaten2a4818d2012-10-19 11:22:51 +11001507
Brad Fitzpatrickb00e4772014-02-27 10:48:36 -08001508func BenchmarkReaderWriteToOptimal(b *testing.B) {
1509 const bufSize = 16 << 10
1510 buf := make([]byte, bufSize)
1511 r := bytes.NewReader(buf)
1512 srcReader := NewReaderSize(onlyReader{r}, 1<<10)
1513 if _, ok := ioutil.Discard.(io.ReaderFrom); !ok {
1514 b.Fatal("ioutil.Discard doesn't support ReaderFrom")
1515 }
1516 for i := 0; i < b.N; i++ {
Joe Tsaiacc757f2016-04-05 11:22:53 -07001517 r.Seek(0, io.SeekStart)
Brad Fitzpatrickb00e4772014-02-27 10:48:36 -08001518 srcReader.Reset(onlyReader{r})
1519 n, err := srcReader.WriteTo(ioutil.Discard)
1520 if err != nil {
1521 b.Fatal(err)
1522 }
1523 if n != bufSize {
1524 b.Fatalf("n = %d; want %d", n, bufSize)
1525 }
1526 }
1527}
1528
Michael Chaten2a4818d2012-10-19 11:22:51 +11001529func BenchmarkWriterCopyOptimal(b *testing.B) {
1530 // Optimal case is where the underlying writer implements io.ReaderFrom
Dmitriy Vyukov0ad2cd02014-01-23 15:13:21 -05001531 srcBuf := bytes.NewBuffer(make([]byte, 8192))
1532 src := onlyReader{srcBuf}
1533 dstBuf := new(bytes.Buffer)
1534 dst := NewWriter(dstBuf)
Michael Chaten2a4818d2012-10-19 11:22:51 +11001535 for i := 0; i < b.N; i++ {
Dmitriy Vyukov0ad2cd02014-01-23 15:13:21 -05001536 srcBuf.Reset()
1537 dstBuf.Reset()
1538 dst.Reset(dstBuf)
Michael Chaten2a4818d2012-10-19 11:22:51 +11001539 io.Copy(dst, src)
1540 }
1541}
1542
1543func BenchmarkWriterCopyUnoptimal(b *testing.B) {
Dmitriy Vyukov0ad2cd02014-01-23 15:13:21 -05001544 srcBuf := bytes.NewBuffer(make([]byte, 8192))
1545 src := onlyReader{srcBuf}
1546 dstBuf := new(bytes.Buffer)
1547 dst := NewWriter(onlyWriter{dstBuf})
Michael Chaten2a4818d2012-10-19 11:22:51 +11001548 for i := 0; i < b.N; i++ {
Dmitriy Vyukov0ad2cd02014-01-23 15:13:21 -05001549 srcBuf.Reset()
1550 dstBuf.Reset()
1551 dst.Reset(onlyWriter{dstBuf})
Michael Chaten2a4818d2012-10-19 11:22:51 +11001552 io.Copy(dst, src)
1553 }
1554}
1555
1556func BenchmarkWriterCopyNoReadFrom(b *testing.B) {
Dmitriy Vyukov0ad2cd02014-01-23 15:13:21 -05001557 srcBuf := bytes.NewBuffer(make([]byte, 8192))
1558 src := onlyReader{srcBuf}
1559 dstBuf := new(bytes.Buffer)
1560 dstWriter := NewWriter(dstBuf)
1561 dst := onlyWriter{dstWriter}
Michael Chaten2a4818d2012-10-19 11:22:51 +11001562 for i := 0; i < b.N; i++ {
Dmitriy Vyukov0ad2cd02014-01-23 15:13:21 -05001563 srcBuf.Reset()
1564 dstBuf.Reset()
1565 dstWriter.Reset(dstBuf)
Michael Chaten2a4818d2012-10-19 11:22:51 +11001566 io.Copy(dst, src)
1567 }
1568}
Brad Fitzpatrickb25a53a2013-05-17 15:16:06 -07001569
1570func BenchmarkReaderEmpty(b *testing.B) {
1571 b.ReportAllocs()
1572 str := strings.Repeat("x", 16<<10)
1573 for i := 0; i < b.N; i++ {
1574 br := NewReader(strings.NewReader(str))
1575 n, err := io.Copy(ioutil.Discard, br)
1576 if err != nil {
1577 b.Fatal(err)
1578 }
1579 if n != int64(len(str)) {
1580 b.Fatal("wrong length")
1581 }
1582 }
1583}
Brad Fitzpatrick99f67222013-05-21 15:51:49 -07001584
1585func BenchmarkWriterEmpty(b *testing.B) {
1586 b.ReportAllocs()
1587 str := strings.Repeat("x", 1<<10)
1588 bs := []byte(str)
1589 for i := 0; i < b.N; i++ {
1590 bw := NewWriter(ioutil.Discard)
1591 bw.Flush()
1592 bw.WriteByte('a')
1593 bw.Flush()
1594 bw.WriteRune('B')
1595 bw.Flush()
1596 bw.Write(bs)
1597 bw.Flush()
1598 bw.WriteString(str)
1599 bw.Flush()
1600 }
1601}
1602
1603func BenchmarkWriterFlush(b *testing.B) {
1604 b.ReportAllocs()
1605 bw := NewWriter(ioutil.Discard)
1606 str := strings.Repeat("x", 50)
1607 for i := 0; i < b.N; i++ {
1608 bw.WriteString(str)
1609 bw.Flush()
1610 }
1611}