pio 0.3.0 → 0.4.0

data/spec/pio/icmp_spec.rb

@@ -1,159 +1,166 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
 require 'pio'
 
-describe Pio::Icmp do
-  context '.read' do
-    subject { Pio::Icmp.read(data.pack('C*')) }
+describe Pio::ICMP do
+  Then { Pio::ICMP == Pio::Icmp }
+end
 
-    context 'with Icmp request frame' do
-      let(:data) do
-        [
-          # Destination MAC
-          0x24, 0xdb, 0xac, 0x41, 0xe5, 0x5b,
-          # Source MAC
-          0x00, 0x26, 0x82, 0xeb, 0xea, 0xd1,
-          # EtherType
-          0x08, 0x00,
-          # IP Version&IP Header Length
-          0x45,
-          # IP Type Of Service
-          0x00,
-          # IP Total Length
-          0x00, 0x3c,
-          # IP Identifier
-          0x39, 0xd3,
-          # IP Flag&IP Fragment
-          0x00, 0x00,
-          # IP TTL
-          0x80,
-          # IP Protocol
-          0x01,
-          # IP Header Checksum
-          0x2e, 0xd0,
-          # IP Source Address
-          0xc0, 0xa8, 0x01, 0x66,
-          # IP Destination Address
-          0x08, 0x08, 0x08, 0x08,
-          # ICMP Type
-          0x08,
-          # ICMP Code
-          0x00,
-          # ICMP Checksum
-          0x4c, 0x5b,
-          # ICMP Identifier
-          0x01, 0x00,
-          # ICMP Sequence Number
-          0x00, 0x01,
-          # Echo Data
-          0x61, 0x62, 0x63, 0x64, 0x65, 0x66,
-          0x67, 0x68, 0x69, 0x6a, 0x6b, 0x6c,
-          0x6d, 0x6e, 0x6f, 0x70, 0x71, 0x72,
-          0x73, 0x74, 0x75, 0x76, 0x77, 0x61,
-          0x62, 0x63, 0x64, 0x65, 0x66, 0x67,
-          0x68, 0x69
-        ]
-      end
+describe Pio::Icmp, '.read' do
+  context 'with an ICMP request frame' do
+    Given(:icmp_request_dump) do
+      [
+       # Destination MAC
+        0x24, 0xdb, 0xac, 0x41, 0xe5, 0x5b,
+       # Source MAC
+        0x00, 0x26, 0x82, 0xeb, 0xea, 0xd1,
+       # EtherType
+        0x08, 0x00,
+       # IP Version&IP Header Length
+        0x45,
+       # IP Type Of Service
+        0x00,
+       # IP Total Length
+        0x00, 0x3c,
+       # IP Identifier
+        0x39, 0xd3,
+       # IP Flag&IP Fragment
+        0x00, 0x00,
+       # IP TTL
+        0x80,
+       # IP Protocol
+        0x01,
+       # IP Header Checksum
+        0x2e, 0xd0,
+       # IP Source Address
+        0xc0, 0xa8, 0x01, 0x66,
+       # IP Destination Address
+        0x08, 0x08, 0x08, 0x08,
+       # ICMP Type
+        0x08,
+       # ICMP Code
+        0x00,
+       # ICMP Checksum
+        0x4c, 0x5b,
+       # ICMP Identifier
+        0x01, 0x00,
+       # ICMP Sequence Number
+        0x00, 0x01,
+       # Echo Data
+        0x61, 0x62, 0x63, 0x64, 0x65, 0x66,
+        0x67, 0x68, 0x69, 0x6a, 0x6b, 0x6c,
+        0x6d, 0x6e, 0x6f, 0x70, 0x71, 0x72,
+        0x73, 0x74, 0x75, 0x76, 0x77, 0x61,
+        0x62, 0x63, 0x64, 0x65, 0x66, 0x67,
+        0x68, 0x69
+      ].pack('C*')
+    end
 
-      its('destination_mac.to_s') { should eq '24:db:ac:41:e5:5b' }
-      its('source_mac.to_s') { should eq '00:26:82:eb:ea:d1' }
-      its(:ether_type) { should eq 0x0800 }
-      its(:ip_version) { should eq 0x4 }
-      its(:ip_header_length) { should eq 0x5 }
-      its(:ip_type_of_service) { should eq 0x0 }
-      its(:ip_total_length) { should eq 60 }
-      its(:ip_identifier) { should eq 0x39d3 }
-      its(:ip_fragment) { should eq 0 }
-      its(:ip_ttl) { should eq 128 }
-      its(:ip_protocol) { should eq 1 }
-      its(:ip_header_checksum) { should eq 0x2ed0 }
-      its('ip_source_address.to_s') { should eq '192.168.1.102' }
-      its('ip_destination_address.to_s') { should eq '8.8.8.8' }
-      its(:icmp_type) { should eq 8 }
-      its(:icmp_code) { should eq 0 }
-      its(:icmp_checksum) { should eq 0x4c5b }
-      its(:icmp_identifier) { should eq 0x0100 }
-      its(:icmp_sequence_number) { should eq 0x0001 }
-      its(:echo_data) { should eq 'abcdefghijklmnopqrstuvwabcdefghi' }
+    When(:icmp_request) do
+      Pio::Icmp.read(icmp_request_dump)
     end
 
