ospfv2 0.0.2 → 0.0.3

data/lib/ie/ls_type.rb

@@ -20,8 +20,10 @@
 # along with OSPFv2.  If not, see <http://www.gnu.org/licenses/>.
 #++
 
+require_relative 'ie'
 module OSPFv2
 class LsType
+  include IE
 
   @ls_type_junos = {
     1 => 'Router'  ,
@@ -34,6 +36,17 @@ class LsType
     11=> 'OpaqAS'  ,
   }
 
+  @ls_type_ios = {
+    1 => 'Router Links',
+    2 => 'Network Links',
+    3 => 'Summary Links(Network)',
+    4 => 'Summary Links(AS Boundary Router)',
+    5 => 'AS External Link',
+    9 => 'OpaqLoca',
+    10=> 'Opaque Area Link',
+    11=> 'OpaqAS'  ,
+  }
+
   @ls_type_short = {
     1=>'router'   ,
     2=>'network'  ,
@@ -46,16 +59,17 @@ class LsType
     11=>'opaqAs'  ,
   }
 
+# FIXME: rename all opaque :opaque_area , :opaque_link_local, :opaque_domain
   @ls_type_sym = {
-    1  => :router_lsa      ,
-    2  => :network_lsa     ,
-    3  => :summary_lsa     ,
-    4  => :asbr_summary_lsa,
-    5  => :as_external_lsa ,
-    7  => :as_external7_lsa,
-    9  => :link_local_lsa  ,
-    10 => :area_lsa        ,
-    11 => :domain_lsa      ,
+    1  => :router      ,
+    2  => :network     ,
+    3  => :summary     ,
+    4  => :asbr_summary,
+    5  => :as_external ,
+    7  => :as_external7,
+    9  => :link_local  ,
+    10 => :area        ,
+    11 => :domain      ,
   }
   
   @ls_type_sym_to_i = @ls_type_sym.invert
@@ -66,23 +80,12 @@ class LsType
 
   class << self
     def all
-      [:router, :network, :summary, :asbr_summary, :as_external]
+      [:router, :network, :summary, :asbr_summary, :as_external, :area]
     end
 
     def to_i(arg)
       return arg unless arg.is_a?(Symbol)
-      case arg.to_s
-      when /^router(_lsa|)$/       ; @ls_type=1
-      when /^network(_lsa|)$/      ; @ls_type=2
-      when /^summary(_lsa|)$/      ; @ls_type=3
-      when /^asbr_summary(_lsa|)$/ ; @ls_type=4
-      when /^as_external(_lsa|)$/  ; @ls_type=5
-        #FIXME: finish and unit-test
-        # when :as_external7_lsa ; @ls_type=7
-        # when :opaque_link      ; @ls_type=9
-        # when :opaque_area      ; @ls_type=10
-        # when :opaque_as        ; @ls_type=11
-      end    
+      ls_type_sym_to_i(arg)
     end
 
     def to_sym(arg)
@@ -99,7 +102,7 @@ class LsType
       if @ls_type_sym_to_i.has_key?(arg)
         @ls_type_sym_to_i[arg]
       else
-        raise
+        raise "cannot convert #{arg.inspect} to i"
       end
     end
 
@@ -112,6 +115,15 @@ class LsType
       end
     end
 
+    def to_s_ios(arg)
+      return arg unless arg.is_a?(Fixnum)
+      if @ls_type_ios.has_key?(arg)
+        @ls_type_ios[arg]
+      else
+        raise
+      end
+    end
+
     def to_short(arg)
       return arg unless arg.is_a?(Fixnum)
       if @ls_type_short.has_key?(arg)
@@ -121,7 +133,7 @@ class LsType
       end
     end
   end
-  
+
   def initialize(ls_type=1)
     @ls_type = case ls_type
     when Symbol
@@ -156,6 +168,10 @@ class LsType
     LsType.to_short(to_i)
   end
   
+  def to_s_ios
+    "LS Type: " + LsType.to_s_ios(to_i)
+  end
+  
   def to_junos
     LsType.to_junos(to_i)
   end
