trema 0.1.3

data/features/step_definitions/send_packets_steps.rb

@@ -0,0 +1,42 @@
+#
+# Author: Yasuhito Takamiya <yasuhito@gmail.com>
+#
+# 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.
+#
+
+
+When /^I send (\d+) packets from (.+) to (.+)$/ do | n_packets, host_a, host_b |
+  run "./trema send_packets --source #{ host_a } --dest #{ host_b } --n_pkts #{ n_packets }"
+  sleep 1  # ensure that all packets are sent
+end
+
+
+When /^I send 1 packet from (.+) to (.+)$/ do | host_a, host_b |
+  step "I send 1 packets from #{ host_a } to #{ host_b }"
+end
+
+
+When /^I send packets from (.+) to (.+) \(duration = (\d+)\)$/ do | host_a, host_b, duration |
+  run "./trema send_packets --source #{ host_a } --dest #{ host_b } --duration #{ duration }"
+  sleep 1  # ensure that all packets are sent
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/features/step_definitions/show_stats_steps.rb

@@ -0,0 +1,43 @@
+#
+# Author: Yasuhito Takamiya <yasuhito@gmail.com>
+#
+# 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.
+#
+
+
+Then /^the stats of "([^"]*)" should be:$/ do | host, string |
+  step %{I try to run "./trema show_stats #{ host }" (log = "show_stats.log")}
+  step %{the content of "show_stats.log" should be:}, string
+end
+
+
+Then /^the tx stats of "([^"]*)" should be:$/ do | host, string |
+  step %{I try to run "./trema show_stats #{ host } --tx" (log = "show_stats.log")}
+  step %{the content of "show_stats.log" should be:}, string
+end
+
+
+Then /^the rx stats of "([^"]*)" should be:$/ do | host, string |
+  step %{I try to run "./trema show_stats #{ host } --rx" (log = "show_stats.log")}
+  step %{the content of "show_stats.log" should be:}, string
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/features/step_definitions/stats_steps.rb

@@ -0,0 +1,39 @@
+#
+# Author: Yasuhito Takamiya <yasuhito@gmail.com>
+#
+# 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.
+#
+
+
+Then /^the total number of tx packets should be:$/ do | table |
+  table.hashes[ 0 ].each_pair do | host, n |
+    count_packets( `./trema show_stats #{ host } --tx` ).should == n.to_i
+  end
+end
+
+
+Then /^the total number of rx packets should be:$/ do | table |
+  table.hashes[ 0 ].each_pair do | host, n |
+    count_packets( `./trema show_stats #{ host } --rx` ).should == n.to_i
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/features/support/env.rb

@@ -0,0 +1,75 @@
+#
+# Author: Yasuhito Takamiya <yasuhito@gmail.com>
+#
+# 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.
+#
+
+
+require "bundler"
+begin
+  Bundler.setup :default, :development
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+
+$LOAD_PATH.unshift( File.expand_path( File.dirname( __FILE__ ) + "/../../ruby" ) )
+
+
+require "rspec"
+require "tempfile"
+require "trema/executables"
+require "trema/monkey-patch/string"
+
+
+def run command
+  raise "Failed to execute #{ command }" unless system( command )
+end
+
+
+def ps_entry_of name
+  `ps -ef | grep -w "#{ name } " | grep -v grep`
+end
+
+
+def cucumber_log name
+  File.join Trema.log_directory, name
+end
+
+
+def new_tmp_log
+  system "rm #{ Trema.log_directory }/tmp.*" # cleanup
+  `mktemp --tmpdir=#{ Trema.log_directory }`.chomp  
+end
+
+
+# show_stats output format:
+# ip_dst,tp_dst,ip_src,tp_src,n_pkts,n_octets
+def count_packets stats
+  return 0 if stats.split.size <= 1
+  stats.split[ 1..-1 ].inject( 0 ) do | sum, each |
+    sum += each.split( "," )[ 4 ].to_i
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/features/support/hooks.rb

@@ -0,0 +1,8 @@
+Before do
+  run "./trema killall"
+end
+
+
+After do
+  run "./trema killall"
+end

data/features/switch_manager.feature

