pio 0.10.1 → 0.11.0

data/spec/pio/packet_in_spec.rb

@@ -13,6 +13,8 @@ describe Pio::PacketIn do
   end
 
   describe '.read' do
+    When(:result) { Pio::PacketIn.read(binary) }
+
     context 'with a packet_in message' do
       Given(:header_dump) do
         [
@@ -31,28 +33,25 @@ describe Pio::PacketIn do
           0x00
         ].pack('C*') + data_dump
       end
-
-      When(:packet_in) do
-        Pio::PacketIn.read(header_dump + body_dump)
-      end
-
-      Then { packet_in.class == Pio::PacketIn }
-      Then { packet_in.ofp_version == 0x1 }
-      Then { packet_in.message_type == 0xa }
-      Then { packet_in.message_length == 0x4e }
-      Then { packet_in.transaction_id == 0 }
-      Then { packet_in.xid == 0 }
-
-      Then { !packet_in.body.empty? }
-      Then { packet_in.buffer_id == 0xffffff00 }
-      Then { packet_in.total_len == 0x3c }
-      Then { packet_in.in_port == 1 }
-      Then { packet_in.reason == :no_match }
-      Then { packet_in.data == data_dump }
+      Given(:binary) { header_dump + body_dump }
+
+      Then { result.class == Pio::PacketIn }
+      Then { result.ofp_version == 0x1 }
+      Then { result.message_type == 0xa }
+      Then { result.message_length == 0x4e }
+      Then { result.transaction_id == 0 }
+      Then { result.xid == 0 }
+
+      Then { !result.body.empty? }
+      Then { result.buffer_id == 0xffffff00 }
+      Then { result.total_len == 0x3c }
+      Then { result.in_port == 1 }
+      Then { result.reason == :no_match }
+      Then { result.data == data_dump }
     end
 
-    context 'with a packet_in message generated with PacketIn.new' do
-      Given(:packet_in_dump) do
+    context 'with a Packet-In message generated with PacketIn.new' do
+      Given(:binary) do
         Pio::PacketIn.new(
           transaction_id: 0,
           buffer_id: 0xffffff00,
@@ -61,30 +60,28 @@ describe Pio::PacketIn do
           data: data_dump
         ).to_binary
       end
-      When(:packet_in) { Pio::PacketIn.read(packet_in_dump) }
-
-      Then { packet_in.class == Pio::PacketIn }
-      Then { packet_in.ofp_version == 0x1 }
-      Then { packet_in.message_type == 0xa }
-      Then { packet_in.message_length == 0x4e }
-      Then { packet_in.transaction_id == 0 }
-      Then { packet_in.xid == 0 }
 
-      Then { !packet_in.body.empty? }
-      Then { packet_in.buffer_id == 0xffffff00 }
-      Then { packet_in.total_len == 0x3c }
-      Then { packet_in.in_port == 1 }
-      Then { packet_in.reason == :no_match }
-      Then { packet_in.data == data_dump }
+      Then { result.class == Pio::PacketIn }
+      Then { result.ofp_version == 0x1 }
+      Then { result.message_type == 0xa }
+      Then { result.message_length == 0x4e }
+      Then { result.transaction_id == 0 }
+      Then { result.xid == 0 }
+
+      Then { !result.body.empty? }
+      Then { result.buffer_id == 0xffffff00 }
+      Then { result.total_len == 0x3c }
+      Then { result.in_port == 1 }
+      Then { result.reason == :no_match }
+      Then { result.data == data_dump }
     end
 
     context 'with a Hello message' do
-      Given(:hello_dump) { [1, 0, 0, 8, 0, 0, 0, 0].pack('C*') }
-
-      When(:result) { Pio::PacketIn.read(hello_dump) }
+      Given(:binary) { [1, 0, 0, 8, 0, 0, 0, 0].pack('C*') }
 
       Then do