@@ -163,19 +179,6 @@ class LsType
 end
 end
 
-load "../../../test/ospfv2/ie/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0
-
-__END__
 
-LSA_Header.aging=false
-LSA_Header.lstype_to_s = Hash.new("unknown")
-LSA_Header.lstype_to_s.store(1,"Router")
-LSA_Header.lstype_to_s.store(2,"Network")
-LSA_Header.lstype_to_s.store(3,"Summary")
-LSA_Header.lstype_to_s.store(4,"ASBR_Sum")
-LSA_Header.lstype_to_s.store(5,"External")
-LSA_Header.lstype_to_s.store(9,"OpaqLink")
-LSA_Header.lstype_to_s.store(10,"OpaqArea")
-LSA_Header.lstype_to_s.store(11,"OpaqAS")
 
 

data/lib/ie/opaque_id.rb

@@ -0,0 +1,46 @@
+#--
+# Copyright 2011 Jean-Michel Esnault.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#
+#
+# This file is part of OSPFv2.
+# 
+#++
+
+require 'infra/ospf_common'
+
+module OSPFv2
+class OpaqueId
+  include Common
+  
+  attr_reader  :opaque_id
+  attr_checked :opaque_id do |x|
+    (0..0xffffff).include?(x)
+  end
+  
+  def initialize(opaque_id=0)
+    self.opaque_id=opaque_id
+  end
+  
+  def to_i
+    opaque_id
+  end
+  
+  def to_s
+    self.class.to_s.split('::').last + ": #{to_i}"
+  end
+  
+  def encode
+    [opaque_id].pack('N')[1..-1]
+  end
+  alias :enc  :encode
+  
+  def to_hash
+    to_i
+  end
+  
+end
+end
+
+load "../../../test/ospfv2/ie/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

data/lib/ie/opaque_type.rb

@@ -0,0 +1,96 @@
+#--
+# Copyright 2011 Jean-Michel Esnault.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#
+#
+# This file is part of OSPFv2.
+# 
+#++
+
+require 'ie/ie'
+module OSPFv2
+class OpaqueType
+  include IE
+  
+  @opaque_type_sym = {
+    1  => :te_lsa,
+    2  => :sycamore_optical_topology_description,
+    3  => :grace_lsa,
+    4  => :router_information,
+  }
+  
+  @opaque_type_sym_to_i = @opaque_type_sym.invert
+  
+  class << self
+    def all
+      @opaque_type_sym_to_i.key
+    end
+    
+    def to_sym(arg)
+      return arg unless arg.is_a?(Fixnum)
+      if @opaque_type_sym.has_key?(arg)
+        @opaque_type_sym[arg]
+      else
+        raise
+      end
+    end
+    
+    def to_i(arg)
+      return arg if arg.is_a?(Fixnum)
+      if @opaque_type_sym_to_i.has_key?(arg)
+        @opaque_type_sym_to_i[arg]
+      else
+        raise
+      end
+    end
+    
+  end
+  
+  def initialize(opaque_type=1)
+    @opaque_type = case opaque_type
+    when Symbol
+      OpaqueType.to_i(opaque_type)
+    when Fixnum
+      opaque_type
+    else
+      raise ArgumentError, "Invalid OpaqueType #{opaque_type}"
+    end
+  end
+  def to_i
+    @opaque_type
+  end
+  def to_s
+    self.class.to_s.split('::').last + ": #{to_sym}"
+  end
+
+  def to_sym
+    OpaqueType.to_sym @opaque_type
+  end
+
+  def encode
+    [@opaque_type].pack('C')
+  end
+  alias :enc  :encode
+  
+  def to_hash
+    to_sym
+  end
+  
+end
+end
+
+load "../../../test/ospfv2/ie/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0
+
+__END__
+
+Registry:
+Value    Opaque Type                                 Reference
+-------  ------------------------------------------  ---------
+1        Traffic Engineering LSA                     [RFC3630]
+2        Sycamore Optical Topology Descriptions      [Moy]
+3        grace-LSA                                   [RFC3623]
+4        Router Information (RI)                     [RFC4970]
+5-127    Unassigned
+128-255  Private Use
+