@@ -0,0 +1,35 @@
+Feature: switch_manager help
+
+  As a Trema user
+  I want to see the help message of switch_manager command
+  So that I can learn how to use switch_manager
+
+  Scenario: switch_manager --help
+    When I try to run "./objects/switch_manager/switch_manager --help"
+    Then the output should be:
+      """
+      OpenFlow Switch Manager.
+      Usage: switch_manager [OPTION]... [-- SWITCH_MANAGER_OPTION]...
+
+        -s, --switch=PATH           the command path of switch
+        -n, --name=SERVICE_NAME     service name
+        -p, --port=PORT             server listen port (default 6633)
+        -d, --daemonize             run in the background
+        -l, --logging_level=LEVEL   set logging level
+        -h, --help                  display this help and exit
+      """
+
+  Scenario: switch_manager -h
+    When I try to run "./objects/switch_manager/switch_manager -h"
+    Then the output should be:
+      """
+      OpenFlow Switch Manager.
+      Usage: switch_manager [OPTION]... [-- SWITCH_MANAGER_OPTION]...
+
+        -s, --switch=PATH           the command path of switch
+        -n, --name=SERVICE_NAME     service name
+        -p, --port=PORT             server listen port (default 6633)
+        -d, --daemonize             run in the background
+        -l, --logging_level=LEVEL   set logging level
+        -h, --help                  display this help and exit
+      """

data/features/trema-config.feature

@@ -0,0 +1,68 @@
+Feature: trema-config compile helper
+
+  As a Trema user
+  I want to compile trema apps like: gcc -o hello_trema hello_trema.c `trema-config --cflags --libs`
+  So that I can compile trema apps without specifying Trema-specific flags and options.
+
+
+  Scenario: trema-config --cflags
+    When I try to run "gcc -c src/examples/hello_trema/hello_trema.c `./trema-config --cflags` -o tmp/hello_trema.o"
+    Then I should not get errors
+
+
+  Scenario: trema-config -c
+    When I try to run "gcc -c src/examples/hello_trema/hello_trema.c `./trema-config -c` -o tmp/hello_trema.o"
+    Then I should not get errors
+
+
+  Scenario: trema-config --libs
+    When I try to run "gcc -c src/examples/hello_trema/hello_trema.c `./trema-config --cflags` -o tmp/hello_trema.o"
+     And I try to run "gcc tmp/hello_trema.o `./trema-config --libs` -o tmp/hello_trema"
+    Then I should not get errors
+
+
+  Scenario: trema-config -l
+    When I try to run "gcc -c src/examples/hello_trema/hello_trema.c `./trema-config --cflags` -o tmp/hello_trema.o"
+     And I try to run "gcc tmp/hello_trema.o `./trema-config -l` -o tmp/hello_trema"
+    Then I should not get errors
+
+
+  Scenario: trema-config --cflags --libs
+    When I try to run "gcc -c src/examples/hello_trema/hello_trema.c `./trema-config -c` -o tmp/hello_trema.o"
+     And I try to run "gcc tmp/hello_trema.o `./trema-config --cflags --libs` -o tmp/hello_trema"
+    Then I should not get errors
+
+
+  Scenario: trema-config -c --libs
+    When I try to run "gcc src/examples/hello_trema/hello_trema.c `./trema-config -c --libs` -o tmp/hello_trema"
+    Then I should not get errors
+
+
+  Scenario: trema-config --cflags -l
+    When I try to run "gcc src/examples/hello_trema/hello_trema.c `./trema-config --cflags -l` -o tmp/hello_trema"
+    Then I should not get errors
+
+
+  Scenario: trema-config -c -l
+    When I try to run "gcc src/examples/hello_trema/hello_trema.c `./trema-config -c -l` -o tmp/hello_trema"
+    Then I should not get errors
+
+
+  Scenario: trema-config --help
+    When I try to run "./trema-config --help"
+    Then the output should be:
+      """
+      Usage: ./trema-config [OPTIONS ...]
+          -c, --cflags
+          -l, --libs
+      """
+
+
+  Scenario: trema-config -h
+    When I try to run "./trema-config -h"
+    Then the output should be:
+      """
+      Usage: ./trema-config [OPTIONS ...]
+          -c, --cflags
+          -l, --libs
+      """

data/features/trema.dump_flows.feature

