trema 0.2.5 → 0.2.6

data/bin/trema-config

@@ -0,0 +1,59 @@
+#! /usr/bin/env ruby
+#
+# Trema compile helper.
+#
+# 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.
+#
+
+
+$LOAD_PATH.unshift( File.expand_path( File.dirname( __FILE__ ) + "/../ruby" ) )
+
+
+require "fileutils"
+require "optparse"
+require "trema/path"
+
+
+$opts = OptionParser.new
+
+FileUtils.cd Trema.home do
+  $opts.banner = "Usage: #{ File.basename $0 } [OPTIONS ...]"
+
+  $opts.on( "-c", "--cflags" ) do
+    $cflags = true
+  end
+  $opts.on( "-l", "--libs" ) do
+    $libs = true
+  end
+
+  $opts.parse! ARGV
+
+  output = []
+  if $cflags
+    output << "-I#{ Trema.home }/src/lib -I#{ Trema.openflow }"
+  end
+  if $libs
+    output << "-L#{ Trema.objects }/lib -ltrema -lrt -lpthread -lsqlite3 -ldl"
+  end
+  print output.join( " " )
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8
+### indent-tabs-mode: nil
+### End:

data/cruise.rb

@@ -24,7 +24,7 @@
 # threshold.
 #
 
-$coverage_threshold = 68.9
+$coverage_threshold = 70.2
 
 
 ################################################################################

data/features/example.dumper.feature

@@ -1,87 +1,67 @@
-Feature: Dump openflow events with dumper
+Feature: "Dumper" sample application
 
-  As a Trema user
-  I want to dump OpenFlow events with dumper example application
-  So that I can visualize OpenFlow messages
+  In order to learn how to dump miscellaneous OpenFlow messages
+  As a developer using Trema
+  I want to execute "Dumper" sample application
 
-
-  Scenario: Dump packet_in events
-    Given I try trema run "./objects/examples/dumper/dumper" with following configuration (backgrounded):
+  Background:
+    Given a file named "dumper.conf" with:
       """
-      vswitch("dumper") { datapath_id "0xabc" }
+      vswitch("dumper") { datapath_id 0xabc }
 
-      vhost("host1") {
-        ip "192.168.0.1"
-        mac "00:00:00:00:00:01"
-      }
-      vhost("host2") {
-        ip "192.168.0.2"
-        mac "00:00:00:00:00:02"
-      }
+      vhost("host1")
+      vhost("host2")
 
       link "dumper", "host1"
       link "dumper", "host2"
       """
-      And wait until "dumper" is up
-    When I try to run "./trema send_packets --source host1 --dest host2 --length=0"
-      And I terminated all trema services
-    Then the output should include:
-      """
-      [packet_in]
-        datapath_id: 0xabc
-      """
-
 
-  Scenario: Dump packet_in events (Ruby)
-    Given I try trema run "./src/examples/dumper/dumper.rb" with following configuration (backgrounded):
-      """
-      vswitch("dumper") { datapath_id "0xabc" }
+  @slow_process
+  Scenario: Run "Dumper" C example
+    Given I run `trema run ../../objects/examples/dumper/dumper -c dumper.conf -d`
+     And wait until "dumper" is up
+    When I send 1 packet from host1 to host2
+    Then the file "../../tmp/log/dumper.log" should contain "[switch_ready]"
+     And the file "../../tmp/log/dumper.log" should contain "[packet_in]"
+     And the file "../../tmp/log/dumper.log" should contain "datapath_id: 0xabc"
 
-      vhost("host1") {
-        ip "192.168.0.1"
-        mac "00:00:00:00:00:01"
-      }
-      vhost("host2") {
-        ip "192.168.0.2"
-        mac "00:00:00:00:00:02"
-      }
+  @slow_process
+  Scenario: Run "Dumper" Ruby example
+    Given I run `trema run ../../src/examples/dumper/dumper.rb -c dumper.conf -d`
+     And wait until "Dumper" is up
+    When I send 1 packet from host1 to host2
+    Then the file "../../tmp/log/Dumper.log" should contain "[switch_ready]"
+     And the file "../../tmp/log/Dumper.log" should contain "[packet_in]"
+     And the file "../../tmp/log/Dumper.log" should contain "datapath_id: 0xabc"
 
-      link "dumper", "host1"
-      link "dumper", "host2"
-      """
-      And wait until "Dumper" is up
-    When I try to run "./trema send_packets --source host1 --dest host2 --length=0"
-      And I terminated all trema services
-    Then the output should include:
-      """
-      [packet_in]
-        datapath_id: 0xabc
-      """
-
-
-  Scenario: dumper --help
-    When I try to run "./objects/examples/dumper/dumper --help" (log = "dumper_help.log")
-    Then the log file "dumper_help.log" should be:
+  Scenario: "dumper --help"
+    When I run `../../objects/examples/dumper/dumper --help`
+    Then the output should contain exactly:
       """
       OpenFlow Event Dumper.
       Usage: dumper [OPTION]...
 
-        -n, --name=SERVICE_NAME     service name
-        -d, --daemonize             run in the background
-        -l, --logging_level=LEVEL   set logging level
-        -h, --help                  display this help and exit
-      """
+        -n, --name=SERVICE_NAME         service name
+        -d, --daemonize                 run in the background
+        -l, --logging_level=LEVEL       set logging level
+        -g, --syslog                    output log messages to syslog
+        -f, --logging_facility=FACILITY set syslog facility
+        -h, --help                      display this help and exit
 
