pio 0.10.1 → 0.11.0

data/lib/pio/send_out_port.rb

@@ -1,6 +1,7 @@
 require 'bindata'
 require 'forwardable'
 require 'pio/monkey_patch/integer'
+require 'pio/open_flow/port_number'
 
 module Pio
   # An action to output a packet to a port.

data/lib/pio/type/ip_address.rb

@@ -8,16 +8,11 @@ module Pio
       array :octets, type: :uint8, initial_length: 4
 
       def set(value)
-        case value
-        when String
-          self.octets = value.split('.').map(&:to_i)
-        else
-          self.octets = value
-        end
+        self.octets = IPv4Address.new(value).to_a
       end
 
       def get
-        IPv4Address.new octets.map { |each| format('%d', each) }.join('.')
+        IPv4Address.new(octets.map { |each| format('%d', each) }.join('.'))
       end
 
       def ==(other)

data/lib/pio/version.rb

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

data/pio.gemspec

@@ -37,11 +37,11 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'bindata', '~> 2.1.0'
 
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'bundler', '~> 1.7.11'
+  gem.add_development_dependency 'bundler', '~> 1.7.12'
   gem.add_development_dependency 'pry', '~> 0.10.1'
 
   # Guard
-  gem.add_development_dependency 'guard', '~> 2.10.5'
+  gem.add_development_dependency 'guard', '~> 2.11.1'
   gem.add_development_dependency 'guard-bundler', '~> 2.1.0'
   gem.add_development_dependency 'guard-cucumber', '~> 1.5.3'
   gem.add_development_dependency 'guard-rspec', '~> 4.5.0'
@@ -52,17 +52,17 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'terminal-notifier-guard', '~> 1.6.4'
 
   # Docs
-  gem.add_development_dependency 'inch', '~> 0.5.8'
+  gem.add_development_dependency 'inch', '~> 0.5.10'
   gem.add_development_dependency 'yard', '~> 0.8.7.6'
 
   # Test
-  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.4'
+  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.5'
   gem.add_development_dependency 'coveralls', '~> 0.7.2'
   gem.add_development_dependency 'cucumber', '~> 1.3.18'
-  gem.add_development_dependency 'flay', '~> 2.5.0'
-  gem.add_development_dependency 'flog', '~> 4.3.0'
-  gem.add_development_dependency 'reek', '~> 1.5.1'
+  gem.add_development_dependency 'flay', '~> 2.6.0'
+  gem.add_development_dependency 'flog', '~> 4.3.1'
+  gem.add_development_dependency 'reek', '~> 1.6.2'
   gem.add_development_dependency 'rspec', '~> 3.1.0'
-  gem.add_development_dependency 'rspec-given', '~> 3.5.4'
+  gem.add_development_dependency 'rspec-given', '~> 3.6.0'
   gem.add_development_dependency 'rubocop', '~> 0.28.0'
 end

data/spec/pio/echo/reply_spec.rb

@@ -1,6 +1,34 @@
 require 'pio/echo'
 
 describe Pio::Echo::Reply do
+  describe '.read' do
+    When(:echo_reply) { Pio::Echo::Reply.read(binary) }
+
+    context 'with an echo reply message' do
+      Given(:binary) { [1, 3, 0, 8, 0, 0, 0, 0].pack('C*') }
+
+      Then { echo_reply.ofp_version == 1 }
+      Then { echo_reply.message_type == Pio::OpenFlow::Type::ECHO_REPLY }
+      Then { echo_reply.message_length == 8 }
+      Then { echo_reply.transaction_id == 0 }
+      Then { echo_reply.xid == 0 }
+      Then { echo_reply.user_data.empty? }
+      Then { echo_reply.user_data == '' }
+      Then { echo_reply.body.empty? }
+      Then { echo_reply.body == '' }
+      Then { echo_reply.to_binary == [1, 3, 0, 8, 0, 0, 0, 0].pack('C*') }
+    end
+
+    context 'with a hello message' do
+      Given(:binary) { [1, 0, 0, 8, 0, 0, 0, 0].pack('C*') }
+
+      Then do
+        echo_reply ==
+          Failure(Pio::ParseError, 'Invalid Echo Reply message.')
+      end
+    end
+  end
+
   describe '.new' do
     context 'with no arguments' do
       When(:echo_reply) { Pio::Echo::Reply.new }
