trema 0.3.0 → 0.3.1

data/README.md

@@ -90,6 +90,7 @@ end
 
 * [switch_ready(datapath_id)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:switch_ready)
 * [switch_disconnected(datapath_id)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:switch_disconnected)
+* [list_switches_reply(datapath_ids)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:list_switches_reply)
 * [packet_in(datapath_id, message)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:packet_in)
 * [flow_removed(datapath_id, message)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:flow_removed)
 * [port_status(datapath_id, message)](http://rubydoc.info/github/trema/trema/master/Trema/Controller:port_status)

data/Rakefile

@@ -17,16 +17,23 @@
 
 
 require "rubygems"
-
-
 require "rake"
 
+
 task :default do
   sh "./build.rb"
 end
 
 
-task :travis => [ :default, "spec:travis" ]
+################################################################################
+# Maintenance Tasks
+################################################################################
+
+# FIXME: Remove dependency to rant
+desc "Generate a monolithic rant file"
+task "build.rb" do
+  sh "rant-import --force --auto .mono.rant"
+end
 
 
 begin
@@ -36,6 +43,13 @@ rescue LoadError
 end
 
 
+################################################################################
+# Tests
+################################################################################
+
+task :travis => [ :default, "spec:travis" ]
+
+
 begin
   require "rspec/core"
   require "rspec/core/rake_task"
@@ -70,6 +84,18 @@ rescue LoadError
 end
 
 
+################################################################################
+# Code Quality Tasks
+################################################################################
+
+$ruby_sources = FileList[ "ruby/**/*.rb", "src/**/*.rb" ]
+$quality_targets = if ENV[ "QUALITY_TARGETS" ]
+                     ENV[ "QUALITY_TARGETS" ].split
+                   else
+                     $ruby_sources
+                   end
+
+
 desc "Enforce Ruby code quality with static analysis of code"
 task :quality => [ :reek, :roodi, :flog, :flay ]
 
@@ -82,7 +108,7 @@ begin
     t.verbose = false
     t.ruby_opts = [ "-rubygems" ]
     t.reek_opts = "--quiet"
-    t.source_files = "ruby/**/*.rb"
+    t.source_files = $quality_targets
   end
 rescue LoadError
   $stderr.puts $!.to_s
@@ -95,7 +121,7 @@ begin
 
   RoodiTask.new do | t |
     t.verbose = false
-    t.patterns = %w(ruby/**/*.rb spec/**/*.rb features/**/*.rb)
+    t.patterns = $quality_targets
   end
 rescue LoadError
   $stderr.puts $!.to_s
@@ -108,7 +134,7 @@ begin
   desc "Analyze for code complexity"
   task :flog do
     flog = Flog.new( :continue => true )
-    flog.flog [ "ruby" ]
+    flog.flog $quality_targets
     threshold = 10
 
     bad_methods = flog.totals.select do | name, score |
@@ -133,7 +159,9 @@ begin
   require "flay_task"
 
   FlayTask.new do | t |
-    t.dirs = %w( ruby )
+    t.dirs = $ruby_sources.collect do | each |
+      each[ /[^\/]+/ ]
+    end.uniq
     t.threshold = 0
     t.verbose = true
   end
@@ -142,66 +170,17 @@ rescue LoadError
 end
 
 
-desc "Generate a monolithic rant file"
-task "build.rb" do
-  sh "rant-import --force --auto .mono.rant"
-end
-
+################################################################################
+# YARD
+################################################################################
 
 begin
   require "yard"
 
   YARD::Rake::YardocTask.new do | t |
-    t.files = [ "ruby/trema/**/*.c", "ruby/trema/**/*.rb" ]
-    t.options = [ "--no-private" ]
-    t.options << "--debug" << "--verbose" if $trace
-  end
-
-  yardoc_i18n = "./vendor/yard.i18n/bin/yardoc"
-
-  namespace :yard do
-    desc "Generate YARD Documentation in Japanese"
-    task :ja => "yard:po" do
-      sh "#{ yardoc_i18n } --language ja ruby/trema"
-    end
-  end
-
-  locale_base_dir = "locale"
-  locale_dir = "#{ locale_base_dir }/ja"
-  pot = "#{ locale_base_dir }/yard.pot"
-  po = "#{ locale_dir }/yard.po"
-
-  namespace :yard do
-    desc "generate .pot file"
-    task :pot => pot
-
-    desc "Generate .po file"
-    task :po => po
-
-    file pot => FileList[ "ruby/trema/**/*.rb", "ruby/trema/**/*.c" ] do
-      Rake::Task[ "yard:pot:generate" ].invoke
-    end
-
-    namespace :pot do
-      task :generate do
-        sh( yardoc_i18n, "--no-yardopts", "--output", locale_base_dir, "--format", "pot", "ruby/trema" )
-      end
-    end
-
-    directory locale_dir
-    file po => [ locale_dir, pot ] do
-      Rake::Task[ "yard:po:generate" ].invoke
-    end
-
-    namespace :po do
-      task :generate do
-        if File.exist?( po )
-          sh( "msgmerge", "--update", "--sort-by-file", po, pot )
-        else
-          sh( "msginit", "--input", pot, "--output", po, "--locale", "ja.UTF-8" )
-        end
-      end
-    end
+   t.files = [ "ruby/trema/**/*.c", "ruby/trema/**/*.rb" ]
+   t.options = [ "--no-private" ]
+   t.options << "--debug" << "--verbose" if $trace
   end
 rescue LoadError
   $stderr.puts $!.to_s

data/bin/quality

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+#
+# Copyright (C) 2008-2012 NEC Corporation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 2, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+
+if ARGV.empty?
+  system "rake quality"
+else
+  system %Q{rake quality QUALITY_TARGETS="#{ ARGV.join ' ' }"}
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/features/example.openflow_message.features_request.feature

@@ -0,0 +1,35 @@
+Feature: Send a features request message
+
+  In order to get the list of switch features
+  As a Trema user
+  I want to send a features request message to openflow switches
+
+  Background:
+    Given a file named "features_request.conf" with:
+     """
+     vswitch( "features_request" ) { datapath_id "0xabc" }
+     """
+
+  @slow_process
+  Scenario: Features Request message in C
+    When I run `trema run ../../objects/examples/openflow_message/features_request -c features_request.conf -d`
+     And wait until "features_request" is up
+     And I run `trema killall`
+    Then the file "../../tmp/log/features_request.log" should match /datapath_id: 0xabc/
+     And the file "../../tmp/log/features_request.log" should match /n_buffers:/
+     And the file "../../tmp/log/features_request.log" should match /n_tables:/
+     And the file "../../tmp/log/features_request.log" should match /capabilities:/
+     And the file "../../tmp/log/features_request.log" should match /actions:/
+     And the file "../../tmp/log/features_request.log" should match /ports:/
+
+  @slow_process
+  Scenario: Feature Request message in Ruby
+    When I run `trema run ../../src/examples/openflow_message/features-request.rb -c features_request.conf -d`
+     And wait until "FeaturesRequestController" is up
+     And I run `trema killall`
+    Then the file "../../tmp/log/FeaturesRequestController.log" should match /datapath_id: 0xabc/
+     And the file "../../tmp/log/FeaturesRequestController.log" should match /n_buffers:/
+     And the file "../../tmp/log/FeaturesRequestController.log" should match /n_tables:/
+     And the file "../../tmp/log/FeaturesRequestController.log" should match /capabilities:/
+     And the file "../../tmp/log/FeaturesRequestController.log" should match /actions:/
+     And the file "../../tmp/log/FeaturesRequestController.log" should match /ports:/

data/ruby/extconf.rb

@@ -71,6 +71,7 @@ EOF
 end
 
 
+$CFLAGS << " -Werror" # must be added after find_library
 create_makefile "trema", "trema"
 
 

data/ruby/trema/controller.rb

@@ -62,6 +62,18 @@ module Trema
     handler :switch_disconnected
 
 
+
+    #
+    # @!method list_switches_reply( datapath_ids )
+    #
+    # @abstract List Switches Reply message handler. Override this to implement a custom handler.
+    #
+    # @param [Array<Integer>] datapath_ids
+    #   the datapath IDs of connected OpenFlow switches.
+    #
+    handler :list_switches_reply
+
+
     #
     # @!method packet_in( datapath_id, message )
     #

data/ruby/trema/stats-request.c

@@ -266,7 +266,7 @@ stats_vendor_id( VALUE self ) {
 
 uint32_t
 get_stats_request_num2uint( VALUE self, const char *field ) {
-  return NUM2UINT( rb_iv_get( self, field ) );
+  return ( uint32_t ) NUM2UINT( rb_iv_get( self, field ) );
 }
 
 

data/ruby/trema/switch.c

@@ -16,13 +16,14 @@
  */
 
 
-#include "chibach.h"
 #include "flow-mod.h"
 #include "logger.h"
 #include "ruby.h"
 #include "rubysig.h"
 #include "switch.h"
 
+#include "chibach.h" // must be included after ruby.h for undef ruby's xmalloc
+
 
 VALUE mTrema;
 VALUE cSwitch;

data/ruby/trema/vendor.c

@@ -207,7 +207,7 @@ handle_vendor(
 
   if ( data != NULL && data->length > 0 ) {
     VALUE data_array = rb_ary_new2( ( long ) data->length );
-    long i;
+    size_t i;
     for ( i = 0; i < data->length; i++ ) {
       rb_ary_push( data_array, INT2FIX( ( ( uint8_t * ) data->data)[ i ] ) );
     }

data/ruby/trema/version.rb

@@ -17,7 +17,7 @@
 
 
 module Trema
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end
 
 

data/spec/trema/controller_spec.rb

@@ -57,7 +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
+          sleep 20 # FIXME: wait to send_flow_mod_add
           vswitch( "0xabc" ).should have( 1 ).flows
         }
       end

data/spec/trema/set-eth-dst-addr_spec.rb

@@ -67,7 +67,7 @@ describe SetEthDstAddr, ".new( VALID OPTION )" do
           0xabc,
           :actions => SetEthDstAddr.new( "52:54:00:a8:ad:8c" )
         )
-        sleep 6 # FIXME: wait to send_flow_mod
+        sleep 20 # FIXME: wait to send_flow_mod
         vswitch( "0xabc" ).should have( 1 ).flows
         vswitch( "0xabc" ).flows[0].actions.should match( /mod_dl_dst:52:54:00:a8:ad:8c/ )
       }

data/spec/trema/set-eth-src-addr_spec.rb

@@ -64,7 +64,7 @@ describe SetEthSrcAddr, ".new( VALID OPTION )" do
         vswitch { datapath_id 0xabc }
       }.run( FlowModAddController ) {
         controller( "FlowModAddController" ).send_flow_mod_add( 0xabc, :actions => SetEthSrcAddr.new( "52:54:00:a8:ad:8c" ) )
-        sleep 6 # FIXME: wait to send_flow_mod
+        sleep 20 # FIXME: wait to send_flow_mod
         vswitch( "0xabc" ).should have( 1 ).flows
         vswitch( "0xabc" ).flows[0].actions.should match( /mod_dl_src:52:54:00:a8:ad:8c/ )
       }

