pio 0.30.0 → 0.30.2

data/lib/pio/icmp/request.rb

@@ -1,52 +1,19 @@
+# frozen_string_literal: true
+
 require 'pio/icmp/message'
-require 'pio/icmp/options'
-require 'pio/mac'
 
 module Pio
   class Icmp
     # ICMP Request packet generator
     class Request < Message
-      TYPE = 8
-      public_class_method :new
-
-      # User options for creating an ICMP Request.
-      class Options < Pio::Icmp::Options
-        DEFAULT_IDENTIFIER = 0x0100
-        DEFAULT_SEQUENCE_NUMBER = 0
-
-        mandatory_option :source_mac
-        mandatory_option :destination_mac
-        mandatory_option :source_ip_address
-        mandatory_option :destination_ip_address
-        option :identifier
-        option :sequence_number
-        option :echo_data
-
-        # rubocop:disable MethodLength
-        # rubocop:disable AbcSize
-        def initialize(options)
-          validate options
-          @type = TYPE
-
-          @source_mac = Mac.new(options[:source_mac]).freeze
-          @destination_mac = Mac.new(options[:destination_mac]).freeze
-          @source_ip_address =
-            IPv4Address.new(options[:source_ip_address]).freeze
-          @destination_ip_address =
-            IPv4Address.new(options[:destination_ip_address]).freeze
-          @identifier =
-            options[:icmp_identifier] ||
-            options[:identifier] ||
-            DEFAULT_IDENTIFIER
-          @sequence_number =
-            options[:icmp_sequence_number] ||
-            options[:sequence_number] ||
-            DEFAULT_SEQUENCE_NUMBER
-          @echo_data = options[:echo_data] || ''
-        end
-        # rubocop:enable AbcSize
-        # rubocop:enable MethodLength
-      end
+      option :icmp_type, value: 8
+      option :source_mac
+      option :destination_mac
+      option :source_ip_address
+      option :destination_ip_address
+      option :icmp_identifier, default: 0
+      option :icmp_sequence_number, default: 0
+      option :echo_data, default: ''
     end
   end
 end

data/lib/pio/icmp.rb

@@ -1,14 +1,19 @@
+# frozen_string_literal: true
+
 require 'pio/icmp/format'
 require 'pio/icmp/reply'
 require 'pio/icmp/request'
-require 'pio/message_type_selector'
+require 'pio/parse_error'
 
-# Packet parser and generator library.
 module Pio
   # Icmp parser and generator.
   class Icmp
-    extend MessageTypeSelector
-    message_type Request::TYPE => Request, Reply::TYPE => Reply
+    def self.read(raw_data)
+      format = Format.read(raw_data)
+      { Request.icmp_type => Request,
+        Reply.icmp_type => Reply }.fetch(format.icmp_type).create(format)
+    rescue
+      raise Pio::ParseError, $ERROR_INFO.message
+    end
   end
-  ICMP = Icmp
 end

data/lib/pio/instance_inspector.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pio
+  # Introduces #inspect method
+  module InstanceInspector
+    def inspect
+      "#<#{self.class.name} " +
+        field_names.map do |each|
+          next if each == :padding
+          next unless __send__("#{each}?")
+          "#{each}: #{__send__(each).inspect}"
+        end.compact.join(', ') +
+        '>'
+    end
+  end
+end

data/lib/pio/ipv4_address.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'ipaddr'
 
@@ -21,14 +23,14 @@ module Pio
     # @return [IPv4Address] self
     #   a proxy to IPAddr.
     def initialize(addr)
-      case addr
-      when Integer
-        @value = IPAddr.new(addr, Socket::AF_INET)
-      when String
-        @value = IPAddr.new(addr)
-      else
-        @value = addr.value
-      end
+      @value = case addr
+               when Integer
+                 IPAddr.new(addr, Socket::AF_INET)
+               when String
+                 IPAddr.new(addr)
+               else
+                 addr.value
+               end
     end
 
     # @return [String] the IPv4 address in its text representation.
@@ -78,14 +80,14 @@ module Pio
       @value = @value.mask(masklen)
       self
     end
-    alias_method :prefix!, :mask!
+    alias prefix! mask!
 
     # Returns the IPv4 address masked with +masklen+.
     # @return [IPv4Address]
     def mask(masklen)
       clone.mask!(masklen)
     end
