pio 0.6.0 → 0.7.0

data/lib/pio/icmp/request.rb

@@ -24,29 +24,45 @@ module Pio
         option :sequence_number
         option :echo_data
 
-        # rubocop:disable MethodLength
-
-        def initialize(options)
-          validate options
+        def initialize(user_options)
           @type = TYPE
-          @source_mac = Mac.new(options[:source_mac]).freeze
-          @destination_mac = Mac.new(options[:destination_mac]).freeze
+
+          @options = user_options.dup
+          validate @options
+          set_mac_and_ip_address_options
+          set_identifier_option
+          set_sequence_number_option
+          set_echo_data_option
+        end
+
+        private
+
+        def set_mac_and_ip_address_options
+          @source_mac = Mac.new(@options[:source_mac]).freeze
+          @destination_mac = Mac.new(@options[:destination_mac]).freeze
           @ip_source_address =
-            IPv4Address.new(options[:ip_source_address]).freeze
+            IPv4Address.new(@options[:ip_source_address]).freeze
           @ip_destination_address =
-            IPv4Address.new(options[:ip_destination_address]).freeze
+            IPv4Address.new(@options[:ip_destination_address]).freeze
+        end
+
+        def set_identifier_option
           @identifier =
-            options[:icmp_identifier] ||
-            options[:identifier] ||
+            @options[:icmp_identifier] ||
+            @options[:identifier] ||
             DEFAULT_IDENTIFIER
+        end
+
+        def set_sequence_number_option
           @sequence_number =
-            options[:icmp_sequence_number] ||
-            options[:sequence_number] ||
+            @options[:icmp_sequence_number] ||
+            @options[:sequence_number] ||
             DEFAULT_SEQUENCE_NUMBER
-          @echo_data = options[:echo_data] || DEFAULT_ECHO_DATA
         end
 
-        # rubocop:enable MethodLength
+        def set_echo_data_option
+          @echo_data = (@options[:echo_data] || DEFAULT_ECHO_DATA).freeze
+        end
       end
     end
   end

data/lib/pio/message_type_selector.rb

@@ -10,13 +10,10 @@ module Pio
     end
 
     def read(raw_data)
-      begin
-        frame = const_get(:Frame).read(raw_data)
-      rescue
-        raise Pio::ParseError, $ERROR_INFO.message
-      end
-
-      const_get(:MESSAGE_TYPE)[frame.message_type].create_from frame
+      parsed = const_get(:Format).read(raw_data)
+      const_get(:MESSAGE_TYPE)[parsed.message_type].create_from parsed
+    rescue
+      raise Pio::ParseError, $ERROR_INFO.message
     end
   end
 end

data/lib/pio/type/ethernet_header.rb

@@ -4,9 +4,7 @@ require 'pio/type/mac_address'
 
 module Pio
   module Type
-    #
     # Adds ethernet_header macro.
-    #
     module EthernetHeader
       def ethernet_header(options)
         class_eval do

data/lib/pio/type/ipv4_header.rb

@@ -8,7 +8,6 @@ module Pio
     module IPv4Header
       # rubocop:disable MethodLength
       def ipv4_header(options)
-        endian :big
         class_eval do
           bit4 :ip_version, initial_value: 0x4
           bit4 :ip_header_length, initial_value: 0x5

data/lib/pio/type/open_flow.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'bindata'
+
+module Pio
+  module Type
+    # OpenFlow 1.0 format.
+    module OpenFlow
+      def openflow_header
+        class_eval do
+          uint8 :version, value: 1
+          uint8 :message_type
+          uint16 :message_length, initial_value: -> { 8 + body.length }
+          uint32 :transaction_id, initial_value: 0
+        end
+      end
+
+      # Description of a physical port
+      class PhyPort < BinData::Record
+        endian :big
+
+        uint16 :port_no
+        uint8 :hw_addr
+        stringz :name, read_length: 16
+        uint32 :config
+        uint32 :state
+        uint32 :curr
+        uint32 :advertised
+        uint32 :supported
+        uint32 :peer
+      end
+    end
+  end
+end

data/lib/pio/type/udp_header.rb

@@ -5,7 +5,6 @@ module Pio
     # UDP Header Format.
     module UdpHeader
       def udp_header(options)
-        endian :big
         class_eval do
           uint16be :udp_src_port
           uint16be :udp_dst_port

data/lib/pio/version.rb

@@ -3,5 +3,5 @@
 # Base module.
 module Pio
   # gem version.
-  VERSION = '0.6.0'.freeze
+  VERSION = '0.7.0'.freeze
 end

data/pio.gemspec

