pio 0.30.0 → 0.30.1

data/features/step_definitions/ruby_steps.rb

@@ -0,0 +1,7 @@
+When(/^I eval the following Ruby code:$/) do |ruby_code|
+  @result = Pio.module_eval(ruby_code)
+end
+
+Then(/^the result of eval should be:$/) do |expected|
+  expect(@result.to_s).to eq expected
+end

data/features/step_definitions/show_stats_steps.rb

@@ -15,7 +15,7 @@ Then(/^the number of packets sent from "(.*?)" should be:$/) do |host_name, tabl
       when /-> (\S+) = (\d+) packet/
         result[Regexp.last_match(1)] = Regexp.last_match(2).to_i
       else
-        fail "Failed to parse line '#{each}'"
+        raise "Failed to parse line '#{each}'"
       end
     end
   end
@@ -43,7 +43,7 @@ Then(/^the number of packets received by "(.*?)" should be:$/) do |host_name, ta
         next unless received
         result[Regexp.last_match(1)] = Regexp.last_match(3).to_i
       else
-        fail "Failed to parse line '#{each}'"
+        raise "Failed to parse line '#{each}'"
       end
     end
   end
@@ -72,7 +72,7 @@ Then(/^the total number of received packets should be:$/) do |table|
           next unless received
           result += Regexp.last_match(3).to_i
         else
-          fail "Failed to parse line '#{each}'"
+          raise "Failed to parse line '#{each}'"
         end
       end
     end

data/features/support/env.rb

@@ -1,5 +1,6 @@
 require 'coveralls'
 Coveralls.wear!
 
+require 'aruba/cucumber'
 require 'pio'
 require 'pio/pcap'

data/features/support/hooks.rb

@@ -1,7 +1,7 @@
 Before('@open_flow10') do
-  Pio::OpenFlow.switch_version :OpenFlow10
+  Pio::OpenFlow.version = :OpenFlow10
 end
 
 Before('@open_flow13') do
-  Pio::OpenFlow.switch_version :OpenFlow13
+  Pio::OpenFlow.version = :OpenFlow13
 end

data/features/udp.feature

@@ -1,28 +1,27 @@
-Feature: Pio::Udp
+Feature: Udp
   Scenario: parse dhcp.pcap
-    When I try to parse a file named "dhcp.pcap" with "Pio::Udp" class
-    Then it should finish successfully
-    And the message #1 have the following fields and values:
-    | field                  |             value |
-    | class                  |          Pio::Udp |
-    | destination_mac        | ff:ff:ff:ff:ff:ff |
-    | source_mac             | 00:0b:82:01:fc:42 |
-    | ether_type             |              2048 |
-    | ip_version             |                 4 |
-    | ip_header_length       |                 5 |
-    | ip_type_of_service     |                 0 |
-    | ip_total_length        |               300 |
-    | ip_identifier          |             43062 |
-    | ip_flag                |                 0 |
-    | ip_fragment            |                 0 |
-    | ip_ttl                 |               250 |
-    | ip_protocol            |                17 |
-    | ip_header_checksum     |              6027 |
-    | source_ip_address      |           0.0.0.0 |
-    | destination_ip_address |   255.255.255.255 |
-    | ip_option              |                   |
-    | udp_source_port        |                68 |
-    | udp_destination_port   |                67 |
-    | udp_length             |               280 |
-    | udp_checksum           |             22815 |
-    | udp_payload.length     |               272 |
+    When I parse a file named "dhcp.pcap" with "Pio::Udp" class
+    Then the message #1 have the following fields and values:
+      | field                  |             value |
+      | class                  |          Pio::Udp |
+      | destination_mac        | ff:ff:ff:ff:ff:ff |
+      | source_mac             | 00:0b:82:01:fc:42 |
+      | ether_type.to_hex      |             0x800 |
+      | ip_version             |                 4 |
+      | ip_header_length       |                 5 |
+      | ip_type_of_service     |                 0 |
+      | ip_total_length        |               300 |
+      | ip_identifier          |             43062 |
+      | ip_flag                |                 0 |
+      | ip_fragment            |                 0 |
+      | ip_ttl                 |               250 |
+      | ip_protocol            |                17 |
+      | ip_header_checksum     |              6027 |
+      | source_ip_address      |           0.0.0.0 |
+      | destination_ip_address |   255.255.255.255 |
+      | ip_option              |                   |
+      | udp_source_port        |                68 |
+      | udp_destination_port   |                67 |
+      | udp_length             |               280 |
+      | udp_checksum           |             22815 |
+      | udp_payload.length     |               272 |