@@ -0,0 +1,25 @@
+Feature: trema dump_flows command
+
+  As a Trema user
+  I want to dump the flow table of OpenFlow switch
+  So that I can debug my Trema apps
+
+
+  Scenario: run trema dump_flows
+    When I try trema run "./objects/examples/repeater_hub/repeater_hub" with following configuration (backgrounded):
+      """
+      vswitch("repeater_hub") { datapath_id "0xabc" }
+
+      vhost("host1")
+      vhost("host2")
+      vhost("host3")
+
+      link "repeater_hub", "host1"
+      link "repeater_hub", "host2"
+      link "repeater_hub", "host3"
+      """
+      And wait until "repeater_hub" is up
+      And I try to run "./trema send_packets --source host1 --dest host2"
+      And *** sleep 1 ***
+      And I try to run "./trema dump_flows repeater_hub" (log = "dump_flows.log")
+    Then "dump_flows.log" should contain some flow entries

data/features/trema.feature

@@ -0,0 +1,25 @@
+Feature: trema help
+
+  As a Trema user
+  I want to see the help message of trema command
+  So that I can learn how to use trema
+
+  Scenario: trema help
+    When I try to run "./trema help"
+    Then the output should be:
+      """
+      usage: ./trema <COMMAND> [OPTIONS ...]
+
+      Trema command-line tool
+      Type './trema help <COMMAND>' for help on a specific command.
+
+      Available commands:
+        run            - runs a trema application.
+        kill           - terminates a trema process.
+        killall        - terminates all trema processes.
+        send_packets   - sends UDP packets to destination host.
+        show_stats     - shows stats of packets.
+        reset_stats    - resets stats of packets.
+        dump_flows     - print all flow entries.
+        ruby           - opens in your browser Trema's Ruby API documentation.
+      """

data/features/trema.kill.feature

@@ -0,0 +1,53 @@
+Feature: kill a trema process with `trema kill' command
+
+  As a Trema user
+  I want to kill a trema processes with `trema kill' command
+  So that I can emulate failures on switch/host/link
+
+
+  Scenario: kill a switch
+    Given I try trema run "./src/examples/switch_monitor/switch-monitor.rb" with following configuration (backgrounded):
+      """
+      vswitch { datapath_id "0x1" }
+      vswitch { datapath_id "0x2" }
+      vswitch { datapath_id "0x3" }
+      """
+      And wait until "SwitchMonitor" is up
+    When I try to run "./trema kill 0x1"
+      And *** sleep 1 ***
+    Then vswitch 0x1 is terminated
+
+
+  Scenario: kill a host
+    Given I try trema run "./src/examples/switch_monitor/switch-monitor.rb" with following configuration (backgrounded):
+      """
+      vswitch { datapath_id "0x1" }
+      vhost "host"
+      link "0x1", "host"
+      """
+      And wait until "SwitchMonitor" is up
+    When I try to run "./trema kill host"
+      And *** sleep 1 ***
+    Then host is terminated
+
+
+  Scenario: kill a controller
+    Given I try trema run "./src/examples/switch_monitor/switch-monitor.rb" with following configuration (backgrounded):
+      """
+      vswitch { datapath_id "0x1" }
+      """
+      And wait until "SwitchMonitor" is up
+    When I try to run "./trema kill SwitchMonitor"
+      And *** sleep 1 ***
+    Then SwitchMonitor is terminated
+
+
+  Scenario: trema help kill
+    When I try to run "./trema help kill"
+    Then the output should be:
+      """
+      Usage: ./trema kill NAME [OPTIONS ...]
+          -h, --help
+          -v, --verbose
+
+      """

data/features/trema.killall.feature

@@ -0,0 +1,30 @@
+Feature: kill all trema processes with `trema killall' command
+
+  As a Trema user
+  I want to kill all trema processes with `trema killall' command
+  So that I can close trema sessions cleanly
+
+
+  Scenario: trema killall
+    Given I try trema run "./objects/examples/dumper/dumper" with following configuration (backgrounded):
+      """
+      vswitch { datapath_id "0xabc" }
+      """
+      And wait until "dumper" is up
+    When I try to run "./trema killall"
+      And *** sleep 1 ***
+    Then switch_manager is terminated
+      And switch is terminated
+      And ovs-openflowd is terminated
+      And dumper is terminated
+
+
+  Scenario: trema help killall
+    When I try to run "./trema help killall"
+    Then the output should be:
+      """
+      Usage: ./trema killall [OPTIONS ...]
+          -h, --help
+          -v, --verbose
+
+      """