trema 0.5.1 → 0.6.0

data/features/step_definitions/rest_api_steps.rb

@@ -0,0 +1,40 @@
+begin
+  require 'rack/test'
+
+  World(Rack::Test::Methods)
+
+  Given(/^I send and accept JSON$/) do
+    header 'Accept', 'application/json'
+    header 'Cotent-Type', 'application/json'
+  end
+
+  Given(/^I send a GET request for "([^\"]*)"$/) do |path|
+    in_current_dir { get path }
+  end
+
+  # rubocop:disable LineLength
+  Given(/^I send a POST request for "([^\"]*)" with body "([^\"]*)"$/) do |path, body|
+    in_current_dir { post path, Object.instance_eval(body) }
+  end
+  # rubocop:enable LineLength
+
+  # rubocop:disable LineLength
+  Given(/^I send a DELETE request for "([^\"]*)" with body "([^\"]*)"$/) do |path, body|
+    in_current_dir { delete path, Object.instance_eval(body) }
+  end
+  # rubocop:enable LineLength
+
+  Then(/^the response should be "([^\"]*)"$/) do |status|
+    expect(last_response.status).to eq(status.to_i)
+  end
+
+  Then(/^the JSON response should be "([^\"]*)"$/) do |json|
+    expect(JSON.parse(last_response.body)).to eq(JSON.parse(json))
+  end
+
+  Then(/^the JSON response should be:$/) do |json|
+    expect(JSON.parse(last_response.body)).to eq(JSON.parse(json))
+  end
+rescue LoadError
+  $stderr.puts 'Rack is disabled'
+end

data/features/step_definitions/show_stats_steps.rb

@@ -2,10 +2,10 @@
 
 Then(/^the number of packets sent from "(.*?)" should be:$/) do |host_name, table|
   command = "trema show_stats #{host_name}"
-  step "I successfully run `#{command}`"
+  step "I run `#{command}`"
 
   result = {}
-  in_current_dir do
+  cd('.') do
     output_from(command).split("\n").each do |each|
       case each
       when /Packets sent/
@@ -27,10 +27,10 @@ end
 
 Then(/^the number of packets received by "(.*?)" should be:$/) do |host_name, table|
   command = "trema show_stats #{host_name}"
-  step "I successfully run `#{command}`"
+  step "I run `#{command}`"
 
   result = Hash.new(0)
-  in_current_dir do
+  cd('.') do
     received = false
     output_from(command).split("\n").each do |each|
       case each
@@ -53,4 +53,31 @@ Then(/^the number of packets received by "(.*?)" should be:$/) do |host_name, ta
   end
 end
 
+Then(/^the total number of received packets should be:$/) do |table|
+  table.hashes[0].each_pair do |host_name, npackets|
+    command = "trema show_stats #{host_name}"
+    step "I run `#{command}`"
+
+    result = 0
+    cd('.') do
+      received = false
+      output_from(command).split("\n").each do |each|
+        case each
+        when /Packets sent/
+          next
+        when /Packets received/
+          received = true
+          next
+        when /(\S+) -> (\S+) = (\d+) packet/
+          next unless received
+          result += Regexp.last_match(3).to_i
+        else
+          fail "Failed to parse line '#{each}'"
+        end
+      end
+    end
+    expect(result).to eq(npackets.to_i)
+  end
+end
+
 # rubocop:enable LineLength

data/features/step_definitions/trema_steps.rb

