pio 0.25.0 → 0.26.0

data/lib/pio/open_flow13/features_reply.rb

@@ -4,43 +4,43 @@ require 'pio/open_flow'
 module Pio
   # OpenFlow 1.3 messages
   module OpenFlow13
-    # OpenFlow 1.3 Features Request and Reply message.
+    # Features Request and Reply message.
     class Features
-      # OpenFlow 1.3 Features Reply message.
+      # Features Reply message.
       class Reply < OpenFlow::Message
-        # OpenFlow 1.3 Features Reply message body.
-        class Body < BinData::Record
-          extend OpenFlow::Flags
-
-          flags_32bit(:capabilities,
-                      [:flow_stats,
-                       :table_stats,
-                       :port_stats,
-                       :group_stats,
-                       :NOT_USED,
-                       :ip_reasm,
-                       :queue_stats,
-                       :NOT_USED,
-                       :port_blocked])
-
-          endian :big
-
-          datapath_id :datapath_id
-          uint32 :n_buffers
-          uint8 :n_tables
-          uint8 :auxiliary_id
-          uint16 :padding
-          hide :padding
-          capabilities :capabilities
-          uint32 :reserved
-
-          def length
-            24
+        # Features Reply message format.
+        class Format < BinData::Record
+          # Features Reply message body.
+          class Body < BinData::Record
+            extend OpenFlow::Flags
+
+            flags_32bit(:capabilities,
+                        [:flow_stats,
+                         :table_stats,
+                         :port_stats,
+                         :group_stats,
+                         :NOT_USED,
+                         :ip_reasm,
+                         :queue_stats,
+                         :NOT_USED,
+                         :port_blocked])
+
+            endian :big
+
+            datapath_id :datapath_id
+            uint32 :n_buffers
+            uint8 :n_tables
+            uint8 :auxiliary_id
+            uint16 :padding
+            hide :padding
+            capabilities :capabilities
+            uint32 :reserved
+
+            def length
+              24
+            end
           end
-        end
 
-        # OpenFlow 1.3 Features Reply message format.
-        class Format < BinData::Record
           extend OpenFlow::Format
 
           header version: 4, message_type: 6

data/lib/pio/open_flow13/features_request.rb

@@ -4,11 +4,11 @@ require 'pio/open_flow'
 module Pio
   # OpenFlow 1.3 messages
   module OpenFlow13
-    # OpenFlow 1.3 Features Request and Reply message.
+    # Features Request and Reply message.
     class Features
-      # OpenFlow 1.3 Features Request message.
+      # Features Request message.
       class Request < OpenFlow::Message
-        # OpenFlow 1.3 Features Request message format.
+        # Features Request message format.
         class Format < BinData::Record
           extend OpenFlow::Format
 

data/lib/pio/open_flow13/flow_mod.rb

@@ -69,8 +69,8 @@ module Pio
         count_bytes_remaining :instructions_length
         string :instructions, read_length: :instructions_length
 
-        def set(object)
-          self.instructions = [object].flatten.map(&:to_binary_s).join
+        def set(instructions)
+          self.instructions = Array(instructions).map(&:to_binary_s).join
         end
 
         # rubocop:disable MethodLength

data/lib/pio/open_flow13/goto_table.rb

@@ -1,3 +1,4 @@
+require 'bindata'
 require 'forwardable'
 
 # Base module.
@@ -12,6 +13,7 @@ module Pio
       uint16 :instruction_length, value: 8
       uint8 :table_id
       bit24 :padding
+      hide :padding
     end
 
     def self.read(raw_data)

data/lib/pio/open_flow13/packet_out.rb

@@ -33,7 +33,7 @@ module Pio
         string :padding, length: 6
         actions :actions, length: :actions_length
         string :raw_data,
-               read_length: -> { message_length - 24 - actions_length }
+               read_length: -> { _length - 24 - actions_length }
 
         def length
           10 + padding.length + actions_length + raw_data.length

data/lib/pio/open_flow13/port32.rb

@@ -0,0 +1,21 @@
+require 'pio/open_flow/port'
+
+module Pio
+  module OpenFlow13
+    # Port numbering (32bit).
+    class Port32 < OpenFlow::Port
+      port_size_in_bytes 32
+
+      max_port_number 0xffffffff00
+
+      reserved_ports(in_port: 0xfffffff8,
+                     table: 0xfffffff9,
+                     normal: 0xfffffffa,
+                     flood: 0xfffffffb,
+                     all: 0xfffffffc,
+                     controller: 0xfffffffd,
+                     local: 0xfffffffe,
+                     any: 0xffffffff)
+    end
+  end
+end

