netaddr 1.5.1 → 2.0.4

data/test/eui48_test.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby
+
+require_relative "../lib/netaddr.rb"
+require 'test/unit'
+
+class TestEUI48 < Test::Unit::TestCase
+	def test_new
+		eui = NetAddr::EUI48.new(0)
+		assert_equal("00-00-00-00-00-00", eui.to_s)
+		
+		assert_raise(NetAddr::ValidationError){ NetAddr::EUI48.new(2**48) }
+		assert_raise(NetAddr::ValidationError){ NetAddr::EUI48.new(-1) }
+		assert_raise(NetAddr::ValidationError){ NetAddr::EUI48.new("00-00-00-00-00-00") } # string
+	end
+	
+	def test_parse
+		assert_equal("aa-bb-cc-dd-ee-ff", NetAddr::EUI48.parse("aa-bb-cc-dd-ee-ff").to_s)
+		assert_equal("aa-bb-cc-dd-ee-ff", NetAddr::EUI48.parse("aa:bb:cc:dd:ee:ff").to_s)
+		assert_equal("aa-bb-cc-dd-ee-ff", NetAddr::EUI48.parse("aabb.ccdd.eeff").to_s)
+		assert_equal("aa-bb-cc-dd-ee-ff", NetAddr::EUI48.parse("aabbccddeeff").to_s)
+		
+		assert_raise(NetAddr::ValidationError){ NetAddr::EUI48.parse("aa-bb-cc-dd-ee-ff-00-11") }
+		assert_raise(NetAddr::ValidationError){ NetAddr::EUI48.parse("aa-bb-cc-dd-ee-gg") }
+		assert_raise(NetAddr::ValidationError){ NetAddr::EUI48.parse("aa;bb;cc;dd;ee;ff") }
+	end
+	
+	def test_to_eui64
+		assert_equal("aa-bb-cc-ff-fe-dd-ee-ff", NetAddr::EUI48.parse("aa-bb-cc-dd-ee-ff").to_eui64.to_s)
+	end
+end

data/test/eui64_test.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby
+
+require_relative "../lib/netaddr.rb"
+require 'test/unit'
+
+class TestEUI64 < Test::Unit::TestCase
+	def test_new
+		eui = NetAddr::EUI64.new(0)
+		assert_equal("00-00-00-00-00-00-00-00", eui.to_s)
+		
+		assert_raise(NetAddr::ValidationError){ NetAddr::EUI64.new(2**64) }
+		assert_raise(NetAddr::ValidationError){ NetAddr::EUI64.new(-1) }
+		assert_raise(NetAddr::ValidationError){ NetAddr::EUI64.new("00-00-00-00-00-00-00-00") } # string
+	end
+	
+	def test_parse
+		assert_equal("aa-bb-cc-dd-ee-ff-00-11", NetAddr::EUI64.parse("aa-bb-cc-dd-ee-ff-00-11").to_s)
+		assert_equal("aa-bb-cc-dd-ee-ff-00-11", NetAddr::EUI64.parse("aa:bb:cc:dd:ee:ff:00:11").to_s)
+		assert_equal("aa-bb-cc-dd-ee-ff-00-11", NetAddr::EUI64.parse("aabb.ccdd.eeff.0011").to_s)
+		assert_equal("aa-bb-cc-dd-ee-ff-00-11", NetAddr::EUI64.parse("aabbccddeeff0011").to_s)
+		
+		assert_raise(NetAddr::ValidationError){ NetAddr::EUI64.parse("aa-bb-cc-dd-ee-ff-00-11-22") }
+		assert_raise(NetAddr::ValidationError){ NetAddr::EUI64.parse("aa-bb-cc-dd-ee-ff-gg") }
+		assert_raise(NetAddr::ValidationError){ NetAddr::EUI64.parse("aa;bb;cc;dd;ee;ff;00;11") }
+	end
+	
+	def test_to_ipv6
+		net = NetAddr::IPv6Net.parse("fe80::/64")
+		eui = NetAddr::EUI64.parse("aa-bb-cc-dd-ee-ff-00-11")
+		assert_equal("fe80::a8bb:ccdd:eeff:11", eui.to_ipv6(net).to_s)
+	end
+end