data/lib/ie/options.rb

@@ -109,11 +109,13 @@ A.2 The Options field
 
 =end
 
-require 'infra/ospf_common'
+require_relative '../infra/ospf_common'
+require_relative 'ie'
 module OSPFv2
   
   
   class Options
+    include IE
      
     attr_accessor :options
 
@@ -149,6 +151,8 @@ module OSPFv2
           end
         end
       end
+
+
       unless arg[:DC].nil? and arg[:dc].nil?
         _flag = arg[:DC] ||= arg[:dc]
         if _flag.is_a?(TrueClass)
@@ -373,5 +377,3 @@ module OSPFv2
   end
   
 end
-
-load "../../../test/ospfv2/ie/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

data/lib/ie/router_link.rb

@@ -82,19 +82,40 @@ module OSPFv2
       rlink.join
     end
     
-    def to_s(ident=2)
+    def to_s(ident=4)
       encode unless @router_link_type
       self.class.to_s.split('::').last + ":" +
       ['',link_id, link_data, router_link_type, metric, *mt_metrics].compact.collect { |x| x.to_s }.join("\n"+" "*ident)
     end
     
-    def to_s_junos_style
-      s = "  id #{id}, data #{data}, Type #{RouterLink.type_to_s_junos_style[@type]} (#{@type})"
-      s +="\n    Topology count: #{@mt_id.size}, Default metric: #{@metric}"
-      s += @mt_id.collect { |mt| "\n    #{mt.to_s_junos_style}" }.join
-      s      
+    def link_id_to_s(link_type)
+      RouterLinkType.link_id_to_s(link_type)
     end
- 
+    
+    def link_data_to_s(link_type)
+      RouterLinkType.link_data_to_s(link_type)
+    end
+    
+    # Link connected to: another Router (point-to-point)
+    #  (Link ID) Neighboring Router ID: 1.1.1.1
+    #  (Link Data) Router Interface address: 192.168.158.1
+    #   Number of TOS metrics: 0
+    #    TOS 0 Metrics: 1
+    def to_s_ios
+      s = []
+      s << ''
+      s << "Link connected to: #{router_link_type.to_s_ios}"
+      s << "  (Link ID) #{link_id_to_s(router_link_type.to_i)}: #{link_id.to_ip}"
+      s << "  (Link Data) #{link_data_to_s(router_link_type.to_i)}: #{link_data.to_ip}"
+      s << "   Number of TOS metrics: #{@mt_metrics.size}"
+      s << "   TOS 0 Metrics: #{metric.to_i}"
+      s << @mt_metrics.collect { |mt| "\n    #{mt.to_s}" }.join unless @mt_metrics.empty?
+      s << ''
+      s.join("\n    ")
+    end
+    alias :to_s_ios_verbose :to_s_ios
+    
+    
     def to_s_junos
       s = "  id #{link_id.to_ip}, data #{link_data.to_ip}, Type #{RouterLinkType.to_junos(router_link_type.to_i)} (#{router_link_type.to_i})"
       s +="\n    Topology count: #{@mt_metrics.size}, Default metric: #{metric.to_i}"
@@ -144,3 +165,5 @@ end
 
 
 load "../../../test/ospfv2/ie/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0
+
+

data/lib/ie/router_link_type.rb

@@ -30,30 +30,121 @@
 
 module OSPFv2
 class RouterLinkType
