pio 0.30.0 → 0.30.2

data/lib/pio/open_flow10/packet_in.rb

@@ -1,39 +1,23 @@
-require 'pio/ethernet_header'
-require 'pio/ipv4_header'
-require 'pio/open_flow'
-require 'pio/parse_error'
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/try'
+require 'pio/open_flow/message'
+require 'pio/open_flow10/packet_in/reason'
 require 'pio/parser'
 
 module Pio
   module OpenFlow10
     # OpenFlow 1.0 Packet-In message
     class PacketIn < OpenFlow::Message
-      # Why is this packet being sent to the controller?
-      # (enum ofp_packet_in_reason)
-      class Reason < BinData::Primitive
-        REASONS = { no_match: 0, action: 1 }
-
-        uint8 :reason
-
-        def get
-          REASONS.invert.fetch(reason)
-        end
-
-        def set(value)
-          self.reason = REASONS.fetch(value)
-        end
-      end
-
       open_flow_header version: 1,
-                       message_type: 10,
-                       message_length: -> { 18 + raw_data.length }
+                       type: 10,
+                       length: -> { header_length + 10 + raw_data.length }
       uint32 :buffer_id
-      uint16 :total_len, value: -> { raw_data.length }
+      uint16 :total_length, initial_value: -> { raw_data.length }
       uint16 :in_port
       reason :reason
       uint8 :padding
-      hide :padding
-      string :raw_data, read_length: :total_len
+      string :raw_data, read_length: -> { length - header_length - 10 }
 
       def data
         @data ||= Pio::Parser.read(raw_data)
@@ -43,13 +27,35 @@ module Pio
         data.is_a? Lldp
       end
 