data/lib/pio.rb

@@ -5,5 +5,5 @@ require 'pio/dhcp'
 require 'pio/icmp'
 require 'pio/lldp'
 require 'pio/mac'
-require 'pio/open_flow'
 require 'pio/udp'
+require 'pio/open_flow'

data/lib/pio/arp.rb

@@ -1,14 +1,17 @@
 require 'pio/arp/format'
-require 'pio/arp/request'
 require 'pio/arp/reply'
-require 'pio/message_type_selector'
+require 'pio/arp/request'
+require 'pio/parse_error'
 
-# Packet parser and generator library.
 module Pio
   # ARP parser and generator.
   class Arp
-    extend MessageTypeSelector
-    message_type Request::OPERATION => Request, Reply::OPERATION => Reply
+    def self.read(raw_data)
+      format = Format.read(raw_data)
+      { Request.operation => Request,
+        Reply.operation => Reply }.fetch(format.operation).create(format)
+    rescue
+      raise Pio::ParseError, $ERROR_INFO.message
+    end
   end
-  ARP = Arp
 end

data/lib/pio/arp/format.rb

@@ -8,11 +8,11 @@ module Pio
   class Arp
     # ARP parser.
     class Format < BinData::Record
-      include EthernetHeader
+      include Ethernet
 
       endian :big
 
-      ethernet_header ether_type: EtherType::ARP
+      ethernet_header ether_type: Ethernet::Type::ARP
       uint16 :hardware_type, value: 1
       uint16 :protocol_type, value: 0x0800
       uint8 :hardware_length, value: 6
@@ -23,17 +23,13 @@ module Pio
       mac_address :target_hardware_address
       ip_address :target_protocol_address
 