@@ -35,6 +35,6 @@ Gem::Specification.new do |gem|
   gem.test_files += Dir.glob('features/**/*')
 
   gem.required_ruby_version = '>= 1.9.3'
-  gem.add_dependency 'bindata', '~> 2.0.0'
-  gem.add_development_dependency 'bundler', '~> 1.6.0'
+  gem.add_dependency 'bindata', '~> 2.1.0'
+  gem.add_development_dependency 'bundler', '~> 1.6.2'
 end

data/spec/pio/dhcp/ack_spec.rb

@@ -151,7 +151,7 @@ describe Pio::Dhcp::Ack, '.new' do
       end
     end
 
-    context  'with String MAC Address' do
+    context 'with String MAC Address' do
       let(:source_mac) { 'aa:bb:cc:dd:ee:ff' }
       let(:destination_mac) { '11:22:33:44:55:66' }
       let(:ip_source_address) { '192.168.0.10' }

data/spec/pio/dhcp_spec.rb

@@ -152,7 +152,7 @@ describe Pio::Dhcp, '.read' do
     its('client_mac_address.to_s') { should eq '24:db:ac:41:e5:5b' }
     its('client_identifier.to_s') { should eq '24:db:ac:41:e5:5b' }
     its('requested_ip_address.to_s') { should eq '0.0.0.0' }
-    its(:parameters_list) { should eq  [0x01, 0x03, 0x06, 0x2a] }
+    its(:parameters_list) { should eq [0x01, 0x03, 0x06, 0x2a] }
   end
 
   context 'with DHCP offer frame' do
@@ -452,7 +452,7 @@ describe Pio::Dhcp, '.read' do
     its('client_mac_address.to_s') { should eq '24:db:ac:41:e5:5b' }
     its('client_identifier.to_s') { should eq '24:db:ac:41:e5:5b' }
     its('requested_ip_address.to_s') { should eq '192.168.0.10' }
-    its(:parameters_list) { should eq  [0x01, 0x03, 0x06, 0x2a] }
+    its(:parameters_list) { should eq [0x01, 0x03, 0x06, 0x2a] }
   end
 
   context 'with DHCP ACK frame' do

data/spec/pio/echo/reply_spec.rb

@@ -4,17 +4,82 @@ require 'pio'
 
 describe Pio::Echo::Reply do
   describe '.new' do
-    context 'with no additional data' do
-      When(:echo_reply) do
-        Pio::Echo::Reply.new(xid: 123)
+    context 'with no arguments' do
+      When(:echo_reply) { Pio::Echo::Reply.new }
+
+      Then { echo_reply.version == 1 }
+      Then { echo_reply.message_type == Pio::Echo::REPLY }
+      Then { echo_reply.message_length == 8 }
+      Then { echo_reply.transaction_id == 0 }
+      Then { echo_reply.xid == 0 }
+      Then { echo_reply.data == '' }
+      Then { echo_reply.to_binary == [1, 3, 0, 8, 0, 0, 0, 0].pack('C*') }
+    end
+
+    context 'with 123' do
+      When(:echo_reply) { Pio::Echo::Reply.new(123) }
+
+      Then { echo_reply.version == 1 }
+      Then { echo_reply.message_type == Pio::Echo::REPLY }
+      Then { echo_reply.message_length == 8 }
+      Then { echo_reply.transaction_id == 123 }
+      Then { echo_reply.xid == 123 }
+      Then { echo_reply.data == '' }
+      Then { echo_reply.to_binary == [1, 3, 0, 8, 0, 0, 0, 123].pack('C*') }
+    end
+
+    context 'with 2**32' do
+      When(:result) { Pio::Echo::Reply.new(2**32) }
+
+      Then do
+        pending 'check if xid is within 32bit range.'
+        result == Failure(ArgumentError)
       end
+    end
+
+    context 'with transaction_id: 123' do
+      When(:echo_reply) { Pio::Echo::Reply.new(transaction_id: 123) }
 
-      Then { echo_reply.class == Pio::Echo::Reply }
       Then { echo_reply.version == 1 }
       Then { echo_reply.message_type == Pio::Echo::REPLY }
       Then { echo_reply.message_length == 8 }
+      Then { echo_reply.transaction_id == 123 }
       Then { echo_reply.xid == 123 }
       Then { echo_reply.data == '' }
