pio 0.23.1 → 0.24.0

data/lib/pio/open_flow13/send_out_port.rb

@@ -2,46 +2,46 @@ require 'forwardable'
 
 # Base module.
 module Pio
-  remove_const :SendOutPort if const_defined?(:SendOutPort)
-
-  # Output to switch port.
-  class SendOutPort
-    # OpenFlow 1.3.4 OFPAT_OUTPUT action format.
-    class Format < BinData::Record
-      NO_BUFFER = 0xffff
-
-      endian :big
-
-      uint16 :action_type, value: 0
-      uint16 :action_length, value: 16
-      uint32 :port
-      uint16 :max_length, initial_value: NO_BUFFER
-      uint48 :padding
-    end
+  module OpenFlow13
+    # Output to switch port.
+    class SendOutPort
+      # OpenFlow 1.3.4 OFPAT_OUTPUT action format.
+      class Format < BinData::Record
+        NO_BUFFER = 0xffff
+
+        endian :big
+
+        uint16 :action_type, value: 0
+        uint16 :action_length, value: 16
+        uint32 :port
+        uint16 :max_length, initial_value: NO_BUFFER
+        uint48 :padding
+      end
 
-    def self.read(raw_data)
-      allocate.tap do |send_out_port|
-        send_out_port.instance_variable_set :@format, Format.read(raw_data)
+      def self.read(raw_data)
+        allocate.tap do |send_out_port|
+          send_out_port.instance_variable_set :@format, Format.read(raw_data)
+        end
       end
-    end
 
-    extend Forwardable
+      extend Forwardable
 
-    def_delegators :@format, :action_type
-    def_delegators :@format, :action_length
-    def_delegators :@format, :port
-    def_delegator :@format, :to_binary_s, :to_binary
+      def_delegators :@format, :action_type
+      def_delegators :@format, :action_length
+      def_delegators :@format, :port
+      def_delegator :@format, :to_binary_s, :to_binary
 
-    def initialize(port)
-      @format = Format.new(port: port)
-    end
+      def initialize(port)
+        @format = Format.new(port: port)
+      end
 
-    def max_length
-      case @format.max_length
-      when Format::NO_BUFFER
-        :no_buffer
-      else
-        @format.max_length
+      def max_length
+        case @format.max_length
+        when Format::NO_BUFFER
+          :no_buffer
+        else
+          @format.max_length
+        end
       end
     end
   end

data/lib/pio/open_flow13/write_metadata.rb

@@ -27,6 +27,7 @@ module Pio
     def_delegators :@format, :instruction_length
     def_delegators :@format, :metadata
     def_delegators :@format, :metadata_mask
+    def_delegators :@format, :to_binary_s
 
     def initialize(user_options)
       @options = user_options

data/lib/pio/parser.rb

@@ -1,3 +1,6 @@
+require 'pio/ethernet_header'
+require 'pio/ipv4_header'
+
 module Pio
   # Raw data parser.
   class Parser

data/lib/pio/version.rb

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

data/pio.gemspec

@@ -31,14 +31,14 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'bindata', '~> 2.1.0'
 
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'bundler', '~> 1.10.5'
+  gem.add_development_dependency 'bundler', '~> 1.10.6'
   gem.add_development_dependency 'pry', '~> 0.10.1'
 
   # Guard
-  gem.add_development_dependency 'guard', '~> 2.12.6'
+  gem.add_development_dependency 'guard', '~> 2.13.0'
   gem.add_development_dependency 'guard-bundler', '~> 2.1.0'
   gem.add_development_dependency 'guard-cucumber', '~> 1.6.0'
-  gem.add_development_dependency 'guard-rspec', '~> 4.5.2'
+  gem.add_development_dependency 'guard-rspec', '~> 4.6.3'
   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'
@@ -53,11 +53,11 @@ Gem::Specification.new do |gem|
   # Test
   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 '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', '~> 2.2.1'
+  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

data/spec/pio/open_flow10/echo_reply_spec.rb