-      def message_type
-        operation
-      end
-
       # rubocop:disable MethodLength
       def to_exact_match(in_port)
         match_options = {
           in_port: in_port,
           source_mac_address: source_mac,
           destination_mac_address: destination_mac,
-          vlan_vid: vlan_vid,
+          vlan_vid: 0xffff,
           vlan_priority: vlan_pcp,
           ether_type: ether_type,
           tos: 0,

data/lib/pio/arp/message.rb

@@ -1,14 +1,18 @@
 require 'pio/arp/format'
+require 'pio/message'
 
 module Pio
   class Arp
     # Base class of ARP Request and Reply
-    class Message
-      private_class_method :new
+    class Message < Pio::Message
+      def self.create(format)
+        allocate.tap do |message|
+          message.instance_variable_set :@format, format
+        end
+      end
 
       def initialize(user_options)
-        options = self.class.const_get(:Options).new(user_options.dup.freeze)
-        @format = Arp::Format.new(options.to_hash)
+        @format = Arp::Format.new(parse_options(user_options))
       end
 
       def method_missing(method, *args)

data/lib/pio/arp/reply.rb

@@ -1,43 +1,20 @@
 require 'pio/arp/message'
+require 'pio/instance_inspector'
 require 'pio/mac'
-require 'pio/options'
 
 module Pio
   class Arp
     # ARP Reply packet generator
     class Reply < Message
-      OPERATION = 2
-      public_class_method :new
+      include InstanceInspector
 
-      # User options for creating an Arp Reply.
-      class Options < Pio::Options
-        mandatory_option :source_mac
-        mandatory_option :destination_mac
-        mandatory_option :sender_protocol_address
-        mandatory_option :target_protocol_address
-
-        def initialize(options)
-          validate options
-          @source_mac = Mac.new(options[:source_mac]).freeze
-          @destination_mac = Mac.new(options[:destination_mac]).freeze
-          @sender_protocol_address =
-            IPv4Address.new(options[:sender_protocol_address]).freeze
-          @target_protocol_address =
-            IPv4Address.new(options[:target_protocol_address]).freeze
-        end
-
-        def to_hash
-          {
-            operation: OPERATION,
-            source_mac: @source_mac,
-            destination_mac: @destination_mac,
-            sender_hardware_address: @source_mac,
-            target_hardware_address: @destination_mac,
-            sender_protocol_address: @sender_protocol_address,
-            target_protocol_address: @target_protocol_address
-          }.freeze
-        end
-      end
+      option :operation, value: 2
+      option :source_mac
+      option :destination_mac
+      option :sender_hardware_address, value: :source_mac
+      option :target_hardware_address, value: :destination_mac
+      option :sender_protocol_address
+      option :target_protocol_address
     end
   end
 end

data/lib/pio/arp/request.rb

@@ -1,44 +1,20 @@
 require 'pio/arp/message'
+require 'pio/instance_inspector'
 require 'pio/mac'
-require 'pio/options'
 
 module Pio
   class Arp
     # ARP Request packet generator
     class Request < Message
-      OPERATION = 1
-      public_class_method :new
+      include InstanceInspector
 
-      # User options for creating an Arp Request.
-      class Options < Pio::Options
-        mandatory_option :source_mac
-        mandatory_option :sender_protocol_address
-        mandatory_option :target_protocol_address
-
-        BROADCAST_MAC = Mac.new(0xffffffffffff).freeze
-        ALL_ZERO_MAC = Mac.new(0).freeze
-
-        def initialize(options)
-          validate options
-          @source_mac = Mac.new(options[:source_mac]).freeze
-          @sender_protocol_address =
-            IPv4Address.new(options[:sender_protocol_address]).freeze
-          @target_protocol_address =
-            IPv4Address.new(options[:target_protocol_address]).freeze
-        end
-
-        def to_hash
-          {
-            operation: OPERATION,
-            source_mac: @source_mac,
-            destination_mac: BROADCAST_MAC,
-            sender_hardware_address: @source_mac,
-            target_hardware_address: ALL_ZERO_MAC,
-            sender_protocol_address: @sender_protocol_address,
-            target_protocol_address: @target_protocol_address
-          }.freeze
-        end
-      end
+      option :operation, value: 1
+      option :source_mac
+      option :destination_mac, default: 'ff:ff:ff:ff:ff:ff'.freeze
+      option :sender_hardware_address, value: :source_mac
+      option :target_hardware_address, default: '00:00:00:00:00:00'.freeze
+      option :sender_protocol_address
+      option :target_protocol_address
     end
   end
 end

data/lib/pio/class_inspector.rb

@@ -0,0 +1,18 @@
+require 'active_support/core_ext/string/inflections'
+
+module Pio
+  # Introduces Class.inspect method
+  module ClassInspector
+    # rubocop:disable LineLength
+    def inspect
+      field_and_type = fields.each_with_object([]) do |each, result|
+        next if each.name == :padding
+        result << [each.name,
+                   each.prototype.instance_variable_get(:@obj_class).name.demodulize.sub(/be$/, '').underscore]
+      end
+      signature = field_and_type.map { |field, type| "#{field}: #{type}" }.join(', ')
+      "#{self}(#{signature})"
+    end
+    # rubocop:enable LineLength
+  end
+end

data/lib/pio/dhcp.rb

@@ -22,7 +22,7 @@ module Pio
         ROUTER_TLV,
         DNS_TLV,
         NTP_SERVERS_TLV
-      ]
+      ].freeze
   end
   DHCP = Dhcp
 end
@@ -41,7 +41,7 @@ module Pio
       Offer::TYPE => Offer,
       Request::TYPE => Request,
       Ack::TYPE => Ack
-    }
+    }.freeze
 
     def self.read(raw_data)
       begin

data/lib/pio/dhcp/frame.rb

@@ -12,12 +12,12 @@ module Pio
 
       OPTION_FIELD_LENGTH = 60
 
-      include EthernetHeader
-      include IPv4Header
+      include Ethernet
+      include IPv4
       include UdpHeader
 
       endian :big
-      ethernet_header ether_type: EtherType::IPV4
+      ethernet_header ether_type: Ethernet::Type::IPV4
       ipv4_header ip_protocol: ProtocolNumber::UDP
       udp_header
       dhcp_field :dhcp
