File: shell_escape_test.go

package info (click to toggle)
gitlab-ci-multi-runner 14.10.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 31,248 kB
  • sloc: sh: 1,694; makefile: 384; asm: 79; ruby: 68
file content (92 lines) | stat: -rw-r--r-- 1,944 bytes parent folder | download
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
//go:build !integration
// +build !integration

package helpers

import (
	"crypto/rand"
	"strconv"
	"testing"

	"github.com/stretchr/testify/assert"
)

func BenchmarkEscaping(b *testing.B) {
	data := make([]byte, 1024*1024)
	if _, err := rand.Read(data); err != nil {
		panic(err)
	}

	input := string(data)

	b.Run("bash-ansi-c-shellescape", func(b *testing.B) {
		b.SetBytes(int64(len(input)))
		b.ReportAllocs()

		for i := 0; i < b.N; i++ {
			ShellEscape(input)
		}
	})

	b.Run("posix-shellescape", func(b *testing.B) {
		b.SetBytes(int64(len(input)))
		b.ReportAllocs()

		for i := 0; i < b.N; i++ {
			PosixShellEscape(input)
		}
	})

	b.Run("strconv.quote", func(b *testing.B) {
		b.SetBytes(int64(len(input)))
		b.ReportAllocs()

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

func TestShellEscape(t *testing.T) {
	var tests = []struct {
		in  string
		out string
	}{
		{"unquoted", "unquoted"},
		{"standard string", "$'standard string'"},
		{"+\t\n\r&", "$'+\\t\\n\\r&'"},
		{"", "''"},
		{"hello, 世界", "$'hello, \\xe4\\xb8\\x96\\xe7\\x95\\x8c'"},
		{"blackslash \\n", "$'blackslash \\\\n'"},
		{"f", "f"},
		{"\f", "$'\\f'"},
		{"export variable='test' && echo $variable", "$'export variable=\\'test\\' && echo $variable'"},
	}

	for _, test := range tests {
		actual := ShellEscape(test.in)
		assert.Equal(t, test.out, actual, "src=%v", test.in)
	}
}

func TestPosixShellEscape(t *testing.T) {
	var tests = []struct {
		in  string
		out string
	}{
		{"unquoted", "unquoted"},
		{"standard string", `"standard string"`},
		{"+\t\n\r&", "\"+\t\n\r&\""},
		{"", "''"},
		{"hello, 世界", `"hello, 世界"`},
		{"blackslash \\n", "\"blackslash \\\\n\""},
		{"f", "f"},
		{"\f", "\f"},
		{"export variable='test' && echo $variable", `"export variable='test' && echo \$variable"`},
	}

	for _, test := range tests {
		actual := PosixShellEscape(test.in)
		assert.Equal(t, test.out, actual, "src=%v", test.in)
	}
}