-        result == Failure(Pio::ParseError, 'Invalid Packet-In message.')
+        result == Failure(Pio::ParseError,
+                          'Invalid PacketIn message.')
       end
     end
   end

data/spec/pio/packet_out_spec.rb

@@ -9,7 +9,6 @@ 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,
@@ -21,7 +20,6 @@ describe Pio::PacketOut do
       0x00, 0x00, 0x00, 0x00
     ].pack('C*')
   end
-
   Given(:body_dump) do
     [
       0xff, 0xff, 0xff, 0xff,
@@ -31,260 +29,323 @@ describe Pio::PacketOut do
     ].pack('C*') + data_dump
   end
 
-  Given(:packet_out_dump) { header_dump + body_dump }
-
   describe '.read' do
+    When(:result) { Pio::PacketOut.read(binary) }
+
     context 'with a Packet-Out message' do
-      When(:packet_out) do
-        Pio::PacketOut.read(packet_out_dump)
+      When(:binary) { header_dump + body_dump }
+
+      Then { result.class == Pio::PacketOut }
+      Then { result.ofp_version == 0x1 }
+      Then { result.message_type == 0xd }
+      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 }
+      Then { result.actions.length == 1 }
+      Then { result.actions[0].is_a? Pio::SendOutPort }
+      Then { result.actions[0].port_number == 2 }
+      Then { result.actions[0].max_len == 2**16 - 1 }
+      Then { result.data.length == 64 }
+    end
+
+    context 'with a Packet-Out message generated with PacketOut.new' do
+      When(:binary) do
+        Pio::PacketOut.new(
+          transaction_id: 0x16,
+          buffer_id: 0xffffffff,
+          in_port: 0xffff,
+          actions: Pio::SendOutPort.new(2),
+          data: data_dump
+        ).to_binary
       end
 
-      Then { packet_out.class == Pio::PacketOut }
-      Then { packet_out.ofp_version == 0x1 }
-      Then { packet_out.message_type == 0xd }
-      Then { packet_out.message_length == 0x58 }
-      Then { packet_out.transaction_id == 0x16 }
-      Then { packet_out.xid == 0x16 }
-
-      Then { !packet_out.body.empty? }
-      Then { packet_out.buffer_id == 0xffffffff }
-      Then { packet_out.in_port == 0xffff }
-      Then { packet_out.actions_len == 0x8 }
-      Then { packet_out.actions.length == 1 }
-      Then { packet_out.actions[0].is_a? Pio::SendOutPort }
-      Then { packet_out.actions[0].port_number == 2 }
-      Then { packet_out.actions[0].max_len == 2**16 - 1 }
-      Then { packet_out.data.length == 64 }
+      Then { result.class == Pio::PacketOut }
+      Then { result.ofp_version == 0x1 }
+      Then { result.message_type == 0xd }
+      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 }
+      Then { result.actions.length == 1 }
+      Then { result.actions[0].is_a? Pio::SendOutPort }
+      Then { result.actions[0].port_number == 2 }
+      Then { result.actions[0].max_len == 2**16 - 1 }
+      Then { result.data.length == 64 }
+    end
+
+    context 'with a Hello message' do
+      When(:binary) { [1, 0, 0, 8, 0, 0, 0, 0].pack('C*') }
+
+      Then do
+        result == Failure(Pio::ParseError,
+                          'Invalid PacketOut message.')
+      end
     end
   end
 
   describe '.new' do
+    When(:result) { Pio::PacketOut.new(user_options) }
+
     context 'with a SendOutPort action' do
-      Given(:packet_out) do
-        Pio::PacketOut.new(transaction_id: 0x16,
-                           buffer_id: 0xffffffff,
-                           in_port: 0xffff,
-                           actions: Pio::SendOutPort.new(2),
-                           data: data_dump)
+      When(:user_options) do
+        {
+          transaction_id: 0x16,
+          buffer_id: 0xffffffff,
+          in_port: 0xffff,
+          actions: Pio::SendOutPort.new(2),
+          data: data_dump
+        }
       end
 