@@ -31,7 +31,7 @@ module Pio
 
       def ff_and_padding
         padding_length = OPTION_FIELD_LENGTH - dhcp.optional_tlvs.num_bytes - 1
-        "\xFF" + (padding_length > 0 ? "\x00" * padding_length : '')
+        [0xFF].pack('C') + (padding_length > 0 ? "\x00" * padding_length : '')
       end
     end
   end

data/lib/pio/dhcp/optional_tlv.rb

@@ -7,15 +7,15 @@ module Pio
   class Dhcp
     # DHCP Optional TLV
     class OptionalTlv < BinData::Record
-      DEFAULT = 'default'
+      DEFAULT = 'default'.freeze
 
       endian :big
 
       bit8 :tlv_type
       bit8 :tlv_info_length,
-           onlyif: -> { !(end_of_dhcpdu?) }
+           onlyif: -> { !end_of_dhcpdu? }
       choice :tlv_value,
-             onlyif: -> { !(end_of_dhcpdu?) },
+             onlyif: -> { !end_of_dhcpdu? },
              selection: :chooser do
         uint8 Dhcp::MESSAGE_TYPE_TLV
         ip_address Dhcp::SERVER_IDENTIFIER_TLV

data/lib/pio/ethernet_frame.rb

@@ -0,0 +1,20 @@
+require 'bindata'
+require 'pio/ethernet_header'
+require 'pio/class_inspector'
+require 'pio/instance_inspector'
+require 'pio/ruby_dumper'
+
+module Pio
+  # Ethernet frame parser
+  class EthernetFrame < BinData::Record
+    extend ClassInspector
+    include Ethernet
+    include InstanceInspector
+    include RubyDumper
+
+    endian :big
+
+    ethernet_header
+    rest :rest
+  end
+end

data/lib/pio/ethernet_header.rb

@@ -1,10 +1,16 @@
+require 'pio/class_inspector'
+require 'pio/instance_inspector'
+require 'pio/ruby_dumper'
+require 'pio/type/ether_type'
 require 'pio/type/mac_address'
 
 module Pio
   # Adds ethernet_header macro.
-  module EthernetHeader
-    # EtherType constants for ethernet_header.ether_type.
-    module EtherType
+  module Ethernet
+    MINIMUM_FRAME_SIZE = 64
+
+    # EtherType constants
+    module Type
       ARP = 0x0806
       IPV4 = 0x0800
       VLAN = 0x8100
@@ -12,28 +18,44 @@ module Pio
     end
 
     # This method smells of :reek:TooManyStatements
+    # rubocop:disable MethodLength
     def self.included(klass)
-      def klass.ethernet_header(options)
+      def klass.ethernet_header(options = nil)
         mac_address :destination_mac
         mac_address :source_mac
-        uint16 :ether_type, value: options.fetch(:ether_type)
-        bit3 :vlan_pcp_internal, onlyif: :vlan?
+        if options
+          ether_type :ether_type, value: options.fetch(:ether_type)
+        else
+          ether_type :ether_type
+        end
+        bit3 :vlan_pcp, onlyif: :vlan?
         bit1 :vlan_cfi, onlyif: :vlan?
-        bit12 :vlan_vid_internal, onlyif: :vlan?
+        bit12 :vlan_vid, onlyif: :vlan?
         uint16 :ether_type_vlan, value: :ether_type, onlyif: :vlan?
       end
     end
+    # rubocop:enable MethodLength
 
-    def vlan_vid
-      vlan? ? vlan_vid_internal : 0xffff
+    def ethernet_header_length
+      vlan? ? 18 : 14
     end
 
-    def vlan_pcp
-      vlan? ? vlan_pcp_internal : 0
-    end
+    private
 
     def vlan?
-      ether_type == EtherType::VLAN
+      ether_type == Type::VLAN
     end
   end
+
+  # Ethernet header generator/parser
+  class EthernetHeader < BinData::Record
+    extend ClassInspector
+    include Ethernet
+    include InstanceInspector
+    include RubyDumper
+
+    endian :big
+
+    ethernet_header
+  end
 end