@@ -0,0 +1,7 @@
+require 'pio/open_flow10/echo'
+
+describe Pio::OpenFlow10::Echo::Reply do
+  describe '.new' do
+    it_should_behave_like('an OpenFlow message', Pio::OpenFlow10::Echo::Reply)
+  end
+end

data/spec/pio/open_flow10/echo_request_spec.rb

@@ -0,0 +1,7 @@
+require 'pio/open_flow10/echo'
+
+describe Pio::OpenFlow10::Echo::Request do
+  describe '.new' do
+    it_should_behave_like('an OpenFlow message', Pio::OpenFlow10::Echo::Request)
+  end
+end

data/spec/pio/open_flow10/features_reply_spec.rb

@@ -0,0 +1,8 @@
+require 'pio/open_flow10/features'
+
+describe Pio::OpenFlow10::Features::Reply do
+  describe '.new' do
+    it_should_behave_like('an OpenFlow message with Datapath ID',
+                          Pio::OpenFlow10::Features::Reply)
+  end
+end

data/spec/pio/open_flow10/features_request_spec.rb

@@ -0,0 +1,13 @@
+require 'pio/open_flow10/features'
+
+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

@@ -1,6 +1,6 @@
 require 'pio/open_flow10/flow_mod'
 
-describe Pio::FlowMod do
+describe Pio::OpenFlow10::FlowMod do
   Given(:dump) do
     [
       0x01,
@@ -26,10 +26,10 @@ describe Pio::FlowMod do
   describe '.read' do
     context 'with a flow_mod message' do
       When(:flow_mod) do
-        Pio::FlowMod.read(dump)
+        Pio::OpenFlow10::FlowMod.read(dump)
       end
 
-      Then { flow_mod.class == Pio::FlowMod }
+      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 }
@@ -73,7 +73,7 @@ describe Pio::FlowMod do
       Then { flow_mod.out_port == 2 }
       Then { flow_mod.flags == [:send_flow_rem, :check_overwrap] }
       Then { flow_mod.actions.length == 1 }
-      Then { flow_mod.actions[0].is_a? Pio::SendOutPort }
+      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 }
     end
@@ -82,19 +82,20 @@ describe Pio::FlowMod do
   describe '.new' do
     context 'with a SendOutPort action' do
       When(:flow_mod) do
-        Pio::FlowMod.new(transaction_id: 0x15,
-                         buffer_id: 0xffffffff,
-                         match: Pio::Match.new(in_port: 1),
-                         cookie: 1,
-                         command: :add,
-                         priority: 0xffff,
-                         out_port: 2,
-                         flags: [:send_flow_rem, :check_overwrap],
-                         actions: Pio::SendOutPort.new(2)
-                        )
+        Pio::OpenFlow10::FlowMod.new(
+          transaction_id: 0x15,
+          buffer_id: 0xffffffff,
+          match: Pio::OpenFlow10::Match.new(in_port: 1),
+          cookie: 1,
+          command: :add,
+          priority: 0xffff,
+          out_port: 2,
+          flags: [:send_flow_rem, :check_overwrap],
+          actions: Pio::OpenFlow10::SendOutPort.new(2)
+        )
       end
 
-      Then { flow_mod.class == Pio::FlowMod }
+      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 }
@@ -138,7 +139,7 @@ describe Pio::FlowMod do
       Then { flow_mod.out_port == 2 }
       Then { flow_mod.flags == [:send_flow_rem, :check_overwrap] }
       Then { flow_mod.actions.length == 1 }
-      Then { flow_mod.actions[0].is_a? Pio::SendOutPort }
+      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 }
 

data/spec/pio/open_flow10/hello_spec.rb

@@ -0,0 +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
+end

data/spec/pio/open_flow10/match_spec.rb

@@ -1,8 +1,8 @@
 require 'pio/open_flow10/match'
 
-describe Pio::Match do
+describe Pio::OpenFlow10::Match do
   describe '.read' do