data/src/examples/openflow_message/features-request.rb

@@ -2,8 +2,6 @@
 # A test example program to send a OFPT_FEATURES_REQUEST message and print
 # the reply.
 #
-# Author: Nick Karanatsios <nickkaranatsios@gmail.com>
-#
 # Copyright (C) 2008-2012 NEC Corporation
 #
 # This program is free software; you can redistribute it and/or modify
@@ -75,16 +73,17 @@ class FeaturesRequestController < Controller
 
 
   def print_ports ports
-    ports.each do | port |
-      info "port_no: %u" % port.number
-      info "  hw_addr = #{ port.hw_addr.to_s }"
-      info "  name = #{ port.name }"
-      info "  config = #{ port.config.to_hex }"
-      info "  state = #{ port.state.to_hex }"
-      info "  curr = #{ port.curr.to_hex }"
-      info "  advertised = #{ port.advertised.to_hex }"
-      info "  supported = #{ port.supported.to_hex }"
-      info "  peer = #{ port.peer.to_hex }"
+    info "ports:"
+    ports.each do | each |
+      info "  port_no: %u" % each.number
+      info "    hw_addr = #{ each.hw_addr.to_s }"
+      info "    name = #{ each.name }"
+      info "    config = #{ each.config.to_hex }"
+      info "    state = #{ each.state.to_hex }"
+      info "    curr = #{ each.curr.to_hex }"
+      info "    advertised = #{ each.advertised.to_hex }"
+      info "    supported = #{ each.supported.to_hex }"
+      info "    peer = #{ each.peer.to_hex }"
     end
   end
 end

