1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18 package org.apache.commons.net.util;
19
20 import static org.junit.jupiter.api.Assertions.assertArrayEquals;
21 import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
22 import static org.junit.jupiter.api.Assertions.assertEquals;
23 import static org.junit.jupiter.api.Assertions.assertFalse;
24 import static org.junit.jupiter.api.Assertions.assertNotNull;
25 import static org.junit.jupiter.api.Assertions.assertThrows;
26 import static org.junit.jupiter.api.Assertions.assertTrue;
27
28 import java.util.ArrayList;
29 import java.util.Arrays;
30 import java.util.List;
31 import java.util.stream.Collectors;
32 import java.util.stream.LongStream;
33
34 import org.apache.commons.collections4.IterableUtils;
35 import org.apache.commons.lang3.tuple.ImmutablePair;
36 import org.apache.commons.net.util.SubnetUtils.SubnetInfo;
37 import org.junit.jupiter.api.Test;
38 import org.junit.jupiter.params.ParameterizedTest;
39 import org.junit.jupiter.params.provider.FieldSource;
40
41
42
43
44 @SuppressWarnings("deprecation")
45 public class SubnetUtilsTest {
46
47
48
49
50
51 private static final List<ImmutablePair<String, Long>> CIDR_SIZES = Arrays.asList(
52
53
54 ImmutablePair.of("192.168.0.1/8", 16777216L),
55 ImmutablePair.of("192.168.0.1/9", 8388608L),
56 ImmutablePair.of("192.168.0.1/10", 4194304L),
57 ImmutablePair.of("192.168.0.1/11", 2097152L),
58 ImmutablePair.of("192.168.0.1/12", 1048576L),
59 ImmutablePair.of("192.168.0.1/13", 524288L),
60 ImmutablePair.of("192.168.0.1/14", 262144L),
61 ImmutablePair.of("192.168.0.1/15", 131072L),
62 ImmutablePair.of("192.168.0.1/16", 65536L),
63 ImmutablePair.of("192.168.0.1/17", 32768L),
64 ImmutablePair.of("192.168.0.1/18", 16384L),
65 ImmutablePair.of("192.168.0.1/19", 8192L),
66 ImmutablePair.of("192.168.0.1/20", 4096L),
67 ImmutablePair.of("192.168.0.1/21", 2048L),
68 ImmutablePair.of("192.168.0.1/22", 1024L),
69 ImmutablePair.of("192.168.0.1/23", 512L),
70 ImmutablePair.of("192.168.0.1/24", 256L),
71 ImmutablePair.of("192.168.0.1/25", 128L),
72 ImmutablePair.of("192.168.0.1/26", 64L),
73 ImmutablePair.of("192.168.0.1/27", 32L),
74 ImmutablePair.of("192.168.0.1/28", 16L),
75 ImmutablePair.of("192.168.0.1/29", 8L),
76 ImmutablePair.of("192.168.0.1/30", 4L),
77 ImmutablePair.of("192.168.0.1/31", 2L),
78 ImmutablePair.of("192.168.0.1/32", 1L));
79
80
81 @Test
82 public void testAddresses() {
83 final SubnetUtils utils = new SubnetUtils("192.168.0.1/29");
84 final SubnetInfo info = utils.getInfo();
85 assertTrue(info.isInRange("192.168.0.1"));
86 assertTrue(info.isInRange("192.168.0.2"));
87 assertTrue(info.isInRange("192.168.0.3"));
88 assertTrue(info.isInRange("192.168.0.4"));
89 assertTrue(info.isInRange("192.168.0.5"));
90 assertTrue(info.isInRange("192.168.0.6"));
91
92 assertFalse(info.isInRange("192.168.0.7"));
93 assertFalse(info.isInRange("192.168.0.8"));
94 assertFalse(info.isInRange("10.10.2.1"));
95 assertFalse(info.isInRange("192.168.1.1"));
96 assertFalse(info.isInRange("192.168.0.255"));
97
98 assertEquals(-1062731775, info.asInteger("192.168.0.1"));
99 assertThrows(IllegalArgumentException.class, () -> info.asInteger("bad"));
100
101 assertArrayEquals(new String[] { "192.168.0.1", "192.168.0.2", "192.168.0.3", "192.168.0.4", "192.168.0.5", "192.168.0.6" }, info.getAllAddresses());
102 }
103
104 @Test
105 public void testAddressIllegalArgument() {
106 assertThrows(IllegalArgumentException.class, () -> new SubnetUtils("bad"));
107 }
108
109
110
111
112 @Test
113 public void testCidrAddresses() {
114 SubnetUtils utils = new SubnetUtils("192.168.0.1/8");
115 utils.setInclusiveHostCount(true);
116 SubnetInfo info = utils.getInfo();
117 assertEquals("255.0.0.0", info.getNetmask());
118 assertEquals(16777216, info.getAddressCount());
119
120 utils = new SubnetUtils("192.168.0.1/0");
121 utils.setInclusiveHostCount(true);
122 info = utils.getInfo();
123 assertEquals("0.0.0.0", info.getNetmask());
124 assertEquals(4294967296L, info.getAddressCountLong());
125
126 utils = new SubnetUtils("192.168.0.1/1");
127 utils.setInclusiveHostCount(true);
128 info = utils.getInfo();
129 assertEquals("128.0.0.0", info.getNetmask());
130 assertEquals(2147483648L, info.getAddressCountLong());
131
132 utils = new SubnetUtils("192.168.0.1/9");
133 utils.setInclusiveHostCount(true);
134 info = utils.getInfo();
135 assertEquals("255.128.0.0", info.getNetmask());
136 assertEquals(8388608, info.getAddressCount());
137
138 utils = new SubnetUtils("192.168.0.1/10");
139 utils.setInclusiveHostCount(true);
140 info = utils.getInfo();
141 assertEquals("255.192.0.0", info.getNetmask());
142 assertEquals(4194304, info.getAddressCount());
143
144 utils = new SubnetUtils("192.168.0.1/11");
145 utils.setInclusiveHostCount(true);
146 info = utils.getInfo();
147 assertEquals("255.224.0.0", info.getNetmask());
148 assertEquals(2097152, info.getAddressCount());
149
150 utils = new SubnetUtils("192.168.0.1/12");
151 utils.setInclusiveHostCount(true);
152 info = utils.getInfo();
153 assertEquals("255.240.0.0", info.getNetmask());
154 assertEquals(1048576, info.getAddressCount());
155
156 utils = new SubnetUtils("192.168.0.1/13");
157 utils.setInclusiveHostCount(true);
158 info = utils.getInfo();
159 assertEquals("255.248.0.0", info.getNetmask());
160 assertEquals(524288, info.getAddressCount());
161
162 utils = new SubnetUtils("192.168.0.1/14");
163 utils.setInclusiveHostCount(true);
164 info = utils.getInfo();
165 assertEquals("255.252.0.0", info.getNetmask());
166 assertEquals(262144, info.getAddressCount());
167
168 utils = new SubnetUtils("192.168.0.1/15");
169 utils.setInclusiveHostCount(true);
170 info = utils.getInfo();
171 assertEquals("255.254.0.0", info.getNetmask());
172 assertEquals(131072, info.getAddressCount());
173
174 utils = new SubnetUtils("192.168.0.1/16");
175 utils.setInclusiveHostCount(true);
176 info = utils.getInfo();
177 assertEquals("255.255.0.0", info.getNetmask());
178 assertEquals(65536, info.getAddressCount());
179
180 utils = new SubnetUtils("192.168.0.1/17");
181 utils.setInclusiveHostCount(true);
182 info = utils.getInfo();
183 assertEquals("255.255.128.0", info.getNetmask());
184 assertEquals(32768, info.getAddressCount());
185
186 utils = new SubnetUtils("192.168.0.1/18");
187 utils.setInclusiveHostCount(true);
188 info = utils.getInfo();
189 assertEquals("255.255.192.0", info.getNetmask());
190 assertEquals(16384, info.getAddressCount());
191
192 utils = new SubnetUtils("192.168.0.1/19");
193 utils.setInclusiveHostCount(true);
194 info = utils.getInfo();
195 assertEquals("255.255.224.0", info.getNetmask());
196 assertEquals(8192, info.getAddressCount());
197
198 utils = new SubnetUtils("192.168.0.1/20");
199 utils.setInclusiveHostCount(true);
200 info = utils.getInfo();
201 assertEquals("255.255.240.0", info.getNetmask());
202 assertEquals(4096, info.getAddressCount());
203
204 utils = new SubnetUtils("192.168.0.1/21");
205 utils.setInclusiveHostCount(true);
206 info = utils.getInfo();
207 assertEquals("255.255.248.0", info.getNetmask());
208 assertEquals(2048, info.getAddressCount());
209
210 utils = new SubnetUtils("192.168.0.1/22");
211 utils.setInclusiveHostCount(true);
212 info = utils.getInfo();
213 assertEquals("255.255.252.0", info.getNetmask());
214 assertEquals(1024, info.getAddressCount());
215
216 utils = new SubnetUtils("192.168.0.1/23");
217 utils.setInclusiveHostCount(true);
218 info = utils.getInfo();
219 assertEquals("255.255.254.0", info.getNetmask());
220 assertEquals(512, info.getAddressCount());
221
222 utils = new SubnetUtils("192.168.0.1/24");
223 utils.setInclusiveHostCount(true);
224 info = utils.getInfo();
225 assertEquals("255.255.255.0", info.getNetmask());
226 assertEquals(256, info.getAddressCount());
227
228 utils = new SubnetUtils("192.168.0.1/25");
229 utils.setInclusiveHostCount(true);
230 info = utils.getInfo();
231 assertEquals("255.255.255.128", info.getNetmask());
232 assertEquals(128, info.getAddressCount());
233
234 utils = new SubnetUtils("192.168.0.1/26");
235 utils.setInclusiveHostCount(true);
236 info = utils.getInfo();
237 assertEquals("255.255.255.192", info.getNetmask());
238 assertEquals(64, info.getAddressCount());
239
240 utils = new SubnetUtils("192.168.0.1/27");
241 utils.setInclusiveHostCount(true);
242 info = utils.getInfo();
243 assertEquals("255.255.255.224", info.getNetmask());
244 assertEquals(32, info.getAddressCount());
245
246 utils = new SubnetUtils("192.168.0.1/28");
247 utils.setInclusiveHostCount(true);
248 info = utils.getInfo();
249 assertEquals("255.255.255.240", info.getNetmask());
250 assertEquals(16, info.getAddressCount());
251
252 utils = new SubnetUtils("192.168.0.1/29");
253 utils.setInclusiveHostCount(true);
254 info = utils.getInfo();
255 assertEquals("255.255.255.248", info.getNetmask());
256 assertEquals(8, info.getAddressCount());
257
258 utils = new SubnetUtils("192.168.0.1/30");
259 utils.setInclusiveHostCount(true);
260 info = utils.getInfo();
261 assertEquals("255.255.255.252", info.getNetmask());
262 assertEquals(4, info.getAddressCount());
263
264 utils = new SubnetUtils("192.168.0.1/31");
265 utils.setInclusiveHostCount(true);
266 info = utils.getInfo();
267 assertEquals("255.255.255.254", info.getNetmask());
268 assertEquals(2, info.getAddressCount());
269
270 utils = new SubnetUtils("192.168.0.1/32");
271 utils.setInclusiveHostCount(true);
272 info = utils.getInfo();
273 assertEquals("255.255.255.255", info.getNetmask());
274 assertEquals(1, info.getAddressCount());
275
276 }
277
278 @Test
279 public void testInvalidMasks() {
280 assertThrows(IllegalArgumentException.class, () -> new SubnetUtils("192.168.0.1/"));
281 assertThrows(IllegalArgumentException.class, () -> new SubnetUtils("192.168.0.1/33"));
282 assertThrows(IllegalArgumentException.class, () -> new SubnetUtils("192.168.0.1/111"));
283 assertThrows(IllegalArgumentException.class, () -> new SubnetUtils("192.168.0.1/032"));
284 }
285
286 @Test
287 public void testNET428_31() {
288 final SubnetUtils subnetUtils = new SubnetUtils("1.2.3.4/31");
289 assertEquals(0, subnetUtils.getInfo().getAddressCount());
290 final String[] address = subnetUtils.getInfo().getAllAddresses();
291 assertNotNull(address);
292 assertEquals(0, address.length);
293 }
294
295 @Test
296 public void testNET428_32() {
297 final SubnetUtils subnetUtils = new SubnetUtils("1.2.3.4/32");
298 assertEquals(0, subnetUtils.getInfo().getAddressCount());
299 final String[] address = subnetUtils.getInfo().getAllAddresses();
300 assertNotNull(address);
301 assertEquals(0, address.length);
302 }
303
304 @Test
305 public void testNET520() {
306 final SubnetUtils utils = new SubnetUtils("0.0.0.0/0");
307 utils.setInclusiveHostCount(true);
308 final SubnetInfo info = utils.getInfo();
309 assertEquals("0.0.0.0", info.getNetworkAddress());
310 assertEquals("255.255.255.255", info.getBroadcastAddress());
311 assertTrue(info.isInRange("127.0.0.0"));
312 utils.setInclusiveHostCount(false);
313 assertTrue(info.isInRange("127.0.0.0"));
314 }
315
316 @Test
317 public void testNET521() {
318 SubnetUtils utils;
319 SubnetInfo info;
320
321 utils = new SubnetUtils("0.0.0.0/0");
322 utils.setInclusiveHostCount(true);
323 info = utils.getInfo();
324 assertEquals("0.0.0.0", info.getNetmask());
325 assertEquals(4294967296L, info.getAddressCountLong());
326 assertThrows(RuntimeException.class, info::getAddressCount);
327 utils = new SubnetUtils("128.0.0.0/1");
328 utils.setInclusiveHostCount(true);
329 info = utils.getInfo();
330 assertEquals("128.0.0.0", info.getNetmask());
331 assertEquals(2147483648L, info.getAddressCountLong());
332 assertThrows(RuntimeException.class, info::getAddressCount);
333
334 utils.setInclusiveHostCount(false);
335 info = utils.getInfo();
336 assertEquals(2147483646, info.getAddressCount());
337 }
338
339 @Test
340 public void testNET624() {
341 assertDoesNotThrow(() -> new SubnetUtils("0.0.0.0/0"));
342 assertDoesNotThrow(() -> new SubnetUtils("0.0.0.0", "0.0.0.0"));
343 assertDoesNotThrow(() -> new SubnetUtils("0.0.0.0", "128.0.0.0"));
344 assertThrows(IllegalArgumentException.class, () -> new SubnetUtils("0.0.0.0", "64.0.0.0"));
345 assertThrows(IllegalArgumentException.class, () -> new SubnetUtils("0.0.0.0", "0.0.0.1"));
346 }
347
348 @Test
349 public void testNET641() {
350 assertFalse(new SubnetUtils("192.168.1.0/00").getInfo().isInRange("0.0.0.0"));
351 assertFalse(new SubnetUtils("192.168.1.0/30").getInfo().isInRange("0.0.0.0"));
352 assertFalse(new SubnetUtils("192.168.1.0/31").getInfo().isInRange("0.0.0.0"));
353 assertFalse(new SubnetUtils("192.168.1.0/32").getInfo().isInRange("0.0.0.0"));
354 }
355
356 @Test
357 public void testNET675() {
358 final SubnetUtils utils = new SubnetUtils("192.168.0.15/32");
359 utils.setInclusiveHostCount(true);
360 final SubnetInfo info = utils.getInfo();
361 assertTrue(info.isInRange("192.168.0.15"));
362 }
363
364 @Test
365 public void testNET679() {
366 final SubnetUtils utils = new SubnetUtils("10.213.160.0/16");
367 utils.setInclusiveHostCount(true);
368 final SubnetInfo info = utils.getInfo();
369 assertTrue(info.isInRange("10.213.0.0"));
370 assertTrue(info.isInRange("10.213.255.255"));
371 }
372
373 @Test
374 public void testNext() {
375 final SubnetUtils utils = new SubnetUtils("192.168.0.1/29");
376 assertEquals("192.168.0.2", utils.getNext().getInfo().getAddress());
377 }
378
379 @Test
380 public void testParseSimpleNetmask() {
381 final String address = "192.168.0.1";
382 final String[] masks = { "255.0.0.0", "255.255.0.0", "255.255.255.0", "255.255.255.248" };
383 final String[] bcastAddresses = { "192.255.255.255", "192.168.255.255", "192.168.0.255", "192.168.0.7" };
384 final String[] lowAddresses = { "192.0.0.1", "192.168.0.1", "192.168.0.1", "192.168.0.1" };
385 final String[] highAddresses = { "192.255.255.254", "192.168.255.254", "192.168.0.254", "192.168.0.6" };
386 final String[] nextAddresses = { "192.168.0.2", "192.168.0.2", "192.168.0.2", "192.168.0.2" };
387 final String[] previousAddresses = { "192.168.0.0", "192.168.0.0", "192.168.0.0", "192.168.0.0" };
388 final String[] networkAddresses = { "192.0.0.0", "192.168.0.0", "192.168.0.0", "192.168.0.0" };
389 final String[] cidrSignatures = { "192.168.0.1/8", "192.168.0.1/16", "192.168.0.1/24", "192.168.0.1/29" };
390 final int[] usableAddresses = { 16777214, 65534, 254, 6 };
391
392 for (int i = 0; i < masks.length; ++i) {
393 final SubnetUtils utils = new SubnetUtils(address, masks[i]);
394 final SubnetInfo info = utils.getInfo();
395 assertEquals(address, info.getAddress());
396 assertEquals(bcastAddresses[i], info.getBroadcastAddress());
397 assertEquals(cidrSignatures[i], info.getCidrSignature());
398 assertEquals(lowAddresses[i], info.getLowAddress());
399 assertEquals(highAddresses[i], info.getHighAddress());
400 assertEquals(nextAddresses[i], info.getNextAddress());
401 assertEquals(previousAddresses[i], info.getPreviousAddress());
402 assertEquals(networkAddresses[i], info.getNetworkAddress());
403 assertEquals(usableAddresses[i], info.getAddressCount());
404 }
405 }
406
407 @Test
408 public void testParseSimpleNetmaskExclusive() {
409 final String address = "192.168.15.7";
410 final String[] masks = { "255.255.255.252", "255.255.255.254", "255.255.255.255" };
411 final String[] bcast = { "192.168.15.7", "192.168.15.7", "192.168.15.7" };
412 final String[] netwk = { "192.168.15.4", "192.168.15.6", "192.168.15.7" };
413 final String[] lowAd = { "192.168.15.5", "0.0.0.0", "0.0.0.0" };
414 final String[] highA = { "192.168.15.6", "0.0.0.0", "0.0.0.0" };
415 final String[] cidrS = { "192.168.15.7/30", "192.168.15.7/31", "192.168.15.7/32" };
416 final int[] usableAd = { 2, 0, 0 };
417
418
419 for (int i = 0; i < masks.length; ++i) {
420 final SubnetUtils utils = new SubnetUtils(address, masks[i]);
421 utils.setInclusiveHostCount(false);
422 final SubnetInfo info = utils.getInfo();
423 assertEquals(cidrS[i], info.getCidrSignature(), "ci " + masks[i]);
424 assertEquals(bcast[i], info.getBroadcastAddress(), "bc " + masks[i]);
425 assertEquals(netwk[i], info.getNetworkAddress(), "nw " + masks[i]);
426 assertEquals(usableAd[i], info.getAddressCount(), "ac " + masks[i]);
427 assertEquals(lowAd[i], info.getLowAddress(), "lo " + masks[i]);
428 assertEquals(highA[i], info.getHighAddress(), "hi " + masks[i]);
429 }
430 }
431
432 @Test
433 public void testParseSimpleNetmaskInclusive() {
434 final String address = "192.168.15.7";
435 final String[] masks = { "255.255.255.252", "255.255.255.254", "255.255.255.255" };
436 final String[] bcast = { "192.168.15.7", "192.168.15.7", "192.168.15.7" };
437 final String[] netwk = { "192.168.15.4", "192.168.15.6", "192.168.15.7" };
438 final String[] lowAd = { "192.168.15.4", "192.168.15.6", "192.168.15.7" };
439 final String[] highA = { "192.168.15.7", "192.168.15.7", "192.168.15.7" };
440 final String[] cidrS = { "192.168.15.7/30", "192.168.15.7/31", "192.168.15.7/32" };
441 final int[] usableAd = { 4, 2, 1 };
442
443 for (int i = 0; i < masks.length; ++i) {
444 final SubnetUtils utils = new SubnetUtils(address, masks[i]);
445 utils.setInclusiveHostCount(true);
446 final SubnetInfo info = utils.getInfo();
447 assertEquals(cidrS[i], info.getCidrSignature(), "ci " + masks[i]);
448 assertEquals(bcast[i], info.getBroadcastAddress(), "bc " + masks[i]);
449 assertEquals(usableAd[i], info.getAddressCount(), "ac " + masks[i]);
450 assertEquals(netwk[i], info.getNetworkAddress(), "nw " + masks[i]);
451 assertEquals(lowAd[i], info.getLowAddress(), "lo " + masks[i]);
452 assertEquals(highA[i], info.getHighAddress(), "hi " + masks[i]);
453 }
454 }
455
456 @Test
457 public void testPrevious() {
458 final SubnetUtils utils = new SubnetUtils("192.168.0.1/29");
459 assertEquals("192.168.0.0", utils.getPrevious().getInfo().getAddress());
460 }
461
462 @Test
463 public void testSubnetAddressIterable() {
464 testSubnetAddressIterable("192.168.1.0/24", 254);
465 }
466
467 private void testSubnetAddressIterable(final String cidrNotation, final long max) {
468 final SubnetUtils subnetUtils = new SubnetUtils(cidrNotation);
469 final List<String> addressList = new ArrayList<>();
470 subnetUtils.getInfo().iterableAddressStrings().forEach(addressList::add);
471 assertEquals(max, addressList.size());
472 LongStream.rangeClosed(1, max).forEach(i -> addressList.contains("192.168.1." + i));
473 assertFalse(addressList.contains("192.168.1.0"));
474 assertFalse(addressList.contains("192.168.1.255"));
475 }
476
477 @ParameterizedTest
478 @FieldSource("CIDR_SIZES")
479 public void testSubnetAddressIterableCount(final ImmutablePair<String, Long> pair) {
480 final String cidrNotation = pair.getKey();
481 final long max = pair.getValue();
482 final SubnetUtils subnetUtils = new SubnetUtils(cidrNotation);
483
484 subnetUtils.setInclusiveHostCount(true);
485 assertEquals(max, IterableUtils.size(subnetUtils.getInfo().iterableAddressStrings()));
486 }
487
488 @Test
489 public void testSubnetAddressStream() {
490 testSubnetAddressStream("192.168.1.0/24", 254);
491 }
492
493 private void testSubnetAddressStream(final String cidrNotation, final long max) {
494 final SubnetUtils subnetUtils = new SubnetUtils(cidrNotation);
495 @SuppressWarnings("resource")
496 final List<String> addressList = subnetUtils.getInfo().streamAddressStrings().collect(Collectors.toList());
497 assertEquals(max, addressList.size());
498 LongStream.rangeClosed(1, max).forEach(i -> addressList.contains("192.168.1." + i));
499 assertFalse(addressList.contains("192.168.1.0"));
500 assertFalse(addressList.contains("192.168.1.255"));
501 }
502
503 @ParameterizedTest
504 @FieldSource("CIDR_SIZES")
505 public void testSubnetAddressStreamCount(final ImmutablePair<String, Long> pair) {
506 final String cidrNotation = pair.getKey();
507 final long max = pair.getValue();
508 final SubnetUtils subnetUtils = new SubnetUtils(cidrNotation);
509
510 subnetUtils.setInclusiveHostCount(true);
511 assertEquals(max, subnetUtils.getInfo().streamAddressStrings().count());
512 }
513
514 @Test
515 public void testToString() {
516 final SubnetUtils utils = new SubnetUtils("192.168.0.1/29");
517 assertDoesNotThrow(() -> utils.toString());
518 final SubnetInfo info = utils.getInfo();
519 assertDoesNotThrow(() -> info.toString());
520 }
521
522 @Test
523 public void testZeroAddressAndCidr() {
524 testSubnetAddressStream("0.0.0.0/0", 0);
525 }
526 }