netaddr 1.3.0 → 1.4.0

data/README

@@ -15,188 +15,3 @@ your life easier.
  
 Dustin Spinhirne
 
-
-=Example Script
-
- #!/usr/bin/ruby
-
- # A script to parse static routes from a Cisco router.
- # Performs the following tasks:
- #  - organizes statics by directly connected next-hop interface
- #  - corrects recursive static routes
- #  - reports statics with no directly connected next-hop
- #  - reports duplicate static routes
- #  - reports static routes that overlap directly connected interfaces
- #
- # Change the variable 'infile' to that of the name of the router configuration
- # file that should be parsed.
-
- require 'rubygems'
- require_gem 'netaddr'
-
- # change this variable to that of the router config file
- infile = 'router_config.txt'
-
-
- ip_interface_count = 0
- static_route_count = 0
- connected_routes = []
- static_routes = []
- statics = {}
- grouped_routes = {}
- duplicates = []
- recursives = []
- corrected_statics = []
- overlapping_statics = []
-
-
- # sort through router config. put connected ip interfaces into 'connected_routes'
- # and static routes into 'statics'. Set aside duplicate static routes.
- File.open(infile, 'r') do |file|
-     while line = file.gets
-         if (line =~/^interface .+/)
-             interface = line.chomp
-         elsif (line =~ /^\s*ip address/) # connected interface
-             ip_interface_count += 1
-             addr = line.split('ip address ').join # ['x.x.x.x y.y.y.y']
-             cidr = NetAddr::CIDR.create(addr, :Tag => {:interface => interface})
-             connected_routes.push(cidr)
-         elsif (line =~/^ip route/) # static route
-             static_route_count += 1
-             elements = line.split(' ') # ['ip','route','x.x.x.x','y.y.y.y','x.x.x.x',]
-                ip = elements[2]
-                netmask = elements[3]
-                nexthop = elements[4]
-
-             # keep all but loopbacks, nulls, or defaults
-             if ( (nexthop !~ /Loopback/) && (nexthop !~ /Null/) && (ip != '0.0.0.0') )
-                 nexthop_cidr = NetAddr::CIDR.create(nexthop)
-                 cidr = NetAddr::CIDR.create("#{ip} #{netmask}",
-                                             :Tag => {:route => line, :nexthop => nexthop_cidr})
-
-                 if (!statics.has_key?(cidr.desc))
-                     statics[cidr.desc] = cidr
-                 else
-                     msg = '! overlaps with - ' + statics[cidr.desc].tag[:route] + line + "!\n"
-                     duplicates.push(msg)
-                 end
-             end
-         end
-     end
- end
-
-
- # look for statics that overlap with a connected interface, and
- # group static routes with their next-hop interface.
- statics.each_key do  |desc|
-     cidr = statics[desc]
-     nexthop = cidr.tag[:nexthop]
-     route = cidr.tag[:route]
-
-     overlaps_with = nil
-     nexthop_int = nil
-     connected_routes.each do |interface|
-         if (interface.contains?(cidr)) # overlapping static
-             overlaps_with = interface
-             break
-         elsif (interface.contains?(nexthop)) # next-hop directly connected
-             nexthop_int = interface
-             break
-         end
-     end
-
-     if (nexthop_int)
-         key = "#{nexthop_int.tag[:interface]} -> #{nexthop_int.desc}"
-         if (grouped_routes.has_key?(key))
-             grouped_routes[key].push(route)
-         else
-             grouped_routes[key] = [route]
-         end
-         static_routes.push(cidr)
-     elsif (overlaps_with)
-         overlap = "! overlaps with: #{overlaps_with.tag[:interface]} -> #{overlaps_with.desc}"
-         overlap << "\n#{route}!\n"
-         overlapping_statics.push(overlap)
-     else
-         recursives.push(cidr)
-     end
- end
-
-
- # process recursive routes. update next-hop so that it points
- # to next hop of a directly connected ip. remove any that do not point to a
- # directly connected ip. We must continually cycle through the list, as the
- # 'static_routes' tree is constantly updated. We do this until our list of
- # recursive static routes stops getting any shorter
- recursives_count = 0
- until (recursives_count == recursives.length)
-     recursives_count = recursives.length
-     recursives.each do  |cidr|
-         nexthop = cidr.tag[:nexthop]
-         route = cidr.tag[:route]
-
-         found = nil
-         static_routes.each do |static|
-             if (static.contains?(nexthop))
-                 found = static
-                 break
-             end
-         end
-
-         if (found)
-             updated = 'no ' + route
-             updated << "ip route #{cidr.network} #{cidr.netmask_ext} #{found.tag[:nexthop].ip}\n"
-             updated << "!\n"
-             corrected_statics.push(updated)
-             static_routes.push(cidr)
-             recursives.delete(cidr)
-         end
-     end
- end
-
-
- # print results.
- puts "--- STATISTICS ---"
- puts "#{ip_interface_count} Connected IP Interfaces\n#{static_route_count} IP Static Routes\n"
-
- print "\n\n"
-
- puts "--- OVERLAPPING STATIC ROUTES ---"
- overlapping_statics.each do |overlap|
-     puts overlap
- end
-
- print "\n\n"
-
- puts "--- DUPLICATE STATIC ROUTES ---"
- duplicates.each do |route|
-     puts route
- end
-
- print "\n\n"
-
- puts "--- STATIC ROUTES WITH UPDATED NEXT-HOP ---"
- corrected_statics.each do |route|
-     puts route
- end
-
- print "\n\n"
-
- puts "--- STATIC ROUTES WITH UNKNOWN NEXT-HOP ---"
- recursives.each do |cidr|
-     puts cidr.tag[:route]
- end
-
- print "\n\n"
-
- puts "--- STATIC ROUTES GROUPED BY NEXT-HOP INTERFACE ---"
- grouped_routes.each_key do |interface|
-     routes = grouped_routes[interface]
-     puts interface
-     routes.each do |route|
-         puts route
-     end
-     print "\n"
- end
-
- __END__

