trema 0.5.1 → 0.6.0

data/features/trema_run/run.feature

@@ -0,0 +1,83 @@
+Feature: run
+  @sudo
+  Scenario: run controller_file
+    Given a file named "hello.rb" with:
+      """ruby
+      class Hello < Trema::Controller
+        def start(_args)
+          logger.info 'Hello'
+        end
+      end
+      """
+    When I run `trema run hello.rb` interactively
+    Then I stop the command if stdout contains:
+      """
+      Hello
+      """
+
+  @sudo
+  Scenario: "No controller class is defined" error
+    Given a file named "empty.rb" with:
+      """
+      """
+    When I trema run "empty.rb"
+    Then the exit status should not be 0
+    And the stderr should contain:
+      """
+      No controller class is defined.
+      """
+
+  @sudo
+  Scenario: SyntaxError
+    Given a file named "invalid_ruby.rb" with:
+      """
+      Today is 13 March 2015
+      """
+    When I run `trema run invalid_ruby.rb`
+    And the exit status should not be 0
+    Then the output should contain "(SyntaxError)"
+
+  @sudo
+  Scenario: NameError
+    Given a file named "invalid_ruby.rb" with:
+      """ruby
+      class InvalidRuby < Trema::Controller
+        Foo
+        Bar
+        Baz
+      end
+      """
+    When I run `trema run invalid_ruby.rb`
+    Then the exit status should not be 0
+    And the output should contain "uninitialized constant InvalidRuby::Foo (NameError)"
+
+  @sudo
+  Scenario: RuntimeError
+    Given a file named "start_fail.rb" with:
+      """ruby
+      class StartFail < Trema::Controller
+        def start(_args)
+          fail 'bang!'
+        end
+      end
+      """
+    When I run `trema run start_fail.rb`
+    Then the exit status should not be 0
+    And the output should contain "bang! (RuntimeError)"
+
+  @sudo
+  Scenario: cleanup on failure
+    Given a file named "switch_ready_fail.rb" with:
+      """ruby
+      class SwitchReadyFail < Trema::Controller
+        def switch_ready(_dpid)
+          fail 'bang!'
+        end
+      end
+      """
+    When I run `trema -v run switch_ready_fail.rb -c trema.conf`
+    Then virtual links should not exist 
+    And the following files should not exist:
+      | SwitchReadyFail.pid    |
+      | vhost.host1.pid        |
+      | vhost.host2.pid        |

data/features/trema_run/socket_dir_option.feature

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

data/features/trema_start/README.md

@@ -0,0 +1,5 @@
+`trema start` starts the stopped vswitch or vhost again.
+
+```
+trema [global options] start [command options] name
+```

data/features/trema_start/socket_dir_option.feature

@@ -0,0 +1,9 @@
+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

data/features/{trema_start.feature → trema_start/start.feature}

@@ -1,34 +1,34 @@
-Feature: trema start command
+Feature: start
   Background:
-    Given I set the environment variables to:
-      | variable         | value |
-      | TREMA_LOG_DIR    | .     |
-      | TREMA_PID_DIR    | .     |
-      | TREMA_SOCKET_DIR | .     |
-    And a file named "switch_ready_controller.rb" with:
-      """
+    Given a file named "switch_ready_controller.rb" with:
+      """ruby
       class SwitchReadyController < Trema::Controller
+        def start(_args)
+          @switch_ready_invoked = 0
+        end
+
         def switch_ready(dpid)
-          if @reconnect
+          if @switch_ready_invoked > 0
             logger.info "Switch #{dpid.to_hex} connected again."
           else
             logger.info "Switch #{dpid.to_hex} connected."
-            @reconnect = true
           end
+          @switch_ready_invoked += 1
         end
       end
       """
     And a file named "trema.conf" with:
-      """
+      """ruby
       vswitch { datapath_id 0xabc }
       vhost('host1') { ip '192.168.0.1' }
       link '0xabc', 'host1'
       """
-    And I run `trema run switch_ready_controller.rb -c trema.conf -d`
+    And I successfully run `trema run switch_ready_controller.rb -c trema.conf -d`
 
   @sudo
-  Scenario: trema stop and start switch_name
+  Scenario: stop and start a switch
     Given I successfully run `trema stop 0xabc`
+    And I successfully run `sleep 3`
     When I successfully run `trema start 0xabc`
     And I successfully run `sleep 10`
     Then the file "SwitchReadyController.log" should contain:
@@ -37,16 +37,15 @@ Feature: trema start command
       """
 
   @sudo
-  Scenario: trema stop and start host_name
+  Scenario: stop and start host_name
     Given I successfully run `trema stop host1`
     And I successfully run `sleep 3`
     When I successfully run `trema start host1`
     And I successfully run `sleep 10`
-    Then the following files should exist:
-      | vhost.host1.pid |
+    Then the file named "vhost.host1.pid" should exist
 
   @sudo
-  Scenario: start switch_name (already running)
+  Scenario: "Open vSwitch is already running" error
     When I run `trema start 0xabc`
     Then the exit status should not be 0
     And the output should contain:
@@ -54,16 +53,16 @@ Feature: trema start command
       error: Open vSwitch (dpid = 2748) is already running!
       """
 
