pio 0.27.1 → 0.27.2

data/lib/pio/open_flow13/hello.rb

@@ -1,8 +1,6 @@
 require 'pio/open_flow'
 
-# Base module.
 module Pio
-  # OpenFlow 1.0 messages
   module OpenFlow13
     # OpenFlow 1.3 Hello message parser and generator
     class Hello < OpenFlow::Message
@@ -43,40 +41,38 @@ module Pio
         end
       end
 
-      # OpenFlow 1.3 Hello message format
-      class Format < BinData::Record
-        extend OpenFlow::Format
+      open_flow_header version: 4, message_type: 0
+      body :body
 
-        header version: 4, message_type: 0
-        body :body
+      def elements
+        body.elements
+      end
 
-        def supported_versions
-          supported_versions_list.map do |each|
-            "open_flow1#{each - 1}".to_sym
-          end
+      def supported_versions
+        supported_versions_list.map do |each|
+          "open_flow1#{each - 1}".to_sym
         end
+      end
 
-        private
+      private
 
-        def supported_versions_list
-          (1..32).each_with_object([]) do |each, result|
-            result << each if (version_bitmap >> each & 1) == 1
-          end
+      def supported_versions_list
+        (1..32).each_with_object([]) do |each, result|
+          result << each if (version_bitmap >> each & 1) == 1
         end
+      end
 
-        def version_bitmap
-          bitmap = elements.detect(&:version_bitmap?)
-          bitmap ? bitmap.element_value : 0
-        end
+      def version_bitmap
+        bitmap = elements.detect(&:version_bitmap?)
+        bitmap ? bitmap.element_value : 0
       end
 
       def initialize(user_options = {})
         validate_user_options user_options
-        header_options = parse_header_options(user_options)
         body_options = { elements: [{ element_type: VERSION_BITMAP,
                                       element_length: 8,
                                       element_value: 0b10000 }] }
-        @format = Format.new(header: header_options, body: body_options)
+        @format = Format.new(user_options.merge(body: body_options))
       end
     end
   end

data/lib/pio/open_flow13/packet_in.rb

@@ -2,7 +2,6 @@ require 'pio/open_flow'
 require 'pio/open_flow13/match'
 require 'pio/parser'
 
-# Base module.
 module Pio
   module OpenFlow13
     # OpenFlow 1.3 PacketIn message parser and generator
@@ -23,53 +22,36 @@ module Pio
         end
       end
 
-      # OpenFlow 1.3 PacketIn message body
-      class Body < BinData::Record
-        endian :big
-
-        uint32 :buffer_id
-        uint16 :total_len, initial_value: -> { raw_data.length }
-        reason :reason
-        uint8 :table_id
-        uint64 :cookie
-        oxm :match
-        string :padding, length: 2
-        hide :padding
-        string :raw_data, read_length: :total_len
-
-        def length
-          16 + match.length + padding.length + raw_data.length
-        end
-
-        def data
-          @data ||= Pio::Parser.read(raw_data)
-        end
-
-        def in_port
-          match.in_port
-        end
-
-        def method_missing(method, *args)
-          data.__send__(method, *args).snapshot
-        end
+      open_flow_header(version: 4,
+                       message_type: 10,
+                       message_length: lambda do
+                         24 + match.length + padding.length + raw_data.length
+                       end)
+      uint32 :buffer_id
+      uint16 :total_len, initial_value: -> { raw_data.length }
+      reason :reason
+      uint8 :table_id
+      uint64 :cookie
+      oxm :match
+      string :padding, length: 2
+      hide :padding
+      string :raw_data, read_length: :total_len
+
+      attr_accessor :datapath_id
+      alias_method :dpid, :datapath_id
+      alias_method :dpid=, :datapath_id=
+
+      def data
+        @data ||= Pio::Parser.read(raw_data)
       end
 
-      # OpenFlow 1.3 PacketIn message format
-      class Format < BinData::Record
-        extend OpenFlow::Format
-
-        header version: 4, message_type: 10
-        body :body
-
-        attr_accessor :datapath_id
-        alias_method :dpid, :datapath_id
-        alias_method :dpid=, :datapath_id=
+      def in_port
+        match.in_port
       end
 
