trema 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a874485c89ec22dec27a4ff7445ef1226f19ab44
-  data.tar.gz: c42a5dae78876b28a2ac924a11cb62ed46e8e882
+  metadata.gz: e5a54d5f3f28b9407ad3aed3e47fa43e8621461d
+  data.tar.gz: 0332b19bd8cc1398160035511eb9dffb6db6e851
 SHA512:
-  metadata.gz: 1aedce74834ac14034d4c71e0d0da7d2459b3555a8b3fe2f0db7b991e64849f7b21b95c6513955621325a2bca2efdcdb972a8b031a31aa01dd39fdc1141a5087
-  data.tar.gz: 060fe0e12cda2aad5c7e4b0509f075a9019d5f1671398be129bc964ea205c6ea3d83159b4771c40549be4d796a3d7cb9ca53ba31a4530129330918701a162f2a
+  metadata.gz: f8c3a5b57a185fac024176c8de07cc62c1a0cf5aeb3e3d67b9a77d7ab0682fc50d9888013f49ab5f02cb14b50867f881e7f5c9140a846ecc38a831f16b3d2987
+  data.tar.gz: 336e7e1f50e16562713547e4e2c43bd9b7d23219125e49e171aae0c630d8eac9134873dd23623c69bf84a6aa30f020803496b5d8b8945e38bb49b2735ffbafd0

data/CHANGELOG.md

@@ -3,6 +3,13 @@
 ## develop (unreleased)
 
 
