bgp4r 0.0.5 → 0.0.7

data/bgp/common.rb

@@ -130,7 +130,11 @@ class String
     end
     if l.size%2 >0
       ns = if l.size>1 then 1 else 0 end
-      ls.last << format("%s%2.2x",' '*ns,l[-1].unpack('C')[0])
+        if RUBY_VERSION.split('.').join[0,2] > "18"
+          ls.last << format("%s%2.2x",' '*ns,l[-1].unpack('C')[0])
+        else
+          ls.last << format("%s%2.2x",' '*ns,l[-1])
+        end
     end
     ls
   end

data/bgp/message.rb

@@ -419,8 +419,12 @@ module BGP
 
 
   class Update < Message
+    def as4byte?
+      @as4byte ||= false
+    end
     def initialize(*args)
       if args[0].is_a?(String) and args[0].is_packed?
+        @as4byte=false
         parse(*args)
       elsif args[0].is_a?(self.class)
         parse(args[0].encode, *args[1..-1])
@@ -454,7 +458,8 @@ module BGP
       @path_attribute=val if val.is_a?(Path_attribute)
     end
     
-    def encode(as4byte=false)
+    #TODO refactor out passing an argument to encode...
+    def encode(as4byte=@as4byte)
       withdrawn, path_attribute, nlri = '', '', ''
       withdrawn = @withdrawn.encode(false) if defined? @withdrawn and @withdrawn
       path_attribute = @path_attribute.encode(as4byte) if defined?(@path_attribute) and @path_attribute
@@ -468,7 +473,9 @@ module BGP
     
     attr_reader :path_attribute, :nlri, :withdrawn
     
+    # CHANGED ME: NO DEFAULT HERE, the factory calling us has to tell what it is giving us.
     def parse(s, as4byte=false)
+      @as4byte=as4byte
       update = super(s)
       len = update.slice!(0,2).unpack('n')[0]
       self.withdrawn=Withdrawn.new(update.slice!(0,len).is_packed) if len>0
@@ -494,12 +501,13 @@ module BGP
       end
     end
 
-    def to_s(as4byte=false, fmt=:tcpdump)
-      if as4byte
-        msg = self.encode(true)
-      else
-        msg = self.encode
-      end
+    def to_s(as4byte=@as4byte, fmt=:tcpdump)
+      msg = encode(as4byte)
+      # if as4byte
+      #   msg = self.encode(true)
+      # else
+      #   msg = self.encode
+      # end
       s = []
       s << @withdrawn.to_s if defined?(@withdrawn) and @withdrawn
       s << @path_attribute.to_s(fmt, as4byte) if defined?(@path_attribute) and @path_attribute
@@ -886,6 +894,10 @@ module BGP
       {:code=> @code, :subcode=> @subcode, :data=>@data}
     end
 
+    def to_string
+      Notification.code_to_s(@code, @subcode)
+    end
+
     def to_s
       msg = self.encode
       s = "Notification (#{MESSAGE::NOTIFICATION}), length: #{msg.size}: "

data/bgp/neighbor.rb

@@ -28,6 +28,14 @@ module BGP
 
   class Neighbor
     include Observable
+    
+    def log_info(txt)
+      Log.info "#{self.class} #{txt}"
+    end
+
+    def log_debug(txt)
+      Log.debug "#{self.class} #{txt}"
+    end
 
     def initialize(*args)
       @opt_parms = []
@@ -49,19 +57,30 @@ module BGP
       event_dispatch
     end
     
-    #  neighbor.capability :as4_byte
-    #  neighbor.capability :route_refresh
+    [:Idle, :Established, :OpenRecv, :OpenConfirm, :Active, :OpenSent].each do |state|
+      define_method("is_#{state.to_s.downcase}?") do
+        @state == state
+      end
+    end
+    
+    #  neighbor.capability :as4_byte | :as4 | :as4byte
+    #  neighbor.capability :route_refresh, :rr
     #  neighbor.capability :route_refresh, 128
     #  neighbor.capability :mbgp, :ipv4, :unicast
     #  neighbor.capability :mbgp, :ipv4, :multicast
     def capability(*args)
       @opt_parms << if args[0].is_a?(Symbol)
         case args[0]