+      Then { echo_reply.to_binary == [1, 3, 0, 8, 0, 0, 0, 123].pack('C*') }
+    end
+
+    context 'with xid: 123' do
+      When(:echo_reply) { Pio::Echo::Reply.new(xid: 123) }
+
+      Then { echo_reply.version == 1 }
+      Then { echo_reply.message_type == Pio::Echo::REPLY }
+      Then { echo_reply.message_length == 8 }
+      Then { echo_reply.transaction_id == 123 }
+      Then { echo_reply.xid == 123 }
+      Then { echo_reply.data == '' }
+      Then { echo_reply.to_binary == [1, 3, 0, 8, 0, 0, 0, 123].pack('C*') }
+    end
+
+    context "with transaction_id: 123, data: 'foobar'" do
+      When(:echo_reply) { Pio::Echo::Reply.new(xid: 123, data: 'foobar') }
+
+      Then { echo_reply.version == 1 }
+      Then { echo_reply.message_type == Pio::Echo::REPLY }
+      Then { echo_reply.message_length == 14 }
+      Then { echo_reply.transaction_id == 123 }
+      Then { echo_reply.xid == 123 }
+      Then { echo_reply.data == 'foobar' }
+      Then do
+        echo_reply.to_binary ==
+          [1, 3, 0, 14, 0, 0, 0, 123, 102, 111, 111, 98, 97, 114].pack('C*')
+      end
+    end
+
+    context 'with :INVALID_ARGUMENT' do
+      When(:result) { Pio::Echo::Reply.new(:INVALID_ARGUMENT) }
+
+      Then { result == Failure(TypeError) }
     end
   end
 end

data/spec/pio/echo/request_spec.rb

@@ -4,44 +4,82 @@ require 'pio'
 
 describe Pio::Echo::Request do
   describe '.new' do
-    Given(:echo_request) do
-      Pio::Echo::Request.new(user_options)
-    end
-
     context 'with no arguments' do
-      When(:user_options) { {} }
+      When(:echo_request) { Pio::Echo::Request.new }
 
-      Then { echo_request.class == Pio::Echo::Request }
       Then { echo_request.version == 1 }
       Then { echo_request.message_type == Pio::Echo::REQUEST }
       Then { echo_request.message_length == 8 }
       Then { echo_request.transaction_id == 0 }
       Then { echo_request.xid == 0 }
       Then { echo_request.data == '' }
+      Then { echo_request.to_binary == [1, 2, 0, 8, 0, 0, 0, 0].pack('C*') }
+    end
+
+    context 'with 123' do
+      When(:echo_request) { Pio::Echo::Request.new(123) }
+
+      Then { echo_request.version == 1 }
+      Then { echo_request.message_type == Pio::Echo::REQUEST }
+      Then { echo_request.message_length == 8 }
+      Then { echo_request.transaction_id == 123 }
+      Then { echo_request.xid == 123 }
+      Then { echo_request.data == '' }
+      Then { echo_request.to_binary == [1, 2, 0, 8, 0, 0, 0, 123].pack('C*') }
+    end
+
+    context 'with 2**32' do
+      When(:result) { Pio::Echo::Request.new(2**32) }
+
+      Then do
+        pending 'check if xid is within 32bit range.'
+        result == Failure(ArgumentError)
+      end
     end
 
     context 'with transaction_id: 123' do
-      When(:user_options) { { transaction_id: 123 } }
+      When(:echo_request) { Pio::Echo::Request.new(transaction_id: 123) }
 
-      Then { echo_request.class == Pio::Echo::Request }
       Then { echo_request.version == 1 }
       Then { echo_request.message_type == Pio::Echo::REQUEST }
       Then { echo_request.message_length == 8 }
       Then { echo_request.transaction_id == 123 }
       Then { echo_request.xid == 123 }
       Then { echo_request.data == '' }
+      Then { echo_request.to_binary == [1, 2, 0, 8, 0, 0, 0, 123].pack('C*') }
     end
 
     context 'with xid: 123' do
-      When(:user_options) { { xid: 123 } }
+      When(:echo_request) { Pio::Echo::Request.new(xid: 123) }
 
-      Then { echo_request.class == Pio::Echo::Request }
       Then { echo_request.version == 1 }
       Then { echo_request.message_type == Pio::Echo::REQUEST }
       Then { echo_request.message_length == 8 }
       Then { echo_request.transaction_id == 123 }
       Then { echo_request.xid == 123 }
       Then { echo_request.data == '' }