+      """
 
-  Scenario: dumper -h
-    When I try to run "./objects/examples/dumper/dumper -h" (log = "dumper_h.log")
-    Then the log file "dumper_h.log" should be:
+  Scenario: "dumper -h"
+    When I run `../../objects/examples/dumper/dumper -h`
+    Then the output should contain exactly:
       """
       OpenFlow Event Dumper.
       Usage: dumper [OPTION]...
 
-        -n, --name=SERVICE_NAME     service name
-        -d, --daemonize             run in the background
-        -l, --logging_level=LEVEL   set logging level
-        -h, --help                  display this help and exit
+        -n, --name=SERVICE_NAME         service name
+        -d, --daemonize                 run in the background
+        -l, --logging_level=LEVEL       set logging level
+        -g, --syslog                    output log messages to syslog
+        -f, --logging_facility=FACILITY set syslog facility
+        -h, --help                      display this help and exit
+
       """

data/features/example.hello_trema.feature

@@ -0,0 +1,21 @@
+Feature: "Hello Trema!" sample application
+
+  In order to learn how to write minimum Trema application
+  As a developer using Trema
+  I want to execute "Hello Trema" sample application
+
+  Background:
+    Given a file named "hello.conf" with:
+      """
+      vswitch { datapath_id "0xabc" }
+      """
+
+  @slow_process
+  Scenario: Run "Hello Trema!" C example
+    When I run `trema run ../../objects/examples/hello_trema/hello_trema -c hello.conf`
+    Then the output should contain exactly "Hello 0xabc!\n"
+
+  @slow_process
+  Scenario: Run "Hello Trema!" Ruby example
+    When I run `trema run ../../src/examples/hello_trema/hello-trema.rb -c hello.conf`
+    Then the output should contain exactly "Hello 0xabc!\n"

data/features/example.learning_switch.feature

@@ -1,39 +1,37 @@
-Feature: control one openflow switch using learning-switch controller
+Feature: "Learning Switch" sample application
 
-  As a Trema user
-  I want to control one openflow switch using learning-switch controller
-  So that I can send and receive packets
+  In order to learn how to implement software L2 switch
+  As a developer using Trema
+  I want to execute "Learning Switch" sample application
 
-
-  Scenario: Send and receive packets
-    Given I try trema run "learning_switch" example with following configuration (backgrounded):
+  Background:
+    Given a file named "learning_switch.conf" with:
       """
       vswitch("learning") { datapath_id "0xabc" }
 
-      vhost("host1")
-      vhost("host2")
+      vhost("host1") { ip "192.168.0.1" }
+      vhost("host2") { ip "192.168.0.2" }
 
       link "learning", "host1"
       link "learning", "host2"
       """
-    When I send 1 packet from host1 to host2
-      And I try to run "./trema show_stats host1 --tx" (log = "host1.learning_switch.log")
-      And I try to run "./trema show_stats host2 --rx" (log = "host2.learning_switch.log")
-    Then the content of "host1.learning_switch.log" and "host2.learning_switch.log" should be identical
-
-
-  Scenario: Send and receive packets (in Ruby)
-    Given I try trema run "learning-switch.rb" example with following configuration (backgrounded):
-      """
-      vswitch("learning") { datapath_id "0xabc" }
 
