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 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
|
package memberlist
import (
"bytes"
"io"
"net"
"strings"
"testing"
"github.com/stretchr/testify/require"
)
func TestAddLabelHeaderToPacket(t *testing.T) {
type testcase struct {
buf []byte
label string
expectPacket []byte
expectErr string
}
run := func(t *testing.T, tc testcase) {
got, err := AddLabelHeaderToPacket(tc.buf, tc.label)
if tc.expectErr != "" {
require.Error(t, err)
require.Contains(t, err.Error(), tc.expectErr)
} else {
require.NoError(t, err)
require.Equal(t, tc.expectPacket, got)
}
}
longLabel := strings.Repeat("a", 255)
cases := map[string]testcase{
"nil buf with no label": testcase{
buf: nil,
label: "",
expectPacket: nil,
},
"nil buf with label": testcase{
buf: nil,
label: "foo",
expectPacket: append([]byte{byte(hasLabelMsg), 3}, []byte("foo")...),
},
"message with label": testcase{
buf: []byte("something"),
label: "foo",
expectPacket: append([]byte{byte(hasLabelMsg), 3}, []byte("foosomething")...),
},
"message with no label": testcase{
buf: []byte("something"),
label: "",
expectPacket: []byte("something"),
},
"message with almost too long label": testcase{
buf: []byte("something"),
label: longLabel,
expectPacket: append([]byte{byte(hasLabelMsg), 255}, []byte(longLabel+"something")...),
},
"label too long by one byte": testcase{
buf: []byte("something"),
label: longLabel + "x",
expectErr: `label "` + longLabel + `x" is too long`,
},
}
for name, tc := range cases {
t.Run(name, func(t *testing.T) {
run(t, tc)
})
}
}
func TestRemoveLabelHeaderFromPacket(t *testing.T) {
type testcase struct {
buf []byte
expectLabel string
expectPacket []byte
expectErr string
}
run := func(t *testing.T, tc testcase) {
gotBuf, gotLabel, err := RemoveLabelHeaderFromPacket(tc.buf)
if tc.expectErr != "" {
require.Error(t, err)
require.Contains(t, err.Error(), tc.expectErr)
} else {
require.NoError(t, err)
require.Equal(t, tc.expectPacket, gotBuf)
require.Equal(t, tc.expectLabel, gotLabel)
}
}
cases := map[string]testcase{
"empty buf": testcase{
buf: []byte{},
expectLabel: "",
expectPacket: []byte{},
},
"ping with no label": testcase{
buf: buildBuffer(t, pingMsg, "blah"),
expectLabel: "",
expectPacket: buildBuffer(t, pingMsg, "blah"),
},
"error with no label": testcase{ // 2021-10: largest standard message type
buf: buildBuffer(t, errMsg, "blah"),
expectLabel: "",
expectPacket: buildBuffer(t, errMsg, "blah"),
},
"v1 encrypt with no label": testcase{ // 2021-10: highest encryption version
buf: buildBuffer(t, maxEncryptionVersion, "blah"),
expectLabel: "",
expectPacket: buildBuffer(t, maxEncryptionVersion, "blah"),
},
"buf too small for label": testcase{
buf: buildBuffer(t, hasLabelMsg, "x"),
expectErr: `cannot decode label; packet has been truncated`,
},
"buf too small for label size": testcase{
buf: buildBuffer(t, hasLabelMsg),
expectErr: `cannot decode label; packet has been truncated`,
},
"label empty": testcase{
buf: buildBuffer(t, hasLabelMsg, 0, "x"),
expectErr: `label header cannot be empty when present`,
},
"label truncated": testcase{
buf: buildBuffer(t, hasLabelMsg, 2, "x"),
expectErr: `cannot decode label; packet has been truncated`,
},
"ping with label": testcase{
buf: buildBuffer(t, hasLabelMsg, 3, "abc", pingMsg, "blah"),
expectLabel: "abc",
expectPacket: buildBuffer(t, pingMsg, "blah"),
},
"error with label": testcase{ // 2021-10: largest standard message type
buf: buildBuffer(t, hasLabelMsg, 3, "abc", errMsg, "blah"),
expectLabel: "abc",
expectPacket: buildBuffer(t, errMsg, "blah"),
},
"v1 encrypt with label": testcase{ // 2021-10: highest encryption version
buf: buildBuffer(t, hasLabelMsg, 3, "abc", maxEncryptionVersion, "blah"),
expectLabel: "abc",
expectPacket: buildBuffer(t, maxEncryptionVersion, "blah"),
},
}
for name, tc := range cases {
t.Run(name, func(t *testing.T) {
run(t, tc)
})
}
}
func TestAddLabelHeaderToStream(t *testing.T) {
type testcase struct {
label string
expectData []byte
expectErr string
}
suffixData := "EXTRA DATA"
run := func(t *testing.T, tc testcase) {
server, client := net.Pipe()
defer server.Close()
defer client.Close()
var (
dataCh = make(chan []byte, 1)
errCh = make(chan error, 1)
)
go func() {
var buf bytes.Buffer
_, err := io.Copy(&buf, server)
if err != nil {
errCh <- err
}
dataCh <- buf.Bytes()
}()
err := AddLabelHeaderToStream(client, tc.label)
if tc.expectErr != "" {
require.Error(t, err)
require.Contains(t, err.Error(), tc.expectErr)
return
}
require.NoError(t, err)
client.Write([]byte(suffixData))
client.Close()
expect := make([]byte, 0, len(suffixData)+len(tc.expectData))
expect = append(expect, tc.expectData...)
expect = append(expect, suffixData...)
select {
case err := <-errCh:
require.NoError(t, err)
case got := <-dataCh:
require.Equal(t, expect, got)
}
}
longLabel := strings.Repeat("a", 255)
cases := map[string]testcase{
"no label": testcase{
label: "",
expectData: nil,
},
"with label": testcase{
label: "foo",
expectData: buildBuffer(t, hasLabelMsg, 3, "foo"),
},
"almost too long label": testcase{
label: longLabel,
expectData: buildBuffer(t, hasLabelMsg, 255, longLabel),
},
"label too long by one byte": testcase{
label: longLabel + "x",
expectErr: `label "` + longLabel + `x" is too long`,
},
}
for name, tc := range cases {
t.Run(name, func(t *testing.T) {
run(t, tc)
})
}
}
func TestRemoveLabelHeaderFromStream(t *testing.T) {
type testcase struct {
buf []byte
expectLabel string
expectData []byte
expectErr string
}
run := func(t *testing.T, tc testcase) {
server, client := net.Pipe()
defer server.Close()
defer client.Close()
var (
errCh = make(chan error, 1)
)
go func() {
_, err := server.Write(tc.buf)
if err != nil {
errCh <- err
}
server.Close()
}()
newConn, gotLabel, err := RemoveLabelHeaderFromStream(client)
if tc.expectErr != "" {
require.Error(t, err)
require.Contains(t, err.Error(), tc.expectErr)
return
}
require.NoError(t, err)
gotBuf, err := io.ReadAll(newConn)
require.NoError(t, err)
require.Equal(t, tc.expectData, gotBuf)
require.Equal(t, tc.expectLabel, gotLabel)
}
cases := map[string]testcase{
"empty buf": testcase{
buf: []byte{},
expectLabel: "",
expectData: []byte{},
},
"ping with no label": testcase{
buf: buildBuffer(t, pingMsg, "blah"),
expectLabel: "",
expectData: buildBuffer(t, pingMsg, "blah"),
},
"error with no label": testcase{ // 2021-10: largest standard message type
buf: buildBuffer(t, errMsg, "blah"),
expectLabel: "",
expectData: buildBuffer(t, errMsg, "blah"),
},
"v1 encrypt with no label": testcase{ // 2021-10: highest encryption version
buf: buildBuffer(t, maxEncryptionVersion, "blah"),
expectLabel: "",
expectData: buildBuffer(t, maxEncryptionVersion, "blah"),
},
"buf too small for label": testcase{
buf: buildBuffer(t, hasLabelMsg, "x"),
expectErr: `cannot decode label; stream has been truncated`,
},
"buf too small for label size": testcase{
buf: buildBuffer(t, hasLabelMsg),
expectErr: `cannot decode label; stream has been truncated`,
},
"label empty": testcase{
buf: buildBuffer(t, hasLabelMsg, 0, "x"),
expectErr: `label header cannot be empty when present`,
},
"label truncated": testcase{
buf: buildBuffer(t, hasLabelMsg, 2, "x"),
expectErr: `cannot decode label; stream has been truncated`,
},
"ping with label": testcase{
buf: buildBuffer(t, hasLabelMsg, 3, "abc", pingMsg, "blah"),
expectLabel: "abc",
expectData: buildBuffer(t, pingMsg, "blah"),
},
"error with label": testcase{ // 2021-10: largest standard message type
buf: buildBuffer(t, hasLabelMsg, 3, "abc", errMsg, "blah"),
expectLabel: "abc",
expectData: buildBuffer(t, errMsg, "blah"),
},
"v1 encrypt with label": testcase{ // 2021-10: highest encryption version
buf: buildBuffer(t, hasLabelMsg, 3, "abc", maxEncryptionVersion, "blah"),
expectLabel: "abc",
expectData: buildBuffer(t, maxEncryptionVersion, "blah"),
},
}
for name, tc := range cases {
t.Run(name, func(t *testing.T) {
run(t, tc)
})
}
}
func buildBuffer(t *testing.T, stuff ...interface{}) []byte {
var buf bytes.Buffer
for _, item := range stuff {
switch x := item.(type) {
case int:
x2 := uint(x)
if x2 > 255 {
t.Fatalf("int is too big")
}
buf.WriteByte(byte(x2))
case byte:
buf.WriteByte(byte(x))
case messageType:
buf.WriteByte(byte(x))
case encryptionVersion:
buf.WriteByte(byte(x))
case string:
buf.Write([]byte(x))
case []byte:
buf.Write(x)
default:
t.Fatalf("unexpected type %T", item)
}
}
return buf.Bytes()
}
func TestLabelOverhead(t *testing.T) {
require.Equal(t, 0, labelOverhead(""))
require.Equal(t, 3, labelOverhead("a"))
require.Equal(t, 9, labelOverhead("abcdefg"))
}
|