data/src/examples/openflow_message/features_request.c

@@ -1,8 +1,6 @@
 /*
  * Sends a features request message.
  *
- * Author: Shin-ya Zenke, Yasuhito Takamiya <yasuhito@gmail.com>
- *
  * Copyright (C) 2008-2012 NEC Corporation
  *
  * This program is free software; you can redistribute it and/or modify
@@ -108,13 +106,14 @@ handle_features_reply(
     info( "  OFPAT_VENDOR" );
   }
 
+  info( "ports:" );
   list_element ports_list;
   memcpy( &ports_list, phy_ports, sizeof( list_element ) );
   for ( list_element *port = &ports_list; port != NULL; port = port->next ) {
     struct ofp_phy_port *phy_port = port->data;
-    info( "port_no: %u", phy_port->port_no );
+    info( "  port_no: %u", phy_port->port_no );
     info(
-      "  hw_addr = %02x:%02x:%02x:%02x:%02x:%02x",
+      "    hw_addr = %02x:%02x:%02x:%02x:%02x:%02x",
       phy_port->hw_addr[ 0 ],
       phy_port->hw_addr[ 1 ],
       phy_port->hw_addr[ 2 ],
@@ -122,13 +121,13 @@ handle_features_reply(
       phy_port->hw_addr[ 4 ],
       phy_port->hw_addr[ 5 ]
     );
-    info( "  name = %s", phy_port->name );
-    info( "  config = %#" PRIx32 "", phy_port->config );
-    info( "  state = %#" PRIx32 "", phy_port->state );
-    info( "  curr = %#" PRIx32 "", phy_port->curr );
-    info( "  advertised = %#" PRIx32 "", phy_port->advertised );
-    info( "  supported = %#" PRIx32 "", phy_port->supported );
-    info( "  peer = %#" PRIx32 "", phy_port->peer );
+    info( "    name = %s", phy_port->name );
+    info( "    config = %#" PRIx32 "", phy_port->config );
+    info( "    state = %#" PRIx32 "", phy_port->state );
+    info( "    curr = %#" PRIx32 "", phy_port->curr );
+    info( "    advertised = %#" PRIx32 "", phy_port->advertised );
+    info( "    supported = %#" PRIx32 "", phy_port->supported );
+    info( "    peer = %#" PRIx32 "", phy_port->peer );
   }
 }
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: trema
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Yasuhito Takamiya
@@ -15,7 +15,7 @@ autorequire:
 bindir: .
 cert_chain: []
 
-date: 2013-01-07 00:00:00 Z
+date: 2013-01-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false
@@ -110,6 +110,7 @@ files:
 - README.md
 - Rakefile
 - Rantfile
+- bin/quality
 - bin/trema
 - bin/trema-config
 - build.rb
@@ -118,11 +119,11 @@ files:
 - features/example.hello_trema.feature
 - features/example.learning_switch.feature
 - features/example.list_switches.feature
-- features/example.message.features_request.feature
 - features/example.message.set_config.feature
 - features/example.message.vendor-action.feature
 - features/example.multi_learning_switch.feature
 - features/example.openflow_message.echo.feature
+- features/example.openflow_message.features_request.feature
 - features/example.openflow_message.hello.feature
 - features/example.packet_in.feature
 - features/example.packetin_filter_config.feature

data/features/example.message.features_request.feature

@@ -1,85 +0,0 @@
-Feature: Send a features request message
-
-  As a Trema user
-  I want to send a features request message to openflow switches
-  So that I can get the list of switch features
-
-  @wip
-  Scenario: Send a features request
-    When I try trema run "./objects/examples/openflow_message/features_request" with following configuration (backgrounded):
-      """
-      vswitch( "features_request" ) { datapath_id "0xabc" }
-      """
-      And wait until "features_request" is up
-      And I run `trema killall`
-    Then the output should include:
-    """
-    datapath_id: 0xabc
-    n_buffers: 256
-    n_tables: 1
-    capabilities:
-      OFPC_FLOW_STATS
-      OFPC_TABLE_STATS
-      OFPC_PORT_STATS
-      OFPC_ARP_MATCH_IP
-    actions:
-      OFPAT_OUTPUT
-      OFPAT_SET_VLAN_VID
-      OFPAT_SET_VLAN_PCP
-      OFPAT_STRIP_VLAN
-      OFPAT_SET_DL_SRC
-      OFPAT_SET_DL_DST
-      OFPAT_SET_NW_SRC
-      OFPAT_SET_NW_DST
-      OFPAT_SET_NW_TOS
-      OFPAT_SET_TP_SRC
-      OFPAT_SET_TP_DST
-    port_no: 65534
-      name = vsw_0xabc
-      config = 0x1
-      state = 0x1
-      curr = 0x82
-      advertised = 0
-      supported = 0
-      peer = 0
-    """
-
-  @wip
-  Scenario: Send a features request in Ruby
-    When I try trema run "./src/examples/openflow_message/features-request.rb" with following configuration (backgrounded):
-      """
-      vswitch( "features-request" ) { datapath_id "0xabc" }
-      """
-      And wait until "FeaturesRequestController" is up
-      And I run `trema killall`
-    Then the output should include:
-    """
-    datapath_id: 0xabc
-    n_buffers: 256
-    n_tables: 1
-    capabilities:
-      OFPC_FLOW_STATS
-      OFPC_TABLE_STATS
-      OFPC_PORT_STATS
-      OFPC_ARP_MATCH_IP
-    actions:
-      OFPAT_OUTPUT
-      OFPAT_SET_VLAN_VID
-      OFPAT_SET_VLAN_PCP
-      OFPAT_STRIP_VLAN
-      OFPAT_SET_DL_SRC
-      OFPAT_SET_DL_DST
-      OFPAT_SET_NW_SRC
-      OFPAT_SET_NW_DST
-      OFPAT_SET_NW_TOS
-      OFPAT_SET_TP_SRC
-      OFPAT_SET_TP_DST
-    port_no: 65534
-      name = vsw_0xabc
-      config = 0x1
-      state = 0x1
-      curr = 0x82
-      advertised = 0x0
-      supported = 0x0
-      peer = 0x0
-    """