data/lib/cidr_shortcuts.rb

@@ -210,7 +210,7 @@ module_function :cidr_make_subnets_from_base_and_ip_count
 
 # given a list of NetAddr::CIDRs, return them as a sorted list
 #
-def cidr_sort(list)
+def cidr_sort(list, desc=false)
     # uses simple quicksort algorithm
     sorted_list = []
     if (list.length < 1)
@@ -220,19 +220,38 @@ def cidr_sort(list)
         greater_list = []
         equal_list = []
         pivot = list[rand(list.length)]
-        list.each do |x|
-            gt_lt = cidr_gt_lt(pivot,x)
-            if (gt_lt == 1)
-                less_list.push(x)
-            elsif (gt_lt == -1)
-                greater_list.push(x)
-            else
-                equal_list.push(x)
+        if (desc)
+            list.each do |x|
+                if ( pivot.to_i(:network) < x.to_i(:network) )
+                    less_list.push(x)
+                elsif ( pivot.to_i(:network) > x.to_i(:network) )
+                    greater_list.push(x)
+                else
+                    if ( pivot.to_i(:netmask) < x.to_i(:netmask) )
+                        greater_list.push(x)
+                    elsif ( pivot.to_i(:netmask) > x.to_i(:netmask) )
+                        less_list.push(x)
+                    else
+                        equal_list.push(x)
+                    end
+                end
+            end
+        else
+            list.each do |x|
+                gt_lt = cidr_gt_lt(pivot,x)
+                if (gt_lt == 1)
+                    less_list.push(x)
+                elsif (gt_lt == -1)
+                    greater_list.push(x)
+                else
+                    equal_list.push(x)
+                end
             end
         end
-        sorted_list.concat( cidr_sort(less_list) )
+
+        sorted_list.concat( cidr_sort(less_list, desc) )
         sorted_list.concat(equal_list)
-        sorted_list.concat( cidr_sort(greater_list) )
+        sorted_list.concat( cidr_sort(greater_list, desc) )
     end
 
     return(sorted_list)
@@ -328,6 +347,64 @@ def cidr_summarize(subnet_list)
 end
 module_function :cidr_summarize
 
+#==============================================================================#
+# netmask_sort()
+#==============================================================================#
+
+# given a list of NetAddr::CIDRs, return them as a sorted (by netmask) list
+#
+def netmask_sort(list, desc=false)
+    # uses simple quicksort algorithm
+    sorted_list = []
+    if (list.length < 1)
+        sorted_list = list
+    else
+        less_list = []
+        greater_list = []
+        equal_list = []
+        pivot = list[rand(list.length)]
+        if (desc)
+            list.each do |x|
+                if ( pivot.to_i(:netmask) < x.to_i(:netmask) )
+                    less_list.push(x)
+                elsif ( pivot.to_i(:netmask) > x.to_i(:netmask) )
+                    greater_list.push(x)
+                else
+                    if ( pivot.to_i(:network) < x.to_i(:network) )
+                        greater_list.push(x)
+                    elsif ( pivot.to_i(:network) > x.to_i(:network) )
+                        less_list.push(x)
+                    else
+                        equal_list.push(x)
+                    end
+                end
+            end
+        else
+            list.each do |x|
+                if ( pivot.to_i(:netmask) < x.to_i(:netmask) )
+                    greater_list.push(x)
+                elsif ( pivot.to_i(:netmask) > x.to_i(:netmask) )
+                    less_list.push(x)
+                else
+                    if ( pivot.to_i(:network) < x.to_i(:network) )
+                        greater_list.push(x)
+                    elsif ( pivot.to_i(:network) > x.to_i(:network) )
+                        less_list.push(x)
+                    else
+                        equal_list.push(x)
+                    end
+                end
+            end
+        end
+
+        sorted_list.concat( netmask_sort(less_list, desc) )
+        sorted_list.concat(equal_list)
+        sorted_list.concat( netmask_sort(greater_list, desc) )
+    end
+
+    return(sorted_list)
+end
+module_function :netmask_sort
 
 end # module NetAddr
 