-      vhost("host1")
-      vhost("host2")
-
-      link "learning", "host1"
-      link "learning", "host2"
-      """
+  @slow_process
+  Scenario: Run "Learning Switch" C example
+    Given I run `trema run ../../objects/examples/learning_switch/learning_switch -c learning_switch.conf -d`
+     And wait until "learning_switch" is up
+    When I send 1 packet from host1 to host2
+     And I run `trema show_stats host1 --tx`
+     And I run `trema show_stats host2 --rx`
+    Then the output from "trema show_stats host1 --tx" should contain "192.168.0.2,1,192.168.0.1,1,1,50"
+     And the output from "trema show_stats host2 --rx" should contain "192.168.0.2,1,192.168.0.1,1,1,50"
+
+  @slow_process
+  Scenario: Run "Learning Switch" Ruby example
+    Given I run `trema run ../../src/examples/learning_switch/learning-switch.rb -c learning_switch.conf -d`
+     And wait until "LearningSwitch" is up
     When I send 1 packet from host1 to host2
-      And I try to run "./trema show_stats host1 --tx" (log = "host1.LearningSwitch.log")
-      And I try to run "./trema show_stats host2 --rx" (log = "host2.LearningSwitch.log")
-    Then the content of "host1.LearningSwitch.log" and "host2.LearningSwitch.log" should be identical
+     And I run `trema show_stats host1 --tx`
+     And I run `trema show_stats host2 --rx`
+    Then the output from "trema show_stats host1 --tx" should contain "192.168.0.2,1,192.168.0.1,1,1,50"
+     And the output from "trema show_stats host2 --rx" should contain "192.168.0.2,1,192.168.0.1,1,1,50"

data/features/example.list_switches.feature

@@ -1,38 +1,24 @@
-Feature: Get the list of openflow switches with list_switches
+Feature: "List Switches" sample application
 
-  As a Trema user
-  I want to get the list of openflow switches
-  So that I can check how many switches are connected to my controller
+  In order to learn how to get the list of OpenFlow switches
+  As a developer using Trema
+  I want to execute "List Switches" sample application
 
-
-  Scenario: Get the list of openflow switches
-    Given I try trema run "./objects/examples/list_switches/list_switches" with following configuration (backgrounded):
-      """
-      vswitch { datapath_id "0x1" }
-      vswitch { datapath_id "0x2" }
-      vswitch { datapath_id "0x3" }
-      vswitch { datapath_id "0x4" }
+  Background:
+    Given a file named "list_switches.conf" with:
       """
-      And wait until "list_switches" is up
-      And *** sleep 2 ***
-      And I terminated all trema services
-    Then the output should include:
-      """
-      switches = 0x1, 0x2, 0x3, 0x4
+      vswitch { datapath_id 0x1 }
+      vswitch { datapath_id 0x2 }
+      vswitch { datapath_id 0x3 }
+      vswitch { datapath_id 0x4 }
       """
 
-  Scenario: Get the list of openflow switches (in Ruby)
-    Given I try trema run "./src/examples/list_switches/list-switches.rb" with following configuration (backgrounded):
-      """
-      vswitch { datapath_id "0x1" }
-      vswitch { datapath_id "0x2" }
-      vswitch { datapath_id "0x3" }
-      vswitch { datapath_id "0x4" }
-      """
-      And wait until "ListSwitches" is up
-      And *** sleep 2 ***
-      And I terminated all trema services
-    Then the output should include:
-      """
-      switches = 0x1, 0x2, 0x3, 0x4
-      """
+  @slow_process
+  Scenario: Run "List Switches" C example
+    Given I run `trema run ../../objects/examples/list_switches/list_switches -c list_switches.conf`
+    Then the file "../../tmp/log/list_switches.log" should contain "switches = 0x1, 0x2, 0x3, 0x4"
+
+  @slow_process
+  Scenario: Run "List Switches" Ruby example
+    Given I run `trema run ../../src/examples/list_switches/list-switches.rb -c list_switches.conf`
+    Then the file "../../tmp/log/ListSwitches.log" should contain "switches = 0x1, 0x2, 0x3, 0x4"

data/features/example.message.echo_reply.feature

@@ -4,7 +4,7 @@ Feature: Send echo reply messages
   I want to send echo reply messages to openflow switches
   Because I want to reply to echo requests from openflow switches
 
-
+  @wip
   Scenario: Send echo reply x 10
     When I try trema run "./objects/examples/openflow_message/echo_reply 10" with following configuration (backgrounded):
       """
@@ -14,13 +14,13 @@ Feature: Send echo reply messages
       And *** sleep 2 ***
     Then the log file "openflowd.echo_reply.log" should include "received: OFPT_ECHO_REPLY" x 10
 