@@ -0,0 +1,72 @@
+Given(/^I use OpenFlow 1\.0$/) do
+  @open_flow_version = :open_flow10
+end
+
+Given(/^I use OpenFlow 1\.3$/) do
+  @open_flow_version = :open_flow13
+end
+
+Given(/^a socket directory named "([^"]*)"$/) do |socket_directory|
+  step %(a directory named "#{socket_directory}")
+  ENV['TREMA_SOCKET_DIR'] = socket_directory
+end
+
+Then(/^a socket file named "([^"]*)" should exist$/) do |socket_file|
+  cd('.') do
+    expect(FileTest.socket?(socket_file)).to be_truthy
+  end
+end
+
+When(/^I trema run "([^"]*)"$/) do |controller_file|
+  controller_path = if controller_file.include?('/')
+                      File.join '..', '..', controller_file
+                    else
+                      controller_file
+                    end
+  step %(I run `trema run #{controller_path} -d`)
+end
+
+When(/^I trema run "([^"]*)" interactively$/) do |controller_file|
+  controller_path = if controller_file.include?('/')
+                      File.join '..', '..', controller_file
+                    else
+                      controller_file
+                    end
+  step %(I run `trema run #{controller_path}` interactively)
+  step %(I successfully run `sleep 3`)
+end
+
+# rubocop:disable LineLength
+When(/^I trema run "([^"]*)"( interactively)? with the configuration "([^"]*)"$/) do |controller_file, interactive, configuration_file|
+  open_flow_option = @open_flow_version == :open_flow13 ? ' --openflow13' : ''
+  controller_path = if controller_file.include?('/')
+                      File.join '..', '..', controller_file
+                    else
+                      controller_file
+                    end
+  run_arguments = "#{controller_path}#{open_flow_option} -c #{configuration_file}"
+  if interactive
+    step %(I run `trema run #{run_arguments}` interactively)
+  else
+    step %(I successfully run `trema run #{run_arguments} -d`)
+  end
+  step %(I successfully run `sleep 3`)
+end
+# rubocop:enable LineLength
+
+When(/^I trema killall "([^"]*)"$/) do |controller_name|
+  step %(I successfully run `trema killall #{controller_name}`)
+end
+
+# rubocop:disable LineLength
+Then(/^the log file "([^"]*)" should contain following messages:$/) do |log_file, messages|
+  step %(a file named "#{log_file}" should exist)
+  messages.rows.flatten.each do |each|
+    step %(the file "#{log_file}" should contain "#{each}")
+  end
+end
+# rubocop:enable LineLength
+
+Then(/^the command returns immediately$/) do
+  # noop
+end

data/features/support/hooks.rb

@@ -3,11 +3,14 @@ Before do
 end
 
 Before('@sudo') do
+  ENV['TREMA_LOG_DIR'] = '.'
+  ENV['TREMA_PID_DIR'] = '.'
+  ENV['TREMA_SOCKET_DIR'] = '.'
   fail 'sudo authentication failed' unless system 'sudo -v'
   @aruba_timeout_seconds = 10
 end
 
 After do
-  run 'trema killall --all'
+  run "trema killall --all -S #{ENV['TREMA_SOCKET_DIR']}"
   sleep 5
 end

data/features/trema_delete_link/README.md

@@ -0,0 +1,5 @@
+`trema delete_link` deletes a virtual link.
+
+```
+trema [global options] delete_link [command options] endpoint1 endpoint2
+```

data/features/{trema_delete_link.feature → trema_delete_link/delete_link.feature}

@@ -1,12 +1,8 @@
-Feature: trema start command
-  Background:
-    Given I set the environment variables to:
-      | variable         | value |
-      | TREMA_LOG_DIR    | .     |
-      | TREMA_PID_DIR    | .     |
-      | TREMA_SOCKET_DIR | .     |
-    And a file named "packet_in_controller.rb" with:
-      """
+Feature: delete_link
+  @sudo
+  Scenario: trema delete_link 0xabc host1
+    Given a file named "packet_in_controller.rb" with:
+      """ruby
       class PacketInController < Trema::Controller
         def packet_in(dpid, message)
           logger.info 'new packet_in'
@@ -14,7 +10,7 @@ Feature: trema start command
       end
       """
     And a file named "trema.conf" with:
-      """
+      """ruby
       vswitch { datapath_id 0xabc }
       vhost('host1') { ip '192.168.0.1' }
       vhost('host2') { ip '192.168.0.2' }
@@ -22,9 +18,9 @@ Feature: trema start command
       link '0xabc', 'host2'
       """
     And I run `trema run packet_in_controller.rb -c trema.conf -d`
-
-  @sudo
-  Scenario: trema delete_link 0xabc host1
     When I successfully run `trema delete_link 0xabc host1`
     And I successfully run `trema send_packets --source host1 --dest host2`
     Then the file "PacketInController.log" should not contain "new packet_in"
+
+  @wip
+  Scenario: "link not found" error

data/features/trema_delete_link/socket_dir_option.feature

@@ -0,0 +1,12 @@
+Feature: -S (--socket_dir) option
+
+  -S (--socket_dir) option specifies the location to find socket files
+
+  @sudo @wip
+  Scenario: -S option
+
+  @sudo @wip
+  Scenario: --socket_dir option
+
+  @sudo @wip
+  Scenario: "link not found" error