-      Then { packet_out.ofp_version == 0x1 }
-      Then { packet_out.message_type == 0xd }
-      Then { packet_out.message_length == 0x58 }
-      Then { packet_out.transaction_id == 0x16 }
-      Then { packet_out.xid == 0x16 }
-
-      Then { !packet_out.body.empty? }
-      Then { packet_out.buffer_id == 0xffffffff }
-      Then { packet_out.in_port == 0xffff }
-      Then { packet_out.actions_len == 0x8 }
-      Then { packet_out.actions.length == 1 }
-      Then { packet_out.actions[0].is_a? Pio::SendOutPort }
-      Then { packet_out.actions[0].port_number == 2 }
-      Then { packet_out.actions[0].max_len == 2**16 - 1 }
-      Then { packet_out.data.length == 64 }
+      Then { result.ofp_version == 0x1 }
+      Then { result.message_type == 0xd }
+      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 }
+      Then { result.actions.length == 1 }
+      Then { result.actions[0].is_a? Pio::SendOutPort }
+      Then { result.actions[0].port_number == 2 }
+      Then { result.actions[0].max_len == 2**16 - 1 }
+      Then { result.data.length == 64 }
 
       context '#to_binary' do
-        When(:binary) { packet_out.to_binary }
-        Then { binary == packet_out_dump }
+        When(:binary) { result.to_binary }
+
+        Then { binary == header_dump + body_dump }
       end
     end
 
     context 'with a SetVlanVid action' do
-      Given(:packet_out) do
-        Pio::PacketOut.new(transaction_id: 0x16,
-                           buffer_id: 0xffffffff,
-                           in_port: 0xffff,
-                           actions: Pio::SetVlanVid.new(10),
-                           data: data_dump)
+      When(:user_options) do
+        {
+          transaction_id: 0x16,
+          buffer_id: 0xffffffff,
+          in_port: 0xffff,
+          actions: Pio::SetVlanVid.new(10),
+          data: data_dump
+        }
       end
 
-      Then { packet_out.message_length == 0x58 }
-      Then { packet_out.actions_len == 0x8 }
-      Then { packet_out.actions.length == 1 }
-      Then { packet_out.actions[0].is_a? Pio::SetVlanVid }
-      Then { packet_out.actions[0].vlan_id == 10 }
+      Then { result.message_length == 0x58 }
+      Then { result.actions_len == 0x8 }
+      Then { result.actions.length == 1 }
+      Then { result.actions[0].is_a? Pio::SetVlanVid }
+      Then { result.actions[0].vlan_id == 10 }
     end
 
     context 'with a SetVlanPriority action' do
-      Given(:packet_out) do
-        Pio::PacketOut.new(transaction_id: 0x16,
-                           buffer_id: 0xffffffff,
-                           in_port: 0xffff,
-                           actions: Pio::SetVlanPriority.new(3),
-                           data: data_dump)
+      When(:user_options) do
+        {
+          transaction_id: 0x16,
+          buffer_id: 0xffffffff,
+          in_port: 0xffff,
+          actions: Pio::SetVlanPriority.new(3),
+          data: data_dump
+        }
       end
 
-      Then { packet_out.message_length == 0x58 }
-      Then { packet_out.actions_len == 0x8 }
-      Then { packet_out.actions.length == 1 }
-      Then { packet_out.actions[0].is_a? Pio::SetVlanPriority }
-      Then { packet_out.actions[0].vlan_priority == 3 }
+      Then { result.message_length == 0x58 }
+      Then { result.actions_len == 0x8 }
+      Then { result.actions.length == 1 }
+      Then { result.actions[0].is_a? Pio::SetVlanPriority }
+      Then { result.actions[0].vlan_priority == 3 }
     end
 
     context 'with a StripVlanHeader action' do
