term/proxy_test.go at main · moby/term · GitHub

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
package term_test

import (
	"bytes"
	"errors"
	"io"
	"testing"

	"github.com/moby/term"
)

func TestEscapeProxyRead(t *testing.T) {
	type readStep struct {
		size   int
		n      int
		expErr error
		buf    []byte
	}

	tests := []struct {
		name       string
		escapeKeys string
		keys       string
		reads      []readStep
	}{
		{
			name: "no escape keys, single key",
			keys: "a",
			reads: []readStep{
				{size: 1, n: 1, buf: []byte("a")},
			},
		},
		{
			name: "no escape keys, multiple keys",
			keys: "a,b,c",
			reads: []readStep{
				{size: 3, n: 3, buf: []byte("abc")},
			},
		},
		{
			name: "no escape keys, no input",
			reads: []readStep{
				{size: 0, n: 0, expErr: io.EOF},
			},
		},
		{
			name:       "DEL escape key, unmatched input",
			escapeKeys: "DEL",
			keys:       "a,b,c,+",
			reads: []readStep{
				{size: 4, n: 4, buf: []byte("abc+")},
			},
		},
		{
			name:       "DEL escape key, no input",
			escapeKeys: "DEL",
			reads: []readStep{
				{size: 0, n: 0, expErr: io.EOF},
			},
		},
		{
			name:       "ctrl-x,ctrl-@ escape sequence, unmatched DEL",
			escapeKeys: "ctrl-x,ctrl-@",
			keys:       "DEL",
			reads: []readStep{
				{size: 1, n: 1, buf: []byte{'\x7f'}},
			},
		},
		{
			name:       "ctrl-c escape key, complete match",
			escapeKeys: "ctrl-c",
			keys:       "ctrl-c",
			reads: []readStep{
				{size: 1, n: 0, expErr: term.EscapeError{}, buf: []byte{'\x03'}},
			},
		},
		{
			name:       "ctrl-c,ctrl-z escape sequence, match across reads",
			escapeKeys: "ctrl-c,ctrl-z",
			keys:       "ctrl-c,ctrl-z",
			reads: []readStep{
				{size: 1, n: 0, buf: []byte{'\x03'}},
				{size: 1, n: 0, expErr: term.EscapeError{}, buf: []byte{'\x1a'}},
			},
		},
		{
			name:       "ctrl-c,ctrl-z escape sequence, match in one read",
			escapeKeys: "ctrl-c,ctrl-z",
			keys:       "ctrl-c,ctrl-z",
			reads: []readStep{
				{size: 2, n: 0, expErr: term.EscapeError{}, buf: []byte{'\x03', '\x1a'}},
			},
		},
		{
			name:       "ctrl-c,ctrl-z escape sequence, partial match followed by DEL and plus",
			escapeKeys: "ctrl-c,ctrl-z",
			keys:       "ctrl-c,DEL,+",
			reads: []readStep{
				{size: 1, n: 0, buf: []byte{'\x03'}},
				{size: 3, n: 3, buf: []byte{'\x03', '\x7f', '+'}},
			},
		},
		{
			name:       "ctrl-c,ctrl-z escape sequence, partial match followed by DEL",
			escapeKeys: "ctrl-c,ctrl-z",
			keys:       "ctrl-c,DEL",
			reads: []readStep{
				{size: 1, n: 0, buf: []byte{'\x03'}},
				{size: 2, n: 2, buf: []byte{'\x03', '\x7f'}},
			},
		},
		{
			name:       "four-key escape sequence, match across reads",
			escapeKeys: "a,b,c,d",
			keys:       "a,b,c,d",
			reads: []readStep{
				{size: 2, n: 0, buf: []byte("ab")},
				{size: 2, n: 0, expErr: term.EscapeError{}, buf: []byte("cd")},
			},
		},
		{
			name:       "ctrl-p,ctrl-q escape sequence, match after mismatch",
			escapeKeys: "ctrl-p,ctrl-q",
			keys:       "ctrl-p,a,ctrl-p,ctrl-q",
			reads: []readStep{
				{size: 1, n: 0},
				{size: 1, n: 1, buf: []byte{'\x10'}},
				{size: 2, n: 1, buf: []byte{'a', '\x10'}},
				{size: 2, n: 0, expErr: term.EscapeError{}},
			},
		},
	}

	for _, tc := range tests {
		t.Run(tc.name, func(t *testing.T) {
			var escapeKeys []byte
			var err error
			if tc.escapeKeys != "" {
				escapeKeys, err = term.ToBytes(tc.escapeKeys)
				if err != nil {
					t.Fatalf("parse escape keys: %v", err)
				}
			}
			var keys []byte
			if tc.keys != "" {
				keys, err = term.ToBytes(tc.keys)
				if err != nil {
					t.Fatalf("parse input keys: %v", err)
				}
			}

			reader := term.NewEscapeProxy(bytes.NewReader(keys), escapeKeys)
			for i, step := range tc.reads {
				buf := make([]byte, step.size)
				n, err := reader.Read(buf)
				if !errors.Is(err, step.expErr) {
					t.Errorf("read %d: expected error %v, got %v", i+1, step.expErr, err)
				}
				if n != step.n {
					t.Errorf("read %d: expected %d bytes, got %d", i+1, step.n, n)
				}
				// Compare the entire buffer, including when Read returns n == 0.
				if step.buf != nil && !bytes.Equal(buf, step.buf) {
					t.Errorf("read %d: expected buffer %v, got %v", i+1, step.buf, buf)
				}
			}
		})
	}
}