-      body_option :buffer_id
-      body_option :in_port
-      body_option :reason
-      body_option :raw_data
+      def method_missing(method, *args)
+        data.__send__(method, *args).snapshot
+      end
     end
   end
 end

data/lib/pio/open_flow13/packet_out.rb

@@ -2,7 +2,6 @@ require 'pio/open_flow'
 require 'pio/open_flow13/actions'
 require 'pio/open_flow13/buffer_id'
 
-# Base module.
 module Pio
   module OpenFlow13
     # OpenFlow 1.3 PacketOut message parser and generator
@@ -23,43 +22,25 @@ module Pio
         end
       end
 
-      # OpenFlow 1.3 PacketOut message body
-      class Body < BinData::Record
-        endian :big
-
-        buffer_id :buffer_id
-        in_port :in_port
-        uint16 :actions_length, initial_value: -> { actions.binary.length }
-        string :padding, length: 6
-        actions :actions, length: :actions_length
-        string :raw_data,
-               read_length: -> { _length - 24 - actions_length }
-
-        def length
-          10 + padding.length + actions_length + raw_data.length
-        end
-
-        def data
-          @data ||= Pio::Parser.read(raw_data)
-        end
-
-        def method_missing(method, *args)
-          data.__send__(method, *args).snapshot
-        end
+      open_flow_header(version: 4,
+                       message_type: 13,
+                       message_length: lambda do
+                         24 + actions_length + raw_data.length
+                       end)
+      buffer_id :buffer_id
+      in_port :in_port
+      uint16 :actions_length, initial_value: -> { actions.binary.length }
+      string :padding, length: 6
+      actions :actions, length: :actions_length
+      string :raw_data, read_length: -> { message_length - 24 - actions_length }
+
+      def data
+        @data ||= Pio::Parser.read(raw_data)
       end
 
-      # OpenFlow 1.3 PacketOut message body
-      class Format < BinData::Record
-        extend OpenFlow::Format
-
-        header version: 4, message_type: 13
-        body :body
+      def method_missing(method, *args)
+        data.__send__(method, *args).snapshot
       end
-
-      body_option :buffer_id
-      body_option :in_port
-      body_option :actions
-      body_option :raw_data
     end
   end
 end

data/lib/pio/open_flow13/stats_request.rb

@@ -27,27 +27,11 @@ module Pio
         end
       end
 
-      # OpenFlow 1.3 Stats Request message body
-      class Body < BinData::Record
-        endian :big
-
-        stats_type :stats_type
-        uint16 :stats_flags
-
-        def length
-          4
-        end
-      end
-
-      # OpenFlow 1.3 Stats Request message format
-      class Format < BinData::Record
-        extend OpenFlow::Format
-
-        header version: 4, message_type: 16
-        body :body
-      end
-
-      body_option :stats_type
+      open_flow_header version: 4,
+                       message_type: 16,
+                       message_length: 12
+      stats_type :stats_type
+      uint16 :stats_flags
     end
   end
 end

data/lib/pio/parser.rb

@@ -5,12 +5,13 @@ module Pio
   # Raw data parser.
   class Parser
     # Ethernet header parser
-    class EtherTypeParser < BinData::Record
+    class EthernetFrame < BinData::Record
       endian :big
 
       mac_address :destination_mac
       mac_address :source_mac
       uint16 :ether_type
+      rest :rest
     end
 
     # IPv4 packet parser
@@ -30,8 +31,8 @@ module Pio
 
     # rubocop:disable MethodLength
     def self.read(raw_data)
-      ethernet_header = EtherTypeParser.read(raw_data)
-      case ethernet_header.ether_type
+      ethernet_frame = EthernetFrame.read(raw_data)
+      case ethernet_frame.ether_type
       when EthernetHeader::EtherType::IPV4, EthernetHeader::EtherType::VLAN
         IPv4Packet.read raw_data
       when EthernetHeader::EtherType::ARP
@@ -39,7 +40,7 @@ module Pio
       when EthernetHeader::EtherType::LLDP
         Pio::Lldp.read raw_data
       else
-        fail 'Failed to parse packet_in data.'
+        ethernet_frame
       end
     end
     # rubocop:enable MethodLength

data/lib/pio/version.rb

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

data/pio.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'bundler', '~> 1.10.6'
-  gem.add_development_dependency 'pry', '~> 0.10.1'
+  gem.add_development_dependency 'pry', '~> 0.10.3'
 
   # Guard
   gem.add_development_dependency 'guard', '~> 2.13.0'