-      Given(:packet_out) do
-        Pio::PacketOut.new(transaction_id: 0x16,
-                           buffer_id: 0xffffffff,
-                           in_port: 0xffff,
-                           actions: Pio::StripVlanHeader.new,
-                           data: data_dump)
+      When(:user_options) do
+        {
+          transaction_id: 0x16,
+          buffer_id: 0xffffffff,
+          in_port: 0xffff,
+          actions: Pio::StripVlanHeader.new,
+          data: data_dump
+        }
       end
 
-      Then { packet_out.message_length == 0x58 }
-      Then { packet_out.actions_len == 0x8 }
-      Then { packet_out.actions.length == 1 }
-      Then { packet_out.actions[0].is_a? Pio::StripVlanHeader }
+      Then { result.message_length == 0x58 }
+      Then { result.actions_len == 0x8 }
+      Then { result.actions.length == 1 }
+      Then { result.actions[0].is_a? Pio::StripVlanHeader }
     end
 
     context 'with a SetEthSrcAddr action' do
-      Given(:packet_out) do
-        Pio::PacketOut.new(transaction_id: 0x16,
-                           buffer_id: 0xffffffff,
-                           in_port: 0xffff,
-                           actions: Pio::SetEthSrcAddr.new('11:22:33:44:55:66'),
-                           data: data_dump)
+      When(:user_options) do
+        {
+          transaction_id: 0x16,
+          buffer_id: 0xffffffff,
+          in_port: 0xffff,
+          actions: Pio::SetEthSrcAddr.new('11:22:33:44:55:66'),
+          data: data_dump
+        }
       end
 
-      Then { packet_out.message_length == 0x60 }
-      Then { packet_out.actions_len == 0x10 }
-      Then { packet_out.actions.length == 1 }
-      Then { packet_out.actions[0].is_a? Pio::SetEthSrcAddr }
-      Then { packet_out.actions[0].mac_address == '11:22:33:44:55:66' }
+      Then { result.message_length == 0x60 }
+      Then { result.actions_len == 0x10 }
+      Then { result.actions.length == 1 }
+      Then { result.actions[0].is_a? Pio::SetEthSrcAddr }
+      Then { result.actions[0].mac_address == '11:22:33:44:55:66' }
     end
 
     context 'with a SetEthDstAddr action' do
-      Given(:packet_out) do
-        Pio::PacketOut.new(transaction_id: 0x16,
-                           buffer_id: 0xffffffff,
-                           in_port: 0xffff,
-                           actions: Pio::SetEthDstAddr.new('11:22:33:44:55:66'),
-                           data: data_dump)
+      When(:user_options) do
+        {
+          transaction_id: 0x16,
+          buffer_id: 0xffffffff,
+          in_port: 0xffff,
+          actions: Pio::SetEthDstAddr.new('11:22:33:44:55:66'),
+          data: data_dump
+        }
       end
 
-      Then { packet_out.message_length == 0x60 }
-      Then { packet_out.actions_len == 0x10 }
-      Then { packet_out.actions.length == 1 }
-      Then { packet_out.actions[0].is_a? Pio::SetEthDstAddr }
-      Then { packet_out.actions[0].mac_address == '11:22:33:44:55:66' }
+      Then { result.message_length == 0x60 }
+      Then { result.actions_len == 0x10 }
+      Then { result.actions.length == 1 }
+      Then { result.actions[0].is_a? Pio::SetEthDstAddr }
+      Then { result.actions[0].mac_address == '11:22:33:44:55:66' }
     end
 
     context 'with a SetIpSrcAddr action' do
-      Given(:packet_out) do
-        Pio::PacketOut.new(transaction_id: 0x16,
-                           buffer_id: 0xffffffff,
-                           in_port: 0xffff,
-                           actions: Pio::SetIpSrcAddr.new('1.2.3.4'),
-                           data: data_dump)
+      When(:user_options) do
+        {
+          transaction_id: 0x16,
+          buffer_id: 0xffffffff,
+          in_port: 0xffff,
+          actions: Pio::SetIpSrcAddr.new('1.2.3.4'),
+          data: data_dump
+        }
       end
 