data/test/examples.rb

@@ -0,0 +1,155 @@
+#!/usr/bin/ruby
+
+require_relative "../lib/netaddr.rb"
+require 'test/unit'
+
+# Testable examples on how to use NetAddr
+class NetAddrExamples < Test::Unit::TestCase
+	
+	# IPv4
+	def test_IPv4_examples
+		puts "\n*** Examples using IPv4 ***\n"
+		
+		puts "\nWhat size network do I need in order to hold 200 addresses?"
+		puts "/" + NetAddr.ipv4_prefix_len(200).to_s
+		assert_equal(24,NetAddr.ipv4_prefix_len(200))
+		
+		puts "\nCreating IPv4Net: '10.0.0.0/24'"
+		net = NetAddr::IPv4Net.parse("10.0.0.0/24")
+		assert_not_nil(net)
+		
+		puts "\nRendering as a String: " + net.to_s
+		assert_equal("10.0.0.0/24", net.to_s)
+		
+		puts "\nIterating its /26 subnets:"
+		expect = ["10.0.0.0/26","10.0.0.64/26","10.0.0.128/26","10.0.0.192/26"]
+		0.upto(net.subnet_count(26) - 1) do |i|
+			subnet = net.nth_subnet(26,i)
+			assert_equal(expect[i], subnet.to_s)
+			puts "  " + subnet.to_s
+		end
+		
+		puts "\nIts 3rd /30 subnet:"
+		subnet30 = net.nth_subnet(30,2)
+		assert_equal("10.0.0.8/30", subnet30.to_s)
+		puts "  " + subnet30.to_s
+		
+		puts "\nIterating the IPs of the /30"
+		expect = ["10.0.0.8","10.0.0.9","10.0.0.10","10.0.0.11"]
+		0.upto(subnet30.len - 1) do |i|
+			ip = subnet30.nth(i)
+			assert_equal(expect[i], ip.to_s)
+			puts "  " + ip.to_s
+		end
+		
+		puts "\nDoes 10.0.0.7 belong to the 10.0.0.8/29 subnet?"
+		subnet29 = NetAddr::IPv4Net.parse("10.0.0.8/29")
+		if subnet29.contains(NetAddr::IPv4.parse("10.0.0.7"))
+			puts " yes"
+		else
+			puts " no"
+		end
+		
+		puts "\nDoes 10.0.0.10 belong to the 10.0.0.8/29 subnet?"
+		if subnet29.contains(NetAddr::IPv4.parse("10.0.0.10"))
+			puts " yes"
+		else
+			puts " no"
+		end 
+		
+		puts "\nGiven the 3rd /30 of 10.0.0.0/24, fill in the holes:"
+		expect = ["10.0.0.0/29","10.0.0.8/30","10.0.0.12/30","10.0.0.16/28","10.0.0.32/27","10.0.0.64/26","10.0.0.128/25"]
+		i = 0
+		net.fill([subnet30]).each do |subnet|
+			puts "  " + subnet.to_s
+			assert_equal(expect[i], subnet.to_s)
+			i+=1
+		end
+		
+		list = ["10.0.1.0/24", "10.0.0.0/25", "10.0.0.128/26","10.0.2.0/24", "10.0.0.192/26",]
+		puts "\nSummarizing this list of networks: " + list.to_s
+		nets = []
+		list.each do |net|
+			nets.push(NetAddr::IPv4Net.parse(net))
+		end
+		expect = ["10.0.0.0/23", "10.0.2.0/24",]
+		i = 0
+		NetAddr.summ_IPv4Net(nets).each do |net|
+			puts "  " + net.to_s
+			assert_equal(expect[i],net.to_s)
+			i += 1
+		end
+		
+		puts "\nThe multicast mac-address for 235.147.18.23 is:"
+		mac = NetAddr::IPv4.parse("235.147.18.23").multicast_mac.to_s
+		assert_equal("01-00-5e-13-12-17", mac)
+		puts "  " + mac
+	end
+	
+	# IPv6
+	def test_IPv6_examples
+		puts "\n\n*** Examples using IPv6 ***\n"
+		
+		puts "\nCreating IPv6Net: 'fec0::/62'"
+		net = NetAddr::IPv6Net.parse("fec0::/62")
+		assert_not_nil(net)
+		
+		puts "\nRendering as a String: " + net.to_s
+		assert_equal("fec0::/62", net.to_s)
+		
+		puts "\nRendering as a String (long format): " + net.long
+		assert_equal("fec0:0000:0000:0000:0000:0000:0000:0000/62", net.long)
+		
+		puts "\nIterating its /64 subnets:"
+		expect = ["fec0::/64","fec0:0:0:1::/64","fec0:0:0:2::/64","fec0:0:0:3::/64"]
+		0.upto(net.subnet_count(64) - 1) do |i|
+			subnet = net.nth_subnet(64,i)
+			assert_equal(expect[i], subnet.to_s)
+			puts "  " + subnet.to_s
+		end
+		
+		puts "\nIts 3rd /64 subnet:"
+		subnet64 = net.nth_subnet(64,2)
+		assert_equal("fec0:0:0:2::/64", subnet64.to_s)
+		puts "  " + subnet64.to_s
+		
+		puts "\nIterating the first 4 IPs of the /64"
+		expect = ["fec0:0:0:2::","fec0:0:0:2::1","fec0:0:0:2::2","fec0:0:0:2::3"]
+		0.upto(3) do |i|
+			ip = subnet64.nth(i)
+			assert_equal(expect[i], ip.to_s)
+			puts "  " + ip.to_s
+		end
+		
+		puts "\nGiven the 3rd /64 of fec0::/62, fill in the holes:"
+		expect = ["fec0::/63", "fec0:0:0:2::/64","fec0:0:0:3::/64"]
+		i = 0
+		net.fill([subnet64]).each do |subnet|
+			puts "  " + subnet.to_s
+			assert_equal(expect[i], subnet.to_s)
+			i+=1
+		end
+		
+		list = ["fec0::/63", "fec0:0:0:3::/64", "fec0:0:0:2::/64", "fe80::/17", "fe80:8000::/17"]
+		puts "\nSummarizing this list of networks: " + list.to_s
+		nets = []
+		list.each do |net|
+			nets.push(NetAddr::IPv6Net.parse(net))
+		end
+		expect = ["fe80::/16", "fec0::/62"]
+		i = 0
+		NetAddr.summ_IPv6Net(nets).each do |net|
+			puts "  " + net.to_s
+			assert_equal(expect[i],net.to_s)
+			i += 1
+		end
+		
+		puts "\nThe IPv6 address for mac-address aa-bb-cc-dd-ee-ff within network fe80::/64 is:"
+		net = NetAddr::IPv6Net.parse("fe80::/64")
+		eui = NetAddr::EUI48.parse("aa-bb-cc-dd-ee-ff").to_eui64
+		ip = eui.to_ipv6(net)
+		assert_equal("fe80::a8bb:ccff:fedd:eeff",ip.to_s)
+		puts "  " + ip.to_s
+	end
+	
+end

