trema 0.2.5 → 0.2.6

data/features/trema.show_stats.feature

@@ -1,14 +1,13 @@
-Feature: show network stats with `trema show_stats' command
-
-  As a Trema user
-  I want to get packet stats with `trema show_stats' command
-  So that I can easily debug trema applications
+Feature: trema show_stats command
 
+  In order to get the stats of sent/received packets
+  As a developer using Trema
+  I want to execute "trema show_stats" command
 
   Background:
-    Given I try trema run "learning_switch" example with following configuration (backgrounded):
+    Given a file named "learning_switch.conf" with:
       """
-      vswitch { datapath_id "0xabc" }
+      vswitch { datapath_id 0xabc }
 
       vhost("host1") { ip "192.168.0.1" }
       vhost("host2") { ip "192.168.0.2" }
@@ -16,11 +15,13 @@ Feature: show network stats with `trema show_stats' command
       link "0xabc", "host1"
       link "0xabc", "host2"
       """
+    And I run `trema run ../../src/examples/learning_switch/learning-switch.rb -c learning_switch.conf -d`
 
-
-  Scenario: show_stats
-    When I send 1 packet from host1 to host2
-    Then the stats of "host1" should be:
+  @slow_process
+  Scenario: show_stats hostname
+    When I run `trema send_packets --source host1 --dest host2`
+     And I run `trema show_stats host1`
+    Then the output should contain:
       """
       Sent packets:
       ip_dst,tp_dst,ip_src,tp_src,n_pkts,n_octets
@@ -28,40 +29,36 @@ Feature: show network stats with `trema show_stats' command
       Received packets:
       """
 
-
-  Scenario: show_stats --tx
-    When I send 1 packet from host1 to host2
-    Then the tx stats of "host1" should be:
+  @slow_process
+  Scenario: show_stats hostname --tx
+    When I run `trema send_packets --source host1 --dest host2`
+     And I run `trema show_stats host1 --tx`
+    Then the output should contain:
       """
       ip_dst,tp_dst,ip_src,tp_src,n_pkts,n_octets
       192.168.0.2,1,192.168.0.1,1,1,50
       """
 
-
-  Scenario: show_stats --rx
-    When I send 1 packet from host1 to host2
-    Then the rx stats of "host2" should be:
+  @slow_process
+  Scenario: show_stats hostname --rx
+    When I run `trema send_packets --source host1 --dest host2`
+     And I run `trema show_stats host2 --rx`
+    Then the output should contain:
       """
       ip_dst,tp_dst,ip_src,tp_src,n_pkts,n_octets
       192.168.0.2,1,192.168.0.1,1,1,50
       """
 
-
-  Scenario: show_stats error
-    Then "./trema show_stats NO_SUCH_HOST" exits abnormally with an error message:
+  Scenario: argument error
+    Then I run `trema show_stats`
+    Then the output should contain:
       """
-      Unknown host: NO_SUCH_HOST
+      host is required
       """
 
-
-  Scenario: trema help show_stats
-    When I try to run "./trema help show_stats"
-    Then the output should be:
+  Scenario: unknown host error
+    Then I run `trema show_stats NO_SUCH_HOST`
+    Then the output should contain:
       """
-      Usage: ./trema show_stats HOSTNAME [OPTIONS ...]
-          -t, --tx
-          -r, --rx
-
-          -h, --help
-          -v, --verbose
+      unknown host: NO_SUCH_HOST
       """

data/features/trema.up.feature