-    context 'with Icmp reply frame' do
-      let(:data) do
-        [
-          # Destination MAC
-          0x00, 0x26, 0x82, 0xeb, 0xea, 0xd1,
-          # Source MAC
-          0x24, 0xdb, 0xac, 0x41, 0xe5, 0x5b,
-          # EtherType
-          0x08, 0x00,
-          # IP Version&IP Header Length
-          0x45,
-          # IP Type Of Service
-          0x00,
-          # IP Total Length
-          0x00, 0x3c,
-          # IP Identifier
-          0x00, 0x00,
-          # IP Flag&IP Fragment
-          0x00, 0x00,
-          # IP TTL
-          0x2d,
-          # IP Protocol
-          0x01,
-          # IP Header Checksum
-          0xbb, 0xa3,
-          # IP Source Address
-          0x08, 0x08, 0x08, 0x08,
-          # IP Destination Address
-          0xc0, 0xa8, 0x01, 0x66,
-          # ICMP Type
-          0x00,
-          # ICMP Code
-          0x00,
-          # ICMP Checksum
-          0x54, 0x5b,
-          # ICMP Identifier
-          0x01, 0x00,
-          # ICMP Sequence Number
-          0x00, 0x01,
-          0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6a,
-          0x6b, 0x6c, 0x6d, 0x6e, 0x6f, 0x70, 0x71, 0x72, 0x73, 0x74,
-          0x75, 0x76, 0x77, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67,
-          0x68, 0x69
-        ]
-      end
+    Then { icmp_request.class == Pio::Icmp::Request }
+    Then { icmp_request.destination_mac.to_s == '24:db:ac:41:e5:5b' }
+    Then { icmp_request.source_mac.to_s == '00:26:82:eb:ea:d1' }
+    Then { icmp_request.ether_type == 0x0800 }
+    Then { icmp_request.ip_version == 0x4 }
+    Then { icmp_request.ip_header_length == 0x5 }
+    Then { icmp_request.ip_type_of_service == 0x0 }
+    Then { icmp_request.ip_total_length == 60 }
+    Then { icmp_request.ip_identifier == 0x39d3 }
+    Then { icmp_request.ip_fragment == 0 }
+    Then { icmp_request.ip_ttl == 128 }
+    Then { icmp_request.ip_protocol == 1 }
+    Then { icmp_request.ip_header_checksum == 0x2ed0 }
+    Then { icmp_request.ip_source_address.to_s == '192.168.1.102' }
+    Then { icmp_request.ip_destination_address.to_s == '8.8.8.8' }
+    Then { icmp_request.icmp_type == 8 }
+    Then { icmp_request.icmp_code == 0 }
+    Then { icmp_request.icmp_checksum == 0x4c5b }
+    Then { icmp_request.icmp_identifier == 0x0100 }
+    Then { icmp_request.icmp_sequence_number == 0x0001 }
+    Then { icmp_request.echo_data == 'abcdefghijklmnopqrstuvwabcdefghi' }
+  end
 