@@ -10,7 +38,10 @@ describe Pio::Echo::Reply do
       Then { echo_reply.message_length == 8 }
       Then { echo_reply.transaction_id == 0 }
       Then { echo_reply.xid == 0 }
+      Then { echo_reply.user_data.empty? }
       Then { echo_reply.user_data == '' }
+      Then { echo_reply.body.empty? }
+      Then { echo_reply.body == '' }
       Then { echo_reply.to_binary == [1, 3, 0, 8, 0, 0, 0, 0].pack('C*') }
     end
 
@@ -22,16 +53,13 @@ describe Pio::Echo::Reply do
       Then { echo_reply.message_length == 8 }
       Then { echo_reply.transaction_id == 123 }
       Then { echo_reply.xid == 123 }
+      Then { echo_reply.user_data.empty? }
       Then { echo_reply.user_data == '' }
+      Then { echo_reply.body.empty? }
+      Then { echo_reply.body == '' }
       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 { result == Failure(ArgumentError) }
-    end
-
     context 'with transaction_id: 123' do
       When(:echo_reply) { Pio::Echo::Reply.new(transaction_id: 123) }
 
@@ -40,7 +68,10 @@ describe Pio::Echo::Reply do
       Then { echo_reply.message_length == 8 }
       Then { echo_reply.transaction_id == 123 }
       Then { echo_reply.xid == 123 }
+      Then { echo_reply.user_data.empty? }
       Then { echo_reply.user_data == '' }
+      Then { echo_reply.body.empty? }
+      Then { echo_reply.body == '' }
       Then { echo_reply.to_binary == [1, 3, 0, 8, 0, 0, 0, 123].pack('C*') }
     end
 
@@ -52,7 +83,10 @@ describe Pio::Echo::Reply do
       Then { echo_reply.message_length == 8 }
       Then { echo_reply.transaction_id == 123 }
       Then { echo_reply.xid == 123 }
+      Then { echo_reply.user_data.empty? }
       Then { echo_reply.user_data == '' }
+      Then { echo_reply.body.empty? }
+      Then { echo_reply.body == '' }
       Then { echo_reply.to_binary == [1, 3, 0, 8, 0, 0, 0, 123].pack('C*') }
     end
 
@@ -65,12 +99,33 @@ describe Pio::Echo::Reply do
       Then { echo_reply.transaction_id == 123 }
       Then { echo_reply.xid == 123 }
       Then { echo_reply.user_data == 'foobar' }