@@ -0,0 +1,33 @@
+Feature: trema up command
+
+  In order to restart killed processes
+  As a developer using Trema
+  I want to execute "trema up" command
+
+  Background:
+    Given a file named "switch_monitor.conf" with:
+      """
+      vswitch { datapath_id 0x1 }
+      vswitch { datapath_id 0x2 }
+      vswitch { datapath_id 0x3 }
+
+      vhost "host1"
+      vhost "host2"
+      vhost "host3"
+
+      link "0x1", "host1"
+      link "0x2", "host2"
+      link "0x3", "host3"
+      """
+    And I successfully run `trema run ../../src/examples/switch_monitor/switch-monitor.rb -c switch_monitor.conf -d`
+    And I run `trema kill 0x1 0x2 0x3`
+    And I run `trema kill host1 host2 host3`
+
+  @slow_process
+  Scenario: up a switch
+    When I run `trema up 0x1`
+    Then the vswitch "0x1" is running
+
+  @wip
+  Scenario: up a host
+

data/features/trema.version.feature

@@ -0,0 +1,9 @@
+Feature: trema version command
+
+  In order to know the current version of Trema
+  As a developer using Trema
+  I want to execute "trema version" command
+
+  Scenario: trema version
+    When I run `trema version`
+    Then the output should match /trema version \d+\.\d+.\d+/

data/ruby/extconf.rb

@@ -72,3 +72,10 @@ end
 
 
 create_makefile "trema", "trema"
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

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

@@ -17,7 +17,7 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 #
 
-  
+
 require "trema/stats-helper"
 
 
@@ -34,14 +34,14 @@ module Trema
     #
     # @overload initialize(options={})
     #
-    #   @example 
+    #   @example
     #     AggregateStatsReply.new(
     #       :packet_count => 10,
     #       :byte_count => 640,
     #       :flow_count => 2
     #     )
     #
-    #   @param [Hash] options 
+    #   @param [Hash] options
     #     the options to create this instance with.
     #
     #   @option options [Number] :packet_count

data/ruby/trema/app.rb

@@ -30,6 +30,10 @@ module Trema
     include Trema::Daemon
 
 
+    #
+    # @return [Trema::DSL::Stanza] a map of key-value pair settings
+    #   for trema's dsl run{} syntax.
+    #
     attr_reader :stanza
 
 
@@ -37,7 +41,7 @@ module Trema
 
 
     #
-    # Creates a new Trema application from {Trema::DSL::App}
+    # Creates a new Trema application from {Trema::DSL::Run}
     #
     # @example
     #   app = Trema::App.new( stanza )

data/ruby/trema/barrier-request.c

@@ -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
@@ -18,8 +16,7 @@
  */
 
 
-#include "trema.h"
-#include "ruby.h"
+#include "trema-ruby-utils.h"
 
 
 extern VALUE mTrema;