data/lib/ip_math.rb

@@ -51,7 +51,7 @@ def detect_ip_version(ip)
     elsif (ip =~ /:/)
         version = 6
     else
-        raise ValidationError, "Count not auto-detect IP version for '#{ip}'."
+        raise ValidationError, "Could not auto-detect IP version for '#{ip}'."
     end
     return(version)
 end

data/lib/methods.rb

@@ -601,30 +601,48 @@ module_function :shorten
 #==============================================================================#
 
 #===Synopsis
-#Given a list of CIDR addresses or NetAddr::CIDR objects,
-#sort them from lowest to highest by Network/Netmask. This method will use the
-#base address of any NetAddr::CIDR objects or CIDR addresses provided.
+#Sort a list of CIDR addresses or NetAddr::CIDR objects,
 #
 # Example:
 # cidr1 = NetAddr::CIDR.create('192.168.1.32/27')
 # cidr2 = NetAddr::CIDR.create('192.168.1.0/27')
 # NetAddr.sort([cidr1,cidr2])
-# NetAddr.sort(['192.168.1.32/27','192.168.1.0/27','192.168.2.0/24'])
+# NetAddr.sort(['192.168.1.32/27','192.168.1.0/27','192.168.2.0/24'], :Desc => true)
 #
 #===Arguments:
 #* list = Array of CIDR addresses as Strings, or Array of NetAddr::CIDR objects
+#* options = Hash with the following keys:
+#     :ByMask -- if true, sorts based on the netmask length
+#     :Desc -- if true, return results in descending order
 #
 #===Returns:
 #* Array of Strings, or Array of NetAddr::CIDR objects
 #
-def sort(list)
-
+def sort(list, options=nil)
     # make sure list is an array
     if ( !list.kind_of?(Array) )
         raise ArgumentError, "Array of NetAddr::CIDR or NetStruct " +
                              "objects expected, but #{list.class} provided."
     end
 
+    desc = false
+    by_mask = false
+    # validate options
+    if (options)
+        known_args = [:Desc, :ByMask]
+        raise ArgumentError, "Hash expected for argument 'options' but #{options.class} provided." if (!options.kind_of?(Hash))
+        NetAddr.validate_args(options.keys,known_args)
+
+        if( options.has_key?(:Desc) && options[:Desc] == true )
+            desc = true
+        end
+
+        if( options.has_key?(:ByMask) && options[:ByMask] == true )
+            by_mask = true
+        end
+
+    end
+
     # make sure all are valid types of the same IP version
     version = nil
     cidr_hash = {}
@@ -647,8 +665,12 @@ def sort(list)
         end 
     end
 
-    # sort by network. if networks are equal, sort by netmask.
-    sorted_list = cidr_sort(cidr_hash.keys)
+    # perform sort
+    if (by_mask)
+        sorted_list = netmask_sort(cidr_hash.keys, desc)
+    else
+        sorted_list = cidr_sort(cidr_hash.keys, desc)
+    end
 
     # return original values passed
     ret_list = []

data/tests/cidr_test.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby
 
-require '../lib/net_addr.rb'
+require 'lib/netaddr.rb'
 require 'test/unit'
 
 

data/tests/eui_test.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby
 
-require '../lib/net_addr.rb'
+require 'lib/netaddr.rb'
 require 'test/unit'
 
 

data/tests/methods_test.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby
 
-require '../lib/net_addr.rb'
+require 'lib/netaddr.rb'
 require 'test/unit'
 
 
@@ -161,11 +161,30 @@ class TestMethods < Test::Unit::TestCase
         cidr6_3 = NetAddr::CIDR.create('fe80::0/10')
         cidr6_4 = 'fe80::0'
 
