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
|
package hotline
import (
"bytes"
"fmt"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"io"
"testing"
)
func TestTrackerRegistration_Payload(t *testing.T) {
type fields struct {
Port [2]byte
UserCount int
PassID [4]byte
Name string
Description string
}
tests := []struct {
name string
fields fields
want []byte
}{
{
name: "returns expected payload bytes",
fields: fields{
Port: [2]byte{0x00, 0x10},
UserCount: 2,
PassID: [4]byte{0x00, 0x00, 0x00, 0x01},
Name: "Test Serv",
Description: "Fooz",
},
want: []byte{
0x00, 0x01,
0x00, 0x10,
0x00, 0x02,
0x00, 0x00,
0x00, 0x00, 0x00, 0x01,
0x09,
0x54, 0x65, 0x73, 0x74, 0x20, 0x53, 0x65, 0x72, 0x76,
0x04,
0x46, 0x6f, 0x6f, 0x7a,
0x00,
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
tr := &TrackerRegistration{
Port: tt.fields.Port,
UserCount: tt.fields.UserCount,
PassID: tt.fields.PassID,
Name: tt.fields.Name,
Description: tt.fields.Description,
}
if got, _ := io.ReadAll(tr); !assert.Equal(t, tt.want, got) {
t.Errorf("Read() = %v, want %v", got, tt.want)
}
})
}
}
func Test_serverScanner(t *testing.T) {
type args struct {
data []byte
atEOF bool
}
tests := []struct {
name string
args args
wantAdvance int
wantToken []byte
wantErr assert.ErrorAssertionFunc
}{
{
name: "when a full server entry is provided",
args: args{
data: []byte{
0x18, 0x05, 0x30, 0x63, // IP Addr
0x15, 0x7c, // Port
0x00, 0x02, // UserCount
0x00, 0x00, // ??
0x03, // Name Len
0x54, 0x68, 0x65, // Name
0x03, // Desc Len
0x54, 0x54, 0x54, // Description
},
atEOF: false,
},
wantAdvance: 18,
wantToken: []byte{
0x18, 0x05, 0x30, 0x63, // IP Addr
0x15, 0x7c, // Port
0x00, 0x02, // UserCount
0x00, 0x00, // ??
0x03, // Name Len
0x54, 0x68, 0x65, // Name
0x03, // Desc Len
0x54, 0x54, 0x54, // Description
},
wantErr: assert.NoError,
},
{
name: "when extra bytes are provided",
args: args{
data: []byte{
0x18, 0x05, 0x30, 0x63, // IP Addr
0x15, 0x7c, // Port
0x00, 0x02, // UserCount
0x00, 0x00, // ??
0x03, // Name Len
0x54, 0x68, 0x65, // Name
0x03, // Desc Len
0x54, 0x54, 0x54, // Description
0x54, 0x54, 0x54, 0x54, 0x54, 0x54, 0x54, 0x54, 0x54,
},
atEOF: false,
},
wantAdvance: 18,
wantToken: []byte{
0x18, 0x05, 0x30, 0x63, // IP Addr
0x15, 0x7c, // Port
0x00, 0x02, // UserCount
0x00, 0x00, // ??
0x03, // Name Len
0x54, 0x68, 0x65, // Name
0x03, // Desc Len
0x54, 0x54, 0x54, // Description
},
wantErr: assert.NoError,
},
{
name: "when insufficient bytes are provided",
args: args{
data: []byte{
0, 0,
},
atEOF: false,
},
wantAdvance: 0,
wantToken: []byte(nil),
wantErr: assert.NoError,
},
{
name: "when nameLen exceeds provided data",
args: args{
data: []byte{
0x18, 0x05, 0x30, 0x63, // IP Addr
0x15, 0x7c, // Port
0x00, 0x02, // UserCount
0x00, 0x00, // ??
0xff, // Name Len
0x54, 0x68, 0x65, // Name
0x03, // Desc Len
0x54, 0x54, 0x54, // Description
},
atEOF: false,
},
wantAdvance: 0,
wantToken: []byte(nil),
wantErr: assert.NoError,
},
{
name: "when description len exceeds provided data",
args: args{
data: []byte{
0x18, 0x05, 0x30, 0x63, // IP Addr
0x15, 0x7c, // Port
0x00, 0x02, // UserCount
0x00, 0x00, // ??
0x03, // Name Len
0x54, 0x68, 0x65, // Name
0xff, // Desc Len
0x54, 0x54, 0x54, // Description
},
atEOF: false,
},
wantAdvance: 0,
wantToken: []byte(nil),
wantErr: assert.NoError,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
gotAdvance, gotToken, err := serverScanner(tt.args.data, tt.args.atEOF)
if !tt.wantErr(t, err, fmt.Sprintf("serverScanner(%v, %v)", tt.args.data, tt.args.atEOF)) {
return
}
assert.Equalf(t, tt.wantAdvance, gotAdvance, "serverScanner(%v, %v)", tt.args.data, tt.args.atEOF)
assert.Equalf(t, tt.wantToken, gotToken, "serverScanner(%v, %v)", tt.args.data, tt.args.atEOF)
})
}
}
type mockConn struct {
readBuffer *bytes.Buffer
writeBuffer *bytes.Buffer
closed bool
}
func (m *mockConn) Read(b []byte) (n int, err error) {
return m.readBuffer.Read(b)
}
func (m *mockConn) Write(b []byte) (n int, err error) {
return m.writeBuffer.Write(b)
}
func (m *mockConn) Close() error {
m.closed = true
return nil
}
func TestGetListing(t *testing.T) {
tests := []struct {
name string
mockConn *mockConn
wantErr bool
wantResult []ServerRecord
}{
{
name: "Successful retrieval",
mockConn: &mockConn{
readBuffer: bytes.NewBuffer([]byte{
// TrackerHeader
0x48, 0x54, 0x52, 0x4B, // Protocol "HTRK"
0x00, 0x01, // Version 1
// ServerInfoHeader
0x00, 0x01, // MsgType (1)
0x00, 0x14, // MsgDataSize (20)
0x00, 0x02, // SrvCount (2)
0x00, 0x02, // SrvCountDup (2)
// ServerRecord 1
192, 168, 1, 1, // IP address
0x1F, 0x90, // Port 8080
0x00, 0x10, // NumUsers 16
0x00, 0x00, // Unused
0x04, // NameSize
'S', 'e', 'r', 'v', // Name
0x0B, // DescriptionSize
'M', 'y', ' ', 'S', 'e', 'r', 'v', 'e', 'r', ' ', '1', // Description
// ServerRecord 2
10, 0, 0, 1, // IP address
0x1F, 0x91, // Port 8081
0x00, 0x05, // NumUsers 5
0x00, 0x00, // Unused
0x04, // NameSize
'S', 'e', 'r', 'v', // Name
0x0B, // DescriptionSize
'M', 'y', ' ', 'S', 'e', 'r', 'v', 'e', 'r', ' ', '2', // Description
}),
writeBuffer: &bytes.Buffer{},
},
wantErr: false,
wantResult: []ServerRecord{
{
IPAddr: [4]byte{192, 168, 1, 1},
Port: [2]byte{0x1F, 0x90},
NumUsers: [2]byte{0x00, 0x10},
Unused: [2]byte{0x00, 0x00},
NameSize: 4,
Name: []byte("Serv"),
DescriptionSize: 11,
Description: []byte("My Server 1"),
},
{
IPAddr: [4]byte{10, 0, 0, 1},
Port: [2]byte{0x1F, 0x91},
NumUsers: [2]byte{0x00, 0x05},
Unused: [2]byte{0x00, 0x00},
NameSize: 4,
Name: []byte("Serv"),
DescriptionSize: 11,
Description: []byte("My Server 2"),
},
},
},
{
name: "Write error",
mockConn: &mockConn{
readBuffer: &bytes.Buffer{},
writeBuffer: &bytes.Buffer{},
},
wantErr: true,
wantResult: nil,
},
{
name: "Read error on TrackerHeader",
mockConn: &mockConn{
readBuffer: bytes.NewBuffer([]byte{
// incomplete data to cause read error
0x48,
}),
writeBuffer: &bytes.Buffer{},
},
wantErr: true,
wantResult: nil,
},
{
name: "Read error on ServerInfoHeader",
mockConn: &mockConn{
readBuffer: bytes.NewBuffer([]byte{
// TrackerHeader
0x48, 0x54, 0x52, 0x4B, // Protocol "HTRK"
0x00, 0x01, // Version 1
// incomplete ServerInfoHeader
0x00,
}),
writeBuffer: &bytes.Buffer{},
},
wantErr: true,
wantResult: nil,
},
{
name: "Scanner error",
mockConn: &mockConn{
readBuffer: bytes.NewBuffer([]byte{
// TrackerHeader
0x48, 0x54, 0x52, 0x4B, // Protocol "HTRK"
0x00, 0x01, // Version 1
// ServerInfoHeader
0x00, 0x01, // MsgType (1)
0x00, 0x14, // MsgDataSize (20)
0x00, 0x01, // SrvCount (1)
0x00, 0x01, // SrvCountDup (1)
// incomplete ServerRecord to cause scanner error
192, 168, 1, 1,
}),
writeBuffer: &bytes.Buffer{},
},
wantErr: true,
wantResult: nil,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := GetListing(tt.mockConn)
if tt.wantErr {
require.Error(t, err)
} else {
require.NoError(t, err)
assert.Equal(t, tt.wantResult, got)
}
})
}
}
|