-    When(:match) { Pio::Match.read(binary) }
+    When(:match) { Pio::OpenFlow10::Match.read(binary) }
 
     context 'with a Match binary' do
       Given(:binary) do
@@ -54,9 +54,11 @@ describe Pio::Match do
       Then { match.transport_destination_port == 0 }
     end
 
-    context 'with a Match binary generated with Pio::Match.new' do
+    context 'with a Match binary generated with Pio::OpenFlow10::Match.new' do
       Given(:binary) do
-        Pio::Match.new(ip_source_address: '192.168.1.0/24').to_binary_s
+        Pio::OpenFlow10::Match
+          .new(ip_source_address: '192.168.1.0/24')
+          .to_binary_s
       end
 
       Then do
@@ -93,7 +95,7 @@ describe Pio::Match do
   end
 
   describe '.new' do
-    When(:match) { Pio::Match.new(options) }
+    When(:match) { Pio::OpenFlow10::Match.new(options) }
 
     context 'with in_port: 1' do
       Given(:options) { { in_port: 1 } }
@@ -129,7 +131,7 @@ describe Pio::Match do
         When(:result) { match == other }
 
         context 'with Match.new(in_port: 1)' do
-          Given(:other) { Pio::Match.new(in_port: 1) }
+          Given(:other) { Pio::OpenFlow10::Match.new(in_port: 1) }
           Then { result == true }
         end
       end

data/spec/pio/open_flow10/packet_in_spec.rb

@@ -0,0 +1,14 @@
+require 'pio/open_flow10/packet_in'
+
+describe Pio::OpenFlow10::PacketIn do
+  Given(:packet_in) { Pio::OpenFlow10::PacketIn.new }
+
+  describe '.new' do
+    it_should_behave_like('an OpenFlow message', Pio::OpenFlow10::PacketIn)
+  end
+
+  describe 'datapath_id=' do
+    When { packet_in.datapath_id = 1 }
+    Then { packet_in.datapath_id == 1 }
+  end
+end

data/spec/pio/open_flow10/packet_out_spec.rb

@@ -1,6 +1,7 @@
 require 'pio/open_flow10/packet_out'
+require 'pio/parse_error'
 
-describe Pio::PacketOut do
+describe Pio::OpenFlow10::PacketOut do
   Given(:header_dump) do
     [
       0x01,
@@ -9,6 +10,7 @@ describe Pio::PacketOut do
       0x00, 0x00, 0x00, 0x16
     ].pack('C*')
   end
+
   Given(:data_dump) do
     [
       0x01, 0x80, 0xc2, 0x00, 0x00, 0x0e, 0x01, 0x02, 0x03, 0x04,
@@ -20,6 +22,7 @@ describe Pio::PacketOut do
       0x00, 0x00, 0x00, 0x00
     ].pack('C*')
   end
+
   Given(:body_dump) do
     [
       0xff, 0xff, 0xff, 0xff,
@@ -30,12 +33,12 @@ describe Pio::PacketOut do
   end
 
   describe '.read' do
-    When(:result) { Pio::PacketOut.read(binary) }
+    When(:result) { Pio::OpenFlow10::PacketOut.read(binary) }
 
     context 'with a Packet-Out message' do
       When(:binary) { header_dump + body_dump }
 
-      Then { result.class == Pio::PacketOut }
+      Then { result.class == Pio::OpenFlow10::PacketOut }
       Then { result.ofp_version == 0x1 }
       Then { result.message_type == 0xd }
       Then { result.message_length == 0x58 }
@@ -47,7 +50,7 @@ describe Pio::PacketOut do
       Then { result.in_port == 0xffff }
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
-      Then { result.actions[0].is_a? Pio::SendOutPort }
+      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.raw_data.length == 64 }
@@ -55,16 +58,16 @@ describe Pio::PacketOut do
 
     context 'with a Packet-Out message generated with PacketOut.new' do
       When(:binary) do