-  @sudo
-  Scenario: start host_name (already running)
+  @sudo @wip
+  Scenario: "vswitch is already running" error
     When I run `trema start host1`
     Then the exit status should not be 0
-    # And the output should contain:
-    #   """
-    #   error: vhost "host1" is already running!
-    #   """
+    And the output should contain:
+      """
+      error: vhost "host1" is already running!
+      """
 
-  @sudo
+  @sudo @announce-output
   Scenario: start NO_SUCH_NAME
     When I run `trema start NO_SUCH_NAME`
     Then the exit status should not be 0

data/features/trema_stop/README.md

@@ -0,0 +1,5 @@
+`trema stop` stops a vswitch or a vhost.
+
+```
+trema [global options] stop [command options] name
+```

data/features/trema_stop/socket_dir_option.feature

@@ -0,0 +1,9 @@
+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

data/features/{trema_stop.feature → trema_stop/stop.feature}

@@ -1,12 +1,7 @@
-Feature: trema stop command
+Feature: stop
   Background:
-    Given I set the environment variables to:
-      | variable         | value |
-      | TREMA_LOG_DIR    | .     |
-      | TREMA_PID_DIR    | .     |
-      | TREMA_SOCKET_DIR | .     |
-    And a file named "switch_disconnected_controller.rb" with:
-      """
+    Given a file named "switch_disconnected_controller.rb" with:
+      """ruby
       class SwitchDisconnectedController < Trema::Controller
         def switch_disconnected(dpid)
           logger.info "Switch #{dpid.to_hex} is disconnected."
@@ -14,7 +9,7 @@ Feature: trema stop command
       end
       """
     And a file named "trema.conf" with:
-      """
+      """ruby
       vswitch { datapath_id 0xabc }
 
       vhost('host1') { ip '192.168.0.1' }
@@ -23,10 +18,10 @@ Feature: trema stop command
       link '0xabc', 'host1'
       link '0xabc', 'host2'
       """
-    And I run `trema run switch_disconnected_controller.rb -c trema.conf -d`
+    And I trema run "switch_disconnected_controller.rb" with the configuration "trema.conf"
 
   @sudo
-  Scenario: stop switch_name
+  Scenario: stop a switch
     When I successfully run `trema stop 0xabc`
     And I successfully run `sleep 10`
     Then the file "SwitchDisconnectedController.log" should contain:
@@ -35,7 +30,7 @@ Feature: trema stop command
       """
 
   @sudo
-  Scenario: stop host_name
+  Scenario: stop a host
     When I successfully run `trema stop host1`
     And I successfully run `sleep 5`
     Then the file "vhost.host1.pid" should not exist

data/lib/trema/command.rb

@@ -1,6 +1,8 @@
 require 'English'
 
 module Trema
+  class InvalidLoggingLevel < StandardError; end
+
   # trema command
   # rubocop:disable ClassLength
   class Command
@@ -21,8 +23,19 @@ module Trema
       @args = args
       @daemon = options[:daemonize]
 
-      Controller.logging_level =
-        options[:verbose] ? ::Logger::DEBUG : ::Logger::INFO
+      begin
+        Controller.logging_level =
+          { debug: ::Logger::DEBUG,
+            info: ::Logger::INFO,
+            warn: ::Logger::WARN,
+            error: ::Logger::ERROR,
+            fatal: ::Logger::FATAL }.fetch(options[:logging_level].to_sym)
+        Controller.logging_level = ::Logger::DEBUG if options[:verbose]
+      rescue KeyError
+        raise(InvalidLoggingLevel,
+              "Invalid logging level: #{options[:logging_level]}")
+      end
+
       $LOAD_PATH.unshift File.expand_path(File.dirname(@args.first))
       load @args.first
       port_number = (options[:port] || Controller::DEFAULT_TCP_PORT).to_i

data/lib/trema/controller.rb

@@ -7,6 +7,8 @@ require 'trema/logger'
 require 'trema/monkey_patch/integer'
 
 module Trema
+  class NoControllerDefined < StandardError; end
+
   # The base class of Trema controller. Subclass and override handlers
   # to implement a custom OpenFlow controller.
   #
@@ -134,7 +136,9 @@ module Trema
 
     # @private
     def self.create(port_number = DEFAULT_TCP_PORT)
-      fail 'No controller class is defined.' unless @controller_klass
+      unless @controller_klass
+        fail NoControllerDefined, 'No controller class is defined.'
+      end
       @controller_klass.new(port_number)
     end
 
@@ -268,8 +272,16 @@ module Trema
     end
 
     def create_and_register_new_switch(socket)
-      switch = Switch.new(socket).init
+      switch = Switch.new(socket)
+      switch.init
       SWITCH[switch.datapath_id] = switch
+    rescue Switch::InitError
+      error_message = switch.error_message
+      case error_message
+      when OpenFlow10::Error::HelloFailed, OpenFlow13::Error::HelloFailed
+        maybe_send_handler :hello_failed, error_message
+        raise $ERROR_INFO
+      end
     end
 
     def unregister_switch(datapath_id)
@@ -309,6 +321,8 @@ module Trema
         else
           fail "Invalid Port Status message: #{message.inspect}"
         end
+      when Barrier::Reply
+        maybe_send_handler :barrier_reply, datapath_id, message
       else
         fail "Unknown OpenFlow message: #{message.inspect}"
       end

data/lib/trema/switch.rb

@@ -3,6 +3,10 @@ require 'pio'
 module Trema
   # OpenFlow switch.
   class Switch
+    attr_reader :error_message
+
+    class InitError < StandardError; end
+
     include Pio
 
     OPENFLOW_HEADER_LENGTH = 8
@@ -35,51 +39,46 @@ module Trema
     private
 
     def exchange_hello_messages
-      fail 'Failed to exchange Hello messages' unless read.is_a?(Hello)
       write Hello.new
+      expect_receiving Hello
     end
 
     def exchange_echo_messages
       write Echo::Request.new
-      loop do
-        message = read
-        if message.is_a?(Echo::Reply)
-          break
-        else
-          handle_early message 'Failed to exchange Echo messages'
-        end
-      end
+      expect_receiving Echo::Reply
     end
 
     def exchange_features_messages
       write Features::Request.new
+      @features_reply = expect_receiving(Features::Reply)
+    end
+
+    # rubocop:disable MethodLength
+    def expect_receiving(expected_message_klass)
       loop do
         message = read
-        if message.is_a?(Features::Reply)
-          @features_reply = message
-          break
+        case message
+        when expected_message_klass
+          return message
+        when Echo::Request
+          write Echo::Reply.new(xid: message.xid)
+        when PacketIn, PortStatus # , FlowRemoved (not implemented yet)
+          return
+        when OpenFlow10::Error::HelloFailed, OpenFlow13::Error::HelloFailed
+          @error_message = message
+          fail InitError, message.description
         else
-          handle_early message 'Failed to exchange Features messages'
+          fail "Failed to receive #{expected_message_klass} message"
         end
       end
     end
-
-    def handle_early(message, fail_message)
-      case message
-      when Echo::Request
-        write Echo::Reply.new xid: message.xid
-      when PacketIn, FlowRemoved, PortStatus
-        return
-      else
-        fail fail_message
-      end
-    end
+    # rubocop:enable MethodLength
 
     def read_openflow_binary
       header_binary = drain(OPENFLOW_HEADER_LENGTH)
       header = OpenFlowHeaderParser.read(header_binary)
-      body_binary = drain(header.message_length - OPENFLOW_HEADER_LENGTH)
-      fail if (header_binary + body_binary).length != header.message_length
+      body_binary = drain(header.length - OPENFLOW_HEADER_LENGTH)
+      fail if (header_binary + body_binary).length != header.length
       header_binary + body_binary
     end
 

data/lib/trema/version.rb

@@ -1,5 +1,5 @@
 # Base module.
 module Trema
   # gem version.
-  VERSION = '0.5.1'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/trema.gemspec

@@ -22,21 +22,22 @@ Gem::Specification.new do |gem|
   gem.test_files = `git ls-files -- {spec,features}/*`.split("\n")
 
   gem.add_dependency 'bundler', '~> 1.10.6'
-  gem.add_dependency 'gli', '~> 2.13.1'
-  gem.add_dependency 'phut', '~> 0.6.6'
-  gem.add_dependency 'pio', '~> 0.24.1'
+  gem.add_dependency 'gli', '~> 2.13.2'
+  gem.add_dependency 'phut', '~> 0.6.9'
+  gem.add_dependency 'pio', '~> 0.26.0'
   gem.add_dependency 'rake'
 
   # Docs
+  gem.add_development_dependency 'relish', '~> 0.7.1'
   gem.add_development_dependency 'yard', '~> 0.8.7.6'
 
   # Test
-  gem.add_development_dependency 'aruba', '~> 0.8.1'
-  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.7'
+  gem.add_development_dependency 'aruba', '~> 0.9.0'
+  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.8'
   gem.add_development_dependency 'coveralls', '~> 0.8.2'
   gem.add_development_dependency 'cucumber', '~> 2.0.2'
-  gem.add_development_dependency 'reek', '~> 3.1'
+  gem.add_development_dependency 'reek', '~> 3.3.1'
   gem.add_development_dependency 'rspec', '~> 3.3.0'
   gem.add_development_dependency 'rspec-given', '~> 3.7.1'
-  gem.add_development_dependency 'rubocop', '~> 0.32.1'
+  gem.add_development_dependency 'rubocop', '~> 0.34.0'
 end