trema 0.2.5 → 0.2.6

data/ruby/trema/switch.c

@@ -83,7 +83,7 @@ handle_flow_mod(
   uint16_t flags,
   const openflow_actions *actions,
   void *rbswitch
-){
+) {
   UNUSED( match );
   UNUSED( cookie );
   UNUSED( priority );

data/ruby/trema/table-stats-reply.rb

@@ -35,7 +35,7 @@ module Trema
     #
     # @overload initialize(options={})
     #
-    #   @example 
+    #   @example
     #     TableStatsReply.new(
     #       :table_id => 0,
     #       :name => "classifier",

data/ruby/trema/timers.rb

@@ -28,8 +28,8 @@ module Timers
   module TimerMethods
     lambda {
       timer_event_handlers = {}
-      
-      
+
+
       Kernel.send :define_method, :add_timer do | handler, interval, event_type |
         timer_event_handlers[ handler ] = {
           :interval => interval,
@@ -37,8 +37,8 @@ module Timers
           :event_type => event_type
         }
       end
-      
-      
+
+
       Kernel.send :define_method, :fire_event do
         timer_event_handlers.each do | handler, data |
           data[ :rest ] -= 1
@@ -51,38 +51,38 @@ module Timers
           data[ :rest ] <= 0 && data[ :event_type ] == :oneshot
         end
       end
-      
-      
+
+
       Kernel.send :define_method, :delete_timer do | handler |
         timer_event_handlers.delete
       end
     }.call
 
-    
+
     def add_timer_event handler, interval, event_type
       add_timer handler, interval, event_type
     end
     alias_method :timer_event, :add_timer_event
 
-  
+
     def delete_timer_event handler
-      delete_timer handler 
+      delete_timer handler
     end
 
-  
+
     # shortcut methods
     def add_periodic_timer_event handler, interval
       add_timer_event handler, interval, :periodic
     end
     alias_method :periodic_timer_event, :add_periodic_timer_event
 
-  
+
     def add_oneshot_timer_event handler, interval
       add_timer_event handler, interval, :oneshot
     end
     alias_method :oneshot_timer_event, :add_oneshot_timer_event
-  
-  
+
+
     def handle_timer_event
       fire_event
     end

data/ruby/trema/trema.c

@@ -58,7 +58,7 @@ Init_trema() {
   rb_define_const( mTrema, "OFPC_FLOW_STATS", INT2NUM( OFPC_FLOW_STATS ) );
   rb_define_const( mTrema, "OFPC_TABLE_STATS", INT2NUM( OFPC_TABLE_STATS ) );
   rb_define_const( mTrema, "OFPC_PORT_STATS", INT2NUM( OFPC_PORT_STATS ) );
-  rb_define_const( mTrema, "OFPC_STP", INT2NUM( OFPC_STP) );
+  rb_define_const( mTrema, "OFPC_STP", INT2NUM( OFPC_STP ) );
   rb_define_const( mTrema, "OFPC_RESERVED", INT2NUM( OFPC_RESERVED ) );
   rb_define_const( mTrema, "OFPC_IP_REASM", INT2NUM( OFPC_IP_REASM ) );
   rb_define_const( mTrema, "OFPC_QUEUE_STATS", INT2NUM( OFPC_QUEUE_STATS ) );
@@ -68,8 +68,8 @@ Init_trema() {
   rb_define_const( mTrema, "OFPAT_SET_VLAN_VID", INT2NUM( OFPAT_SET_VLAN_VID ) );
   rb_define_const( mTrema, "OFPAT_SET_VLAN_PCP", INT2NUM( OFPAT_SET_VLAN_PCP ) );
   rb_define_const( mTrema, "OFPAT_STRIP_VLAN", INT2NUM( OFPAT_STRIP_VLAN ) );
-  rb_define_const( mTrema, "OFPAT_SET_DL_SRC", INT2NUM( OFPAT_SET_DL_SRC) );
-  rb_define_const( mTrema, "OFPAT_SET_DL_DST", INT2NUM( OFPAT_SET_DL_DST) );
+  rb_define_const( mTrema, "OFPAT_SET_DL_SRC", INT2NUM( OFPAT_SET_DL_SRC ) );
+  rb_define_const( mTrema, "OFPAT_SET_DL_DST", INT2NUM( OFPAT_SET_DL_DST ) );
   rb_define_const( mTrema, "OFPAT_SET_NW_SRC", INT2NUM( OFPAT_SET_NW_SRC ) );
   rb_define_const( mTrema, "OFPAT_SET_NW_DST", INT2NUM( OFPAT_SET_NW_DST ) );
   rb_define_const( mTrema, "OFPAT_SET_NW_TOS", INT2NUM( OFPAT_SET_NW_TOS ) );

data/ruby/trema/tremashark.rb

@@ -1,8 +1,6 @@
 #
 # The controller class of tremashark.
 #
-# Author: Yasuhito Takamiya <yasuhito@gmail.com>
-#
 # Copyright (C) 2008-2012 NEC Corporation
 #
 # This program is free software; you can redistribute it and/or modify
@@ -24,7 +22,16 @@ require "trema/executables"
 
 
 module Trema
+  #
+  # Represents an abstract instance to start the tremashark debugging program.
+  #
   class Tremashark
+    #
+    # Runs the tremashark program as a daemon for debugging.
+    #
+    # @return [Boolean, Nil]
+    #   a true or false tremashark exit status code or nil if failed to run.
+    #
     def run
       sh "#{ Executables.tremashark } --daemonize"
     end

data/ruby/trema/util.rb

@@ -1,8 +1,6 @@
 #
 # Common utility functions.
 #
-# Author: Yasuhito Takamiya <yasuhito@gmail.com>
-#
 # Copyright (C) 2008-2012 NEC Corporation
 #
 # This program is free software; you can redistribute it and/or modify
@@ -27,7 +25,16 @@ require "trema/process"
 
 
 module Trema::Util
-  def sanity_check
+  def sh cmd
+    ENV[ "TREMA_HOME" ] = Trema.home
+    puts cmd if $verbose
+    unless system( cmd )
+      raise "Command '#{ cmd }' failed!"
+    end
+  end
+
+
+  def assert_trema_is_built
     unless Trema::Executables.compiled?
       $stderr.puts <<-EOF
 ERROR: Trema is not compiled yet!
@@ -40,15 +47,6 @@ EOF
   end
 
 
-  def sh cmd
-    ENV[ "TREMA_HOME" ] = Trema.home
-    puts cmd if $verbose
-    unless system( cmd )
-      raise "Command '#{ cmd }' failed!"
-    end
-  end
-
-
   def cleanup session
     # [FIXME] Use session.switch_manager
     sm_pid = File.join( Trema.pid, "switch_manager.pid" )
@@ -67,17 +65,43 @@ EOF
     session.links.each do | name, link |
       link.delete!
     end
+    session.netnss.each do | name, netns |
+      netns.shutdown!
+    end
 
     Dir.glob( File.join Trema.pid, "*.pid" ).each do | each |
       Trema::Process.read( each ).kill!
     end
-
-    FileUtils.rm_f Trema::DSL::Context::PATH
   end
 
 
   def cleanup_current_session
-    cleanup Trema::DSL::Context.load_current
+    begin
+      cleanup Trema::DSL::Context.load_current
+    ensure
+      FileUtils.rm_f Trema::DSL::Context::PATH
+    end
+  end
+
+
+  def find_app_by_name name
+    # [FIXME] Trema apps does not appear in context.apps. why?
+    pid_file = File.join( Trema.pid, "#{ name }.pid" )
+    if FileTest.exist?( pid_file )
+      Trema::Process.read( pid_file )
+    else
+      nil
+    end
+  end
+
+
+  def find_switch_by_name name
+    Trema::DSL::Context.load_current.switches[ name ]
+  end
+
+
+  def find_host_by_name name
+    Trema::DSL::Context.load_current.hosts[ name ]
   end
 end
 

data/ruby/trema/vendor-action.rb

@@ -25,7 +25,12 @@ module Trema
   # An action to set vendor specific extensions.
   #
   class VendorAction < Action
+    #
+    # @return [Array<Fixnum>] the value of attribute {#body} that represents
+    #   binary data as an array of bytes.
+    #
     attr_reader :body
+    # @return [Integer] the value of attribute {#vendor_id}
     attr_reader :vendor_id
 
 
@@ -46,16 +51,16 @@ module Trema
     # @raise [TypeError] if body is not an Array.
     #
     def initialize vendor_id, body = nil
-      if not vendor_id.is_a?( Integer )
+      unless vendor_id.is_a?( Integer )
         raise TypeError, "Vendor ID must be an unsigned 32-bit integer"
       end
-      if not vendor_id.unsigned_32bit?
+      unless vendor_id.unsigned_32bit?
         raise ArgumentError, "Vendor ID must be an unsigned 32-bit integer"
       end
       if ( not body.nil? )  and ( not body.is_a?( Array ) )
         raise TypeError, "Body must be an Array"
       end
-        
+
       @vendor_id = vendor_id
       @body = body
     end

data/ruby/trema/vendor-stats-reply.rb

@@ -1,6 +1,4 @@
 #
-# Author: Nick Karanatsios <nickkaranatsios@gmail.com>
-#
 # Copyright (C) 2008-2012 NEC Corporation
 #
 # This program is free software; you can redistribute it and/or modify
@@ -26,7 +24,7 @@ module Trema
     FIELDS = %w(vendor_id)
     FIELDS.each { |field| attr_reader field.intern }
 
-    
+
     # Vendor statistics reply.
     # A user would not explicitly instantiate a {VendorStatsReply} object but would
     # be created as a result of parsing the +OFPT_STATS_REPLY(OFPST_VENDOR)+
@@ -34,7 +32,7 @@ module Trema
     #
     # @overload initialize(otions={})
     #
-    #   @example 
+    #   @example
     #     VendorStatsReply.new(
     #       :vendor_id => 123
     #     )
@@ -45,8 +43,8 @@ module Trema
     #   @option options [Number] :vendor_id
     #     the specific vendor identifier.
     #
-    #   @return [VendorStatsReply] 
-    #     an object that encapsulates the OFPST_STATS_REPLY(OPPST_VENDOR) OpenFlow message.
+    #   @return [VendorStatsReply]
+    #     an object that encapsulates the OFPST_STATS_REPLY(OFPST_VENDOR) OpenFlow message.
     #
     def initialize options
       super FIELDS, options

data/ruby/trema/vendor.c

@@ -33,7 +33,7 @@ vendor_alloc( VALUE klass ) {
 
 
 /*
- * Creates a Vendor Reqeust message. This message can be used
+ * Creates a Vendor Request message. This message can be used
  * to facilitate sending of vendor-defined arbitrary data.
  *
  * @overload initialize

data/ruby/trema/version.rb

@@ -17,7 +17,7 @@
 
 
 module Trema
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end
 
 

data/spec/trema/barrier-request_spec.rb

@@ -20,56 +20,66 @@ require File.join( File.dirname( __FILE__ ), "..", "spec_helper" )
 require "trema"
 
 
-describe BarrierRequest, ".new( OPTIONAL OPTION MISSING )" do
-  it_should_behave_like "any Openflow message with default transaction ID"
+shared_examples_for "barrier request message" do
+  class BarrierRequestController < Controller; end
+
+  it "should be logged to the switch's log", :sudo => true do
+    network {
+      vswitch( "barrier-request" ) { datapath_id 0xabc }
+    }.run( BarrierRequestController ) {
+      controller( "BarrierRequestController" ).send_message( 0xabc, subject )
+      IO.read( File.join( Trema.log, "openflowd.barrier-request.log" ) ).should include( "OFPT_BARRIER_REQUEST" )
+    }
+  end
 end
 
 
-describe BarrierRequest, ".new( VALID OPTION )" do
-  subject { BarrierRequest.new :transaction_id => transaction_id }
-  it_should_behave_like "any OpenFlow message with transaction_id option"
+module Trema
+  describe BarrierRequest, ".new" do
+    it_should_behave_like "any Openflow message with default transaction ID"
+    it_should_behave_like "barrier request message"
+  end
+
+
+  describe BarrierRequest, ".new(nil)" do
+    subject { BarrierRequest.new( nil ) }
+    it_should_behave_like "any Openflow message with default transaction ID"
+    it_should_behave_like "barrier request message"
+  end
+
+
+  describe BarrierRequest, ".new(transaction_id)" do
+    subject { BarrierRequest.new( transaction_id ) }
+    it_should_behave_like "any Openflow message with transaction ID"
+    context "when sent to a switch" do
+      let( :transaction_id ) { 123 }
+      it_should_behave_like "barrier request message"
+    end
+  end
 
 
-  context "when #barrier_request" do
-    it "should #barrier_reply" do
-      class BarrierController < Controller; end
-      network {
-        vswitch { datapath_id 0xabc }
-      }.run( BarrierController ) {
-        controller( "BarrierController" ).should_receive( :barrier_reply )
-        controller( "BarrierController" ).send_message( 0xabc, BarrierRequest.new )
-        sleep 2 # FIXME: wait to send_message
-      }
+  describe BarrierRequest, ".new(:transaction_id => value)" do
+    subject { BarrierRequest.new( :transaction_id => transaction_id ) }
+    it_should_behave_like "any Openflow message with transaction ID"
+    context "when sent to a switch" do
+      let( :transaction_id ) { 123 }
+      it_should_behave_like "barrier request message"
     end
   end
-end
 
 
-describe BarrierRequest, ".new( OPTIONAL OPTION ) - transaction_id" do
-  context "when #barrier_request" do
-    it "should #barrier_reply with transaction_id == value" do
-      class BarrierController < Controller; end
-      network {
-        vswitch { datapath_id 0xabc }
-      }.run( BarrierController ) {
-        controller( "BarrierController" ).should_receive( :barrier_reply ) do | datapath_id, message |
-          datapath_id.should == 0xabc
-          message.transaction_id.should == 1234
-        end
-        barrier_request = BarrierRequest.new( :transaction_id => 1234 )
-        controller( "BarrierController" ).send_message( 0xabc, barrier_request )
-        sleep 2 # FIXME: wait to send_message
-      }
+  describe BarrierRequest, ".new(:xid => value)" do
+    subject { BarrierRequest.new( :xid => xid ) }
+    it_should_behave_like "any Openflow message with xid"
+    context "when sent to a switch" do
+      let( :xid ) { 123 }
+      it_should_behave_like "barrier request message"
     end
   end
-end
 
 
-describe BarrierRequest, ".new( INVALID_OPTION )" do
-  it "should raise TypeError" do
-    expect {
-      BarrierRequest.new "INVALID_OPTION"
-    }.to raise_error( TypeError )
+  describe BarrierRequest, '.new("INVALID OPTION")', :nosudo => true do
+    it { expect { BarrierRequest.new "INVALID OPTION" }.to raise_error( TypeError ) }
   end
 end
 

data/spec/trema/controller_spec.rb

@@ -57,6 +57,7 @@ module Trema
           vswitch { datapath_id 0xabc }
         }.run( FlowModAddController ) {
           controller( "FlowModAddController" ).send_flow_mod_add( 0xabc )
+          sleep 6 # FIXME: wait to send_flow_mod_add
           vswitch( "0xabc" ).should have( 1 ).flows
         }
       end

data/spec/trema/dsl/runner_spec.rb

@@ -1,6 +1,4 @@
 #
-# Author: Yasuhito Takamiya <yasuhito@gmail.com>
-#
 # Copyright (C) 2008-2012 NEC Corporation
 #
 # This program is free software; you can redistribute it and/or modify
@@ -47,7 +45,8 @@ module Trema
             :links => {},
             :hosts => {},
             :switches => {},
-            :apps => {}
+            :apps => {},
+            :netnss => {}
           )
 
           Runner.new( context ).run
@@ -67,6 +66,7 @@ module Trema
             :hosts => {},
             :switches => {},
             :apps => {},
+            :netnss => {},
             :port => 6633
           )
 
@@ -96,6 +96,7 @@ module Trema
             :hosts => {},
             :switches => {},
             :apps => {},
+            :netnss => {},
             :port => 6633
           )
 
@@ -138,6 +139,7 @@ module Trema
             :hosts => { "host0" => host0, "host1" => host1, "host2" => host2 },
             :switches => {},
             :apps => {},
+            :netnss => {},
             :port => 6633
           )
 
@@ -164,6 +166,7 @@ module Trema
             :hosts => {},
             :switches => { "switch0" => switch0, "switch1" => switch1, "switch 2" => switch2 },
             :apps => {},
+            :netnss => {},
             :port => 6633
           )
 
@@ -194,6 +197,7 @@ module Trema
             :links => {},
             :hosts => {},
             :switches => {},
+            :netnss => {},
             :apps => apps
           )
 
@@ -224,6 +228,7 @@ module Trema
             :links => {},
             :hosts => {},
             :switches => {},
+            :netnss => {},
             :apps => apps
           )