+## 0.6.0 (9/9/2015)
+### New features
+* [#398](https://github.com/trema/trema/pull/398): Add `Trema::Controller#barrier_reply` handler.
+* [#400](https://github.com/trema/trema/pull/400): Add `Trema::Controller#hello_failed` handler.
+* [#404](https://github.com/trema/trema/pull/404): Add `--logging_level` option to trema run command.
+
+
 ## 0.5.1 (8/4/2015)
 ### Bugs fixed
 * [#396](https://github.com/trema/trema/issues/396): `send_flow_mod_add` doesn't allow `:idle_timeout` and `:hard_timeout` options.

data/Rakefile

@@ -1,3 +1,5 @@
+RELISH_PROJECT = 'trema/trema'
+
 task default: [:test, :quality]
 task test: [:spec, :cucumber]
 task quality: [:rubocop, :reek]

data/bin/trema

@@ -8,8 +8,6 @@ require 'pio'
 require 'rake'
 require 'trema'
 
-ENV['GLI_DEBUG'] = 'true'
-
 # OpenFlow controller framework.
 module Trema
   # trema command.
@@ -37,6 +35,9 @@ module Trema
       c.desc 'Overrides the default openflow channel port'
       c.flag [:p, :port]
 
+      c.desc 'Set logging level'
+      c.flag [:l, :logging_level], default_value: :info
+
       c.desc 'Location to put pid files'
       c.flag [:P, :pid_dir], default_value: Trema::DEFAULT_PID_DIR
       c.desc 'Location to put log files'
@@ -234,6 +235,20 @@ module Trema
 
     default_command :help
 
+    on_error do |e|
+      case e
+      when OptionParser::ParseError,
+        Trema::NoControllerDefined,
+        Trema::InvalidLoggingLevel,
+        Phut::OpenVswitch::AlreadyRunning,
+        GLI::UnknownCommandArgument
+        true
+      else
+        # show backtrace
+        fail e
+      end
+    end
+
     exit run(ARGV)
   end
 end

data/cucumber.yml

@@ -0,0 +1,7 @@
+<%
+std_opts = "--format progress features --tags ~@wip --no-source -r features"
+wip_opts = "--color -r features --tags @wip"
+%>
+default: <%= std_opts %>
+wip: --wip <%= wip_opts %> features
+none: --format pretty

data/features/.nav

@@ -0,0 +1,47 @@
+- trema_run (trema run command):
+  - run.feature (basic usage)
+  - log_dir_option.feature
+  - pid_dir_option.feature
+  - socket_dir_option.feature
+  - conf_option.feature
+  - daemonize_option.feature
+  - logging_level_option.feature
+  - openflow13_option.feature
+  - port_option.feature
+
+- trema_killall (trema killall command):
+  - killall.feature (basic usage)
+  - all_option.feature
+  - socket_dir_option.feature
+
+- trema_start (trema start command):
+  - start.feature (basic usage)
+  - socket_dir_option.feature
+
+- trema_stop (trema stop command):
+  - stop.feature (basic usage)
+  - socket_dir_option.feature
+
+- trema_delete_link (trema delete_link command):
+  - delete_link.feature (basic usage)
+  - socket_dir_option.feature
+
+- logger:
+  - debug.feature
+  - info.feature
+  - warn.feature
+  - error.feature
+  - fatal.feature
+
+- api (controller API):
+  - logging.feature
+  - send_flow_mod_add.feature
+
+- handlers:
+  - start.feature
+  - echo_reply.feature
+  - switch_ready.feature
+  - switch_disconnected.feature
+  - packet_in.feature
+  - barrier_reply.feature
+  - hello_failed.feature

data/features/{logging.feature → api/logging.feature}

@@ -1,11 +1,4 @@
 Feature: logging
-  Background:
-    Given I set the environment variables to:
-      | variable         | value |
-      | TREMA_LOG_DIR    | .     |
-      | TREMA_PID_DIR    | .     |
-      | TREMA_SOCKET_DIR | .     |
-
   @sudo
   Scenario: controller, vhost and vswitch creates log files
     Given a file named "hello.rb" with:
@@ -48,6 +41,7 @@ Feature: logging
       | NullController.log     |
       | vhost.host1.log        |
 
+  @sudo
   Scenario: run multiple controllers, and each have its own log file
     Given a file named "two_controllers.rb" with:
       """

data/features/{send_flow_mod_add.feature → api/send_flow_mod_add.feature}

@@ -1,11 +1,6 @@
-Feature: Controller#send_flow_mod_add
+Feature: send_flow_mod_add
   Background:
-    Given I set the environment variables to:
-      | variable         | value |
-      | TREMA_LOG_DIR    | .     |
-      | TREMA_PID_DIR    | .     |
-      | TREMA_SOCKET_DIR | .     |
-    And a file named "trema.conf" with:
+    Given a file named "trema.conf" with:
       """
       vswitch { datapath_id 0xabc }
       """

data/features/handlers/barrier_reply.feature

@@ -0,0 +1,30 @@
+Feature: barrier_reply handler
+  Background:
+    Given a file named "barrier_reply.rb" with:
+      """ruby
+      class BarrierReply < Trema::Controller
+        def switch_ready(dpid)
+          send_message dpid, Barrier::Request.new
+        end
+
+        def barrier_reply(dpid, message)
+          logger.info 'barrier_reply handler is invoked'
+        end
+      end
+      """
+    And a file named "trema.conf" with:
+      """ruby
+      vswitch { datapath_id 0xabc }
+      """
+
+  @sudo
+  Scenario: invoke barrier_reply handler
+    Given I use OpenFlow 1.0
+    When I trema run "barrier_reply.rb" with the configuration "trema.conf"
+    Then the file "BarrierReply.log" should contain "barrier_reply handler is invoked"
+
+  @sudo @wip
+  Scenario: invoke barrier_reply handler
+    Given I use OpenFlow 1.3
+    When I trema run "barrier_reply.rb" with the configuration "trema.conf"
+    Then the file "BarrierReply.log" should contain "barrier_reply handler is invoked"

data/features/{echo_reply_handler.feature → handlers/echo_reply.feature}

@@ -1,15 +1,7 @@
-Feature: Trema::Controller#echo_reply handler
+Feature: echo_reply handler
   Background:
-    Given I set the environment variables to:
-      | variable         | value |
-      | TREMA_LOG_DIR    | .     |
-      | TREMA_PID_DIR    | .     |
-      | TREMA_SOCKET_DIR | .     |
-
-  @sudo
-  Scenario: the default port
     Given a file named "echo_reply.rb" with:
-      """
+      """ruby
       class EchoReply < Trema::Controller
         def switch_ready(dpid)
           send_message dpid, Echo::Request.new
@@ -21,9 +13,18 @@ Feature: Trema::Controller#echo_reply handler
       end
       """
     And a file named "trema.conf" with:
-      """
+      """ruby
       vswitch { datapath_id 0xabc }
       """
-    When I successfully run `trema -v run echo_reply.rb -c trema.conf -d`
-    And I run `sleep 5`
+
+  @sudo
+  Scenario: invoke echo_reply handler
+    Given I use OpenFlow 1.0
+    When I trema run "echo_reply.rb" with the configuration "trema.conf"
+    Then the file "EchoReply.log" should contain "echo_reply handler is invoked"
+
+  @sudo
+  Scenario: invoke echo_reply handler (OpenFlow 1.3)
+    Given I use OpenFlow 1.3
+    When I trema run "echo_reply.rb" with the configuration "trema.conf"
     Then the file "EchoReply.log" should contain "echo_reply handler is invoked"

data/features/handlers/hello_failed.feature

@@ -0,0 +1,56 @@
+Feature: hello_failed handler
+  Background:
+    Given a file named "hello_fails.rb" with:
+      """ruby
+      require 'version_mismatch'
+
+      class HelloFails < Trema::Controller
+        def hello_failed(message)
+          logger.info 'Hello failed.'
+        end
+      end
+      """
+    And a file named "trema.conf" with:
+      """ruby
+      vswitch { datapath_id 0xabc }
+      """
+
+  @sudo
+  Scenario: invoke hello_failed handler
+    Given I use OpenFlow 1.0
+    And a file named "version_mismatch.rb" with:
+      """ruby
+      module Trema
+        class Switch
+          private
+
+          # force trema to send Hello1.3 on startup.
+          def exchange_hello_messages
+            write Pio::OpenFlow13::Hello.new
+            expect_receiving Hello
+          end
+        end
+      end
+      """
+    When I trema run "hello_fails.rb" with the configuration "trema.conf"
+    Then the file "HelloFails.log" should contain "Hello failed."
+
+  @sudo
+  Scenario: invoke hello_failed handler (OpenFlow 1.3)
+    Given I use OpenFlow 1.3
+    And a file named "version_mismatch.rb" with:
+      """ruby
+      module Trema
+        class Switch
+          private
+
+          # force trema to send Hello1.0 on startup.
+          def exchange_hello_messages
+            write Pio::OpenFlow10::Hello.new
+            expect_receiving Hello
+          end
+        end
+      end
+      """
+    When I trema run "hello_fails.rb" with the configuration "trema.conf"
+    Then the file "HelloFails.log" should contain "Hello failed."

data/features/handlers/packet_in.feature

@@ -0,0 +1,32 @@
+Feature: packet_in handler
+  Background:
+    Given a file named "packet_in_controller.rb" with:
+      """ruby
+      class PacketInController < Trema::Controller
+        def packet_in(dpid, message)
+          logger.info "new packet_in (dpid = #{dpid.to_hex})"
+        end
+      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'
+      """
+
+  @sudo
+  Scenario: invoke packet_in handler
+    Given I successfully run `trema run packet_in_controller.rb -c trema.conf -d`
+    And I successfully run `sleep 3`
+    When I successfully run `trema send_packets --source host1 --dest host2`
+    Then the file "PacketInController.log" should contain "new packet_in (dpid = 0xabc)"
+
+  @sudo
+  Scenario: invoke packet_in handler (OpenFlow 1.3)
+    Given I successfully run `trema run packet_in_controller.rb -c trema.conf --openflow13 -d`
+    And I successfully run `sleep 3`
+    When I successfully run `trema send_packets --source host1 --dest host2`
+    Then the file "PacketInController.log" should contain "new packet_in (dpid = 0xabc)"

data/features/handlers/start.feature

@@ -0,0 +1,31 @@
+Feature: start handler
+  Background:
+    Given a file named "hello.rb" with:
+      """ruby
+      class Hello < Trema::Controller
+        def start(args)
+          logger.info "args = [#{args.join(', ')}]"
+        end
+      end
+      """
+
+  @sudo
+  Scenario: invoke start handler
+    When I successfully run `trema run hello.rb -d`
+    Then the file "Hello.log" should contain "args = []"
+
+  @sudo
+  Scenario: invoke start handler with args
+    When I successfully run `trema run hello.rb -d -- arg0 arg1 arg2`
+    Then the file "Hello.log" should contain "args = [arg0, arg1, arg2]"
+
+  @sudo
+  Scenario: invoke start handler (OpenFlow 1.3)
+    When I successfully run `trema run hello.rb --openflow13 -d`
+    Then the file "Hello.log" should contain "args = []"
+
+  @sudo
+  Scenario: invoke start handler with args (OpenFlow 1.3)
+    When I successfully run `trema run hello.rb --openflow13 -d -- arg0 arg1 arg2`
+    Then the file "Hello.log" should contain "args = [arg0, arg1, arg2]"
+

data/features/handlers/switch_disconnected.feature

@@ -0,0 +1,34 @@
+Feature: switch_disconnected handler
+  Background:
+    Given a file named "switch_disconnected.rb" with:
+      """ruby
+      class SwitchDisconnected < Trema::Controller
+        def switch_disconnected(dpid)
+          logger.info "Switch #{dpid.to_hex} is disconnected."
+        end
+      end
+      """
+    And a file named "trema.conf" with:
+      """ruby
+      vswitch { datapath_id 0xabc }
+      """
+
+  @sudo
+  Scenario: invoke switch_disconnected handler
+    Given I use OpenFlow 1.0
+    And I trema run "switch_disconnected.rb" with the configuration "trema.conf"
+    When I successfully run `trema stop 0xabc`
+    Then the file "SwitchDisconnected.log" should contain:
+      """
+      Switch 0xabc is disconnected.
+      """
+
+  @sudo
+  Scenario: invoke switch_disconnected handler (OpenFlow 1.3)
+    Given I use OpenFlow 1.3
+    And I trema run "switch_disconnected.rb" with the configuration "trema.conf"
+    When I successfully run `trema stop 0xabc`
+    Then the file "SwitchDisconnected.log" should contain:
+      """
+      Switch 0xabc is disconnected.
+      """

data/features/handlers/switch_ready.feature

@@ -0,0 +1,26 @@
+Feature: switch_ready handler
+  Background:
+    Given a file named "switch_ready.rb" with:
+      """ruby
+      class SwitchReady < 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: invoke switch_ready handler
+    Given I use OpenFlow 1.0
+    When I trema run "switch_ready.rb" with the configuration "trema.conf"
+    Then the file "SwitchReady.log" should contain "Hello 0xabc!"
+
+  @sudo
+  Scenario: invoke switch_ready handler (OpenFlow 1.3)
+    Given I use OpenFlow 1.3
+    When I trema run "switch_ready.rb" with the configuration "trema.conf"
+    Then the file "SwitchReady.log" should contain "Hello 0xabc!"

data/features/logger/debug.feature

@@ -0,0 +1,41 @@
+Feature: Trema::Controller#logger.debug
+  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" interactively
+    And I trema killall "Hello"
+    Then the output should not contain "Konnichi Wa"
+    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` interactively
+    And I run `sleep 3`
+    And I trema killall "Hello"
+    Then the output should contain "Konnichi Wa"
+    And the file "Hello.log" should contain "DEBUG -- : Konnichi Wa"
+
+  @sudo
+  Scenario: -v
+    When I run `trema -v run hello.rb` interactively
+    And I run `sleep 3`
+    And I trema killall "Hello"
+    Then the output should contain "Konnichi Wa"
+    And the file "Hello.log" should contain "DEBUG -- : Konnichi Wa"
+
+  @sudo
+  Scenario: --verbose
+    When I run `trema --verbose run hello.rb` interactively
+    And I run `sleep 3`
+    And I trema killall "Hello"
+    Then the output should contain "Konnichi Wa"
+    And the file "Hello.log" should contain "DEBUG -- : Konnichi Wa"

data/features/logger/error.feature

@@ -0,0 +1,41 @@
+Feature: Trema::Controller#logger.error
+  Background:
+    Given a file named "hello.rb" with:
+      """ruby
+      class Hello < Trema::Controller
+        def start(_args)
+          logger.error 'Konnichi Wa'
+        end
+      end
+      """
+
+  @sudo
+  Scenario: the default logging level
+    When I trema run "hello.rb" interactively
+    And I trema killall "Hello"
+    Then the output should contain "Konnichi Wa"
+    And the file "Hello.log" should contain "ERROR -- : Konnichi Wa"
+
+  @sudo
+  Scenario: --logging_level error
+    When I run `trema run hello.rb --logging_level error` interactively
+    And I run `sleep 3`
+    And I trema killall "Hello"
+    Then the output should contain "Konnichi Wa"
+    And the file "Hello.log" should contain "ERROR -- : Konnichi Wa"
+
+  @sudo
+  Scenario: -v
+    When I run `trema -v run hello.rb` interactively
+    And I run `sleep 3`
+    And I trema killall "Hello"
+    Then the output should contain "Konnichi Wa"
+    And the file "Hello.log" should contain "ERROR -- : Konnichi Wa"
+
+  @sudo
+  Scenario: --verbose
+    When I run `trema --verbose run hello.rb` interactively
+    And I run `sleep 3`
+    And I trema killall "Hello"
+    Then the output should contain "Konnichi Wa"
+    And the file "Hello.log" should contain "ERROR -- : Konnichi Wa"

data/features/logger/fatal.feature

@@ -0,0 +1,41 @@
+Feature: Trema::Controller#logger.fatal
+  Background:
+    Given a file named "hello.rb" with:
+      """ruby
+      class Hello < Trema::Controller
+        def start(_args)
+          logger.fatal 'Konnichi Wa'
+        end
+      end
+      """
+
+  @sudo
+  Scenario: the default logging level
+    When I trema run "hello.rb" interactively
+    And I trema killall "Hello"
+    Then the output should contain "Konnichi Wa"
+    And the file "Hello.log" should contain "FATAL -- : Konnichi Wa"
+
+  @sudo
+  Scenario: --logging_level fatal
+    When I run `trema run hello.rb --logging_level fatal` interactively
+    And I run `sleep 3`
+    And I trema killall "Hello"
+    Then the output should contain "Konnichi Wa"
+    And the file "Hello.log" should contain "FATAL -- : Konnichi Wa"
+
+  @sudo
+  Scenario: -v
+    When I run `trema -v run hello.rb` interactively
+    And I run `sleep 3`
+    And I trema killall "Hello"
+    Then the output should contain "Konnichi Wa"
+    And the file "Hello.log" should contain "FATAL -- : Konnichi Wa"
+
+  @sudo
+  Scenario: --verbose
+    When I run `trema --verbose run hello.rb` interactively
+    And I run `sleep 3`
+    And I trema killall "Hello"
+    Then the output should contain "Konnichi Wa"
+    And the file "Hello.log" should contain "FATAL -- : Konnichi Wa"

data/features/logger/info.feature

@@ -0,0 +1,41 @@
+Feature: Trema::Controller#logger.info
+  Background:
+    Given a file named "hello.rb" with:
+      """ruby
+      class Hello < Trema::Controller
+        def start(_args)
+          logger.info 'Konnichi Wa'
+        end
+      end
+      """
+
+  @sudo
+  Scenario: the default logging level
+    When I trema run "hello.rb" interactively
+    And I trema killall "Hello"
+    Then the output should contain "Konnichi Wa"
+    And the file "Hello.log" should contain "INFO -- : Konnichi Wa"
+
+  @sudo
+  Scenario: --logging_level info
+    When I run `trema run hello.rb --logging_level info` interactively
+    And I run `sleep 3`
+    And I trema killall "Hello"
+    Then the output should contain "Konnichi Wa"
+    And the file "Hello.log" should contain "INFO -- : Konnichi Wa"
+
+  @sudo
+  Scenario: -v
+    When I run `trema -v run hello.rb` interactively
+    And I run `sleep 3`
+    And I trema killall "Hello"
+    Then the output should contain "Konnichi Wa"
+    And the file "Hello.log" should contain "INFO -- : Konnichi Wa"
+
+  @sudo
+  Scenario: --verbose
+    When I run `trema --verbose run hello.rb` interactively
+    And I run `sleep 3`
+    And I trema killall "Hello"
+    Then the output should contain "Konnichi Wa"
+    And the file "Hello.log" should contain "INFO -- : Konnichi Wa"

data/features/logger/warn.feature

@@ -0,0 +1,41 @@
+Feature: Trema::Controller#logger.warn
+  Background:
+    Given a file named "hello.rb" with:
+      """ruby
+      class Hello < Trema::Controller
+        def start(_args)
+          logger.warn 'Konnichi Wa'
+        end
+      end
+      """
+
+  @sudo
+  Scenario: the default logging level
+    When I trema run "hello.rb" interactively
+    And I trema killall "Hello"
+    Then the output should contain "Konnichi Wa"
+    And the file "Hello.log" should contain "WARN -- : Konnichi Wa"
+
+  @sudo
+  Scenario: --logging_level warn
+    When I run `trema run hello.rb --logging_level warn` interactively
+    And I run `sleep 3`
+    And I trema killall "Hello"
+    Then the output should contain "Konnichi Wa"
+    And the file "Hello.log" should contain "WARN -- : Konnichi Wa"
+
+  @sudo
+  Scenario: -v
+    When I run `trema -v run hello.rb` interactively
+    And I run `sleep 3`
+    And I trema killall "Hello"
+    Then the output should contain "Konnichi Wa"
+    And the file "Hello.log" should contain "WARN -- : Konnichi Wa"
+
+  @sudo
+  Scenario: --verbose
+    When I run `trema --verbose run hello.rb` interactively
+    And I run `sleep 3`
+    And I trema killall "Hello"
+    Then the output should contain "Konnichi Wa"
+    And the file "Hello.log" should contain "WARN -- : Konnichi Wa"

data/features/step_definitions/README.txt

@@ -0,0 +1,2 @@
+A collection of step definitions for use with Trema and Trema apps.
+These steps are highly specific to Trema.

data/features/step_definitions/dump_flows_steps.rb

@@ -0,0 +1,13 @@
+# rubocop:disable LineLength
+
+Then(/^the switch "(.*?)" has (\d+) flow entr(?:y|ies)$/) do |switch, num_entries|
+  command = "trema dump_flows #{switch} -S."
+  step "I run `#{command}`"
+  expect(output_from(command).split("\n").size - 1).to eq(num_entries.to_i)
+end
+
+Then(/^the switch "(.*?)" has no flow entry$/) do |switch|
+  step %(the switch "#{switch}" has 0 flow entry)
+end
+
+# rubocop:enable LineLength