-      its('destination_mac.to_s') { should eq '00:26:82:eb:ea:d1' }
-      its('source_mac.to_s') { should eq '24:db:ac:41:e5:5b' }
-      its(:ether_type) { should eq 0x0800 }
-      its(:ip_version) { should eq 0x4 }
-      its(:ip_header_length) { should eq 0x5 }
-      its(:ip_type_of_service) { should eq 0 }
-      its(:ip_total_length) { should eq 60 }
-      its(:ip_identifier) { should eq 0 }
-      its(:ip_fragment) { should eq 0 }
-      its(:ip_ttl) { should eq 45 }
-      its(:ip_protocol) { should eq 1 }
-      its(:ip_header_checksum) { should eq 0xbba3 }
-      its('ip_source_address.to_s') { should eq '8.8.8.8' }
-      its('ip_destination_address.to_s') { should eq '192.168.1.102' }
-      its(:icmp_type) { should eq 0 }
-      its(:icmp_code) { should eq 0 }
-      its(:icmp_checksum) { should eq 0x545b }
-      its(:icmp_identifier) { should eq 0x0100 }
-      its(:icmp_sequence_number) { should eq 0x0001 }
-      its(:echo_data) { should eq 'abcdefghijklmnopqrstuvwabcdefghi' }
+  context 'with an ICMP reply frame' do
+    Given(:icmp_reply_dump) do
+      [
+       # Destination MAC
+        0x00, 0x26, 0x82, 0xeb, 0xea, 0xd1,
+       # Source MAC
+        0x24, 0xdb, 0xac, 0x41, 0xe5, 0x5b,
+       # EtherType
+        0x08, 0x00,
+       # IP Version&IP Header Length
+        0x45,
+       # IP Type Of Service
+        0x00,
+       # IP Total Length
+        0x00, 0x3c,
+       # IP Identifier
+        0x00, 0x00,
+       # IP Flag&IP Fragment
+        0x00, 0x00,
+       # IP TTL
+        0x2d,
+       # IP Protocol
+        0x01,
+       # IP Header Checksum
+        0xbb, 0xa3,
+       # IP Source Address
+        0x08, 0x08, 0x08, 0x08,
+       # IP Destination Address
+        0xc0, 0xa8, 0x01, 0x66,
+       # ICMP Type
+        0x00,
+       # ICMP Code
+        0x00,
+       # ICMP Checksum
+        0x54, 0x5b,
+       # ICMP Identifier
+        0x01, 0x00,
+       # ICMP Sequence Number
+        0x00, 0x01,
+        0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6a,
+        0x6b, 0x6c, 0x6d, 0x6e, 0x6f, 0x70, 0x71, 0x72, 0x73, 0x74,
+        0x75, 0x76, 0x77, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67,
+        0x68, 0x69
+      ].pack('C*')
     end
 
-    context 'with an invalid Icmp frame' do
-      let(:data) { [] }
+    When(:icmp_reply) do
+      Pio::Icmp.read(icmp_reply_dump)
+    end
 
-      it { expect { subject }.to raise_error(Pio::ParseError) }
+    Then { icmp_reply.class == Pio::Icmp::Reply }
+    Then { icmp_reply.destination_mac.to_s == '00:26:82:eb:ea:d1' }
+    Then { icmp_reply.source_mac.to_s == '24:db:ac:41:e5:5b' }
+    Then { icmp_reply.ether_type == 0x0800 }
+    Then { icmp_reply.ip_version == 0x4 }
+    Then { icmp_reply.ip_header_length == 0x5 }
+    Then { icmp_reply.ip_type_of_service == 0 }
+    Then { icmp_reply.ip_total_length == 60 }
+    Then { icmp_reply.ip_identifier == 0 }
+    Then { icmp_reply.ip_fragment == 0 }
+    Then { icmp_reply.ip_ttl == 45 }
+    Then { icmp_reply.ip_protocol == 1 }
+    Then { icmp_reply.ip_header_checksum == 0xbba3 }
+    Then { icmp_reply.ip_source_address.to_s == '8.8.8.8' }
+    Then { icmp_reply.ip_destination_address.to_s == '192.168.1.102' }
+    Then { icmp_reply.icmp_type == 0 }
+    Then { icmp_reply.icmp_code == 0 }
+    Then { icmp_reply.icmp_checksum == 0x545b }
+    Then { icmp_reply.icmp_identifier == 0x0100 }
+    Then { icmp_reply.icmp_sequence_number == 0x0001 }
+    Then { icmp_reply.echo_data == 'abcdefghijklmnopqrstuvwabcdefghi' }
+  end
+
+  context 'with an invalid ICMP packet' do
+    When(:result) do
+      Pio::Icmp.read('')
     end
+
+    Then { result == Failure(Pio::ParseError, 'End of file reached') }
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/spec/pio/ipv4_address_spec.rb

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
 require 'pio/ipv4_address'
 
 describe Pio::IPv4Address do
@@ -96,9 +97,3 @@ describe Pio::IPv4Address do
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/spec/pio/lldp/options_spec.rb