+        sort1 = NetAddr.sort(['192.168.1.0/24','192.168.1.128/25','192.168.1.64/26','192.168.1.0/30','192.168.2.0/24'])
+        assert_equal(['192.168.1.0/24','192.168.1.0/30','192.168.1.64/26','192.168.1.128/25','192.168.2.0/24'], sort1)
         sort1 = NetAddr.sort([cidr4_1,cidr4_2,cidr4_3,cidr4_4,cidr4_5])
-        sort2 = NetAddr.sort([cidr6_1,cidr6_2,cidr6_3,cidr6_4])
-
         assert_equal([cidr4_1,cidr4_4,cidr4_3,cidr4_2,cidr4_5], sort1)
+
+        sort2 = NetAddr.sort(['fec0::0/64','fec0::0/10','fe80::0/10','fe80::0'])
+        assert_equal(['fe80::0/10','fe80::0','fec0::0/10','fec0::0/64'], sort2)
+        sort2 = NetAddr.sort([cidr6_1,cidr6_2,cidr6_3,cidr6_4])
         assert_equal([cidr6_3,cidr6_4,cidr6_2,cidr6_1], sort2)
+
+        sort3 = NetAddr.sort([cidr4_1,cidr4_2,cidr4_3,cidr4_4,cidr4_5], :Desc => true)
+        assert_equal([cidr4_5,cidr4_2,cidr4_3,cidr4_1,cidr4_4], sort3)
+        sort3 = NetAddr.sort(['192.168.1.0/24','192.168.1.128/25','192.168.1.64/26','192.168.1.0/30','192.168.2.0/24'], :Desc => true)
+        assert_equal(['192.168.2.0/24','192.168.1.128/25','192.168.1.64/26','192.168.1.0/24','192.168.1.0/30'], sort3)
+
+        sort4 = NetAddr.sort(['192.168.1.0/24','192.168.1.128/25','192.168.1.64/26','192.168.1.0/30','192.168.2.0/24'], :ByMask => true)
+        assert_equal(['192.168.1.0/24','192.168.2.0/24','192.168.1.128/25','192.168.1.64/26','192.168.1.0/30'], sort4)
+        sort4 = NetAddr.sort([cidr4_1,cidr4_2,cidr4_3,cidr4_4,cidr4_5], :ByMask => true)
+        assert_equal([cidr4_1,cidr4_5,cidr4_2,cidr4_3,cidr4_4], sort4)
+
+        sort5 = NetAddr.sort(['192.168.1.0/24','192.168.1.128/25','192.168.1.64/26','192.168.1.0/30','192.168.2.0/24'], :ByMask => true, :Desc => true)
+        assert_equal(['192.168.1.0/30','192.168.1.64/26','192.168.1.128/25','192.168.1.0/24','192.168.2.0/24'], sort5)
+        sort5 = NetAddr.sort([cidr4_1,cidr4_2,cidr4_3,cidr4_4,cidr4_5], :ByMask => true, :Desc => true)
+        assert_equal([cidr4_4,cidr4_3,cidr4_2,cidr4_1,cidr4_5], sort5)
     end
 
     def test_unshorten

data/tests/tree_test.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby
 
-require '../lib/net_addr.rb'
+require 'lib/netaddr.rb'
 require 'test/unit'
 
 

metadata

@@ -1,61 +1,68 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: netaddr
 version: !ruby/object:Gem::Version 
-  version: 1.3.0
-date: 2007-07-10 00:00:00 -05:00
-summary: A package for manipulating network addresses.
-require_paths: 
-- lib
-email: 
-homepage: 
-rubyforge_project: 
-description: 
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 1.4.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Dustin Spinhirne
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-02-15 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- Errors
+- changelog
 files: 
 - lib/cidr_shortcuts.rb
 - lib/cidr.rb
 - lib/ip_math.rb
-- lib/eui.rb
-- lib/methods.rb
 - lib/validation_shortcuts.rb
+- lib/eui.rb
 - lib/netaddr.rb
+- lib/methods.rb
 - lib/tree.rb
 - README
 - Errors
 - changelog
-test_files: 
-- tests/eui_test.rb
-- tests/methods_test.rb
-- tests/cidr_test.rb
-- tests/tree_test.rb
+has_rdoc: true
+homepage: 
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: 
-- README
-- Errors
-- changelog
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
-
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: A package for manipulating network addresses.
+test_files: 
+- tests/tree_test.rb
+- tests/methods_test.rb
+- tests/cidr_test.rb
+- tests/eui_test.rb