+      Then { echo_reply.body == '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 -1' do
+      When(:result) { Pio::Echo::Reply.new(-1) }
+
+      Then do
+        result ==
+          Failure(ArgumentError,
+                  'Transaction ID should be an unsigned 32-bit integer.')
+      end
+    end
+
+    context 'with 2**32' do
+      When(:result) { Pio::Echo::Reply.new(2**32) }
+
+      Then do
+        result ==
+          Failure(ArgumentError,
+                  'Transaction ID should be an unsigned 32-bit integer.')
+      end
+    end
+
     context 'with :INVALID_ARGUMENT' do
       When(:result) { Pio::Echo::Reply.new(:INVALID_ARGUMENT) }
 

data/spec/pio/echo/request_spec.rb

@@ -1,6 +1,34 @@
 require 'pio/echo'
 
 describe Pio::Echo::Request do
+  describe '.read' do
+    When(:echo_request) { Pio::Echo::Request.read(binary) }
+
+    context 'with an echo request message' do
+      Given(:binary) { [1, 2, 0, 8, 0, 0, 0, 0].pack('C*') }
+
+      Then { echo_request.ofp_version == 1 }
+      Then { echo_request.message_type == Pio::OpenFlow::Type::ECHO_REQUEST }
+      Then { echo_request.message_length == 8 }
+      Then { echo_request.transaction_id == 0 }
+      Then { echo_request.xid == 0 }
+      Then { echo_request.user_data.empty? }
+      Then { echo_request.user_data == '' }
+      Then { echo_request.body.empty? }
+      Then { echo_request.body == '' }
+      Then { echo_request.to_binary == [1, 2, 0, 8, 0, 0, 0, 0].pack('C*') }
+    end
+
+    context 'with a hello message' do
+      Given(:binary) { [1, 0, 0, 8, 0, 0, 0, 0].pack('C*') }
+
+      Then do
+        echo_request ==
+          Failure(Pio::ParseError, 'Invalid Echo Request message.')
+      end
+    end
+  end
+
   describe '.new' do
     context 'with no arguments' do
       When(:echo_request) { Pio::Echo::Request.new }
@@ -11,6 +39,9 @@ describe Pio::Echo::Request do
       Then { echo_request.transaction_id == 0 }
       Then { echo_request.xid == 0 }
       Then { echo_request.user_data.empty? }
+      Then { echo_request.user_data == '' }
+      Then { echo_request.body.empty? }
+      Then { echo_request.body == '' }
       Then { echo_request.to_binary == [1, 2, 0, 8, 0, 0, 0, 0].pack('C*') }
     end
 
@@ -23,15 +54,12 @@ describe Pio::Echo::Request do
       Then { echo_request.transaction_id == 123 }
       Then { echo_request.xid == 123 }
       Then { echo_request.user_data.empty? }
+      Then { echo_request.user_data == '' }
+      Then { echo_request.body.empty? }
+      Then { echo_request.body == '' }
       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 { result == Failure(ArgumentError) }
-    end
-
     context 'with transaction_id: 123' do
       When(:echo_request) { Pio::Echo::Request.new(transaction_id: 123) }
 
@@ -41,6 +69,9 @@ describe Pio::Echo::Request do
       Then { echo_request.transaction_id == 123 }
       Then { echo_request.xid == 123 }
       Then { echo_request.user_data.empty? }
+      Then { echo_request.user_data == '' }
+      Then { echo_request.body.empty? }
+      Then { echo_request.body == '' }
       Then { echo_request.to_binary == [1, 2, 0, 8, 0, 0, 0, 123].pack('C*') }
     end
 
@@ -53,6 +84,9 @@ describe Pio::Echo::Request do
       Then { echo_request.transaction_id == 123 }
       Then { echo_request.xid == 123 }
       Then { echo_request.user_data.empty? }
+      Then { echo_request.user_data == '' }
+      Then { echo_request.body.empty? }
+      Then { echo_request.body == '' }
       Then { echo_request.to_binary == [1, 2, 0, 8, 0, 0, 0, 123].pack('C*') }
     end
 
@@ -67,12 +101,33 @@ describe Pio::Echo::Request do
       Then { echo_request.transaction_id == 123 }
       Then { echo_request.xid == 123 }
       Then { echo_request.user_data == 'foobar' }
+      Then { echo_request.body == '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 -1' do
+      When(:result) { Pio::Echo::Request.new(-1) }
+
+      Then do
+        result ==
+          Failure(ArgumentError,
+                  'Transaction ID should be an unsigned 32-bit integer.')
+      end
+    end
+
+    context 'with 2**32' do
+      When(:result) { Pio::Echo::Request.new(2**32) }
+
+      Then do
+        result ==
+          Failure(ArgumentError,
+                  'Transaction ID should be an unsigned 32-bit integer.')
+      end
+    end
+
     context 'with :INVALID_ARGUMENT' do
       When(:result) { Pio::Echo::Request.new(:INVALID_ARGUMENT) }
 

data/spec/pio/features/reply_spec.rb

@@ -1,6 +1,83 @@
 require 'pio/features'
 
 describe Pio::Features::Reply do
+  context 'with a Features Reply message' do
+    When(:result) { Pio::Features::Reply.read(binary) }
+
+    describe '.read' do
+      Given(:binary) do
+        [0x01, 0x06, 0x00, 0xb0, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00,
+         0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x01, 0x00,
+         0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x87, 0x00, 0x00,
+         0x0f, 0xff, 0x00, 0x02, 0x16, 0x7d, 0xa4, 0x37, 0xba, 0x10,
+         0x74, 0x72, 0x65, 0x6d, 0x61, 0x30, 0x2d, 0x30, 0x00, 0x00,
+         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xc0, 0x00, 0x00,
+         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+         0xff, 0xfe, 0x2a, 0xb4, 0xd6, 0x3c, 0x66, 0xba, 0x76, 0x73,
+         0x77, 0x5f, 0x30, 0x78, 0x31, 0x00, 0x00, 0x00, 0x00, 0x00,
+         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00,
+         0x00, 0x01, 0x00, 0x00, 0x00, 0x82, 0x00, 0x00, 0x00, 0x00,
+         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01,
+         0x62, 0x94, 0x3a, 0xf6, 0x40, 0xdb, 0x74, 0x72, 0x65, 0x6d,
+         0x61, 0x31, 0x2d, 0x30, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+         0x00, 0x00, 0x00, 0xc0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+         0x00, 0x00, 0x00, 0x00, 0x00, 0x00].pack('C*')
+      end
+
+      Then { result.class == Pio::Features::Reply }
+      Then { result.ofp_version == 1 }
+      Then do
+        result.message_type ==
+          Pio::OpenFlow::Type::FEATURES_REPLY
+      end
+      Then { result.message_length == 176 }
+      Then { result.transaction_id == 2 }
+      Then { result.xid == 2 }
+      Then { !result.body.empty? }
+      Then { result.datapath_id == 1 }
+      Then { result.n_buffers == 0x100 }
+      Then { result.n_tables == 1 }
+      Then do
+        result.capabilities ==
+          [:flow_stats, :table_stats, :port_stats, :arp_match_ip]
+      end
+      Then do
+        result.actions ==
+          [:output, :set_vlan_vid, :set_vlan_pcp, :strip_vlan,
+           :set_dl_src, :set_dl_dst, :set_nw_src, :set_nw_dst,
+           :set_nw_tos, :set_tp_src, :set_tp_dst, :enqueue]
+      end
+      Then { result.ports.size == 3 }
+      Then { result.ports.all? { |each| each.port_no > 0 } }
+      Then do
+        result.ports.all? do |each|
+          /^([0-9a-fA-F]{2}[:-]){5}[0-9a-fA-F]{2}$/i=~
+            each.hardware_address.to_s
+        end
+      end
+      Then { result.ports.all? { |each| !each.name.empty? } }
+      Then { result.ports.any? { |each| each.config == [:port_down] } }
+      Then { result.ports.any? { |each| each.state == [:link_down] } }
+      Then { result.ports.all? { |each| each.curr.include? :port_copper } }
+      Then { result.ports.all? { |each| each.advertised.empty? } }
+      Then { result.ports.all? { |each| each.supported.empty? } }
+      Then { result.ports.all? { |each| each.peer.empty? } }
+    end
+
+    context 'with a Hello message' do
+      Given(:binary) { [1, 0, 0, 8, 0, 0, 0, 0].pack('C*') }
+
+      When(:result) { Pio::Features::Reply.read(binary) }
+
+      Then do
+        result == Failure(Pio::ParseError,
+                          'Invalid Features Reply message.')
+      end
+    end
+  end
+
   Given(:options) do
     {
       dpid: 0x123,
@@ -50,11 +127,11 @@ describe Pio::Features::Reply do
     Then { features_reply.ports[0].advertised.empty? }
     Then { features_reply.ports[0].supported.empty? }
     Then { features_reply.ports[0].peer.empty? }
-  end
 
-  describe '#to_binary' do
-    When(:binary) { Pio::Features::Reply.new(options).to_binary }
+    describe '#to_binary' do
+      When(:result) { Pio::Features::Reply.new(options).to_binary }
 
-    Then { binary.length > 0 }
+      Then { result.length > 0 }
+    end
   end
 end

data/spec/pio/features/request_spec.rb

@@ -1,59 +1,106 @@
 require 'pio/features'
 
 describe Pio::Features::Request do
+  describe '.read' do
+    When(:result) { Pio::Features::Request.read(binary) }
+
+    context 'with a Features Request message' do
+      Given(:binary) { [1, 5, 0, 8, 0, 0, 0, 0].pack('C*') }
+
+      Then { result.class == Pio::Features::Request }
+      Then { result.ofp_version == 1 }
+      Then do
+        result.message_type ==
+          Pio::OpenFlow::Type::FEATURES_REQUEST
+      end
+      Then { result.message_length == 8 }
+      Then { result.transaction_id == 0 }
+      Then { result.xid == 0 }
+      Then { result.body.empty? }
+      Then { result.body == '' }
+    end
+
+    context 'with a Hello message' do
+      Given(:binary) { [1, 0, 0, 8, 0, 0, 0, 0].pack('C*') }
+
+      Then do
+        result == Failure(Pio::ParseError,
+                          'Invalid Features Request message.')
+      end
+    end
+  end
+
   describe '.new' do
     context 'with no arguments' do
-      When(:request) { Pio::Features::Request.new }
-
-      Then { request.ofp_version == 1 }
-      Then { request.message_type == Pio::OpenFlow::Type::FEATURES_REQUEST }
-      Then { request.message_length == 8 }
-      Then { request.transaction_id == 0 }
-      Then { request.xid == 0 }
-      Then { request.body.empty? }
-      Then { request.to_binary == [1, 5, 0, 8, 0, 0, 0, 0].pack('C*') }
-    end
+      When(:result) { Pio::Features::Request.new }
 
-    context 'with 123' do
-      When(:request) { Pio::Features::Request.new(123) }
-
-      Then { request.ofp_version == 1 }
-      Then { request.message_type == Pio::OpenFlow::Type::FEATURES_REQUEST }
-      Then { request.message_length == 8 }
-      Then { request.transaction_id == 123 }
-      Then { request.xid == 123 }
-      Then { request.body.empty? }
-      Then { request.to_binary == [1, 5, 0, 8, 0, 0, 0, 123].pack('C*') }
+      Then { result.ofp_version == 1 }
+      Then { result.message_type == Pio::OpenFlow::Type::FEATURES_REQUEST }
+      Then { result.message_length == 8 }
+      Then { result.transaction_id == 0 }
+      Then { result.xid == 0 }
+      Then { result.body.empty? }
+      Then { result.body == '' }
+      Then { result.to_binary == [1, 5, 0, 8, 0, 0, 0, 0].pack('C*') }
     end
 
-    context 'with 2**32' do
-      When(:result) { Pio::Features::Request.new(2**32) }
+    context 'with 123' do
+      When(:result) { Pio::Features::Request.new(123) }
 
-      Then { result == Failure(ArgumentError) }
+      Then { result.ofp_version == 1 }
+      Then { result.message_type == Pio::OpenFlow::Type::FEATURES_REQUEST }
+      Then { result.message_length == 8 }
+      Then { result.transaction_id == 123 }
+      Then { result.xid == 123 }
+      Then { result.body.empty? }
+      Then { result.body == '' }
+      Then { result.to_binary == [1, 5, 0, 8, 0, 0, 0, 123].pack('C*') }
     end
 
     context 'with transaction_id: 123' do
-      When(:request) { Pio::Features::Request.new(transaction_id: 123) }
-
-      Then { request.ofp_version == 1 }
-      Then { request.message_type == Pio::OpenFlow::Type::FEATURES_REQUEST }
-      Then { request.message_length == 8 }
-      Then { request.transaction_id == 123 }
-      Then { request.xid == 123 }
-      Then { request.body.empty? }
-      Then { request.to_binary == [1, 5, 0, 8, 0, 0, 0, 123].pack('C*') }
+      When(:result) { Pio::Features::Request.new(transaction_id: 123) }
+
+      Then { result.ofp_version == 1 }
+      Then { result.message_type == Pio::OpenFlow::Type::FEATURES_REQUEST }
+      Then { result.message_length == 8 }
+      Then { result.transaction_id == 123 }
+      Then { result.xid == 123 }
+      Then { result.body.empty? }
+      Then { result.body == '' }
+      Then { result.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.ofp_version == 1 }
-      Then { request.message_type == Pio::OpenFlow::Type::FEATURES_REQUEST }
-      Then { request.message_length == 8 }
-      Then { request.transaction_id == 123 }
-      Then { request.xid == 123 }
-      Then { request.body.empty? }
-      Then { request.to_binary == [1, 5, 0, 8, 0, 0, 0, 123].pack('C*') }
+      When(:result) { Pio::Features::Request.new(xid: 123) }
+
+      Then { result.ofp_version == 1 }
+      Then { result.message_type == Pio::OpenFlow::Type::FEATURES_REQUEST }
+      Then { result.message_length == 8 }
+      Then { result.transaction_id == 123 }
+      Then { result.xid == 123 }
+      Then { result.body.empty? }
+      Then { result.body == '' }
+      Then { result.to_binary == [1, 5, 0, 8, 0, 0, 0, 123].pack('C*') }
+    end
+
+    context 'with -1' do
+      When(:result) { Pio::Features::Request.new(-1) }
+
+      Then do
+        result ==
+          Failure(ArgumentError,
+                  'Transaction ID should be an unsigned 32-bit integer.')
+      end
+    end
+
+    context 'with 2**32' do
+      When(:result) { Pio::Features::Request.new(2**32) }
+
+      Then do
+        result ==
+          Failure(ArgumentError,
+                  'Transaction ID should be an unsigned 32-bit integer.')
+      end
     end
 
     context 'with :INVALID_ARGUMENT' do