@@ -46,18 +46,18 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'terminal-notifier-guard', '~> 1.6.4'
 
   # Docs
-  gem.add_development_dependency 'inch', '~> 0.6.4'
+  gem.add_development_dependency 'inch', '~> 0.7.0'
   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.8'
-  gem.add_development_dependency 'coveralls', '~> 0.8.2'
-  gem.add_development_dependency 'cucumber', '~> 2.0.2'
+  gem.add_development_dependency 'coveralls', '~> 0.8.3'
+  gem.add_development_dependency 'cucumber', '~> 2.1.0'
   gem.add_development_dependency 'flay', '~> 2.6.1'
   gem.add_development_dependency 'flog', '~> 4.3.2'
-  gem.add_development_dependency 'reek', '~> 3.3.1'
+  gem.add_development_dependency 'reek', '~> 3.5.0'
   gem.add_development_dependency 'rspec', '~> 3.3.0'
   gem.add_development_dependency 'rspec-given', '~> 3.7.1'
-  gem.add_development_dependency 'rubocop', '~> 0.34.0'
+  gem.add_development_dependency 'rubocop', '~> 0.34.2'
 end

data/spec/pio/open_flow10/{echo_reply_spec.rb → echo/reply_spec.rb}

@@ -1,4 +1,4 @@
-require 'pio/open_flow10/echo'
+require 'pio/open_flow10/echo/reply'
 
 describe Pio::OpenFlow10::Echo::Reply do
   describe '.new' do

data/spec/pio/open_flow10/{echo_request_spec.rb → echo/request_spec.rb}

@@ -1,4 +1,4 @@
-require 'pio/open_flow10/echo'
+require 'pio/open_flow10/echo/request'
 
 describe Pio::OpenFlow10::Echo::Request do
   describe '.new' do

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

@@ -10,7 +10,7 @@ describe Pio::OpenFlow10::Error::HelloFailed do
     context 'with {}' do
       Given(:options) { {} }
 
-      Then { hello_failed.length == 12 }
+      Then { hello_failed.message_length == 12 }
       Then { hello_failed.error_type == :hello_failed }
       Then { hello_failed.error_code == :incompatible }
       Then { hello_failed.description == '' }
@@ -19,7 +19,7 @@ describe Pio::OpenFlow10::Error::HelloFailed do
     context "with description: 'error description'" do
       Given(:options) { { description: 'error description' } }
 
-      Then { hello_failed.length == 29 }
+      Then { hello_failed.message_length == 29 }
       Then { hello_failed.description == 'error description' }
     end
   end

data/spec/pio/open_flow10/features/request_spec.rb

@@ -4,10 +4,5 @@ describe Pio::OpenFlow10::Features::Request do
   describe '.new' do
     it_should_behave_like('an OpenFlow message',
                           Pio::OpenFlow10::Features::Request)
-
-    context "with body: 'abcde'" do
-      When(:message) { Pio::OpenFlow10::Features::Request.new(body: 'abcde') }
-      Then { message == Failure(RuntimeError, 'Unknown option: body') }
-    end
   end
 end

data/spec/pio/open_flow10/flow_mod_spec.rb

@@ -32,11 +32,10 @@ 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.length == 0x50 }
+      Then { flow_mod.message_length == 0x50 }
       Then { flow_mod.transaction_id == 0x15 }
       Then { flow_mod.xid == 0x15 }
 
-      Then { !flow_mod.body.empty? }
       Then do
         flow_mod.match.wildcards.keys == [
           :vlan_vid,
@@ -98,11 +97,10 @@ 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.length == 0x50 }
+      Then { flow_mod.message_length == 0x50 }
       Then { flow_mod.transaction_id == 0x15 }
       Then { flow_mod.xid == 0x15 }
 
