/
core_test.go
488 lines (446 loc) · 11.2 KB
/
core_test.go
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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
// Copyright (c) Bruno Schaatsbergen
// SPDX-License-Identifier: MIT
package core_test
import (
"net"
"testing"
"github.com/bschaatsbergen/cidr/pkg/core"
"github.com/stretchr/testify/assert"
)
func TestGetAddressCount(t *testing.T) {
IPv4CIDR, err := core.ParseCIDR("10.0.0.0/16")
if err != nil {
t.Log(err)
t.Fail()
}
IPv6CIDR, err := core.ParseCIDR("2001:db8:1234:1a00::/106")
if err != nil {
t.Log(err)
t.Fail()
}
largeIPv4PrefixCIDR, err := core.ParseCIDR("172.16.18.0/31")
if err != nil {
t.Log(err)
t.Fail()
}
largestIPv4PrefixCIDR, err := core.ParseCIDR("172.16.18.0/32")
if err != nil {
t.Log(err)
t.Fail()
}
tests := []struct {
name string
cidr *net.IPNet
expectedCount uint64
}{
{
name: "Return the count of all distinct host addresses in a common IPv4 CIDR",
cidr: IPv4CIDR,
expectedCount: 65536,
},
{
name: "Return the count of all distinct host addresses in a common IPv6 CIDR",
cidr: IPv6CIDR,
expectedCount: 4194304,
},
{
name: "Return the count of all distinct host addresses in an uncommon (large prefix) IPv4 CIDR",
cidr: largeIPv4PrefixCIDR,
expectedCount: 2,
},
{
name: "Return the count of all distinct host addresses in an uncommon (largest prefix) IPv4 CIDR",
cidr: largestIPv4PrefixCIDR,
expectedCount: 1,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
count := core.GetAddressCount(tt.cidr)
assert.Equal(t, int(tt.expectedCount), int(count), "Both address counts should be equal")
})
}
}
func TestOverlaps(t *testing.T) {
firstIPv4CIDR, err := core.ParseCIDR("10.0.0.0/16")
if err != nil {
t.Log(err)
t.Fail()
}
secondIPv4CIDR, err := core.ParseCIDR("10.0.14.0/22")
if err != nil {
t.Log(err)
t.Fail()
}
thirdIPv4CIDR, err := core.ParseCIDR("10.1.0.0/28")
if err != nil {
t.Log(err)
t.Fail()
}
firstIPv6CIDR, err := core.ParseCIDR("2001:db8:1111:2222:1::/80")
if err != nil {
t.Log(err)
t.Fail()
}
secondIPv6CIDR, err := core.ParseCIDR("2001:db8:1111:2222:1:1::/96")
if err != nil {
t.Log(err)
t.Fail()
}
tests := []struct {
name string
cidrA *net.IPNet
cidrB *net.IPNet
overlaps bool
}{
{
name: "2 IPv4 CIDR ranges should overlap",
cidrA: firstIPv4CIDR,
cidrB: secondIPv4CIDR,
overlaps: true,
},
{
name: "2 IPv4 CIDR ranges should NOT overlap",
cidrA: firstIPv4CIDR,
cidrB: thirdIPv4CIDR,
overlaps: false,
},
{
name: "2 IPv6 CIDR ranges should overlap",
cidrA: firstIPv6CIDR,
cidrB: secondIPv6CIDR,
overlaps: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
overlaps := core.Overlaps(tt.cidrA, tt.cidrB)
assert.Equal(t, tt.overlaps, overlaps, "Given CIDRs should overlap")
})
}
}
func TestContainsAddress(t *testing.T) {
IPv4CIDR, err := core.ParseCIDR("10.0.0.0/16")
if err != nil {
t.Log(err)
t.Fail()
}
IPv6CIDR, err := core.ParseCIDR("2001:db8:1234:1a00::/106")
if err != nil {
t.Log(err)
t.Fail()
}
tests := []struct {
name string
cidr *net.IPNet
ip net.IP
contains bool
}{
{
name: "IPv4 CIDR that does contain an IPv4 IP",
cidr: IPv4CIDR,
ip: net.ParseIP("10.0.14.5"),
contains: true,
},
{
name: "IPv4 CIDR that does NOT contain an IPv4 IP",
cidr: IPv4CIDR,
ip: net.ParseIP("10.1.55.5"),
contains: false,
},
{
name: "IPv6 CIDR that does contain an IPv6 IP",
cidr: IPv6CIDR,
ip: net.ParseIP("2001:db8:1234:1a00::"),
contains: true,
},
{
name: "IPv6 CIDR that does NOT contain an IPv6 IP",
cidr: IPv6CIDR,
ip: net.ParseIP("2001:af1:1222:1a20::"),
contains: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
overlaps := core.ContainsAddress(tt.cidr, tt.ip)
assert.Equal(t, tt.contains, overlaps, "Given IP address should be part of the given CIDR")
})
}
}
func TestGetPrefixLength(t *testing.T) {
IPv4CIDR, err := core.ParseCIDR("10.0.0.0/16")
if err != nil {
t.Log(err)
t.Fail()
}
IPv6CIDR, err := core.ParseCIDR("2001:db8:1234:1a00::/106")
if err != nil {
t.Log(err)
t.Fail()
}
tests := []struct {
name string
netmask net.IP
expectedPrefixLength int
}{
{
name: "Get the prefix length of an IPv4 netmask",
netmask: net.IP(IPv4CIDR.Mask),
expectedPrefixLength: 16,
},
{
name: "Get the prefix length of an IPv6 netmask",
netmask: net.IP(IPv6CIDR.Mask),
expectedPrefixLength: 106,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
prefixLength := core.GetPrefixLength(tt.netmask)
assert.Equal(t, tt.expectedPrefixLength, prefixLength, "Prefix length is not correct")
})
}
}
func TestGetNetMask(t *testing.T) {
IPv4CIDR, err := core.ParseCIDR("10.0.0.0/16")
if err != nil {
t.Log(err)
t.Fail()
}
IPv6CIDR, err := core.ParseCIDR("2001:db8:1234:1a00::/106")
if err != nil {
t.Log(err)
t.Fail()
}
tests := []struct {
name string
CIDR *net.IPNet
expectedNetmask net.IPMask
}{
{
name: "Get the netmask of an IPv4 CIDR range",
CIDR: IPv4CIDR,
expectedNetmask: net.IPMask{0xff, 0xff, 0x00, 0x00},
},
{
name: "Get the netmask of an IPv6 CIDR range",
CIDR: IPv6CIDR,
expectedNetmask: net.IPMask{0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xc0, 0x0, 0x0},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
netmask := core.GetNetmask(tt.CIDR)
if err != nil {
t.Log(err)
t.Fail()
}
assert.Equal(t, tt.expectedNetmask, netmask, "Netmask is not correct")
})
}
}
func TestGetFirstUsableIPAddress(t *testing.T) {
IPv4CIDR, err := core.ParseCIDR("10.0.0.0/16")
if err != nil {
t.Log(err)
t.Fail()
}
IPv6CIDR, err := core.ParseCIDR("2001:db8:1234:1a00::/106")
if err != nil {
t.Log(err)
t.Fail()
}
tests := []struct {
name string
CIDR *net.IPNet
expectedFirstUsableIPAddress net.IP
}{
{
name: "Get the first usable IP address of an IPv4 CIDR range",
CIDR: IPv4CIDR,
expectedFirstUsableIPAddress: net.ParseIP("10.0.0.1").To4(),
},
{
name: "Get the first usable IP address of an IPv6 CIDR range",
CIDR: IPv6CIDR,
expectedFirstUsableIPAddress: net.ParseIP("2001:db8:1234:1a00::").To16(),
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
firstUsableIPAddress, err := core.GetFirstUsableIPAddress(tt.CIDR)
if err != nil {
t.Log(err)
t.Fail()
}
assert.Equal(t, tt.expectedFirstUsableIPAddress, firstUsableIPAddress, "First usable IP address is not correct")
})
}
}
func TestGetLastUsableIPAddress(t *testing.T) {
IPv4CIDR, err := core.ParseCIDR("10.0.0.0/16")
if err != nil {
t.Log(err)
t.Fail()
}
IPv6CIDR, err := core.ParseCIDR("2001:db8:1234:1a00::/106")
if err != nil {
t.Log(err)
t.Fail()
}
tests := []struct {
name string
CIDR *net.IPNet
expectedLastUsableIPAddress net.IP
}{
{
name: "Get the last usable IP address of an IPv4 CIDR range",
CIDR: IPv4CIDR,
expectedLastUsableIPAddress: net.ParseIP("10.0.255.254").To4(),
},
{
name: "Get the last usable IP address of an IPv6 CIDR range",
CIDR: IPv6CIDR,
expectedLastUsableIPAddress: net.ParseIP("2001:db8:1234:1a00::3f:ffff").To16(),
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
lastUsableIPAddress, err := core.GetLastUsableIPAddress(tt.CIDR)
if err != nil {
t.Log(err)
t.Fail()
}
assert.Equal(t, tt.expectedLastUsableIPAddress, lastUsableIPAddress, "Last usable IP address is not correct")
})
}
}
func TestGetBroadcastAddress(t *testing.T) {
IPv4CIDR, err := core.ParseCIDR("10.0.0.0/16")
if err != nil {
t.Log(err)
t.Fail()
}
IPv4CIDRWithNoBroadcastAddress, err := core.ParseCIDR("10.0.0.0/31")
if err != nil {
t.Log(err)
t.Fail()
}
IPv6CIDR, err := core.ParseCIDR("2001:db8:1234:1a00::/106")
if err != nil {
t.Log(err)
t.Fail()
}
tests := []struct {
name string
CIDR *net.IPNet
expectedBroadcastAddress net.IP
wantErr bool
}{
{
name: "Get the broadcast IP address of an IPv4 CIDR range",
CIDR: IPv4CIDR,
expectedBroadcastAddress: net.ParseIP("10.0.255.255").To4(),
wantErr: false,
},
{
name: "Get the broadcast IP address of an IPv4 CIDR range that has no broadcast address",
CIDR: IPv4CIDRWithNoBroadcastAddress,
expectedBroadcastAddress: nil,
wantErr: true,
},
{
name: "Get the broadcast IP address of an IPv6 CIDR range",
CIDR: IPv6CIDR,
expectedBroadcastAddress: nil,
wantErr: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
broadcastAddress, err := core.GetBroadcastAddress(tt.CIDR)
if err != nil {
assert.Equal(t, tt.wantErr, true, "Expected error when getting broadcast address, but got none")
} else {
assert.Equal(t, tt.expectedBroadcastAddress, broadcastAddress, "Broadcast IP address is not correct")
}
})
}
}
func TestGetBaseAddress(t *testing.T) {
IPv4CIDR, err := core.ParseCIDR("192.168.90.4/30")
if err != nil {
t.Log(err)
t.Fail()
}
IPv6CIDR, err := core.ParseCIDR("4a00:db8:1234:1a00::/127")
if err != nil {
t.Log(err)
t.Fail()
}
tests := []struct {
name string
cidr *net.IPNet
expectedBaseAddress net.IP
}{
{
name: "Get the base address of an IPv4 CIDR",
cidr: IPv4CIDR,
expectedBaseAddress: IPv4CIDR.IP,
},
{
name: "Get the base address of an IPv6 CIDR",
cidr: IPv6CIDR,
expectedBaseAddress: IPv6CIDR.IP,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
baseAddress := core.GetBaseAddress(tt.cidr)
assert.Equal(t, tt.expectedBaseAddress, baseAddress, "Base address is not correct")
})
}
}
func TestParseCIDR(t *testing.T) {
tests := []struct {
name string
cidrStr string
wantErr bool
}{
{
name: "Parse a valid IPv4 CIDR",
cidrStr: "10.0.0.0/16",
wantErr: false,
},
{
name: "Parse a valid IPv6 CIDR",
cidrStr: "2001:db8:1234:1a00::/106",
wantErr: false,
},
{
name: "Parse an invalid IPv4 CIDR",
cidrStr: "356.356.356.356/16",
wantErr: true,
},
{
name: "Parse an invalid IPv6 CIDR",
cidrStr: "2001:db8:1234:1a00::/129",
wantErr: true,
},
{
name: "Parse an empty CIDR",
cidrStr: "",
wantErr: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
_, err := core.ParseCIDR(tt.cidrStr)
if (err != nil) != tt.wantErr {
t.Errorf("ParseCIDR() error = %v, wantErr %v", err, tt.wantErr)
return
}
})
}
}