data/lib/pio/open_flow13/send_out_port.rb

@@ -1,4 +1,5 @@
 require 'forwardable'
+require 'pio/open_flow13/port32'
 
 # Base module.
 module Pio
@@ -13,7 +14,7 @@ module Pio
 
         uint16 :action_type, value: 0
         uint16 :action_length, value: 16
-        uint32 :port
+        port32 :port
         uint16 :max_length, initial_value: NO_BUFFER
         uint48 :padding
       end
@@ -27,7 +28,7 @@ module Pio
       extend Forwardable
 
       def_delegators :@format, :action_type
-      def_delegators :@format, :action_length
+      def_delegator :@format, :action_length, :length
       def_delegators :@format, :port
       def_delegator :@format, :to_binary_s, :to_binary
 

data/lib/pio/version.rb

@@ -1,5 +1,5 @@
 # Base module.
 module Pio
   # gem version.
-  VERSION = '0.25.0'.freeze
+  VERSION = '0.26.0'.freeze
 end

data/pio.gemspec

@@ -41,23 +41,23 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'guard-rspec', '~> 4.6.4'
   gem.add_development_dependency 'guard-rubocop', '~> 1.2.0'
   gem.add_development_dependency 'rb-fchange', '~> 0.0.6'
-  gem.add_development_dependency 'rb-fsevent', '~> 0.9.5'
+  gem.add_development_dependency 'rb-fsevent', '~> 0.9.6'
   gem.add_development_dependency 'rb-inotify', '~> 0.9.5'
   gem.add_development_dependency 'terminal-notifier-guard', '~> 1.6.4'
 
   # Docs
-  gem.add_development_dependency 'inch', '~> 0.6.3'
+  gem.add_development_dependency 'inch', '~> 0.6.4'
   gem.add_development_dependency 'relish', '~> 0.7.1'
   gem.add_development_dependency 'yard', '~> 0.8.7.6'
 
   # Test
-  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.7'
+  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 'flay', '~> 2.6.1'
   gem.add_development_dependency 'flog', '~> 4.3.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.33.0'
+  gem.add_development_dependency 'rubocop', '~> 0.34.0'
 end

data/spec/pio/open_flow10/enqueue_spec.rb

@@ -2,23 +2,23 @@ require 'pio/open_flow10/enqueue'
 
 describe Pio::Enqueue do
   describe '.new' do
-    context 'with port_number: 1, queue_id: 2' do
-      When(:enqueue) { Pio::Enqueue.new(port_number: 1, queue_id: 2) }
+    context 'with port: 1, queue_id: 2' do
+      When(:enqueue) { Pio::Enqueue.new(port: 1, queue_id: 2) }
 
-      describe '#port_number' do
-        Then { enqueue.port_number == 1 }
+      describe '#port' do
+        Then { enqueue.port == 1 }
       end
 
       describe '#queue_id' do
         Then { enqueue.queue_id == 2 }
       end
 
-      describe '#type' do
-        Then { enqueue.type == 11 }
+      describe '#action_type' do
+        Then { enqueue.action_type == 11 }
       end
 
-      describe '#message_length' do
-        Then { enqueue.message_length == 16 }
+      describe '#length' do
+        Then { enqueue.length == 16 }
       end
 
       describe '#to_binary' do
@@ -26,36 +26,36 @@ describe Pio::Enqueue do
       end
     end
 
-    context 'with port_number: :in_port, queue_id: 2' do
-      When(:enqueue) { Pio::Enqueue.new(port_number: :in_port, queue_id: 2) }
+    context 'with port: :in_port, queue_id: 2' do
+      When(:enqueue) { Pio::Enqueue.new(port: :in_port, queue_id: 2) }
 
-      describe '#port_number' do
-        Then { enqueue.port_number == :in_port }
+      describe '#port' do
+        Then { enqueue.port == :in_port }
       end
     end
 
-    context 'with port_number: :local, queue_id: 2' do
-      When(:enqueue) { Pio::Enqueue.new(port_number: :local, queue_id: 2) }
+    context 'with port: :local, queue_id: 2' do
+      When(:enqueue) { Pio::Enqueue.new(port: :local, queue_id: 2) }
       Then { enqueue == Failure(ArgumentError) }
     end
 