data/test/ipv4_test.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/ruby
+
+require_relative "../lib/netaddr.rb"
+require 'test/unit'
+
+class TestIPv4 < Test::Unit::TestCase
+	def test_new
+		ip = NetAddr::IPv4.new(0x80000001)
+		assert_equal("128.0.0.1", ip.to_s)
+		
+		assert_raise(NetAddr::ValidationError){ NetAddr::IPv4.new(0x8000000001) }
+		assert_raise(NetAddr::ValidationError){ NetAddr::IPv4.new(-1) }
+		assert_raise(NetAddr::ValidationError){ NetAddr::IPv4.new("128.0.0.1") } # string
+	end
+	
+	def test_parse
+		assert_equal("128.0.0.1", NetAddr::IPv4.parse("128.0.0.1").to_s)
+		assert_equal("0.0.0.0", NetAddr::IPv4.parse("0.0.0.0").to_s)
+		
+		assert_raise(NetAddr::ValidationError){ NetAddr::IPv4.parse("128.0.0.1a") }
+		assert_raise(NetAddr::ValidationError){ NetAddr::IPv4.parse("256.0.0.1") }
+		assert_raise(NetAddr::ValidationError){ NetAddr::IPv4.parse("128.0.0.1.1") }
+		assert_raise(NetAddr::ValidationError){ NetAddr::IPv4.parse("128") }
+	end
+	
+	def test_cmp
+		ip = NetAddr::IPv4.parse("128.0.0.1")
+		ip2 = NetAddr::IPv4.parse("128.0.0.0")
+		ip3 = NetAddr::IPv4.parse("128.0.0.2")
+		ip4 = NetAddr::IPv4.parse("128.0.0.1")
+		assert_equal(1, ip.cmp(ip2))
+		assert_equal(-1, ip.cmp(ip3))
+		assert_equal(0, ip.cmp(ip4))
+	end
+	
+	def test_multicast_mac
+		assert_equal(0, NetAddr::IPv4.parse("223.255.255.255").multicast_mac.addr)
+		assert_equal("01-00-5e-00-00-00", NetAddr::IPv4.parse("224.0.0.0").multicast_mac.to_s)
+		assert_equal("01-00-5e-02-03-05", NetAddr::IPv4.parse("230.2.3.5").multicast_mac.to_s)
+		assert_equal("01-00-5e-13-12-17", NetAddr::IPv4.parse("235.147.18.23").multicast_mac.to_s)
+		assert_equal("01-00-5e-7f-ff-ff", NetAddr::IPv4.parse("239.255.255.255").multicast_mac.to_s)
+		assert_equal(0, NetAddr::IPv4.parse("240.0.0.0").multicast_mac.addr)
+	end
+	
+	def test_next
+		assert_equal("255.255.255.255", NetAddr::IPv4.parse("255.255.255.254").next().to_s)
+		assert_nil(NetAddr::IPv4.parse("255.255.255.255").next())
+	end
+	
+	def test_prev
+		assert_equal("0.0.0.0", NetAddr::IPv4.parse("0.0.0.1").prev().to_s)
+		assert_nil(NetAddr::IPv4.parse("0.0.0.0").prev())
+	end
+	
+	def test_to_net
+		ip = NetAddr::IPv4.parse("192.168.1.1")
+		net = NetAddr::IPv4Net.parse("192.168.1.1")
+		assert_equal(0, net.cmp(ip.to_net()))
+	end
+end