-        when :route_refresh ; Route_refresh_cap.new(*args[1..-1])
-        when :mbgp          ; Mbgp_cap.new(*args[1..-1])
-        when :as4_byte      ; As4_cap.new(@my_as)
+        when :route_refresh, :rr
+          Route_refresh_cap.new(*args[1..-1])
+        when :mbgp
+          Mbgp_cap.new(*args[1..-1])
+        when :as4_byte, :as4byte, :as4
+          As4_cap.new(@my_as)
+        else
+          raise ArgumentError, "Invalid argument #{args.inspect}", caller
         end        
-      elsif args[0].is_a?(Capability) and args.size==1
+      elsif args[0].is_a?(Capability)
         args[0]
       else
         raise ArgumentError, "Invalid argument"
@@ -69,7 +88,7 @@ module BGP
     end
 
     def state
-      @state.to_s
+      "#{@state}"
     end
 
     def retry_thread(action=:start)
@@ -96,10 +115,9 @@ module BGP
           ev, type, m = eventQ.deq
           case ev
           when :ev_msg
-            msg = BGP::Message.factory(m)
-            Log.info "Recv#{msg.class.to_s.split('::')[-1]}"
-            Log.debug "Recv #{msg}\n"            
-            changed and notify_observers(msg)
+            msg = BGP::Message.factory(m, @as4byte)
+            log_info "Recv#{msg.class.to_s.split('::').last}"
+            log_debug "Recv #{msg}\n"
             if msg.is_a?(Update)
               rcv_update(msg)
             elsif msg.is_a?(Notification)
@@ -115,6 +133,7 @@ module BGP
             else
               Log.error "unexpected message type #{type}"
             end
+            changed and notify_observers(msg)
           when :ev_conn_reset
             Log.warn "#{type}"
             disable
@@ -131,23 +150,28 @@ module BGP
     def clean
       @threads.list.each { |x| 
         x.exit; x.join
-        Log.info "#{x['name']}: stopped at #{Time.now.strftime("%I:%M:%S%P")}"
+        log_info "#{x['name']}: stopped at #{Time.now.strftime("%I:%M:%S%P")}"
       }
     end
-
-
-    def _open_msg_
-      @open = BGP::Open.new(@version, @my_as, @holdtime, @id, *@opt_parms)
+    
+    def open
+      @open ||= BGP::Open.new(version, @my_as, holdtime, @id, *@opt_parms)
     end
-    private :_open_msg_
-
+    
+    def version
+      @version ||= 4
+    end
+    
+    def holdtime
+      @holdtime ||= 180
+    end
+    
     def enable(auto_retry=:no_auto_retry, wait= :wait)
       return if @state == :Established
       disable unless @state == :Idle
       
       init_socket
       init_io