-    context 'with port_number: -1, queue_id: 2' do
-      When(:enqueue) { Pio::Enqueue.new(port_number: -1, queue_id: 2) }
+    context 'with port: -1, queue_id: 2' do
+      When(:enqueue) { Pio::Enqueue.new(port: -1, queue_id: 2) }
       Then { enqueue == Failure(ArgumentError) }
     end
 
-    context 'with port_number: 0xff00, queue_id: 2' do
-      When(:enqueue) { Pio::Enqueue.new(port_number: 0xff00, queue_id: 2) }
+    context 'with port: 0xff00, queue_id: 2' do
+      When(:enqueue) { Pio::Enqueue.new(port: 0xff00, queue_id: 2) }
       Then { enqueue == Failure(ArgumentError) }
     end
 
-    context 'with port_number: 1, queue_id: -2' do
-      When(:enqueue) { Pio::Enqueue.new(port_number: 1, queue_id: -2) }
+    context 'with port: 1, queue_id: -2' do
+      When(:enqueue) { Pio::Enqueue.new(port: 1, queue_id: -2) }
       Then { enqueue == Failure(ArgumentError) }
     end
 
-    context 'with port_number: 1' do
-      When(:enqueue) { Pio::Enqueue.new(port_number: 1) }
+    context 'with port: 1' do
+      When(:enqueue) { Pio::Enqueue.new(port: 1) }
       Then { enqueue == Failure(ArgumentError) }
     end
 

data/spec/pio/open_flow10/error/hello_failed_spec.rb

@@ -0,0 +1,26 @@
+require 'pio/open_flow10/error/hello_failed'
+
+describe Pio::OpenFlow10::Error::HelloFailed do
+  it_should_behave_like('an OpenFlow message',
+                        Pio::OpenFlow10::Error::HelloFailed)
+
+  describe '.new' do
+    When(:hello_failed) { Pio::OpenFlow10::Error::HelloFailed.new(options) }
+
+    context 'with {}' do
+      Given(:options) { {} }
+
+      Then { hello_failed.length == 12 }
+      Then { hello_failed.error_type == :hello_failed }
+      Then { hello_failed.error_code == :incompatible }
+      Then { hello_failed.description == '' }
+    end
+
+    context "with description: 'error description'" do
+      Given(:options) { { description: 'error description' } }
+
+      Then { hello_failed.length == 29 }
+      Then { hello_failed.description == 'error description' }
+    end
+  end
+end

data/spec/pio/open_flow10/flow_mod_spec.rb

@@ -32,7 +32,7 @@ describe Pio::OpenFlow10::FlowMod do
       Then { flow_mod.class == Pio::OpenFlow10::FlowMod }
       Then { flow_mod.ofp_version == 0x1 }
       Then { flow_mod.message_type == 0xe }
-      Then { flow_mod.message_length == 0x50 }
+      Then { flow_mod.length == 0x50 }
       Then { flow_mod.transaction_id == 0x15 }
       Then { flow_mod.xid == 0x15 }
 
@@ -74,8 +74,8 @@ describe Pio::OpenFlow10::FlowMod do
       Then { flow_mod.flags == [:send_flow_rem, :check_overwrap] }
       Then { flow_mod.actions.length == 1 }
       Then { flow_mod.actions[0].is_a? Pio::OpenFlow10::SendOutPort }
-      Then { flow_mod.actions[0].port_number == 2 }
-      Then { flow_mod.actions[0].max_len == 2**16 - 1 }
+      Then { flow_mod.actions[0].port == 2 }
+      Then { flow_mod.actions[0].max_length == 2**16 - 1 }
     end
   end
 
@@ -98,7 +98,7 @@ describe Pio::OpenFlow10::FlowMod do
       Then { flow_mod.class == Pio::OpenFlow10::FlowMod }
       Then { flow_mod.ofp_version == 0x1 }
       Then { flow_mod.message_type == 0xe }
-      Then { flow_mod.message_length == 0x50 }
+      Then { flow_mod.length == 0x50 }
       Then { flow_mod.transaction_id == 0x15 }
       Then { flow_mod.xid == 0x15 }
 
@@ -140,8 +140,8 @@ describe Pio::OpenFlow10::FlowMod do
       Then { flow_mod.flags == [:send_flow_rem, :check_overwrap] }
       Then { flow_mod.actions.length == 1 }
       Then { flow_mod.actions[0].is_a? Pio::OpenFlow10::SendOutPort }