+      Then { echo_request.to_binary == [1, 2, 0, 8, 0, 0, 0, 123].pack('C*') }
+    end
+
+    context "with transaction_id: 123, data: 'foobar'" do
+      When(:echo_request) { Pio::Echo::Request.new(xid: 123, data: 'foobar') }
+
+      Then { echo_request.version == 1 }
+      Then { echo_request.message_type == Pio::Echo::REQUEST }
+      Then { echo_request.message_length == 14 }
+      Then { echo_request.transaction_id == 123 }
+      Then { echo_request.xid == 123 }
+      Then { echo_request.data == 'foobar' }
+      Then do
+        echo_request.to_binary ==
+          [1, 2, 0, 14, 0, 0, 0, 123, 102, 111, 111, 98, 97, 114].pack('C*')
+      end
+    end
+
+    context 'with :INVALID_ARGUMENT' do
+      When(:result) { Pio::Echo::Request.new(:INVALID_ARGUMENT) }
+
+      Then { result == Failure(TypeError) }
     end
   end
 end

data/spec/pio/echo_spec.rb

@@ -39,5 +39,13 @@ describe Pio::Echo do
       Then { echo_reply.data == '' }
       Then { echo_reply.to_binary == echo_reply_dump }
     end
+
+    context 'with a Features Request message' do
+      Given(:features_request_dump) { [1, 5, 0, 8, 0, 0, 0, 0].pack('C*') }
+
+      When(:result) { Pio::Echo.read(features_request_dump) }
+
+      Then { result == Failure(Pio::ParseError) }
+    end
   end
 end

data/spec/pio/features/reply_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'pio'
+
+describe Pio::Features::Reply do
+  describe '.new' do
+    Given(:options) do
+      {
+        dpid: 0x123,
+        n_buffers: 0x100,
+        n_tables: 0xfe,
+        capabilities: 0xc7,
+        actions: 0xfff
+      }
+    end
+
+    When(:features_reply) { Pio::Features::Reply.new(options) }
+
+    Then { features_reply.version == 1 }
+    Then { features_reply.message_type == Pio::Features::REPLY }
+    Then { features_reply.transaction_id == 0 }
+    Then { features_reply.xid == 0 }
+    Then { features_reply.dpid == 0x123 }
+    Then { features_reply.n_buffers == 0x100 }
+    Then { features_reply.n_tables == 0xfe }
+    Then { features_reply.capabilities == 0xc7 }
+    Then { features_reply.actions == 0xfff }
+    Then { features_reply.ports == [] }
+  end
+end

data/spec/pio/features/request_spec.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+require 'pio'
+
+describe Pio::Features::Request do
+  describe '.new' do
+    context 'with no arguments' do
+      When(:request) { Pio::Features::Request.new }
+
+      Then { request.version == 1 }
+      Then { request.message_type == Pio::Features::REQUEST }
+      Then { request.message_length == 8 }
+      Then { request.transaction_id == 0 }
+      Then { request.xid == 0 }
+      Then { request.body == '' }
+      Then { request.to_binary == [1, 5, 0, 8, 0, 0, 0, 0].pack('C*') }
+    end
+
+    context 'with 123' do
+      When(:request) { Pio::Features::Request.new(123) }
+
+      Then { request.version == 1 }
+      Then { request.message_type == Pio::Features::REQUEST }
+      Then { request.message_length == 8 }
+      Then { request.transaction_id == 123 }
+      Then { request.xid == 123 }
+      Then { request.body == '' }
+      Then { request.to_binary == [1, 5, 0, 8, 0, 0, 0, 123].pack('C*') }
+    end
+
+    context 'with 2**32' do
+      When(:result) { Pio::Features::Request.new(2**32) }
+
+      Then do
+        pending 'check if xid is within 32bit range.'
+        result == Failure(ArgumentError)
+      end
+    end
+
+    context 'with transaction_id: 123' do
+      When(:request) { Pio::Features::Request.new(transaction_id: 123) }
+
+      Then { request.version == 1 }
+      Then { request.message_type == Pio::Features::REQUEST }
+      Then { request.message_length == 8 }
+      Then { request.transaction_id == 123 }
+      Then { request.xid == 123 }
+      Then { request.body == '' }
+      Then { request.to_binary == [1, 5, 0, 8, 0, 0, 0, 123].pack('C*') }
+    end
+
+    context 'with xid: 123' do
+      When(:request) { Pio::Features::Request.new(xid: 123) }
+
+      Then { request.version == 1 }
+      Then { request.message_type == Pio::Features::REQUEST }
+      Then { request.message_length == 8 }
+      Then { request.transaction_id == 123 }
+      Then { request.xid == 123 }
+      Then { request.body == '' }
+      Then { request.to_binary == [1, 5, 0, 8, 0, 0, 0, 123].pack('C*') }
+    end
+
+    context 'with :INVALID_ARGUMENT' do
+      When(:result) { Pio::Features::Request.new(:INVALID_ARGUMENT) }
+
+      Then { result == Failure(TypeError) }
+    end
+  end
+end