-    alias_method :prefix, :mask
+    alias prefix mask
 
     # @return [bool]
     #   Returns true if the address belongs to class A.
@@ -110,7 +112,7 @@ module Pio
     def class_d?
       mask(4).to_s == '224.0.0.0'
     end
-    alias_method :multicast?, :class_d?
+    alias multicast? class_d?
 
     # @return [bool]
     #   Returns true if the address belongs to class E.

data/lib/pio/ipv4_header.rb

@@ -1,9 +1,14 @@
+# frozen_string_literal: true
+
+require 'pio/instance_inspector'
+require 'pio/monkey_patch/bindata_string'
 require 'pio/payload'
+require 'pio/ruby_dumper'
 require 'pio/type/ip_address'
 
 module Pio
   # IP Version 4 Header Format
-  module IPv4Header
+  module IPv4
     # Internet protocol numbers for ipv4_header.ip_protocol
     module ProtocolNumber
       ICMP = 1
@@ -39,7 +44,7 @@ module Pio
         in_port: in_port,
         source_mac_address: source_mac,
         destination_mac_address: destination_mac,
-        vlan_vid: vlan_vid,
+        vlan_vid: vlan? ? vlan_vid : 0xffff,
         vlan_priority: vlan_pcp,
         ether_type: ether_type,
         tos: ip_type_of_service,
@@ -53,6 +58,10 @@ module Pio
     end
     # rubocop:enable MethodLength
 
+    def ip_header_length_in_bytes
+      ip_header_length * 4
+    end
+
     private
 
     def calculate_ip_length
@@ -82,4 +91,19 @@ module Pio
       20 - ip_header_length * 4
     end
   end
+
+  # IPv4 header generator/parser
+  class IPv4Header < BinData::Record
+    include IPv4
+    include InstanceInspector
+    include RubyDumper
+
+    ipv4_header
+
+    # rubocop:disable LineLength
+    def self.inspect
+      'IPv4Header(ip_version: bit4, ip_header_length: bit4, ip_type_of_service: uint8, ip_total_length: uint16, ip_identifier: uint16, ip_flag: bit3, ip_fragment: bit13, ip_ttl: uint8, ip_protocol: uint8, ip_header_checksum: uint16, source_ip_address: ip_address, destination_ip_address: ip_address, ip_option: string)'
+    end
+    # rubocop:enable LineLength
+  end
 end

data/lib/pio/lldp/chassis_id_tlv.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bindata'
 
 module Pio

data/lib/pio/lldp/end_of_lldpdu_value.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bindata'
 
 module Pio

data/lib/pio/lldp/frame.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bindata'
 
 require 'pio/ethernet_header'
@@ -11,11 +13,11 @@ module Pio
   class Lldp
     # LLDP frame
     class Frame < BinData::Record
-      include EthernetHeader
+      include Ethernet
 
       endian :big
 
-      ethernet_header ether_type: EtherType::LLDP
+      ethernet_header ether_type: Ethernet::Type::LLDP
       chassis_id_tlv :chassis_id
       port_id_tlv :port_id
       ttl_tlv :ttl, initial_value: 120

data/lib/pio/lldp/management_address_value.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bindata'
 
 module Pio

data/lib/pio/lldp/optional_tlv.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/lldp/port_description_value'
 require 'pio/lldp/system_name_value'
 require 'pio/lldp/system_description_value'
@@ -29,7 +31,7 @@ module Pio
       end
 
       def end_of_lldpdu?
-        tlv_type == 0
+        tlv_type.zero?
       end
 
       def chooser
@@ -52,7 +54,7 @@ module Pio
       end
 
       def end_of_lldpdu_tlv?
-        tlv_type == 0
+        tlv_type.zero?
       end
     end
   end

data/lib/pio/lldp/options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/options'
 
 module Pio
@@ -9,8 +11,8 @@ module Pio
       option :destination_mac
       option :source_mac
 
-      DEFAULT_DESTINATION_MAC = '01:80:c2:00:00:0e'.freeze
-      DEFAULT_SOURCE_MAC = '01:02:03:04:05:06'.freeze
+      DEFAULT_DESTINATION_MAC = '01:80:c2:00:00:0e'
+      DEFAULT_SOURCE_MAC = '01:02:03:04:05:06'
 
       def initialize(options)
         validate options