-      Then { flow_mod.actions[0].port_number == 2 }
-      Then { flow_mod.actions[0].max_len == 2**16 - 1 }
+      Then { flow_mod.actions[0].port == 2 }
+      Then { flow_mod.actions[0].max_length == 2**16 - 1 }
 
       context '#to_binary' do
         When(:binary) { flow_mod.to_binary }

data/spec/pio/open_flow10/flow_stats_request_spec.rb

@@ -19,7 +19,7 @@ describe Pio::OpenFlow10::FlowStats::Request do
       Then { flow_stats_request.class == Pio::OpenFlow10::FlowStats::Request }
       Then { flow_stats_request.ofp_version == 1 }
       Then { flow_stats_request.message_type == 16 }
-      Then { flow_stats_request.message_length == 56 }
+      Then { flow_stats_request.length == 56 }
       Then { flow_stats_request.transaction_id == 13 }
       Then { flow_stats_request.xid == 13 }
       Then { flow_stats_request.stats_type == :flow }

data/spec/pio/open_flow10/hello_spec.rb

@@ -1,7 +1,7 @@
 require 'pio/open_flow10/hello'
 
 describe Pio::OpenFlow10::Hello do
-  describe '.new' do
-    it_should_behave_like('an OpenFlow message', Pio::OpenFlow10::Hello)
-  end
+  it_should_behave_like('an OpenFlow message', Pio::OpenFlow10::Hello)
+  it_should_behave_like('an OpenFlow message with no body',
+                        Pio::OpenFlow10::Hello)
 end

data/spec/pio/open_flow10/packet_out_spec.rb

@@ -41,7 +41,7 @@ describe Pio::OpenFlow10::PacketOut do
       Then { result.class == Pio::OpenFlow10::PacketOut }
       Then { result.ofp_version == 0x1 }
       Then { result.message_type == 0xd }
-      Then { result.message_length == 0x58 }
+      Then { result.length == 0x58 }
       Then { result.transaction_id == 0x16 }
       Then { result.xid == 0x16 }
 
@@ -51,8 +51,8 @@ describe Pio::OpenFlow10::PacketOut do
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::OpenFlow10::SendOutPort }
-      Then { result.actions[0].port_number == 2 }
-      Then { result.actions[0].max_len == 2**16 - 1 }
+      Then { result.actions[0].port == 2 }
+      Then { result.actions[0].max_length == 2**16 - 1 }
       Then { result.raw_data.length == 64 }
     end
 
@@ -70,7 +70,7 @@ describe Pio::OpenFlow10::PacketOut do
       Then { result.class == Pio::OpenFlow10::PacketOut }
       Then { result.ofp_version == 0x1 }
       Then { result.message_type == 0xd }
-      Then { result.message_length == 0x58 }
+      Then { result.length == 0x58 }
       Then { result.transaction_id == 0x16 }
       Then { result.xid == 0x16 }
 
@@ -80,8 +80,8 @@ describe Pio::OpenFlow10::PacketOut do
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::OpenFlow10::SendOutPort }
-      Then { result.actions[0].port_number == 2 }
-      Then { result.actions[0].max_len == 2**16 - 1 }
+      Then { result.actions[0].port == 2 }
+      Then { result.actions[0].max_length == 2**16 - 1 }
       Then { result.raw_data.length == 64 }
     end
 
@@ -113,7 +113,7 @@ describe Pio::OpenFlow10::PacketOut do
 
       Then { result.ofp_version == 0x1 }
       Then { result.message_type == 0xd }
-      Then { result.message_length == 0x58 }
+      Then { result.length == 0x58 }
       Then { result.transaction_id == 0x16 }
       Then { result.xid == 0x16 }
 
@@ -123,8 +123,8 @@ describe Pio::OpenFlow10::PacketOut do
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::OpenFlow10::SendOutPort }
-      Then { result.actions[0].port_number == 2 }
-      Then { result.actions[0].max_len == 2**16 - 1 }
+      Then { result.actions[0].port == 2 }
+      Then { result.actions[0].max_length == 2**16 - 1 }
       Then { result.raw_data.length == 64 }
 
       context '#to_binary' do
@@ -145,7 +145,7 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.message_length == 0x58 }
+      Then { result.length == 0x58 }
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::SetVlanVid }
@@ -163,7 +163,7 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.message_length == 0x58 }
+      Then { result.length == 0x58 }
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::SetVlanPriority }
@@ -181,45 +181,45 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.message_length == 0x58 }
+      Then { result.length == 0x58 }
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::StripVlanHeader }
     end
 