data/features/trema_killall/README.md

@@ -0,0 +1,5 @@
+`trema killall` terminates all trema processes.
+
+```
+trema [global options] killall [command options] controller_name
+```

data/features/trema_killall/all_option.feature

@@ -0,0 +1,20 @@
+Feature: --all option
+
+  --all option kills all known trema processes
+
+  @sudo
+  Scenario: killall --all
+    Given a file named "null_controller.rb" with:
+      """ruby
+      class NullController < Trema::Controller; end
+      """
+    And a file named "void_controller.rb" with:
+      """ruby
+      class VoidController < Trema::Controller; end
+      """
+    And I successfully run `trema run null_controller.rb -d`
+    And I successfully run `trema run void_controller.rb -p 6654 -d`
+    When I successfully run `trema killall --all`
+    Then the following files should not exist:
+      | NullController.pid |
+      | VoidController.pid |

data/features/{trema_killall.feature → trema_killall/killall.feature}

@@ -1,53 +1,35 @@
-Feature: trema killall command
-  Background:
-    Given I set the environment variables to:
-      | variable         | value |
-      | TREMA_LOG_DIR    | .     |
-      | TREMA_PID_DIR    | .     |
-      | TREMA_SOCKET_DIR | .     |
-    And a file named "null_controller.rb" with:
-      """
+Feature: killall
+  @sudo
+  Scenario: killall controller_name
+    Given a file named "null_controller.rb" with:
+      """ruby
       class NullController < Trema::Controller; end
       """
     And a file named "trema.conf" with:
-      """
+      """ruby
       vswitch { datapath_id 0xabc }
       vhost('host1') { ip '192.168.0.1' }
       vhost('host2') { ip '192.168.0.2' }
       link '0xabc', 'host1'
       link '0xabc', 'host2'
       """
-    And I run `trema run null_controller.rb -c trema.conf -d`
     And a file named "void_controller.rb" with:
-      """
+      """ruby
       class VoidController < Trema::Controller; end
       """
-    And I run `trema run void_controller.rb -p 6654 -d`
-
-  @sudo
-  Scenario: killall controller_name
+    And I successfully run `trema run null_controller.rb -c trema.conf -d`
+    And I successfully run `trema run void_controller.rb -p 6654 -d`
     When I successfully run `trema killall NullController`
     Then virtual links should not exist 
-    And I successfully run `ls`
     And the following files should not exist:
       | NullController.pid |
       | vhost.host1.pid    |
       | vhost.host2.pid    |
     And the following files should exist:
       | VoidController.pid |
-  
-  @sudo
-  Scenario: killall --all
-    When I successfully run `trema killall --all`
-    Then virtual links should not exist 
-    And the following files should not exist:
-      | NullController.pid |
-      | VoidController.pid |
-      | vhost.host1.pid    |
-      | vhost.host2.pid    |
 
   @sudo
-  Scenario: killall NO_SUCH_NAME
+  Scenario: "Controller process does not exist" error
     When I run `trema killall NO_SUCH_NAME`
     Then the exit status should not be 0
     And the output should contain:

data/features/trema_killall/socket_dir_option.feature

@@ -0,0 +1,38 @@
+Feature: -S (--socket_dir) option
+
+  -S (--socket_dir) option specifies the location to find socket files
+
+  @sudo
+  Scenario: -S option
+    Given a file named "null_controller.rb" with:
+      """ruby
+      class NullController < Trema::Controller; end
+      """
+    And I successfully run `trema run null_controller.rb -d`
+    When I successfully run `trema killall NullController -S .`
+    And the file "NullController.pid" should not exist
+
+  @sudo
+  Scenario: --socket_dir option
+    Given a file named "null_controller.rb" with:
+      """ruby
+      class NullController < Trema::Controller; end
+      """
+    And I successfully run `trema run null_controller.rb -d`
+    When I successfully run `trema killall NullController --socket_dir .`
+    And the file "NullController.pid" should not exist
+
+  @sudo
+  Scenario: "Controller process does not exist" error
+    Given a file named "null_controller.rb" with:
+      """ruby
+      class NullController < Trema::Controller; end
+      """
+    And I successfully run `trema run null_controller.rb -d`
+    When I run `trema killall NullController -S /tmp`
+    Then the exit status should not be 0
+    And the output should contain:
+    """
+    Controller process "NullController" does not exist.
+    """
+    And the file "NullController.pid" should exist

data/features/trema_run/README.md

@@ -0,0 +1,5 @@
+`trema run` command runs a trema application (controller).
+
+```
+trema [global options] run [command options] controller
+```

data/features/trema_run/conf_option.feature

@@ -0,0 +1,66 @@
+Feature: -c (--conf) option
+
+  -c (--conf) option specifies emulated network configuration
+
+  Background:
+    Given a file named "hello.rb" with:
+      """ruby
+      class Hello < Trema::Controller
+        def switch_ready(dpid)
+          logger.info format('Hello %s!', dpid.to_hex)
+        end
+      end
+      """
+    And a file named "trema.conf" with:
+      """ruby
+      vswitch { datapath_id 0xabc }
+      """
+
+  @sudo
+  Scenario: -c option
+    When I successfully run `trema run hello.rb -c trema.conf -d`
+    And I run `sleep 5`
+    Then the file "Hello.log" should contain "Hello 0xabc!"
+
+  @sudo
+  Scenario: --conf option
+    When I successfully run `trema run hello.rb --conf trema.conf -d`
+    And I run `sleep 5`
+    Then the file "Hello.log" should contain "Hello 0xabc!"
+
+  @sudo
+  Scenario: "No such file" error
+    When I run `trema run hello.rb -c nosuchfile -d`
+    Then the exit status should not be 0
+    And the stderr should contain:
+      """
+      No such file
+      """
+
+  @sudo
+  Scenario: NameError
+    Given a file named "invalid_trema.conf" with:
+      """
+      Foo Bar Baz
+      """
+    And a file named "null_controller.rb" with:
+      """ruby
+      class NullController < Trema::Controller; end
+      """
+    When I run `trema run null_controller.rb -c invalid_trema.conf`
+    Then the exit status should not be 0
+    Then the output should contain "uninitialized constant Phut::Syntax::Baz (NameError)"
+
+  @sudo
+  Scenario: SyntaxError
+    Given a file named "invalid_trema.conf" with:
+      """
+      Today is 19 June 2015
+      """
+    And a file named "null_controller.rb" with:
+      """ruby
+      class NullController < Trema::Controller; end
+      """
+    When I run `trema run null_controller.rb -c invalid_trema.conf`
+    Then the exit status should not be 0
+    And the output should contain "(SyntaxError)"

data/features/trema_run/daemonize_option.feature

@@ -0,0 +1,19 @@
+Feature: -d (--daemonize) option
+
+  -d (--daemonize) runs a controller as a daemon
+
+  Background:
+    Given a file named "null_controller.rb" with:
+      """ruby
+      class NullController < Trema::Controller; end
+      """
+
+  @sudo
+  Scenario: -d option
+    When I successfully run `trema run null_controller.rb -d`
+    Then the command returns immediately
+
+  @sudo
+  Scenario: --daemonize option
+    When I successfully run `trema run null_controller.rb --daemonize`
+    Then the command returns immediately

data/features/trema_run/log_dir_option.feature

@@ -0,0 +1,32 @@
+Feature: -L (--log_dir) option
+
+  -L (--log_dir) option specifies the location to put log files
+
+  Background:
+    Given a file named "null_controller.rb" with:
+      """ruby
+      class NullController < Trema::Controller; end
+      """
+
+  @sudo
+  Scenario: -L option
+    Given a directory named "log"
+    When I successfully run `trema run null_controller.rb -L log -d`
+    And I run `sleep 3`
+    Then a file named "log/NullController.log" should exist
+
+  @sudo
+  Scenario: --log_dir option
+    Given a directory named "log"
+    When I successfully run `trema run null_controller.rb --log_dir log -d`
+    And I run `sleep 3`
+    Then a file named "log/NullController.log" should exist
+
+  @sudo
+  Scenario: "No such directory" error
+    When I run `trema run null_controller.rb -L log -d`
+    Then the exit status should not be 0
+    And the stderr should contain:
+      """
+      No such directory
+      """

data/features/trema_run/logging_level_option.feature

@@ -0,0 +1,30 @@
+Feature: -l (--logging_level) option
+  Background:
+    Given a file named "hello.rb" with:
+      """ruby
+      class Hello < Trema::Controller
+        def start(_args)
+          logger.debug 'Konnichi Wa'
+        end
+      end
+      """
+
+  @sudo
+  Scenario: the default logging level
+    When I trema run "hello.rb"
+    And the file "Hello.log" should not contain "DEBUG -- : Konnichi Wa"
+
+  @sudo
+  Scenario: --logging_level debug
+    When I run `trema run hello.rb --logging_level debug -d`
+    And I run `sleep 3`
+    And the file "Hello.log" should contain "DEBUG -- : Konnichi Wa"
+
+  @sudo
+  Scenario: "Invalid logging level" error
+    When I run `trema run hello.rb --logging_level hoge -d`
+    Then the exit status should not be 0
+    And the stderr should contain:
+      """
+      Invalid logging level: hoge
+      """

data/features/trema_run/openflow13_option.feature

@@ -0,0 +1,39 @@
+Feature: --openflow13 option
+
+  Use --openflow13 option to enable OpenFlow 1.3
+
+  Background:
+    Given a file named "openflow_version.rb" with:
+      """ruby
+      class OpenflowVersion < Trema::Controller
+        def switch_ready(dpid)
+          send_message dpid, Echo::Request.new
+        end
+
+        def echo_reply(dpid, message)
+          logger.info "ofp_version = #{message.ofp_version}"
+        end
+      end
+      """
+    And a file named "trema.conf" with:
+      """ruby
+      vswitch { datapath_id 0xabc }
+      """
+
+  @sudo
+  Scenario: --openflow13 option
+    When I successfully run `trema run openflow_version.rb --openflow13 -c trema.conf -d`
+    And I run `sleep 5`
+    Then the file "OpenflowVersion.log" should contain "ofp_version = 4"
+
+  @sudo
+  Scenario: --no-openflow13 option
+    When I successfully run `trema run openflow_version.rb --no-openflow13 -c trema.conf -d`
+    And I run `sleep 5`
+    Then the file "OpenflowVersion.log" should contain "ofp_version = 1"
+
+  @sudo
+  Scenario: the default OpenFlow version is 1.0
+    When I successfully run `trema run openflow_version.rb -c trema.conf -d`
+    And I run `sleep 5`
+    Then the file "OpenflowVersion.log" should contain "ofp_version = 1"

data/features/trema_run/pid_dir_option.feature

@@ -0,0 +1,32 @@
+Feature: -P (--pid_dir) option
+
+  -P (--pid_dir) option specifies the location to put pid files
+
+  Background:
+    Given a file named "null_controller.rb" with:
+      """ruby
+      class NullController < Trema::Controller; end
+      """
+
+  @sudo
+  Scenario: -P option
+    Given a directory named "pid"
+    When I successfully run `trema run null_controller.rb -P pid -d`
+    And I run `sleep 3`
+    Then a file named "pid/NullController.pid" should exist
+
+  @sudo
+  Scenario: --pid_dir option
+    Given a directory named "pid"
+    When I successfully run `trema run null_controller.rb --pid_dir pid -d`
+    And I run `sleep 3`
+    Then a file named "pid/NullController.pid" should exist
+
+  @sudo
+  Scenario: "No such directory" error
+    When I run `trema run null_controller.rb -P pid -d`
+    Then the exit status should not be 0
+    And the stderr should contain:
+      """
+      No such directory
+      """

data/features/trema_run/port_option.feature

@@ -0,0 +1,32 @@
+Feature: -p (--port) option
+
+  -p (--port) option overrides the default openflow channel port.
+
+  Background:
+    Given a file named "switch_ready.rb" with:
+      """ruby
+      class SwitchReady < Trema::Controller
+        def switch_ready(dpid)
+          logger.info 'connected to port 1234'
+        end
+      end
+      """
+    And a file named "trema.conf" with:
+      """ruby
+      vswitch {
+        datapath_id 0xabc
+        port 1234
+      }
+      """
+
+  @sudo
+  Scenario: -p option
+    When I successfully run `trema run -p 1234 switch_ready.rb -c trema.conf -d`
+    And I run `sleep 5`
+    Then the file "SwitchReady.log" should contain "connected to port 1234"
+
+  @sudo
+  Scenario: --port option
+    When I successfully run `trema run --port 1234 switch_ready.rb -c trema.conf -d`
+    And I run `sleep 5`
+    Then the file "SwitchReady.log" should contain "connected to port 1234"