-
-   Scenario: Send echo reply x 10 in Ruby
-    When I try trema run "./src/examples/openflow_message/echo-reply.rb 0xabc, 10" with following configuration (backgrounded):
-      """
-      vswitch("echo-reply") { datapath_id "0xabc" }
-      """
-      And wait until "EchoReplyController" is up
-      And *** sleep 2 ***
-    Then the log file "openflowd.echo-reply.log" should include "received: OFPT_ECHO_REPLY" x 10
+  @wip
+  Scenario: Send echo reply x 10 in Ruby
+   When I try trema run "./src/examples/openflow_message/echo-reply.rb 0xabc, 10" with following configuration (backgrounded):
+     """
+     vswitch("echo-reply") { datapath_id "0xabc" }
+     """
+   And wait until "EchoReplyController" is up
+   And *** sleep 2 ***
+  Then the log file "openflowd.echo-reply.log" should include "received: OFPT_ECHO_REPLY" x 10
 

data/features/example.message.echo_request.feature

@@ -4,7 +4,7 @@ Feature: Send echo request messages
   I want to send echo request messages to openflow switches
   So that I can receive echo reply messages from openflow switches
 
-
+  @wip
   Scenario: Send echo request x 10
     When I try trema run "./objects/examples/openflow_message/echo_request 10" with following configuration (backgrounded):
       """
@@ -14,7 +14,7 @@ Feature: Send echo request messages
       And *** sleep 2 ***
     Then the log file "openflowd.echo_request.log" should include "received: OFPT_ECHO_REQUEST" x 10
 
-
+  @wip
   Scenario: Send echo request x 10 in Ruby
     When I try trema run "./src/examples/openflow_message/echo-request.rb 0xabc, 10" with following configuration (backgrounded):
       """

data/features/example.message.features_request.feature

@@ -4,14 +4,14 @@ Feature: Send a features request message
   I want to send a features request message to openflow switches
   So that I can get the list of switch features
 
-
-  Scenario: Send a features request 
+  @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 terminated all trema services
+      And I run `trema killall`
     Then the output should include:
     """
     datapath_id: 0xabc
@@ -44,13 +44,14 @@ Feature: Send a features request message
       peer = 0
     """
 
-  Scenario: Send a features request in Ruby 
+  @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 terminated all trema services
+      And I run `trema killall`
     Then the output should include:
     """
     datapath_id: 0xabc

data/features/example.message.hello.feature

@@ -1,25 +1,59 @@
 Feature: Send hello messages
 
+  In order to start conversations with switches
   As a Trema user
   I want to send hello messages to openflow switches
-  So that I can start transactions with switches
 
-
-  Scenario: Hello trema
-    When I try trema run "./objects/examples/openflow_message/hello 10" with following configuration (backgrounded):
+  @slow_process
+  Scenario: Hello message in C
+    Given a file named "hello.conf" with:
       """
-      vswitch("hello") { datapath_id "0xabc" }
+      custom_switch("hello") { 
+        datapath_id "0xabc" 
+        path "./objects/examples/openflow_switch/hello_switch"
+      }
       """
+    When I run `trema run "../../objects/examples/openflow_message/hello 10" -c hello.conf -d`
       And wait until "hello" is up
-      And I terminated all trema services
-    Then the log file "openflowd.hello.log" should include "received: OFPT_HELLO" x 11
-
+      And I run `trema killall`
+    Then the file "../../tmp/log/customswitch.hello.log" should contain:
+      """
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      """
 
-  Scenario: Hello trema in Ruby
-    When I try trema run "./src/examples/openflow_message/hello.rb 0xabc, 10" with following configuration (backgrounded):
+  @slow_process
+  Scenario: Hello message in Ruby
+    Given a file named "hello-r.conf" with:
       """
-      vswitch("hello-r") { datapath_id "0xabc" }
+      custom_switch("hello-r") { 
+        datapath_id "0xabc" 
+        path "./objects/examples/openflow_switch/hello_switch"
+      }
       """
+    When I run `trema run "../../src/examples/openflow_message/hello.rb 10" -c hello-r.conf -d`
       And wait until "HelloController" is up
-      And I terminated all trema services
-    Then the log file "openflowd.hello-r.log" should include "received: OFPT_HELLO" x 11
+      And I run `trema killall`
+    Then the file "../../tmp/log/customswitch.hello-r.log" should contain:
+      """
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      received: OFPT_HELLO
+      """