-        Pio::PacketOut.new(
+        Pio::OpenFlow10::PacketOut.new(
           transaction_id: 0x16,
           buffer_id: 0xffffffff,
           in_port: 0xffff,
-          actions: Pio::SendOutPort.new(2),
+          actions: Pio::OpenFlow10::SendOutPort.new(2),
           raw_data: data_dump
         ).to_binary
       end
 
-      Then { result.class == Pio::PacketOut }
+      Then { result.class == Pio::OpenFlow10::PacketOut }
       Then { result.ofp_version == 0x1 }
       Then { result.message_type == 0xd }
       Then { result.message_length == 0x58 }
@@ -76,7 +79,7 @@ describe Pio::PacketOut do
       Then { result.in_port == 0xffff }
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
-      Then { result.actions[0].is_a? Pio::SendOutPort }
+      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.raw_data.length == 64 }
@@ -86,13 +89,16 @@ describe Pio::PacketOut do
       When(:binary) { [1, 0, 0, 8, 0, 0, 0, 0].pack('C*') }
 
       Then do
-        result == Failure(Pio::ParseError, 'Invalid PacketOut message.')
+        result == Failure(Pio::ParseError,
+                          'Invalid OpenFlow10 PacketOut message.')
       end
     end
   end
 
   describe '.new' do
-    When(:result) { Pio::PacketOut.new(user_options) }
+    it_should_behave_like('an OpenFlow message', Pio::OpenFlow10::PacketOut)
+
+    When(:result) { Pio::OpenFlow10::PacketOut.new(user_options) }
 
     context 'with a SendOutPort action' do
       When(:user_options) do
@@ -100,7 +106,7 @@ describe Pio::PacketOut do
           transaction_id: 0x16,
           buffer_id: 0xffffffff,
           in_port: 0xffff,
-          actions: Pio::SendOutPort.new(2),
+          actions: Pio::OpenFlow10::SendOutPort.new(2),
           raw_data: data_dump
         }
       end
@@ -116,7 +122,7 @@ describe Pio::PacketOut do
       Then { result.in_port == 0xffff }
       Then { result.actions_len == 0x8 }
       Then { result.actions.length == 1 }
-      Then { result.actions[0].is_a? Pio::SendOutPort }
+      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.raw_data.length == 64 }
@@ -332,7 +338,8 @@ describe Pio::PacketOut do
           transaction_id: 0x16,
           buffer_id: 0xffffffff,
           in_port: 0xffff,
-          actions: [Pio::SendOutPort.new(2), Pio::SetVlanVid.new(10)],
+          actions: [Pio::OpenFlow10::SendOutPort.new(2),
+                    Pio::SetVlanVid.new(10)],
           raw_data: data_dump
         }
       end
@@ -340,7 +347,7 @@ describe Pio::PacketOut do
       Then { result.message_length == 0x60 }
       Then { result.actions_len == 0x10 }
       Then { result.actions.length == 2 }
-      Then { result.actions[0].is_a? Pio::SendOutPort }
+      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[1].is_a? Pio::SetVlanVid }

data/spec/pio/open_flow10/send_out_port_spec.rb

@@ -1,8 +1,8 @@
 require 'pio/open_flow10/send_out_port'
 
-describe Pio::SendOutPort do
+describe Pio::OpenFlow10::SendOutPort do
   describe '.new' do
-    When(:send_out_port) { Pio::SendOutPort.new(options) }
+    When(:send_out_port) { Pio::OpenFlow10::SendOutPort.new(options) }
 
     context 'with 1' do
       Given(:options) { 1 }
@@ -13,12 +13,12 @@ describe Pio::SendOutPort do
         When(:result) { send_out_port == other }
 
         context 'with SendOutPort.new(1)' do
-          Given(:other) { Pio::SendOutPort.new(1) }
+          Given(:other) { Pio::OpenFlow10::SendOutPort.new(1) }
           Then { result == true }
         end
 
         context 'with SendOutPort.new(2)' do
-          Given(:other) { Pio::SendOutPort.new(2) }
+          Given(:other) { Pio::OpenFlow10::SendOutPort.new(2) }
           Then { result == false }
         end
       end