-      @open = _open_msg_
             
       [@in, @out].each { |io| 
         io.start 
@@ -166,7 +190,7 @@ module BGP
           sleep(0.3)
           break if @state == :Established
         end
-        Log.info "#{self} started"
+        log_info "#{self} started"
       end
       
     rescue => e
@@ -183,10 +207,11 @@ module BGP
     alias stop disable
 
     def send_message(m)
+      raise if m.nil?
       return unless @out
       unless m.is_a?(String)
-        Log.info "Send#{m.class.to_s.split('::')[-1]}"
-        Log.debug "Send #{m.is_a?(Update) ? m.to_s(@as4byte) : m }\n"
+        log_info "Send#{m.class.to_s.split('::')[-1]}"
+        log_debug "Send #{m.is_a?(Update) ? m.to_s(@as4byte) : m }\n"
       end
       if m.is_a?(Update)
         @out.enq m.encode(@as4byte)
@@ -216,21 +241,16 @@ module BGP
     end
     
     def new_state(state, txt='')
-      Log.info "#{txt} old state #{@state} new state #{state}"
+      log_info "#{txt} old state #{@state} new state #{state}"
       @state = state
     end
 
-    def _send_open_(open)
-      send_message open
-    end
-    private :_send_open_
-
     def send_open(ev)
       case @state
       when :OpenRecv
-        _send_open_ @open ; new_state :OpenConfirm, ev
+        send_message open  ; new_state :OpenConfirm, ev
       when :Active
-        _send_open_ @open     ; new_state :OpenSent, ev
+        send_message open  ; new_state :OpenSent, ev
       else
         Log.warn "#{self.class}: attempt to send OPEN msg while in #{@state}"
       end    
@@ -255,14 +275,13 @@ module BGP
       else
         Log.warn "#{self.class}: received open message while in state #{@state}"
       end
-      
-      @as4byte = (@open.has?(As4_cap) and o.has?(As4_cap))
+      @as4byte = (open.has?(As4_cap) && o.has?(As4_cap))
     end
     
     def rcv_keepalive
       if @state == :OpenConfirm
         send_message(BGP::Keepalive.new)
-        Log.debug "SendKeepAlive"
+        log_debug "SendKeepAlive state is #{@state}"
         new_state(:Established, 'RecvKeepAlive')
         @keepalive_thread = Thread.new(@holdtime/3) do |h|
           Thread.current['name'] = "BGP Keepalive interval:(#{h})"
@@ -276,10 +295,16 @@ module BGP
     end
 
     def rcv_notification(m)
-      Log.info "#{m}"
+      log_info "#{m}"
       disable
     end
     
+    def rcv_route_refresh(m)
+    end
+
+    def rcv_update(m)
+    end
+    
     def to_s
       "version: #{@version}, id: #{@id}, as: #{@my_as}, holdtime: #{@holdtime}, peer addr: #{@remote_addr}, local addr: #{@local_addr}"
     end

data/bgp/path_attribute.rb

@@ -32,7 +32,7 @@ module BGP
         s = args[0]
         @attributes=[]
         while s.size>0
-          @attributes << Attr.factory(s)
+          @attributes << Attr.factory(*args)
         end
       else
         add(*args)
@@ -160,13 +160,13 @@ module BGP
 
   class Attr
     include BGP::ATTR
-    def self.factory(s)
+    def self.factory(s, as4byte=false)
       flags, type = s.unpack('CC')
       case type
       when ORIGIN
         Origin.new(s)
       when AS_PATH
-        As_path.new(s)
+        As_path.new(s,as4byte)
       when NEXT_HOP
         Next_hop.new(s)
       when MULTI_EXIT_DISC

data/bgp/version.rb

@@ -0,0 +1,3 @@
+module BGP
+  VERSION = '0.0.6'
+end

data/bgp4r.gemspec

@@ -1,12 +1,15 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{bgp4r}
-  s.version = "0.0.5"
+  s.version = "0.0.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jean-Michel Esnault"]
-  s.date = %q{2010-08-14}
+  s.date = %q{2010-09-12}
   s.description = %q{BGP4R is a BGP-4 ruby library to create,  send, and receive  BGP messages in an  object oriented manner}
   s.email = %q{jesnault@gmail.com}
   s.extra_rdoc_files = [
@@ -43,11 +46,14 @@ Gem::Specification.new do |s|
      "bgp/path_attribute.rb",
      "bgp/prefix_orf.rb",
      "bgp/rd.rb",
+     "bgp/version.rb",
      "bgp4r.gemspec",
      "bgp4r.rb",
-     "examples/bgp",
      "examples/routegen",
      "examples/routegen.yml",
+     "examples/simple.rb",
+     "examples/unit-testing/malformed_update.rb",
+     "examples/unit-testing/prepend_aspath.rb",
      "test/aggregator_test.rb",
      "test/as_path_test.rb",
      "test/atomic_aggregate_test.rb",
@@ -76,7 +82,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["."]
   s.required_ruby_version = Gem::Requirement.new(">= 1.8.6")
   s.rubyforge_project = %q{bgp4r}
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{A BGP-4 Ruby Library}
   s.test_files = [
     "test/aggregator_test.rb",
@@ -106,9 +112,11 @@ Gem::Specification.new do |s|
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
+
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
     else
     end
   else
   end
 end
+

data/bgp4r.rb

@@ -24,3 +24,4 @@ require 'bgp/common'
 require 'bgp/io'
 require 'bgp/neighbor'
 require 'bgp/message'
+require 'bgp/version'

data/examples/routegen.yml

@@ -5,16 +5,16 @@ neighbor:
   router id: 1.1.1.1
   my as: 100
   holdtime: 180
-  local address: 192.168.1.6
-  neighbor address: 192.168.1.199
+  local address: 199.0.0.5
+  neighbor address: 199.0.0.6
   capabilities: 
   - four byte as
 routes: 
   nlris: 11.0.0.0/28, 1999, 127
-  next hop: 192.168.1.6
+  next hop: 199.0.0.5
   local pref: 100
   med: 100
-  origin: 1
+  origin: 0
   communities: 100:1 200:1 300:1
   as path: 200 300 400 500
 

data/examples/unit-testing/malformed_update.rb

@@ -0,0 +1,81 @@
+
+require "test/unit"
+require 'bgp4r'
+require 'timeout'
+
+Thread.abort_on_exception=true
+
+class TestBgp < Test::Unit::TestCase
+  
+  include BGP
+
+  # Log.create
+  # Log.level=Logger::DEBUG
+  
+  N100 = Class.new(BGP::Neighbor)
+
+  class RecvMsgHandler
+    def initialize(q)
+      @q = q
+    end
+    def update(bgp_msg)
+      @q.enq bgp_msg
+    end
+  end
+  
+  def setup
+    @n100 = N100.new(:my_as=> 100, :remote_addr => '40.0.0.2', :local_addr => '40.0.0.1', :id=> '13.11.19.59')
+    start_peering
+  end
+  
+  def test_verify_missing_well_known_attribute_is_greeting_with_a_notification_from_as200
+    assert @n100.is_established?, "Expected to be in Established state. <> #{@n100.state}"
+    queue = Queue.new
+    @n100.add_observer RecvMsgHandler.new(queue)
+    @n100.send_message malformed_update
+    msg = recv(queue)
+    assert msg, "Did not receive expected BGP update message."
+    assert_instance_of(Notification, msg)
+    assert_equal 'Missing Well-known Attribute', msg.to_string
+    assert @n100.is_idle?
+  end
+  
+  def teardown
+    @n100.stop
+    sleep(0.5)
+  end
+  
+  private
+  
+  def start_peering
+    @n100.capability :as4_byte
+    @n100.start 
+  end
+  
+  def recv(q, timeout=5)
+    begin
+       Timeout::timeout(timeout) do |t| 
+         msg = q.deq
+       end
+     rescue Timeout::Error => e
+       nil
+     end
+  end
+    
+  def malformed_update
+     update = Update.new(
+       Path_attribute.new(
+         Origin.new(0),
+         Multi_exit_disc.new(100),
+         Local_pref.new(100),
+         As_path.new(100),
+       ),
+       Nlri.new('77.0.0.0/17', '78.0.0.0/18', '79.0.0.0/19')
+     )
+   end
+  
+  def send_update_to(n)
+    n.send_message update1
+  end
+  
+end

data/examples/unit-testing/prepend_aspath.rb

@@ -0,0 +1,87 @@
+require "test/unit"
+require 'bgp4r'
+require 'timeout'
+
+Thread.abort_on_exception=true
+
+class TestBgp < Test::Unit::TestCase
+  
+  include BGP
+
+  Log.create
+  Log.level=Logger::DEBUG
+  
+  N100 = Class.new(BGP::Neighbor)
+  N300 = Class.new(BGP::Neighbor)
+
+  class RecvMsgHandler
+    def initialize(q)
+      @q = q
+    end
+    def update(bgp_msg)
+      @q.enq bgp_msg
+    end
+  end
+  
+  def setup
+    @n100 = N100.new(:my_as=> 100, :remote_addr => '40.0.0.2', :local_addr => '40.0.0.1', :id=> '13.11.19.59')
+    @n300 = N300.new(:my_as=> 300, :remote_addr => '40.0.1.1', :local_addr => '40.0.1.2', :id=> '13.11.19.57')
+    start_peering
+  end
+  
+  def test_verify_that_200_is_prepended_to_aspath
+    assert @n100.is_established?, "Expected to be in Established state. <> #{@n100.state}"
+    assert @n300.is_established?, "Expected to be in Established state. <> #{@n300.state}"
+    queue = Queue.new
+    @n300.add_observer RecvMsgHandler.new(queue)
+    send_update_to @n100
+    msg = recv(queue)
+    assert msg, "Did not receive expected BGP update message."
+    assert msg.path_attribute.has?(As_path)
+    assert_not_nil msg.path_attribute[:as_path]
+    assert_equal '200 100', msg.path_attribute[:as_path].as_path
+  end
+
+  def teardown
+    [@n100, @n300].each { |n| n.stop }
+    sleep(0.5)
+  end
+  
+  private
+  
+  def start_peering
+    [@n100, @n300].each { |n| 
+      n.capability :as4_byte
+      n.start 
+    }
+  end
+  
+  def recv(q, timeout=5)
+    begin
+       Timeout::timeout(timeout) do |t| 
+         msg = q.deq
+       end
+     rescue Timeout::Error => e
+       nil
+     end
+  end
+  
+  def update1
+    update = Update.new(
+      Path_attribute.new(
+        Origin.new(0),
+        Next_hop.new('40.0.0.1'),
+        Multi_exit_disc.new(100),
+        Local_pref.new(100),
+        As_path.new(100),
+        Communities.new('1311:1 311:59 2805:64')
+      ),
+      Nlri.new('77.0.0.0/17', '78.0.0.0/18', '79.0.0.0/19')
+    )
+  end
+
+  def send_update_to(n)
+    n.send_message update1
+  end
+  
+end

data/test/message_test.rb

@@ -125,6 +125,14 @@ class Update_Test < Test::Unit::TestCase
     an_update << Nlri.new('21.0.0.0/11', '22.0.0.0/22')
     assert_equal 4, an_update.nlri.size
   end
+  
+  def test_6
+    s = 'ffffffffffffffffffffffffffffffff004a02000000274001010040020a0202000000c80000006440030428000101c0080c0137003b051f00010af50040114d0000124e0000134f0000'
+    m = Message.factory([s].pack('H*'), true)
+    assert_not_nil m
+    assert_instance_of(Update, m)
+    assert m.as4byte?
+  end
 
 end
 

data/test/neighbor_test.rb

@@ -40,11 +40,24 @@ class TestBgpNeighbor < Test::Unit::TestCase
     neighbor.capability Route_refresh_cap.new
     neighbor.capability Route_refresh_cap.new 128
     neighbor.capability As4_cap.new(100)
-    open_msg = neighbor.instance_eval { _open_msg_ }
+    open_msg = neighbor.open
     assert_equal(5,open_msg.opt_parms.size)
     assert_equal(4,open_msg.version)
     assert_equal(20,open_msg.holdtime)
     assert_equal(100,open_msg.local_as)
     # puts neighbor
   end
+  def test_states
+    neighbor = Neighbor.new \
+      :version=> 4, 
+      :my_as=> 100, 
+      :remote_addr => '192.168.1.200', 
+      :local_addr => '192.168.1.5', 
+      :id=> '1.1.1.1', 
+      :holdtime=> 20
+      assert neighbor.is_idle?
+      assert ! neighbor.is_established?
+      assert ! neighbor.is_openrecv?
+      assert ! neighbor.is_openconfirm?  
+  end
 end

data/test/path_attribute_test.rb

@@ -124,4 +124,15 @@ class Path_attribute_Test < Test::Unit::TestCase # :nodoc:
     
   end
   
+  def test_4
+    s =   '4001010040020a0202000000c80000006440030428000101c0080c0137003b051f00010af50040'
+    sbin = [s].pack('H*')
+    assert_instance_of(Origin, attr = Attr.factory(sbin))
+    assert_instance_of(As_path, attr = Attr.factory(sbin,true))
+    assert_equal '200 100', attr.as_path
+    assert_instance_of(Next_hop, Attr.factory(sbin,true))
+    assert_instance_of(Communities, Attr.factory(sbin,true))
+    assert_equal 0, sbin.size
+  end
+  
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Jean-Michel Esnault
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-14 00:00:00 -07:00
+date: 2010-09-12 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -57,11 +57,14 @@ files:
 - bgp/path_attribute.rb
 - bgp/prefix_orf.rb
 - bgp/rd.rb
+- bgp/version.rb
 - bgp4r.gemspec
 - bgp4r.rb
-- examples/bgp
 - examples/routegen
 - examples/routegen.yml
+- examples/simple.rb
+- examples/unit-testing/malformed_update.rb
+- examples/unit-testing/prepend_aspath.rb
 - test/aggregator_test.rb
 - test/as_path_test.rb
 - test/atomic_aggregate_test.rb
@@ -97,7 +100,6 @@ rdoc_options:
 require_paths: 
 - .
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -107,7 +109,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 6
       version: 1.8.6
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -117,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: bgp4r
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A BGP-4 Ruby Library