trema 0.4.8 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48a0af62c781422b77ef3f758b26a3e4b34b2d99
-  data.tar.gz: f58f34df8927027a444dcc26a8f9ead5daa37555
+  metadata.gz: cd254b79f9c14fa501bbd579c616b4a387f2d832
+  data.tar.gz: fbf648fbf79f72498a28fa45d93095042c93a074
 SHA512:
-  metadata.gz: f05fd27d3a5a1f0e78780e32f720d8d17374dc6aa6e5047da2d1af174b66e266a9a2a28f396f60c2821657694a558e8b515455c88651634ca35396e21fb6dd34
-  data.tar.gz: 75c19a12a5dd974a95fe3845b41a0428e8935808bd4cf6937c2deb540a203c284729fde6e4a3665cbd06fccf69a9637effb0a70261a04527eef5db0cc623ebce
+  metadata.gz: 960bf892ff737db25a541bd8b20929d76b4e6103a541fc16fc6c0fb0c7e92f85ffc4ede76bb5ce9558bff7d567b20e6a65cff7eadc8e944bafc407e03ded2af6
+  data.tar.gz: 7d2229720caa81f7f3a9a36b1a4b326e024c724bdea82745d0896fb93205abee59d382f7370c202c133c20b98b42b5e65c4dac7a0876e5a3b4e8c052ebbe23cd

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 ## develop (unreleased)
 
 
+## 0.5.0 (8/2/2015)
+### Changes
+* [#392](https://github.com/trema/trema/pull/392): Allow packet_in, etc during startup.
+
+
 ## 0.4.8 (6/29/2015)
 ### Changes
 * [#384](https://github.com/trema/trema/pull/384): Add trema run --port (-p) option to override the default OpenFlow channel listen port.

data/bin/trema

@@ -4,6 +4,7 @@ $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'drb/drb'
 require 'gli'
 require 'phut'
+require 'pio'
 require 'rake'
 require 'trema'
 
@@ -47,7 +48,7 @@ module Trema
         Phut.pid_dir = options[:pid_dir]
         Phut.log_dir = options[:log_dir]
         Phut.socket_dir = options[:socket_dir]
-        require 'pio/open_flow13' if options[:openflow13]
+        Pio::OpenFlow.switch_version 'OpenFlow13' if options[:openflow13]
         require 'trema/switch'
         Trema::Command.new.run(args, global_options.merge(options))
       end

data/features/echo_reply_handler.feature

@@ -0,0 +1,29 @@
+Feature: Trema::Controller#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:
+      """
+      class EchoReply < Trema::Controller
+        def switch_ready(dpid)
+          send_message dpid, Echo::Request.new
+        end
+
+        def echo_reply(dpid, message)
+          logger.info 'echo_reply handler is invoked'
+        end
+      end
+      """
+    And a file named "trema.conf" with:
+      """
+      vswitch { datapath_id 0xabc }
+      """
+    When I successfully run `trema -v run echo_reply.rb -c trema.conf -d`
+    And I run `sleep 5`
+    Then the file "EchoReply.log" should contain "echo_reply handler is invoked"

data/features/open_flow13.feature

@@ -19,3 +19,32 @@ Feature: OpenFlow1.3
     When I successfully run `trema -v run null_controller.rb --openflow13 -c trema.conf -d`
     And I run `sleep 5`
     Then the output should contain "protocols=OpenFlow13"
+
+  @sudo
+  Scenario: send_flow_mod_add
+    Given a file named "flow_mod_controller.rb" with:
+      """
+      class FlowModController < Trema::Controller
+        def switch_ready(datapath_id)
+          logger.info 'Sending a FlowMod with OpenFlow 1.3 options'
+          send_flow_mod_add(
+            datapath_id,
+            table_id: 0,
+            idle_timeout: 180,
+            flags: [],
+            priority: 1,
+            match: Match.new({}),
+            instructions: []
+          )
+          logger.info 'Sent a FlowMod successfully'
+        end
+      end
+      """
+    And a file named "trema.conf" with:
+      """
+      vswitch { datapath_id 0xabc }
+      """
+    When I successfully run `trema run flow_mod_controller.rb --openflow13 -c trema.conf -d`
+    And I run `sleep 5`
+    Then the file "FlowModController.log" should contain "Sent a FlowMod successfully"
+

data/features/trema_run.feature

@@ -45,3 +45,14 @@ Feature: trema run command
     And I run `sleep 5`
     Then the file "SwitchReady.log" should contain "Hello 0xabc!"
 
+  @sudo
+  Scenario: trema run empty file and error
+    Given a file named "empty.rb" with:
+      """
+      """
+    When I run `trema -v run empty.rb`
+    Then the exit status should not be 0
+    And the stderr should contain:
+      """
+      No controller class is defined.
+      """

data/lib/trema/controller.rb

@@ -21,7 +21,9 @@ module Trema
       def to_hash
         {
           command: :add,
+          priority: @user_options[:priority] || 0,
           transaction_id: rand(0xffffffff),
+          idle_timeout: @user_options[:idle_timeout] || 0,
           hard_timeout: @user_options[:hard_timeout] || 0,
           buffer_id: @user_options[:buffer_id] || 0xffffffff,
           match: @user_options.fetch(:match),
@@ -30,6 +32,35 @@ module Trema
       end
     end
 
+    # Pio::FlowMod.new argument (OpenFlow 1.3)
+    class FlowModAdd13Option
+      def initialize(user_options)
+        @user_options = user_options
+      end
+
+      # rubocop:disable MethodLength
+      # rubocop:disable CyclomaticComplexity
+      # rubocop:disable PerceivedComplexity
+      def to_hash
+        {
+          command: :add,
+          priority: @user_options[:priority] || 0,
+          transaction_id: rand(0xffffffff),
+          idle_timeout: @user_options[:idle_timeout] || 0,
+          hard_timeout: @user_options[:hard_timeout] || 0,
+          buffer_id: @user_options[:buffer_id] || 0xffffffff,
+          match: @user_options.fetch(:match),
+          table_id: @user_options[:table_id] || 0,
+          flags: @user_options[:flags] || [],
+          instructions: @user_options[:instructions] || [],
+          actions: @user_options[:actions] || []
+        }
+      end
+      # rubocop:enable MethodLength
+      # rubocop:enable CyclomaticComplexity
+      # rubocop:enable PerceivedComplexity
+    end
+
     # Pio::FlowMod.new argument
     class FlowModDeleteOption
       def initialize(user_options)
@@ -103,6 +134,7 @@ module Trema
 
     # @private
     def self.create(port_number = DEFAULT_TCP_PORT)
+      fail 'No controller class is defined.' unless @controller_klass
       @controller_klass.new(port_number)
     end
 
@@ -140,7 +172,15 @@ module Trema
     # @!group OpenFlow Message
 
     def send_flow_mod_add(datapath_id, options)
-      flow_mod = FlowMod.new(FlowModAddOption.new(options).to_hash)
+      flow_mod =
+        case Pio::OpenFlow.version
+        when 'OpenFlow10'
+          FlowMod.new(FlowModAddOption.new(options).to_hash)
+        when 'OpenFlow13'
+          FlowMod.new(FlowModAdd13Option.new(options).to_hash)
+        else
+          fail "Unsupported OpenFlow version: #{Pio::OpenFlow.version}"
+        end
       send_message datapath_id, flow_mod
     end
 
@@ -250,6 +290,8 @@ module Trema
       case message
       when Echo::Request
         maybe_send_handler :echo_request, datapath_id, message
+      when Echo::Reply
+        maybe_send_handler :echo_reply, datapath_id, message
       when Features::Reply
         maybe_send_handler :features_reply, datapath_id, message
       when PacketIn

data/lib/trema/switch.rb

@@ -7,15 +7,6 @@ module Trema
 
     OPENFLOW_HEADER_LENGTH = 8
 
-    OPENFLOW_MESSAGE_PARSER = {
-      OpenFlow::HELLO => Hello,
-      OpenFlow::ECHO_REQUEST => Echo::Request,
-      OpenFlow::ECHO_REPLY => Echo::Reply,
-      OpenFlow::FEATURES_REPLY => Features::Reply,
-      OpenFlow::PACKET_IN => PacketIn,
-      OpenFlow::PORT_STATUS => PortStatus
-    }
-
     def initialize(socket)
       @socket = socket
     end
@@ -38,10 +29,7 @@ module Trema
     end
 
     def read
-      message_type, binary = read_openflow_binary
-      OPENFLOW_MESSAGE_PARSER.fetch(message_type).read(binary)
-    rescue KeyError
-      raise "Unknown OpenFlow message (message_type = #{message_type})."
+      OpenFlow.read read_openflow_binary
     end
 
     private
@@ -53,14 +41,38 @@ module Trema
 
     def exchange_echo_messages
       write Echo::Request.new
-      fail 'Failed to exchange Echo messages' unless read.is_a?(Echo::Reply)
+      loop do
+        message = read
+        if message.is_a?(Echo::Reply)
+          break
+        else
+          handle_early message 'Failed to exchange Echo messages'
+        end
+      end
     end
 
     def exchange_features_messages
       write Features::Request.new
-      @features_reply = read
-      return if @features_reply.is_a?(Features::Reply)
-      fail 'Failed to exchange Features messages'
+      loop do
+        message = read
+        if message.is_a?(Features::Reply)
+          @features_reply = message
+          break
+        else
+          handle_early message 'Failed to exchange Features messages'
+        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
 
     def read_openflow_binary
@@ -68,7 +80,7 @@ module Trema
       header = OpenFlowHeaderParser.read(header_binary)
       body_binary = drain(header.message_length - OPENFLOW_HEADER_LENGTH)
       fail if (header_binary + body_binary).length != header.message_length
-      [header.message_type, header_binary + body_binary]
+      header_binary + body_binary
     end
 
     def drain(length)

data/lib/trema/version.rb

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

data/trema.gemspec

@@ -21,22 +21,22 @@ Gem::Specification.new do |gem|
 
   gem.test_files = `git ls-files -- {spec,features}/*`.split("\n")
 
-  gem.add_dependency 'bundler', '~> 1.10.5'
+  gem.add_dependency 'bundler', '~> 1.10.6'
   gem.add_dependency 'gli', '~> 2.13.1'
-  gem.add_dependency 'phut', '~> 0.6.5'
-  gem.add_dependency 'pio', '~> 0.23.0'
+  gem.add_dependency 'phut', '~> 0.6.6'
+  gem.add_dependency 'pio', '~> 0.24.0'
   gem.add_dependency 'rake'
 
   # Docs
   gem.add_development_dependency 'yard', '~> 0.8.7.6'
 
   # Test
-  gem.add_development_dependency 'aruba', '~> 0.6.2'
+  gem.add_development_dependency 'aruba', '~> 0.8.1'
   gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.7'
   gem.add_development_dependency 'coveralls', '~> 0.8.2'
-  gem.add_development_dependency 'cucumber', '~> 2.0.0'
-  gem.add_development_dependency 'reek', '~> 2.2.1'
+  gem.add_development_dependency 'cucumber', '~> 2.0.2'
+  gem.add_development_dependency 'reek', '~> 3.1'
   gem.add_development_dependency 'rspec', '~> 3.3.0'
-  gem.add_development_dependency 'rspec-given', '~> 3.7.0'
+  gem.add_development_dependency 'rspec-given', '~> 3.7.1'
   gem.add_development_dependency 'rubocop', '~> 0.32.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trema
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.5.0
 platform: ruby
 authors:
 - Yasuhito Takamiya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2015-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.10.5
+        version: 1.10.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.10.5
+        version: 1.10.6
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.5
+        version: 0.6.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.5
+        version: 0.6.6
 - !ruby/object:Gem::Dependency
   name: pio
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: 0.24.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: 0.24.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -142,28 +142,28 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.7.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -229,6 +229,7 @@ files:
 - bin/.gitignore
 - bin/trema
 - features/cleanup_on_failure.feature
+- features/echo_reply_handler.feature
 - features/logging.feature
 - features/open_flow13.feature
 - features/step_definitions/.gitignore