data/lib/pio/lldp/organizationally_specific_value.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bindata'
 
 module Pio

data/lib/pio/lldp/port_description_value.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bindata'
 
 module Pio

data/lib/pio/lldp/port_id_tlv.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bindata'
 
 module Pio

data/lib/pio/lldp/system_capabilities_value.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bindata'
 
 module Pio

data/lib/pio/lldp/system_description_value.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bindata'
 
 module Pio

data/lib/pio/lldp/system_name_value.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bindata'
 
 module Pio

data/lib/pio/lldp/ttl_tlv.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bindata'
 
 module Pio

data/lib/pio/lldp.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'English'
 require 'forwardable'
 require 'pio/lldp/frame'

data/lib/pio/mac.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 module Pio
@@ -29,7 +31,7 @@ module Pio
         @value = value.to_int
         validate_value_range
       else
-        fail TypeError
+        raise TypeError
       end
     rescue ArgumentError, TypeError
       raise InvalidValueError, "Invalid MAC address: #{value.inspect}"
@@ -91,6 +93,10 @@ module Pio
       to_s.split(':').map(&:hex)
     end
 
+    def to_hex
+      to_a.map(&:to_hex).join(', ')
+    end
+
     # @!endgroup
 
     # @!group Predicates
@@ -202,12 +208,12 @@ module Pio
       when /^(?:#{octet}(:)){5}#{octet}$/, /^(?:#{doctet}(\.)){2}#{doctet}$/
         mac.gsub(Regexp.last_match[1], '').hex
       else
-        fail ArgumentError
+        raise ArgumentError
       end
     end
 
     def validate_value_range
-      fail ArgumentError unless @value >= 0 && @value <= 0xffffffffffff
+      raise ArgumentError unless @value >= 0 && @value <= 0xffffffffffff
     end
   end
 end

data/lib/pio/message.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/class/attribute'
+require 'pio/ruby_dumper'
+
+module Pio
+  # Base message class
+  class Message
+    include RubyDumper
+
+    class_attribute :options
+
+    def self.option(name, value: nil, default: nil)
+      self.options ||= {}
+      if value && !value.is_a?(Symbol)
+        class_eval { class_attribute name }
+        class_eval { __send__("#{name}=", value) }
+      end
+      self.options.merge! name => { value: value, default: default }
+    end
+
+    private
+
+    # rubocop:disable MethodLength
+    # rubocop:disable AbcSize
+    # rubocop:disable PerceivedComplexity
+    # rubocop:disable CyclomaticComplexity
+    def parse_options(user_options)
+      options = {}
+      self.class.options.each_pair do |key, attrs|
+        if !attrs[:value] && !attrs[:default]
+          begin
+            options[key] = user_options.fetch(key)
+          rescue
+            raise "#{key} option is a mandatory"
+          end
+        elsif attrs[:value] && attrs[:value].is_a?(Symbol)
+          options[key] = user_options.fetch(attrs[:value])
+        elsif attrs[:value]
+          options[key] = user_options[key] || attrs[:value]
+        else
+          options[key] = user_options[key] || attrs[:default]
+        end
+      end
+      options
+    end
+    # rubocop:enable MethodLength
+    # rubocop:enable AbcSize
+    # rubocop:enable PerceivedComplexity
+    # rubocop:enable CyclomaticComplexity
+  end
+end

data/lib/pio/message_type_selector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'English'
 require 'pio/parse_error'
 

data/lib/pio/monkey_patch/bindata_record.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module BinData
+  # Add BinData::Record#to_binary
+  class Record
+    alias to_binary to_binary_s
+  end
+end

data/lib/pio/monkey_patch/bindata_string.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module BinData
+  # Add BinData::String#to_bytes
+  class String
+    def to_bytes
+      to_s.unpack('H*').pop.scan(/[0-9a-f]{2}/).map do |each|
+        "0x#{each}"
+      end.join(', ')
+    end
+  end
+end

data/lib/pio/monkey_patch/integer/base_conversions.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module MonkeyPatch
   module Integer
     # to_hex etc.
     module BaseConversions
       def to_hex
-        format '%#x', self
+        format '0x%02x', self
       end
     end
   end

data/lib/pio/monkey_patch/integer/ranges.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MonkeyPatch
   module Integer
     # Defines Integer#nbit? methods.

data/lib/pio/monkey_patch/integer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/monkey_patch/integer/base_conversions'
 require 'pio/monkey_patch/integer/ranges'
 

data/lib/pio/monkey_patch/uint/base_conversions.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module MonkeyPatch
+  module Uint
+    # Uint8#to_bytes, Uintxxbe#to_bytes
+    module BaseConversions
+      def to_bytes
+        /Uint(8|\d+be)$/=~ self.class.name
+        nbyte = Regexp.last_match(1).to_i / 4
+        format("%0#{nbyte}x", to_i).scan(/.{1,2}/).map do |each|
+          '0x' + each
+        end.join(', ')
+      end
+    end
+  end
+end

data/lib/pio/monkey_patch/uint.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bindata'
+require 'pio/monkey_patch/uint/base_conversions'
+
+# BinData's base module
+module BinData
+  Uint8.__send__ :include, MonkeyPatch::Uint::BaseConversions
+  Uint16be.__send__ :include, MonkeyPatch::Uint::BaseConversions
+  Uint32be.__send__ :include, MonkeyPatch::Uint::BaseConversions
+end

data/lib/pio/open_flow/action.rb

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
+
+require 'active_support/descendants_tracker'
 require 'bindata'
 
 module Pio
   module OpenFlow
     # OpenFlow actions.
     class Action
-      def self.inherited(child_klass)
-        child_klass.const_set :Format, Class.new(BinData::Record)
-      end
+      extend ActiveSupport::DescendantsTracker
 
       def self.action_header(options)
         module_eval do
@@ -24,7 +25,12 @@ module Pio
       end
 
       def self.method_missing(method, *args, &block)
-        const_get(:Format).__send__ method, *args, &block
+        begin
+          const_get(:Format).__send__ method, *args, &block
+        rescue NameError
+          const_set :Format, Class.new(BinData::Record)
+          retry
+        end
         return if method == :endian || method == :virtual
         define_method(args.first) { @format.__send__ args.first }
       end

data/lib/pio/open_flow/buffer_id.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Pio
+  module OpenFlow
+    # Buffered packet to apply to, or :no_buffer.
+    class BufferId < BinData::Primitive
+      NO_BUFFER = 0xffffffff
+
+      endian :big
+      uint32 :buffer_id, initial_value: NO_BUFFER
+
+      def get
+        buffer_id == NO_BUFFER ? :no_buffer : buffer_id
+      end
+
+      def set(value)
+        self.buffer_id = (value == :no_buffer ? NO_BUFFER : value)
+      end
+    end
+  end
+end

data/lib/pio/open_flow/datapath_id.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bindata'
 require 'pio/monkey_patch/integer'
 
@@ -12,14 +14,14 @@ module Pio
 
       def set(value)
         unless value.unsigned_64bit?
-          fail(ArgumentError,
-               'Datapath ID should be an unsigned 64-bit integer.')
+          raise(ArgumentError,
+                'Datapath ID should be an unsigned 64-bit integer.')
         end
         self.datapath_id = value
       end
 
       def get
-        datapath_id
+        datapath_id.to_i
       end
     end
   end

data/lib/pio/open_flow/error_message.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/string/inflections'
+
+module Pio
+  module OpenFlow
+    # Error message parser
+    module ErrorMessage
+      mattr_reader(:type) { 1 }
+
+      # rubocop:disable AbcSize
+      def read(binary)
+        body = OpenFlow::Header.read(binary).body
+        error = const_get(:BodyParser).read(body)
+        klass = error_classes.find do |each|
+          each.name.split('::').last.underscore == error.error_type.to_s
+        end
+        unless klass
+          raise 'Unknown error message '\
+               "(type=#{error.error_type}, code=#{error.error_code})"
+        end
+        klass.read binary
+      end
+      # rubocop:enable AbcSize
+
+      def error_classes
+        OpenFlow::Message.descendants.select do |each|
+          each.parents.include? parent.const_get(:Error)
+        end
+      end
+    end
+  end
+end