data/test/ipv4net_test.rb

@@ -0,0 +1,177 @@
+#!/usr/bin/ruby
+
+require_relative "../lib/netaddr.rb"
+require 'test/unit'
+
+class TestIPv4Net < Test::Unit::TestCase
+	def test_new
+		ip = NetAddr::IPv4.parse("128.0.0.1")
+		m32 = NetAddr::Mask32.new(24)
+		net = NetAddr::IPv4Net.new(ip,m32)
+		assert_equal("128.0.0.0/24", net.to_s)
+
+		net = NetAddr::IPv4Net.new(ip,nil)
+		assert_equal("128.0.0.1/32", net.to_s)
+	end
+	
+	def test_parse
+		assert_equal("128.0.0.0/24", NetAddr::IPv4Net.parse("128.0.0.1/24").to_s)
+		assert_equal("128.0.0.0/24", NetAddr::IPv4Net.parse("128.0.0.1 255.255.255.0").to_s)
+		assert_equal("0.0.0.0/0", NetAddr::IPv4Net.parse("0.0.0.0/0").to_s)
+		assert_equal("128.0.0.1/32", NetAddr::IPv4Net.parse("128.0.0.1").to_s) # default /32
+	end
+	
+	def test_cmp
+		net1 = NetAddr::IPv4Net.parse("1.1.1.0/24")
+		net2 = NetAddr::IPv4Net.parse("1.1.0.0/24")
+		net3 =NetAddr::IPv4Net.parse("1.1.2.0/24")
+		net4 = NetAddr::IPv4Net.parse("1.1.1.0/25")
+		net5 = NetAddr::IPv4Net.parse("1.1.1.0/24")
+		
+		assert_equal(1, net1.cmp(net2)) # ip less
+		assert_equal(-1, net1.cmp(net3))# ip greater
+		assert_equal(-1, net4.cmp(net1)) # ip eq, mask less
+		assert_equal(1, net1.cmp(net4)) # ip eq, mask greater
+		assert_equal(0, net1.cmp(net5)) # eq
+	end
+	
+	def test_contains
+		net = NetAddr::IPv4Net.parse("1.0.0.8/29")
+		ip1 = NetAddr::IPv4.parse("1.0.0.15")
+		ip2 = NetAddr::IPv4.parse("1.0.0.16")
+		ip3 = NetAddr::IPv4.parse("1.0.0.7")
+		
+		assert_equal(true, net.contains(ip1))
+		assert_equal(false, net.contains(ip2))
+		assert_equal(false, net.contains(ip3))
+	end
+	
+	def test_extended
+		net = NetAddr::IPv4Net.parse("128.0.0.1/24")
+		assert_equal("128.0.0.0 255.255.255.0", net.extended)
+	end
+
+	def test_fill
+		parent = NetAddr::IPv4Net.parse("10.0.0.0/24")
+		nets = []
+		["10.0.0.0/24", "10.0.0.0/8", "10.0.0.8/30", "10.0.0.16/30", "10.0.0.16/28"].each do |net|
+			nets.push(NetAddr::IPv4Net.parse(net))
+		end
+		expect = ["10.0.0.0/29", "10.0.0.8/30", "10.0.0.12/30", "10.0.0.16/28", "10.0.0.32/27", "10.0.0.64/26", "10.0.0.128/25"]
+		i = 0
+		parent.fill(nets).each do |net|
+			assert_equal(expect[i],net.to_s)
+			i += 1
+		end
+		
+		parent = NetAddr::IPv4Net.parse("128.0.0.0/1")
+		nets = []
+		["192.0.0.0/2"].each do |net|
+			nets.push(NetAddr::IPv4Net.parse(net))
+		end
+		expect = ["128.0.0.0/2", "192.0.0.0/2"]
+		i = 0
+		parent.fill(nets).each do |net|
+			assert_equal(expect[i],net.to_s)
+			i += 1
+		end
+		
+		parent = NetAddr::IPv4Net.parse("1.0.0.0/25")
+		nets = []
+		["1.0.0.0/30", "1.0.0.64/26"].each do |net|
+			nets.push(NetAddr::IPv4Net.parse(net))
+		end
+		expect = ["1.0.0.0/30", "1.0.0.4/30", "1.0.0.8/29", "1.0.0.16/28", "1.0.0.32/27", "1.0.0.64/26"]
+		i = 0
+		parent.fill(nets).each do |net|
+			assert_equal(expect[i],net.to_s)
+			i += 1
+		end
+	end
+	
+	def test_len
+		net1 = NetAddr::IPv4Net.parse("1.1.1.0/24")
+		assert_equal(256, net1.len())
+	end
+	
+	def test_next
+		assert_equal("1.0.0.2/31", NetAddr::IPv4Net.parse("1.0.0.0/31").next.to_s)
+		assert_equal("1.0.0.8/29", NetAddr::IPv4Net.parse("1.0.0.4/30").next.to_s)
+		assert_equal("1.0.0.16/28", NetAddr::IPv4Net.parse("1.0.0.8/29").next.to_s)
+	end
+	
+	def test_next_sib
+		assert_equal("255.255.255.64/26", NetAddr::IPv4Net.parse("255.255.255.0/26").next_sib.to_s)
+		assert_equal("255.255.255.128/26", NetAddr::IPv4Net.parse("255.255.255.64/26").next_sib.to_s)
+		assert_equal("255.255.255.192/26", NetAddr::IPv4Net.parse("255.255.255.128/26").next_sib.to_s)
+		assert_nil(NetAddr::IPv4Net.parse("255.255.255.192/26").next_sib)
+	end
+	
+	def test_nth
+		assert_equal("1.1.1.1", NetAddr::IPv4Net.parse("1.1.1.0/26").nth(1).to_s)
+		assert_nil(NetAddr::IPv4Net.parse("1.1.1.0/26").nth(64))
+	end
+	
+	def test_nth_subnet
+		assert_equal("1.1.1.0/26", NetAddr::IPv4Net.parse("1.1.1.0/24").nth_subnet(26,0).to_s)
+		assert_equal("1.1.1.64/26", NetAddr::IPv4Net.parse("1.1.1.0/24").nth_subnet(26,1).to_s)
+		assert_nil(NetAddr::IPv4Net.parse("1.1.1.0/24").nth_subnet(26,4))
+		assert_nil(NetAddr::IPv4Net.parse("1.1.1.0/24").nth_subnet(26,-1))
+		assert_nil(NetAddr::IPv4Net.parse("1.1.1.0/24").nth_subnet(24,0))
+	end
+	
+	def test_prev
+		assert_equal("1.0.0.0/29", NetAddr::IPv4Net.parse("1.0.0.8/30").prev.to_s)
+		assert_equal("1.0.0.128/26", NetAddr::IPv4Net.parse("1.0.0.192/26").prev.to_s)
+		assert_equal("1.0.0.0/25", NetAddr::IPv4Net.parse("1.0.0.128/26").prev.to_s)
+	end
+	
+	def test_prev_sib
+		assert_equal("0.0.0.64/26", NetAddr::IPv4Net.parse("0.0.0.128/26").prev_sib.to_s)
+		assert_equal("0.0.0.0/26", NetAddr::IPv4Net.parse("0.0.0.64/26").prev_sib.to_s)
+		assert_nil(NetAddr::IPv4Net.parse("0.0.0.0/26").prev_sib)
+	end
+	
+	def test_rel
+		net1 = NetAddr::IPv4Net.parse("1.1.1.0/24")
+		net2 = NetAddr::IPv4Net.parse("1.1.1.0/25")
+		net3 = NetAddr::IPv4Net.parse("1.1.1.128/25")
+		net4 = NetAddr::IPv4Net.parse("1.1.1.0/25")
+		assert_equal(1, net1.rel(net2)) # net eq, supernet
+		assert_equal(-1, net2.rel(net1)) # net eq, subnet
+		assert_equal(0, net2.rel(net2)) # eq
+		assert_equal(1, net1.rel(net3)) # net ne, supernet
+		assert_equal(-1, net3.rel(net1)) # net ne, subnet
+		assert_nil(net3.rel(net4)) # unrelated
+	end
+	
+	def test_resize
+		assert_equal("1.1.1.0/24", NetAddr::IPv4Net.parse("1.1.1.0/26").resize(24).to_s)
+	end
+	
+	def test_subnet_count
+		assert_equal(2, NetAddr::IPv4Net.parse("1.1.1.0/24").subnet_count(25))
+		assert_equal(0, NetAddr::IPv4Net.parse("1.1.1.0/24").subnet_count(24))
+		assert_equal(0, NetAddr::IPv4Net.parse("1.1.1.0/24").subnet_count(33))
+		assert_equal(0, NetAddr::IPv4Net.parse("0.0.0.0/0").subnet_count(32))
+	end
+	
+	def test_summ
+		net1 = NetAddr::IPv4Net.parse("1.1.1.0/30")
+		net2 = NetAddr::IPv4Net.parse("1.1.1.4/30")
+		net3 = NetAddr::IPv4Net.parse("1.1.1.16/28")
+		net4 = NetAddr::IPv4Net.parse("1.1.1.0/28")
+		net5 = NetAddr::IPv4Net.parse("1.1.2.0/30")
+		net6 = NetAddr::IPv4Net.parse("1.1.1.4/30")
+		net7 = NetAddr::IPv4Net.parse("1.1.1.16/28")
+		net8 = NetAddr::IPv4Net.parse("1.1.1.32/28")
+		net9 = NetAddr::IPv4Net.parse("1.1.1.0/29")
+		net10 = NetAddr::IPv4Net.parse("1.1.1.8/30")
+		assert_equal("1.1.1.0/29", net1.summ(net2).to_s) # lesser to greater
+		assert_equal("1.1.1.0/27", net3.summ(net4).to_s) # greater to lesser
+		assert_nil(net5.summ(net6)) # different nets
+		assert_nil(net7.summ(net8)) # consecutive but not within bit boundary
+		assert_nil(net9.summ(net10)) # within bit boundary, but not same size
+	end
+	
+end