+      def to_ruby
+        @format.to_ruby
+      end
+
+      # rubocop:disable LineLength
+      def self.inspect
+        'PacketIn(open_flow_version: uint8, message_type: uint8, message_length: uint16, transaction_id: uint32, buffer_id: uint32, total_length: uint16, in_port: uint16, reason: symbol, raw_data: string)'
+      end
+      # rubocop:enable LineLength
+
+      # rubocop:disable LineLength
+      def inspect
+        data_inspection = if raw_data.empty?
+                            %(raw_data: "")
+                          else
+                            %(data: #{data.inspect})
+                          end
+        %(#<PacketIn open_flow_version: #{version}, message_type: #{type}, message_length: #{_length}, transaction_id: #{Kernel.format('0x%x', transaction_id)}, buffer_id: #{Kernel.format('0x%x', buffer_id)}, total_length: #{total_length}, in_port: #{in_port}, reason: :#{reason}, #{data_inspection}>)
+      end
+      # rubocop:enable LineLength
+
       def method_missing(method, *args)
-        data.__send__(method, *args).snapshot
+        bindata_value = data.__send__(method, *args)
+        bindata_value.try(:snapshot) || bindata_value
       end
 
       attr_accessor :datapath_id
-      alias_method :dpid, :datapath_id
-      alias_method :dpid=, :datapath_id=
+      alias dpid datapath_id
+      alias dpid= datapath_id=
     end
   end
 end

data/lib/pio/open_flow10/packet_out.rb

@@ -1,18 +1,19 @@
-require 'pio/open_flow'
+# frozen_string_literal: true
+
+require 'pio/open_flow/message'
 require 'pio/open_flow10/actions'
 
-# Base module.
 module Pio
   module OpenFlow10
     # OpenFlow 1.0 Packet-Out message
     class PacketOut < OpenFlow::Message
       open_flow_header version: 1,
-                       message_type: 13,
-                       message_length: -> { 16 + actions_len + raw_data.length }
+                       type: 13,
+                       length: -> { 16 + actions_length + raw_data.length }
       uint32 :buffer_id
       uint16 :in_port
-      uint16 :actions_len, initial_value: -> { actions.binary.length }
-      actions :actions, length: -> { actions_len }
+      uint16 :actions_length, initial_value: -> { actions.binary.length }
+      actions10 :actions, length: -> { actions_length }
       rest :raw_data
     end
   end

data/lib/pio/open_flow10/phy_port16.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'bindata'
+require 'pio/open_flow/flags'
 require 'pio/type/mac_address'
 
 module Pio
@@ -7,84 +10,61 @@ module Pio
     class PhyPort16 < BinData::Record
       extend OpenFlow::Flags
 
-      # enum ofp_port_config
-      flags_32bit :port_config,
-                  [:port_down,
-                   :no_stp,
-                   :no_recv,
-                   :no_recv_stp,
-                   :no_flood,
-                   :no_fwd,
-                   :no_packet_in]
+      endian :big
 
-      # enum ofp_port_state
-      flags_32bit :port_state,
+      uint16 :number
+      mac_address :mac_address
+      string :name, length: 16, trim_padding: true
+      flags_32bit :config,
+                  %i[port_down
+                     no_stp
+                     no_receive
+                     no_receive_stp
+                     no_flood
+                     no_forward
+                     no_packet_in]
+      flags_32bit :state,
                   link_down: 1 << 0,
                   stp_listen: 0 << 8,
                   stp_learn: 1 << 8,
                   stp_forward: 2 << 8,
                   stp_block: 3 << 8
 
-      # enum ofp_port_features
-      flags_32bit :port_feature,
-                  [:port_10mb_hd,
-                   :port_10mb_fd,
-                   :port_100mb_hd,
-                   :port_100mb_fd,
-                   :port_1gb_hd,
-                   :port_1gb_fd,
-                   :port_10gb_fd,
-                   :port_copper,
-                   :port_fiber,
-                   :port_autoneg,
-                   :port_pause,
-                   :port_pause_asym]
-
-      endian :big
-
-      uint16 :port_no
-      mac_address :hardware_address
-      string :name, length: 16, trim_padding: true
-      port_config :config
-      port_state :state
+      define_flags_32bit :port_feature,
+                         %i[port_10mb_hd
+                            port_10mb_fd
+                            port_100mb_hd
+                            port_100mb_fd
+                            port_1gb_hd
+                            port_1gb_fd
+                            port_10gb_fd
+                            port_copper
+                            port_fiber
+                            port_autoneg
+                            port_pause
+                            port_pause_asym]
       port_feature :curr
       port_feature :advertised
       port_feature :supported
       port_feature :peer
 
-      # rubocop:disable MethodLength
-      def snapshot
-        super.tap do |ss|
-          def ss.datapath_id
-            @datapath_id || fail
-          end
-
-          def ss.dpid
-            @datapath_id || fail
-          end
-
-          def ss.number
-            port_no
-          end
+      cattr_reader(:length) { 48 }
 
-          def ss.mac_address
-            hardware_address
-          end
+      attr_accessor :datapath_id
+      alias dpid datapath_id
+      alias dpid= datapath_id=
 
-          def ss.up?
-            !down?
-          end
+      def up?
+        !down?
+      end
 
-          def ss.down?
-            config.include?(:port_down) || state.include?(:link_down)
-          end
+      def down?
+        config.include?(:port_down) || state.include?(:link_down)
+      end
 
-          def ss.local?
-            port_no == OpenFlow10::Port16.reserved_port_number(:local)
-          end
-        end
+      def local?
+        number == OpenFlow10::Port16.reserved_port_number(:local)
       end
-      # rubocop:enable MethodLength
     end
   end
 end

data/lib/pio/open_flow10/port16.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/port'
 
 module Pio

data/lib/pio/open_flow10/port_stats/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/message'
 
 module Pio
@@ -6,9 +8,7 @@ module Pio
     class PortStats
       # Port Stats Request message
       class Request < OpenFlow::Message
-        open_flow_header version: 1,
-                         message_type: 16,
-                         message_length: 20
+        open_flow_header version: 1, type: 16, length: 20
 
         stats_type :stats_type, value: -> { :port }
         uint16 :flags

data/lib/pio/open_flow10/port_status/reason.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Pio
+  module OpenFlow10
+    # OpenFlow 1.0 Port Status message
+    class PortStatus < OpenFlow::Message
+      # What changed about the physical port
+      class Reason < BinData::Primitive
+        REASONS = { add: 0, delete: 1, modify: 2 }.freeze
+
+        uint8 :reason
+
+        def get
+          REASONS.invert.fetch(reason)
+        end
+
+        def set(value)
+          self.reason = REASONS.fetch(value)
+        end
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/port_status.rb

@@ -1,43 +1,38 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/delegation'
 require 'pio/open_flow/message'
+require 'pio/open_flow10/phy_port16'
+require 'pio/open_flow10/port_status/reason'
 
 module Pio
   module OpenFlow10
     # OpenFlow 1.0 Port Status message
     class PortStatus < OpenFlow::Message
-      # What changed about the physical port
-      class Reason < BinData::Primitive
-        REASONS = { add: 0, delete: 1, modify: 2 }
-
-        uint8 :reason
-
-        def get
-          REASONS.invert.fetch(reason)
-        end
-
-        def set(value)
-          self.reason = REASONS.fetch(value)
-        end
-      end
+      open_flow_header version: 1, type: 12,
+                       length: -> { header_length + 8 + PhyPort16.length }
 
-      open_flow_header version: 1,
-                       message_type: 12,
-                       message_length: 10
       reason :reason
       uint56 :padding
       hide :padding
-      phy_port16 :desc
-
-      def reason
-        @format.reason.to_sym
-      end
-
-      attr_writer :datapath_id
-
-      def desc
-        @desc ||= @format.desc.snapshot
-        @desc.instance_variable_set :@datapath_id, @datapath_id
-        @desc
-      end
+      phy_port16 :description
+
+      attr_accessor :datapath_id
+      alias dpid datapath_id
+      alias dpid= datapath_id=
+
+      delegate :number, to: :description
+      delegate :mac_address, to: :description
+      delegate :name, to: :description
+      delegate :config, to: :description
+      delegate :state, to: :description
+      delegate :curr, to: :description
+      delegate :advertised, to: :description
+      delegate :supported, to: :description
+      delegate :peer, to: :description
+      delegate :up?, to: :description
+      delegate :down?, to: :description
+      delegate :local?, to: :description
     end
   end
 end

data/lib/pio/open_flow10/queue_stats/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/message'
 
 module Pio
@@ -6,9 +8,7 @@ module Pio
     class QueueStats
       # Queue Stats Request message
       class Request < OpenFlow::Message
-        open_flow_header version: 1,
-                         message_type: 16,
-                         message_length: 20
+        open_flow_header version: 1, type: 16, length: 20
 
         stats_type :stats_type, value: -> { :queue }
         uint16 :flags

data/lib/pio/open_flow10/send_out_port.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/monkey_patch/integer'
 require 'pio/open_flow/action'
 require 'pio/open_flow10/port16'
@@ -21,8 +23,8 @@ module Pio
                   end
         max_length = options[:max_length]
         if max_length && !max_length.unsigned_16bit?
-          fail(ArgumentError,
-               'The max_length should be an unsigned 16bit integer.')
+          raise(ArgumentError,
+                'The max_length should be an unsigned 16bit integer.')
         end
         super(options)
       end

data/lib/pio/open_flow10/set_destination_ip_address.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/action'
 require 'pio/type/ip_address'
 

data/lib/pio/open_flow10/set_destination_mac_address.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/action'
 require 'pio/type/mac_address'
 

data/lib/pio/open_flow10/set_source_ip_address.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/action'
 require 'pio/type/ip_address'
 

data/lib/pio/open_flow10/set_source_mac_address.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/action'
 require 'pio/type/mac_address'
 

data/lib/pio/open_flow10/set_tos.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/monkey_patch/integer'
 require 'pio/open_flow/action'
 
@@ -14,8 +16,8 @@ module Pio
         # tos (IP ToS) value consists of 8 bits, of which only the
         # 6 high-order bits belong to DSCP, the 2 low-order bits must
         # be zero.
-        unless type_of_service.unsigned_8bit? && type_of_service % 4 == 0
-          fail ArgumentError, 'Invalid type_of_service (ToS) value.'
+        unless type_of_service.unsigned_8bit? && (type_of_service % 4).zero?
+          raise ArgumentError, 'Invalid type_of_service (ToS) value.'
         end
         super(type_of_service: type_of_service)
       end

data/lib/pio/open_flow10/set_transport_port.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/monkey_patch/integer'
 require 'pio/open_flow/action'
 
@@ -13,7 +15,8 @@ module Pio
       def initialize(number)
         port = number.to_i
         unless port.unsigned_16bit?
-          fail ArgumentError, 'TCP/UDP port must be an unsigned 16-bit integer.'
+          raise ArgumentError,
+                'TCP/UDP port must be an unsigned 16-bit integer.'
         end
         super(port: port)
       rescue NoMethodError
@@ -31,7 +34,8 @@ module Pio
       def initialize(number)
         port = number.to_i
         unless port.unsigned_16bit?
-          fail ArgumentError, 'TCP/UDP port must be an unsigned 16-bit integer.'
+          raise ArgumentError,
+                'TCP/UDP port must be an unsigned 16-bit integer.'
         end
         super(port: port)
       rescue NoMethodError

data/lib/pio/open_flow10/set_vlan_priority.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/action'
 
 module Pio
@@ -12,7 +14,7 @@ module Pio
       def initialize(number)
         priority = number.to_i
         if priority < 0 || priority > 7
-          fail ArgumentError, 'VLAN priority must be between 0 and 7 inclusive'
+          raise ArgumentError, 'VLAN priority must be between 0 and 7 inclusive'
         end
         super(vlan_priority: priority)
       rescue NoMethodError

data/lib/pio/open_flow10/set_vlan_vid.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/action'
 
 module Pio
@@ -12,7 +14,7 @@ module Pio
       def initialize(number)
         vlan_id = number.to_i
         unless vlan_id >= 1 && vlan_id <= 4095
-          fail ArgumentError, 'VLAN ID must be between 1 and 4095 inclusive'
+          raise ArgumentError, 'VLAN ID must be between 1 and 4095 inclusive'
         end
         super(vlan_id: vlan_id)
       rescue NoMethodError

data/lib/pio/open_flow10/stats_reply.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/message'
 require 'pio/open_flow10/aggregate_stats/reply'
 require 'pio/open_flow10/description_stats/reply'
@@ -7,21 +9,18 @@ module Pio
   module OpenFlow10
     class Stats
       # Stats reply parser.
-      class Reply
-        TYPES = {
+      class Reply < OpenFlow::Message
+        open_flow_header version: 1, type: 17, length: 10
+        stats_type :stats_type
+
+        TYPE = {
           description: OpenFlow10::DescriptionStats::Reply,
           flow: OpenFlow10::FlowStats::Reply,
           aggregate: OpenFlow10::AggregateStats::Reply
-        }
-
-        # Stats reply format.
-        class Format < OpenFlow::Message
-          open_flow_header version: 1, message_type: 17, message_length: 10
-          stats_type :stats_type
-        end
+        }.freeze
 
         def self.read(binary)
-          TYPES.fetch(Format.read(binary).stats_type.to_sym).read(binary)
+          TYPE.fetch(Format.read(binary).stats_type.to_sym).read(binary)
         rescue KeyError
           raise "Unknown stats type: #{stats_type}"
         end

data/lib/pio/open_flow10/stats_request.rb

@@ -1,28 +1,31 @@
-require 'pio/open_flow10/table_stats/request'
-require 'pio/open_flow10/port_stats/request'
+# frozen_string_literal: true
+
 require 'pio/open_flow/message'
+require 'pio/open_flow10/aggregate_stats/request'
+require 'pio/open_flow10/flow_stats/request'
+require 'pio/open_flow10/port_stats/request'
+require 'pio/open_flow10/queue_stats/request'
+require 'pio/open_flow10/table_stats/request'
 
 module Pio
   module OpenFlow10
     class Stats
       # Stats request parser.
-      class Request
-        TYPES = {
+      class Request < OpenFlow::Message
+        open_flow_header version: 1, type: 16, length: 10
+        stats_type :stats_type
+
+        TYPE = {
+          aggregate: OpenFlow10::AggregateStats::Request,
           description: OpenFlow10::DescriptionStats::Request,
           flow: OpenFlow10::FlowStats::Request,
-          aggregate: OpenFlow10::AggregateStats::Request,
-          table: OpenFlow10::TableStats::Request,
-          port: OpenFlow10::PortStats::Request
-        }
-
-        # Stats request format.
-        class Format < OpenFlow::Message
-          open_flow_header version: 1, message_type: 16, message_length: 10
-          stats_type :stats_type
-        end
+          port: OpenFlow10::PortStats::Request,
+          queue: OpenFlow10::QueueStats::Request,
+          table: OpenFlow10::TableStats::Request
+        }.freeze
 
         def self.read(binary)
-          TYPES.fetch(Format.read(binary).stats_type.to_sym).read(binary)
+          TYPE.fetch(Format.read(binary).stats_type.to_sym).read(binary)
         rescue KeyError
           raise "Unknown stats type: #{stats_type}"
         end

data/lib/pio/open_flow10/stats_type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pio
   module OpenFlow10
     # enum ofp_stats_types
@@ -10,7 +12,7 @@ module Pio
         port: 4,
         queue: 5,
         vendor: 0xffff
-      }
+      }.freeze
 
       endian :big
       uint16 :command

data/lib/pio/open_flow10/strip_vlan_header.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow/action'
 
 module Pio

data/lib/pio/open_flow10/table_stats/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pio/open_flow10/stats_type'
 require 'pio/open_flow/message'
 
@@ -7,9 +9,7 @@ module Pio
     module TableStats
       # OpenFlow 1.0 Table Stats Request message
       class Request < OpenFlow::Message
-        open_flow_header version: 1,
-                         message_type: 16,
-                         message_length: 12
+        open_flow_header version: 1, type: 16, length: 12
         stats_type :stats_type, value: -> { :table }
         uint16 :flags
         string :body, value: ''