-      Then { packet_out.message_length == 0x58 }
-      Then { packet_out.actions_len == 0x8 }
-      Then { packet_out.actions.length == 1 }
-      Then { packet_out.actions[0].is_a? Pio::SetIpSrcAddr }
-      Then { packet_out.actions[0].ip_address == '1.2.3.4' }
+      Then { result.message_length == 0x58 }
+      Then { result.actions_len == 0x8 }
+      Then { result.actions.length == 1 }
+      Then { result.actions[0].is_a? Pio::SetIpSrcAddr }
+      Then { result.actions[0].ip_address == '1.2.3.4' }
     end
 
     context 'with a SetIpDstAddr action' do
-      Given(:packet_out) do
-        Pio::PacketOut.new(transaction_id: 0x16,
-                           buffer_id: 0xffffffff,
-                           in_port: 0xffff,
-                           actions: Pio::SetIpDstAddr.new('1.2.3.4'),
-                           data: data_dump)
+      When(:user_options) do
+        {
+          transaction_id: 0x16,
+          buffer_id: 0xffffffff,
+          in_port: 0xffff,
+          actions: Pio::SetIpDstAddr.new('1.2.3.4'),
+          data: data_dump
+        }
       end
 
-      Then { packet_out.message_length == 0x58 }
-      Then { packet_out.actions_len == 0x8 }
-      Then { packet_out.actions.length == 1 }
-      Then { packet_out.actions[0].is_a? Pio::SetIpDstAddr }
-      Then { packet_out.actions[0].ip_address == '1.2.3.4' }
+      Then { result.message_length == 0x58 }
+      Then { result.actions_len == 0x8 }
+      Then { result.actions.length == 1 }
+      Then { result.actions[0].is_a? Pio::SetIpDstAddr }
+      Then { result.actions[0].ip_address == '1.2.3.4' }
     end
 
     context 'with a SetIpTos action' do
-      Given(:packet_out) do
-        Pio::PacketOut.new(transaction_id: 0x16,
-                           buffer_id: 0xffffffff,
-                           in_port: 0xffff,
-                           actions: Pio::SetIpTos.new(32),
-                           data: data_dump)
+      When(:user_options) do
+        {
+          transaction_id: 0x16,
+          buffer_id: 0xffffffff,
+          in_port: 0xffff,
+          actions: Pio::SetIpTos.new(32),
+          data: data_dump
+        }
       end
 
-      Then { packet_out.message_length == 0x58 }
-      Then { packet_out.actions_len == 0x8 }
-      Then { packet_out.actions.length == 1 }
-      Then { packet_out.actions[0].is_a? Pio::SetIpTos }
-      Then { packet_out.actions[0].type_of_service == 32 }
+      Then { result.message_length == 0x58 }
+      Then { result.actions_len == 0x8 }
+      Then { result.actions.length == 1 }
+      Then { result.actions[0].is_a? Pio::SetIpTos }
+      Then { result.actions[0].type_of_service == 32 }
     end
 
     context 'with a SetTransportSrcPort action' do
-      Given(:packet_out) do
-        Pio::PacketOut.new(transaction_id: 0x16,
-                           buffer_id: 0xffffffff,
-                           in_port: 0xffff,
-                           actions: Pio::SetTransportSrcPort.new(100),
-                           data: data_dump)
+      When(:user_options) do
+        {
+          transaction_id: 0x16,
+          buffer_id: 0xffffffff,
+          in_port: 0xffff,
+          actions: Pio::SetTransportSrcPort.new(100),
+          data: data_dump
+        }
       end
 