-    context 'with a SetEtherSourceAddr action' do
+    context 'with a SetEtherSourceAddress action' do
       When(:user_options) do
         {
           transaction_id: 0x16,
           buffer_id: 0xffffffff,
           in_port: 0xffff,
-          actions: Pio::SetEtherSourceAddr.new('11:22:33:44:55:66'),
+          actions: Pio::SetEtherSourceAddress.new('11:22:33:44:55:66'),
           raw_data: data_dump
         }
       end
 
-      Then { result.message_length == 0x60 }
+      Then { result.length == 0x60 }
       Then { result.actions_len == 0x10 }
       Then { result.actions.length == 1 }
-      Then { result.actions[0].is_a? Pio::SetEtherSourceAddr }
+      Then { result.actions[0].is_a? Pio::SetEtherSourceAddress }
       Then { result.actions[0].mac_address == '11:22:33:44:55:66' }
     end
 
-    context 'with a SetEtherDestinationAddr action' do
+    context 'with a SetEtherDestinationAddress action' do
       When(:user_options) do
         {
           transaction_id: 0x16,
           buffer_id: 0xffffffff,
           in_port: 0xffff,
-          actions: Pio::SetEtherDestinationAddr.new('11:22:33:44:55:66'),
+          actions: Pio::SetEtherDestinationAddress.new('11:22:33:44:55:66'),
           raw_data: data_dump
         }
       end
 
-      Then { result.message_length == 0x60 }
+      Then { result.length == 0x60 }
       Then { result.actions_len == 0x10 }
       Then { result.actions.length == 1 }
-      Then { result.actions[0].is_a? Pio::SetEtherDestinationAddr }
+      Then { result.actions[0].is_a? Pio::SetEtherDestinationAddress }
       Then { result.actions[0].mac_address == '11:22:33:44:55:66' }
     end
 
@@ -234,7 +234,7 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.message_length == 0x58 }
+      Then { result.length == 0x58 }
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::SetIpSourceAddress }
@@ -252,7 +252,7 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.message_length == 0x58 }
+      Then { result.length == 0x58 }
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::SetIpDestinationAddress }
@@ -270,7 +270,7 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.message_length == 0x58 }
+      Then { result.length == 0x58 }
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::SetIpTos }
@@ -288,11 +288,11 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.message_length == 0x58 }
+      Then { result.length == 0x58 }
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::SetTransportSourcePort }
-      Then { result.actions[0].port_number == 100 }
+      Then { result.actions[0].port == 100 }
     end
 
     context 'with a SetTransportDestinationPort action' do
@@ -306,11 +306,11 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.message_length == 0x58 }
+      Then { result.length == 0x58 }
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::SetTransportDestinationPort }
-      Then { result.actions[0].port_number == 100 }
+      Then { result.actions[0].port == 100 }
     end
 
     context 'with a Enqueue action' do
@@ -319,16 +319,16 @@ describe Pio::OpenFlow10::PacketOut do
           transaction_id: 0x16,
           buffer_id: 0xffffffff,
           in_port: 0xffff,
-          actions: Pio::Enqueue.new(port_number: 1, queue_id: 2),
+          actions: Pio::Enqueue.new(port: 1, queue_id: 2),
           raw_data: data_dump
         }
       end
 
-      Then { result.message_length == 0x60 }
+      Then { result.length == 0x60 }
       Then { result.actions_len == 0x10 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::Enqueue }
-      Then { result.actions[0].port_number == 1 }
+      Then { result.actions[0].port == 1 }
       Then { result.actions[0].queue_id == 2 }
     end
 
@@ -344,12 +344,12 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.message_length == 0x60 }
+      Then { result.length == 0x60 }
       Then { result.actions_len == 0x10 }
       Then { result.actions.length == 2 }
       Then { result.actions[0].is_a? Pio::OpenFlow10::SendOutPort }
-      Then { result.actions[0].port_number == 2 }
-      Then { result.actions[0].max_len == 2**16 - 1 }
+      Then { result.actions[0].port == 2 }
+      Then { result.actions[0].max_length == 2**16 - 1 }
       Then { result.actions[1].is_a? Pio::SetVlanVid }
       Then { result.actions[1].vlan_id == 10 }
     end