@@ -37,42 +34,73 @@ barrier_request_alloc( VALUE klass ) {
  * A barrier request message could be sent to ensure that an operation
  * completed successfully signaled with the reception of a barrier reply message.
  *
- * @overload initialize(options={})
- *   @example 
+ * @overload initialize()
+ *   @example
  *     BarrierRequest.new
- *     BarrierRequest.new( :transaction_id => 123 )
  *
+ * @overload initialize(transaction_id)
+ *   @example
+ *     BarrierRequest.new( 123 )
+ *   @param [Integer] transaction_id
+ *     An unsigned 32-bit integer number associated with this message.
+ *
+ * @overload initialize(options)
+ *   @example
+ *     BarrierRequest.new( :xid => 123 )
+ *     BarrierRequest.new( :transaction_id => 123 )
  *   @param [Hash] options
  *     the options to create a message with.
- *
+ *   @option options [Number] :xid an alias to transaction_id.
  *   @option options [Number] :transaction_id
- *     an unsigned 32-bit integer number associated with this message.
+ *     An unsigned 32-bit integer number associated with this message.
  *     If not specified, an auto-generated value is set.
  *
- *   @raise [ArgumentError] if transaction_id is not an unsigned 32-bit integer.
- *   @raise [TypeError] if options is not a hash.
- *
- *   @return [BarrierRequest]
- *     an object that encapsulates the +OPFT_BARRIER_REQUEST+ OpenFlow message.
+ * @raise [ArgumentError] if transaction ID is not an unsigned 32-bit integer.
+ * @raise [TypeError] if argument is not a Integer or a Hash.
+ * @return [BarrierRequest]
+ *   an object that encapsulates the +OPFT_BARRIER_REQUEST+ OpenFlow message.
  */
 static VALUE
 barrier_request_init( int argc, VALUE *argv, VALUE self ) {
-  buffer *barrier_request;
+  buffer *barrier_request = NULL;
   Data_Get_Struct( self, buffer, barrier_request );
-  uint32_t xid = get_transaction_id();
-  VALUE options;
-
-  if ( rb_scan_args( argc, argv, "01", &options ) == 1 ) {
-    Check_Type( options, T_HASH );
-    VALUE xid_ruby;
-    if ( ( xid_ruby = rb_hash_aref( options, ID2SYM( rb_intern( "transaction_id" ) ) ) ) != Qnil ) {
-      if ( rb_funcall( xid_ruby, rb_intern( "unsigned_32bit?" ), 0 ) == Qfalse ) {
-        rb_raise( rb_eArgError, "Transaction ID must be an unsigned 32-bit integer" );
+  VALUE options = Qnil;
+
+  if ( rb_scan_args( argc, argv, "01", &options ) == 0 ) {
+    set_xid( barrier_request, get_transaction_id() );
+  }
+  else {
+    if ( options == Qnil ) {
+      set_xid( barrier_request, get_transaction_id() );
+    }
+    else if ( rb_obj_is_kind_of( options, rb_cInteger ) == Qtrue ) {
+      validate_xid( options );
+      set_xid( barrier_request, ( uint32_t ) NUM2UINT( options ) );
+    }
+    else {
+      Check_Type( options, T_HASH );
+      VALUE tmp = Qnil;
+      VALUE xid = Qnil;
+
+      tmp = rb_hash_aref( options, ID2SYM( rb_intern( "transaction_id" ) ) );
+      if ( tmp != Qnil ) {
+        xid = tmp;
+      }
+      tmp = rb_hash_aref( options, ID2SYM( rb_intern( "xid" ) ) );
+      if ( tmp != Qnil ) {
+        xid = tmp;
+      }
+
+      if ( xid != Qnil ) {
+        validate_xid( xid );
+        set_xid( barrier_request, ( uint32_t ) NUM2UINT( xid ) );
+      }
+      else {
+        set_xid( barrier_request, get_transaction_id() );
       }
-      xid = ( uint32_t ) NUM2UINT( xid_ruby );
     }
   }
-  ( ( struct ofp_header * ) ( barrier_request->data ) )->xid = htonl( xid );
+
   return self;
 }
 
@@ -84,10 +112,7 @@ barrier_request_init( int argc, VALUE *argv, VALUE self ) {
  */
 static VALUE
 barrier_request_transaction_id( VALUE self ) {
-  buffer *barrier_request;
-  Data_Get_Struct( self, buffer, barrier_request );
-  uint32_t xid = ntohl( ( ( struct ofp_header * ) ( barrier_request->data ) )->xid );
-  return UINT2NUM( xid );
+  return get_xid( self );
 }
 
 

data/ruby/trema/cli.rb

@@ -28,7 +28,7 @@ module Trema
     class Packet
     end
 
-    
+
     attr_reader :ip_dst
     attr_reader :tp_dst
     attr_reader :ip_src
@@ -36,7 +36,7 @@ module Trema
     attr_reader :n_pkts
     attr_reader :n_octets
 
-    
+
     def initialize ip_dst, tp_dst, ip_src, tp_src, n_pkts, n_octets
       @ip_dst = ip_dst
       @tp_dst = tp_dst.to_i
@@ -71,7 +71,7 @@ module Trema
       end
 
       sh( "#{ Executables.cli } -i #{ @host.interface } send_packets " +
-          "--ip_src #{ @host.ip } --ip_dst #{ dest.ip } " + 
+          "--ip_src #{ @host.ip } --ip_dst #{ dest.ip } " +
           send_packets_options( options ) )
     end
 
@@ -84,12 +84,12 @@ module Trema
     def show_rx_stats
       puts stats( :rx )
     end
-    
+
 
     def tx_stats
       stat = stats( :tx ).split( "\n" )[ 1 ]
       if stat
-        Trema::Stats.new *stat.split( "," )        
+        Trema::Stats.new *stat.split( "," )
       else
         nil
       end
@@ -99,7 +99,7 @@ module Trema
     def rx_stats
       stat = stats( :rx ).split( "\n" )[ 1 ]
       if stat
-        Trema::Stats.new *stat.split( "," )        
+        Trema::Stats.new *stat.split( "," )
       else
         Trema::Stats.new nil, nil, nil, nil, 0, 0
       end
@@ -115,7 +115,7 @@ module Trema
     def add_arp_entry other
       sh "sudo #{ Executables.cli } -i #{ @host.interface } add_arp_entry --ip_addr #{ other.ip } --mac_addr #{ other.mac }"
     end
-    
+
 
     def set_ip_and_mac_address
       sh "sudo #{ Executables.cli } -i #{ @host.interface } set_host_addr --ip_addr #{ @host.ip } --ip_mask #{ @host.netmask } --mac_addr #{ @host.mac }"
@@ -125,7 +125,7 @@ module Trema
     def enable_promisc
       sh "sudo #{ Executables.cli } -i #{ @host.interface } enable_promisc"
     end
-    
+
 
     ################################################################################
     private

data/ruby/trema/command.rb

@@ -1,8 +1,6 @@
 #
 # Trema sub-commands.
 #
-# Author: Yasuhito Takamiya <yasuhito@gmail.com>
-#
 # Copyright (C) 2008-2012 NEC Corporation
 #
 # This program is free software; you can redistribute it and/or modify
@@ -23,6 +21,7 @@
 require "trema/command/dump_flows"
 require "trema/command/kill"
 require "trema/command/killall"
+require "trema/command/netns"
 require "trema/command/reset_stats"
 require "trema/command/ruby"
 require "trema/command/run"
@@ -30,7 +29,6 @@ require "trema/command/send_packets"
 require "trema/command/shell"
 require "trema/command/show_stats"
 require "trema/command/up"
-require "trema/command/usage"
 require "trema/command/version"
 
 

data/ruby/trema/command/dump_flows.rb

@@ -1,8 +1,4 @@
 #
-# trema dump_flows command.
-#
-# Author: Yasuhito Takamiya <yasuhito@gmail.com>
-#
 # Copyright (C) 2008-2012 NEC Corporation
 #
 # This program is free software; you can redistribute it and/or modify
@@ -20,8 +16,6 @@
 #
 
 
-require "optparse"
-require "trema/dsl"
 require "trema/ofctl"
 require "trema/util"
 
@@ -31,25 +25,12 @@ module Trema
     include Trema::Util
 
 
-    def dump_flows
-      sanity_check
-
-      switch = Trema::DSL::Context.load_current.switches[ ARGV[ 0 ] ]
-
-      options = OptionParser.new
-      options.banner = "Usage: trema dump_flows SWITCH [OPTIONS ...]"
-
-      options.on( "-h", "--help" ) do
-        puts options.to_s
-        exit 0
-      end
-      options.on( "-v", "--verbose" ) do
-        $verbose = true
+    def trema_dump_flows switches
+      switches.each do | each |
+        switch = find_switch_by_name( each )
+        exit_now! "No switch named `#{ each }` found!" if switch.nil?
+        puts Trema::Ofctl.new.dump_flows( switch )
       end
-
-      options.parse! ARGV
-
-      puts Trema::Ofctl.new.dump_flows( switch )
     end
   end
 end