-      Then { packet_out.message_length == 0x58 }
-      Then { packet_out.actions_len == 0x8 }
-      Then { packet_out.actions.length == 1 }
-      Then { packet_out.actions[0].is_a? Pio::SetTransportSrcPort }
-      Then { packet_out.actions[0].port_number == 100 }
+      Then { result.message_length == 0x58 }
+      Then { result.actions_len == 0x8 }
+      Then { result.actions.length == 1 }
+      Then { result.actions[0].is_a? Pio::SetTransportSrcPort }
+      Then { result.actions[0].port_number == 100 }
     end
 
     context 'with a SetTransportDstPort action' do
-      Given(:packet_out) do
-        Pio::PacketOut.new(transaction_id: 0x16,
-                           buffer_id: 0xffffffff,
-                           in_port: 0xffff,
-                           actions: Pio::SetTransportDstPort.new(100),
-                           data: data_dump)
+      When(:user_options) do
+        {
+          transaction_id: 0x16,
+          buffer_id: 0xffffffff,
+          in_port: 0xffff,
+          actions: Pio::SetTransportDstPort.new(100),
+          data: data_dump
+        }
       end
 
-      Then { packet_out.message_length == 0x58 }
-      Then { packet_out.actions_len == 0x8 }
-      Then { packet_out.actions.length == 1 }
-      Then { packet_out.actions[0].is_a? Pio::SetTransportDstPort }
-      Then { packet_out.actions[0].port_number == 100 }
+      Then { result.message_length == 0x58 }
+      Then { result.actions_len == 0x8 }
+      Then { result.actions.length == 1 }
+      Then { result.actions[0].is_a? Pio::SetTransportDstPort }
+      Then { result.actions[0].port_number == 100 }
     end
 
     context 'with a Enqueue action' do
-      Given(:packet_out) do
-        Pio::PacketOut.new(transaction_id: 0x16,
-                           buffer_id: 0xffffffff,
-                           in_port: 0xffff,
-                           actions: Pio::Enqueue.new(port_number: 1,
-                                                     queue_id: 2),
-                           data: data_dump)
+      When(:user_options) do
+        {
+          transaction_id: 0x16,
+          buffer_id: 0xffffffff,
+          in_port: 0xffff,
+          actions: Pio::Enqueue.new(port_number: 1, queue_id: 2),
+          data: data_dump
+        }
       end
 
-      Then { packet_out.message_length == 0x60 }
-      Then { packet_out.actions_len == 0x10 }
-      Then { packet_out.actions.length == 1 }
-      Then { packet_out.actions[0].is_a? Pio::Enqueue }
-      Then { packet_out.actions[0].port_number == 1 }
-      Then { packet_out.actions[0].queue_id == 2 }
+      Then { result.message_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].queue_id == 2 }
     end
 
     context 'with SendOutPort and SetVlanVid action' do
-      Given(:packet_out) do
-        Pio::PacketOut.new(transaction_id: 0x16,
-                           buffer_id: 0xffffffff,
-                           in_port: 0xffff,
-                           actions: [Pio::SendOutPort.new(2),
-                                     Pio::SetVlanVid.new(10)],
-                           data: data_dump)
+      When(:user_options) do
+        {
+          transaction_id: 0x16,
+          buffer_id: 0xffffffff,
+          in_port: 0xffff,
+          actions: [Pio::SendOutPort.new(2), Pio::SetVlanVid.new(10)],
+          data: data_dump
+        }
       end
 
-      Then { packet_out.message_length == 0x60 }
-      Then { packet_out.actions_len == 0x10 }
-      Then { packet_out.actions.length == 2 }
-      Then { packet_out.actions[0].is_a? Pio::SendOutPort }
-      Then { packet_out.actions[0].port_number == 2 }
-      Then { packet_out.actions[0].max_len == 2**16 - 1 }
-      Then { packet_out.actions[1].is_a? Pio::SetVlanVid }
-      Then { packet_out.actions[1].vlan_id == 10 }
+      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].port_number == 2 }
+      Then { result.actions[0].max_len == 2**16 - 1 }
+      Then { result.actions[1].is_a? Pio::SetVlanVid }
+      Then { result.actions[1].vlan_id == 10 }
     end
   end
 end