-      Then { !flow_mod.body.empty? }
       Then do
         flow_mod.match.wildcards.keys == [
           :vlan_vid,

data/spec/pio/open_flow10/flow_stats_reply_spec.rb

@@ -1,4 +1,4 @@
-require 'pio/open_flow10/flow_stats_reply'
+require 'pio/open_flow10/flow_stats/reply'
 
 describe Pio::OpenFlow10::FlowStats::Reply do
   describe '.read' do

data/spec/pio/open_flow10/flow_stats_request_spec.rb

@@ -1,4 +1,4 @@
-require 'pio/open_flow10/flow_stats_request'
+require 'pio/open_flow10/flow_stats/request'
 
 describe Pio::OpenFlow10::FlowStats::Request do
   describe '.read' do
@@ -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.length == 56 }
+      Then { flow_stats_request.message_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/packet_out_spec.rb

@@ -41,11 +41,10 @@ describe Pio::OpenFlow10::PacketOut do
       Then { result.class == Pio::OpenFlow10::PacketOut }
       Then { result.ofp_version == 0x1 }
       Then { result.message_type == 0xd }
-      Then { result.length == 0x58 }
+      Then { result.message_length == 0x58 }
       Then { result.transaction_id == 0x16 }
       Then { result.xid == 0x16 }
 
-      Then { !result.body.empty? }
       Then { result.buffer_id == 0xffffffff }
       Then { result.in_port == 0xffff }
       Then { result.actions_len == 0x8 }
@@ -70,11 +69,10 @@ describe Pio::OpenFlow10::PacketOut do
       Then { result.class == Pio::OpenFlow10::PacketOut }
       Then { result.ofp_version == 0x1 }
       Then { result.message_type == 0xd }
-      Then { result.length == 0x58 }
+      Then { result.message_length == 0x58 }
       Then { result.transaction_id == 0x16 }
       Then { result.xid == 0x16 }
 
-      Then { !result.body.empty? }
       Then { result.buffer_id == 0xffffffff }
       Then { result.in_port == 0xffff }
       Then { result.actions_len == 0x8 }
@@ -113,11 +111,10 @@ describe Pio::OpenFlow10::PacketOut do
 
       Then { result.ofp_version == 0x1 }
       Then { result.message_type == 0xd }
-      Then { result.length == 0x58 }
+      Then { result.message_length == 0x58 }
       Then { result.transaction_id == 0x16 }
       Then { result.xid == 0x16 }
 
-      Then { !result.body.empty? }
       Then { result.buffer_id == 0xffffffff }
       Then { result.in_port == 0xffff }
       Then { result.actions_len == 0x8 }
@@ -145,7 +142,7 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.length == 0x58 }
+      Then { result.message_length == 0x58 }
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::SetVlanVid }
@@ -163,7 +160,7 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.length == 0x58 }
+      Then { result.message_length == 0x58 }
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::SetVlanPriority }
@@ -181,7 +178,7 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.length == 0x58 }
+      Then { result.message_length == 0x58 }
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::StripVlanHeader }
@@ -198,7 +195,7 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.length == 0x60 }
+      Then { result.message_length == 0x60 }
       Then { result.actions_len == 0x10 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::SetEtherSourceAddress }
@@ -216,7 +213,7 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.length == 0x60 }
+      Then { result.message_length == 0x60 }
       Then { result.actions_len == 0x10 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::SetEtherDestinationAddress }
@@ -234,7 +231,7 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.length == 0x58 }
+      Then { result.message_length == 0x58 }
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::SetIpSourceAddress }
@@ -252,7 +249,7 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.length == 0x58 }
+      Then { result.message_length == 0x58 }
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::SetIpDestinationAddress }
@@ -270,7 +267,7 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.length == 0x58 }
+      Then { result.message_length == 0x58 }
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::SetIpTos }
@@ -288,7 +285,7 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.length == 0x58 }
+      Then { result.message_length == 0x58 }
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::SetTransportSourcePort }
@@ -306,7 +303,7 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.length == 0x58 }
+      Then { result.message_length == 0x58 }
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::SetTransportDestinationPort }
@@ -324,7 +321,7 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.length == 0x60 }
+      Then { result.message_length == 0x60 }
       Then { result.actions_len == 0x10 }
       Then { result.actions.length == 1 }
       Then { result.actions[0].is_a? Pio::Enqueue }
@@ -344,7 +341,7 @@ describe Pio::OpenFlow10::PacketOut do
         }
       end
 
-      Then { result.length == 0x60 }
+      Then { result.message_length == 0x60 }
       Then { result.actions_len == 0x10 }
       Then { result.actions.length == 2 }
       Then { result.actions[0].is_a? Pio::OpenFlow10::SendOutPort }