-  def self.each
-    [:point_to_point, :transit_network, :stub_network, :virtual_link].each { |x| yield(x) } if block_given?
-  end
-  def self.to_i(arg)
-    return arg unless arg.is_a?(Symbol)
-    [:point_to_point, :transit_network, :stub_network, :virtual_link].index(arg)+1
-  end
-  def self.to_junos(type)
-    case type.to_i
-    when 1 ; 'Point-to-point'
-    when 2 ; 'Transit'
-    when 3 ; 'Stub'
-    when 4 ; 'Virtual-link'
-    else   ; type.to_i 
+
+  @router_link_sym = {
+    1  => :point_to_point,
+    2  => :transit_network,
+    3  => :stub_network,
+    4  => :virtual_link,
+  }
+  
+  @router_link_sym_to_i = @router_link_sym.invert
+  
+  @router_link_type_junos = {
+    1 => 'Point-to-point',
+    2 => 'Transit',
+    3 => 'Stub',
+    4 => 'Virtual-link',
+  }
+
+  @router_link_type_ios = {
+    1 => 'another Router (point-to-point)',
+    2 => 'a Transit Network',
+    3 => 'a Stub Network',
+    4 => 'a Virtual Link',
+  }
+  
+  @link_id_from_type = {
+    1 => 'Neighboring Router ID',
+    2 => 'Designated Router address',
+    3 => 'Network/subnet number',
+    4 => 'TBD',
+  }
+
+  @link_data_from_type = {
+    1 => 'Router Interface address',
+    2 => 'Router Interface address',
+    3 => 'Network Mask',
+    4 => 'TBD',
+  }
+
+  class << self
+
+    def to_i(arg)
+      router_link_sym_to_i(arg)
+    end
+    
+    def all
+      [:point_to_point, :transit_network, :stub_network, :virtual_link]
+    end
+    
+    def each
+      all.each { |x| yield(x) } if block_given?
+    end
+
+    def to_sym(arg)
+      return arg unless arg.is_a?(Fixnum)
+      if @router_link_sym.has_key?(arg)
+        @router_link_sym[arg]
+      else
+        raise
+      end
+    end
+
+    def router_link_sym_to_i(arg)
+      return arg if arg.is_a?(Fixnum)
+      if @router_link_sym_to_i.has_key?(arg)
+        @router_link_sym_to_i[arg]
+      else
+        raise
+      end
+    end
+    
+    def link_id_to_s(arg)
+      return arg unless arg.is_a?(Fixnum)
+      if @link_id_from_type.has_key?(arg)
+        @link_id_from_type[arg]
+      else
+        raise
+      end
+    end
+    
+    def link_data_to_s(arg)
+      return arg unless arg.is_a?(Fixnum)
+      if @link_data_from_type.has_key?(arg)
+        @link_data_from_type[arg]
+      else
+        raise
+      end
+    end
+
+    def to_junos(arg)
+      return arg unless arg.is_a?(Fixnum)
+      if @router_link_type_junos.has_key?(arg)
+        @router_link_type_junos[arg]
+      else
+        arg
+      end
+    end
+
+    def to_s_ios(arg)
+      return arg unless arg.is_a?(Fixnum)
+      if @router_link_type_ios.has_key?(arg)
+        @router_link_type_ios[arg]
+      else
+        arg
+      end
     end
   end
-  def initialize(router_link_type=1)
-    case router_link_type
-    when  1, :point_to_point   ; @router_link_type=1
-    when  2, :transit_network  ; @router_link_type=2
-    when  3, :stub_network     ; @router_link_type=3
-    when  4, :virtual_link     ; @router_link_type=4
+
+  def initialize(arg=1)
+    @router_link_type = case arg
+    when Symbol
+      self.class.router_link_sym_to_i(arg)
+    when Fixnum
+      arg
     else
-      raise ArgumentError, "Invalid RouterLinkType #{router_link_type}"
+      raise ArgumentError, "Invalid RouterLinkType #{arg}"
     end
   end
   def to_i
@@ -62,13 +153,11 @@ class RouterLinkType
   def to_s
     self.class.to_s.split('::').last + ": #{to_sym}"
   end
+  def to_s_ios
+    RouterLinkType.to_s_ios to_i
+  end
   def to_sym
-    case @router_link_type
-    when 1  ; :point_to_point
-    when 2  ; :transit_network
-    when 3  ; :stub_network
-    when 4  ; :virtual_link
-    end
+    RouterLinkType.to_sym @router_link_type
   end
   def encode
     [@router_link_type].pack('C')