@@ -0,0 +1,188 @@
+# encoding: utf-8
+
+require 'pio'
+
+describe Pio::Lldp::Options, '.new' do
+  def options_with(user_options)
+    Pio::Lldp::Options.new(user_options)
+  end
+
+  Given(:mandatory_options) do
+    {
+      dpid: 0x192fa7b28d,
+      port_number: 1
+    }
+  end
+
+  context 'with :dpid and :port_number' do
+    Given(:options) { options_with(mandatory_options) }
+
+    describe '#to_hash' do
+      When(:result) { options.to_hash }
+
+      Then { result[:chassis_id] == 0x192fa7b28d }
+      Then { result[:port_id] == 1 }
+      Then do
+        result[:destination_mac] ==
+          Pio::Mac.new(Pio::Lldp::Options::DEFAULT_DESTINATION_MAC)
+      end
+      Then do
+        result[:source_mac] ==
+          Pio::Mac.new(Pio::Lldp::Options::DEFAULT_SOURCE_MAC)
+      end
+    end
+
+    context 'with :destination_mac' do
+      Given(:options) do
+        user_options =
+          mandatory_options.update(destination_mac: '06:05:04:03:02:01')
+        options_with(user_options)
+      end
+
+      describe '#to_hash' do
+        When(:result) do
+          options.to_hash
+        end
+
+        Then { result[:destination_mac] == Pio::Mac.new('06:05:04:03:02:01') }
+        And { result[:chassis_id] == 0x192fa7b28d }
+        And { result[:port_id] == 1 }
+        And do
+          result[:source_mac] ==
+            Pio::Mac.new(Pio::Lldp::Options::DEFAULT_SOURCE_MAC)
+        end
+      end
+    end
+
+    context 'with :source_mac' do
+      Given(:options) do
+        user_options =
+          mandatory_options.update(source_mac: '06:05:04:03:02:01')
+        options_with(user_options)
+      end
+
+      describe '#to_hash' do
+        When(:result) do
+          options.to_hash
+        end
+
+        Then { result[:source_mac] == Pio::Mac.new('06:05:04:03:02:01') }
+        And { result[:chassis_id] == 0x192fa7b28d }
+        And { result[:port_id] == 1 }
+        And do
+          result[:destination_mac] ==
+            Pio::Mac.new(Pio::Lldp::Options::DEFAULT_DESTINATION_MAC)
+        end
+      end
+    end
+
+    context 'with :destination_mac = nil' do
+      Given(:options) do
+        user_options = mandatory_options.update(destination_mac: nil)
+        options_with(user_options)
+      end
+
+      describe '#to_hash' do
+        When(:result) do
+          options.to_hash
+        end
+
+        Then do
+          result[:destination_mac] ==
+            Pio::Mac.new(Pio::Lldp::Options::DEFAULT_DESTINATION_MAC)
+        end
+        And { result[:chassis_id] == 0x192fa7b28d }
+        And { result[:port_id] == 1 }
+        And do
+          result[:source_mac] ==
+            Pio::Mac.new(Pio::Lldp::Options::DEFAULT_SOURCE_MAC)
+        end
+      end
+    end
+
+    context 'with :source_mac = nil' do
+      Given(:options) do
+        user_options = mandatory_options.update(source_mac: nil)
+        options_with(user_options)
+      end
+
+      describe '#to_hash' do
+        When(:result) do
+          options.to_hash
+        end
+
+        Then do
+          result[:source_mac] ==
+            Pio::Mac.new(Pio::Lldp::Options::DEFAULT_SOURCE_MAC)
+        end
+        And { result[:chassis_id] == 0x192fa7b28d }
+        And { result[:port_id] == 1 }
+        And do
+          result[:destination_mac] ==
+            Pio::Mac.new(Pio::Lldp::Options::DEFAULT_DESTINATION_MAC)
+        end
+      end
+    end
+  end
+
+  context 'when :dpid is not passed' do
+    Given(:user_options) do
+      mandatory_options.delete(:dpid)
+      mandatory_options
+    end
+
+    When(:result) do
+      options_with(user_options)
+    end
+
+    Then do
+      result ==
+        Failure(ArgumentError, 'The dpid option should be passed.')
+    end
+  end
+
+  context 'with :dpid = nil' do
+    Given(:user_options) do
+      mandatory_options.update(dpid: nil)
+    end
+
+    When(:result) do
+      options_with(user_options)
+    end
+
+    Then do
+      result == Failure(ArgumentError, "The dpid option shouldn't be nil.")
+    end
+  end
+
+  context 'when :port_number is not passed' do
+    Given(:user_options) do
+      mandatory_options.delete(:port_number)
+      mandatory_options
+    end
+
+    When(:result) do
+      options_with(user_options)
+    end
+
+    Then do
+      result ==
+        Failure(ArgumentError, 'The port_number option should be passed.')
+    end
+  end
+
+  context 'with :port_number = nil' do
+    Given(:user_options) do
+      mandatory_options.update(port_number: nil)
+    end
+
+    When(:result) do
+      options_with(user_options)
+    end
+
+    Then do
+      result ==
+        Failure(ArgumentError, "The port_number option shouldn't be nil.")
+    end
+  end
+end