File: streamquote_test.go

package info (click to toggle)
golang-github-nkovacs-streamquote 1.0.0-5
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid, trixie
  • size: 108 kB
  • sloc: makefile: 2
file content (149 lines) | stat: -rw-r--r-- 3,555 bytes parent folder | download | duplicates (2)
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
package streamquote

import (
	"bytes"
	"io"
	"io/ioutil"
	"math/rand"
	"strconv"
	"strings"
	"testing"
)

// Taken from stdlib's strconv/quote_test.go
type quoteTest struct {
	in      string
	out     string
	ascii   string
	graphic string
}

var quotetests = []quoteTest{
	{"\a\b\f\r\n\t\v", `"\a\b\f\r\n\t\v"`, `"\a\b\f\r\n\t\v"`, `"\a\b\f\r\n\t\v"`},
	{"\\", `"\\"`, `"\\"`, `"\\"`},
	{"abc\xffdef", `"abc\xffdef"`, `"abc\xffdef"`, `"abc\xffdef"`},
	{"\u263a", `"☺"`, `"\u263a"`, `"☺"`},
	{"\U0010ffff", `"\U0010ffff"`, `"\U0010ffff"`, `"\U0010ffff"`},
	{"\x04", `"\x04"`, `"\x04"`, `"\x04"`},
	// Some non-printable but graphic runes. Final column is double-quoted.
	{"!\u00a0!\u2000!\u3000!", `"!\u00a0!\u2000!\u3000!"`, `"!\u00a0!\u2000!\u3000!"`, "\"!\u00a0!\u2000!\u3000!\""},
}

func TestConverter(t *testing.T) {
	converter := New()

	for _, tt := range quotetests {
		var buffer bytes.Buffer
		converter.Convert(strings.NewReader(tt.in), &buffer)
		expected := tt.out[1 : len(tt.out)-1]
		if out := buffer.String(); out != expected {
			t.Errorf("Quote(%s) = %s, want %s", tt.in, out, expected)
		}
	}
}

// Size of the large string for benchmarking.
const largeSize = 10 * 1024 * 1024

// random seed for large string, to make the benchmark consistent.
const randSeed = 47

type randomRuneProvider struct {
	r     *rand.Rand
	limit int
	read  int
}

func (r *randomRuneProvider) Read(p []byte) (n int, err error) {
	n = len(p)
	available := r.limit - r.read
	if available < n {
		n = available
		err = io.EOF
	}
	for i := 0; i < n; i++ {
		p[i] = byte(r.r.Int63())
	}
	r.read += n
	return
}

func generateLargeString() io.Reader {
	source := rand.NewSource(randSeed)
	r := rand.New(source)

	return &randomRuneProvider{
		r:     r,
		limit: largeSize,
	}
}

// TestLargeString tests that converter and strconv.Quote
// return the same result for the large string.
func TestLargeString(t *testing.T) {
	largeStringReader := generateLargeString()
	b, err := ioutil.ReadAll(largeStringReader)
	if err != nil {
		t.Fatalf("Failed to read large string into buffer: %v", err)
	}
	expected := strconv.Quote(string(b))

	buffer := bytes.NewBufferString("\"")
	converter := New()

	largeStringReader = generateLargeString()
	_, err = converter.Convert(largeStringReader, buffer)
	if err != nil {
		t.Fatalf("Converter failed: %v", err)
	}
	buffer.WriteRune('"')
	got := buffer.String()
	if got != expected {
		t.Fatalf("Large string does not match")
	}
}

func BenchmarkConverterSmall(b *testing.B) {
	converter := New()
	r := strings.NewReader("\a\b\f\r\n\t\v\a\b\f\r\n\t\v\a\b\f\r\n\t\v")

	b.ResetTimer()

	for i := 0; i < b.N; i++ {
		converter.Convert(r, ioutil.Discard)
		r.Seek(0, 0)
	}
}

func BenchmarkStrconvQuoteSmall(b *testing.B) {
	for i := 0; i < b.N; i++ {
		strconv.Quote("\a\b\f\r\n\t\v\a\b\f\r\n\t\v\a\b\f\r\n\t\v")
	}
}

func BenchmarkConverterLarge(b *testing.B) {
	converter := New()

	b.ResetTimer()

	for i := 0; i < b.N; i++ {
		// Using ioutil.Discard here may not seem fair,
		// because strconv.Quote has to allocate the result string,
		// but the point of this package is that you don't have to
		// allocate the entire result string, you can stream the result.
		converter.Convert(generateLargeString(), ioutil.Discard)
	}
}

func BenchmarkStrconvQuoteLarge(b *testing.B) {
	largeStringReader := generateLargeString()
	bs, err := ioutil.ReadAll(largeStringReader)
	if err != nil {
		b.Fatalf("Failed to read large string into buffer: %v", err)
	}
	s := string(bs)

	for i := 0; i < b.N; i++ {
		strconv.Quote(s)
	}
}