pio 0.9.0 → 0.10.0

data/lib/pio/send_out_port.rb

@@ -0,0 +1,74 @@
+require 'bindata'
+require 'forwardable'
+require 'pio/monkey_patch/integer'
+
+module Pio
+  # An action to output a packet to a port.
+  class SendOutPort
+    # OpenFlow 1.0 OFPAT_OUTPUT action format.
+    class Format < BinData::Record
+      endian :big
+
+      uint16 :type, value: 0
+      uint16 :message_length, value: 8
+      port_number :port_number
+      uint16 :max_len, initial_value: 2**16 - 1
+    end
+
+    def self.read(raw_data)
+      send_out_port = allocate
+      send_out_port.instance_variable_set :@format, Format.read(raw_data)
+      send_out_port
+    end
+
+    extend Forwardable
+
+    def_delegators :@format, :message_length
+    def_delegators :@format, :port_number
+    def_delegators :@format, :max_len
+    def_delegator :@format, :to_binary_s, :to_binary
+
+    # Creates an action to output a packet to a port.
+    #
+    # @example
+    #   SendOutPort.new(1)
+    #   SendOutPort.new(port_number: 1)
+    #   SendOutPort.new(port_number: :controller, max_len: 256)
+    #
+    # @param [Integer|Hash] user_options
+    #   the port number or the options hash to create this action
+    #   class instance with.
+    #
+    # @option user_options [Number] :port_number
+    #   port number an index into switch's physical port list. There
+    #   are also fake output ports. For example a port number set to
+    #   +:flood+ would output packets to all physical ports except
+    #   input port and ports disabled by STP.
+    # @option user_options [Number] :max_len
+    #   the maximum number of bytes from a packet to send to
+    #   controller when port is set to +:controller+. A zero length
+    #   means no bytes of the packet should be sent. It defaults to
+    #   64K.
+    #
+    # @raise [ArgumentError] if +:port_number+ is not an unsigned
+    #                        16-bit integer.
+    # @raise [ArgumentError] if +:max_len+ is not an unsigned 16-bit integer.
+    #
+    # rubocop:disable MethodLength
+    def initialize(user_options)
+      options = if user_options.respond_to?(:to_i)
+                  { port_number: user_options.to_i }
+                elsif PortNumber::NUMBERS.key?(user_options)
+                  { port_number: user_options }
+                else
+                  user_options
+                end
+      max_len = options[:max_len]
+      if max_len && !max_len.unsigned_16bit?
+        fail ArgumentError, 'The max_len should be an unsigned 16bit integer.'
+      end
+      @format = Format.new(options)
+    end
+    # rubocop:enable MethodLength
+  end
+end

data/lib/pio/set_eth_addr.rb

@@ -0,0 +1,52 @@
+require 'bindata'
+require 'forwardable'
+require 'pio/type/mac_address'
+
+module Pio
+  # An action to modify the source/destination Ethernet address of a packet.
+  class SetEthAddr
+    # rubocop:disable MethodLength
+    def self.def_format(action_type)
+      str = %(
+        class Format < BinData::Record
+          endian :big
+
+          uint16 :type, value: #{action_type}
+          uint16 :message_length, value: 16
+          mac_address :mac_address
+          uint48 :padding
+          hide :padding
+        end
+      )
+      module_eval str
+    end
+    # rubocop:enable MethodLength
+
+    def self.read(raw_data)
+      set_eth_addr = allocate
+      set_eth_addr.instance_variable_set(:@format,
+                                         const_get(:Format).read(raw_data))
+      set_eth_addr
+    end
+
+    extend Forwardable
+
+    def_delegators :@format, :message_length
+    def_delegators :@format, :mac_address
+    def_delegator :@format, :to_binary_s, :to_binary
+
+    def initialize(mac_address)
+      @format = self.class.const_get(:Format).new(mac_address: mac_address)
+    end
+  end
+
+  # An action to modify the source Ethernet address of a packet.
+  class SetEthSrcAddr < SetEthAddr
+    def_format 4
+  end
+
+  # An action to modify the destination Ethernet address of a packet.
+  class SetEthDstAddr < SetEthAddr
+    def_format 5
+  end
+end

data/lib/pio/set_ip_addr.rb

@@ -0,0 +1,49 @@
+require 'bindata'
+require 'forwardable'
+require 'pio/type/ip_address'
+
+module Pio
+  # An action to modify the IPv4 source/destination address of a packet.
+  class SetIpAddr
+    def self.def_format(action_type)
+      str = %(
+        class Format < BinData::Record
+          endian :big
+
+          uint16 :type, value: #{action_type}
+          uint16 :message_length, value: 8
+          ip_address :ip_address
+        end
+      )
+      module_eval str
+    end
+
+    def self.read(raw_data)
+      set_ip_addr = allocate
+      set_ip_addr.instance_variable_set(:@format,
+                                        const_get(:Format).read(raw_data))
+      set_ip_addr
+    end
+
+    extend Forwardable
+
+    def_delegators :@format, :type
+    def_delegators :@format, :message_length
+    def_delegators :@format, :ip_address
+    def_delegator :@format, :to_binary_s, :to_binary
+
+    def initialize(ip_address)
+      @format = self.class.const_get(:Format).new(ip_address: ip_address)
+    end
+  end
+
+  # An action to modify the IPv4 source address of a packet.
+  class SetIpSrcAddr < SetIpAddr
+    def_format 6
+  end
+
+  # An action to modify the IPv4 source address of a packet.
+  class SetIpDstAddr < SetIpAddr
+    def_format 7
+  end
+end

data/lib/pio/set_ip_tos.rb

@@ -0,0 +1,42 @@
+require 'bindata'
+require 'forwardable'
+require 'pio/monkey_patch/integer'
+
+module Pio
+  # An action to modify the IP ToS/DSCP field of a packet.
+  class SetIpTos
+    # OpenFlow 1.0 OFPAT_SET_NW_TOS action format.
+    class Format < BinData::Record
+      endian :big
+
+      uint16 :type, value: 8
+      uint16 :message_length, value: 8
+      uint8 :type_of_service
+      uint24 :padding
+      hide :padding
+    end
+
+    def self.read(raw_data)
+      set_ip_tos = allocate
+      set_ip_tos.instance_variable_set :@format, Format.read(raw_data)
+      set_ip_tos
+    end
+
+    extend Forwardable
+
+    def_delegators :@format, :type
+    def_delegators :@format, :message_length
+    def_delegators :@format, :type_of_service
+    def_delegator :@format, :to_binary_s, :to_binary
+
+    def initialize(type_of_service)
+      # nw_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.'
+      end
+      @format = Format.new(type_of_service: type_of_service)
+    end
+  end
+end

data/lib/pio/set_transport_port.rb

@@ -0,0 +1,58 @@
+require 'bindata'
+require 'forwardable'
+require 'pio/monkey_patch/integer'
+
+module Pio
+  # An action to modify the source/destination TCP/UDP port of a packet.
+  class SetTransportPort
+    # rubocop:disable MethodLength
+    def self.def_format(action_type)
+      str = %(
+        class Format < BinData::Record
+          endian :big
+
+          uint16 :type, value: #{action_type}
+          uint16 :message_length, value: 8
+          uint16 :port_number
+          uint16 :padding
+          hide :padding
+        end
+      )
+      module_eval str
+    end
+    # rubocop:enable MethodLength
+
+    def self.read(raw_data)
+      action = allocate
+      action.instance_variable_set(:@format, const_get(:Format).read(raw_data))
+      action
+    end
+
+    extend Forwardable
+
+    def_delegators :@format, :type
+    def_delegators :@format, :message_length
+    def_delegators :@format, :port_number
+    def_delegator :@format, :to_binary_s, :to_binary
+
+    def initialize(number)
+      port_number = number.to_i
+      unless port_number.unsigned_16bit?
+        fail ArgumentError, 'TCP/UDP port must be an unsigned 16-bit integer.'
+      end
+      @format = self.class.const_get(:Format).new(port_number: port_number)
+    rescue NoMethodError
+      raise TypeError, 'TCP/UDP port must be an unsigned 16-bit integer.'
+    end
+  end
+
+  # An action to modify the source TCP/UDP port of a packet.
+  class SetTransportSrcPort < SetTransportPort
+    def_format 9
+  end
+
+  # An action to modify the source TCP/UDP port of a packet.
+  class SetTransportDstPort < SetTransportPort
+    def_format 10
+  end
+end

data/lib/pio/set_vlan.rb

@@ -0,0 +1,37 @@
+require 'bindata'
+require 'forwardable'
+
+module Pio
+  # An action to modify the VLAN related fields of a packet.
+  class SetVlan
+    extend Forwardable
+
+    # rubocop:disable MethodLength
+    def self.def_format(field_name, action_type)
+      str = %(
+        class Format < BinData::Record
+          endian :big
+
+          uint16 :type, value: #{action_type}
+          uint16 :message_length, value: 8
+          uint16 :#{field_name}
+          uint16 :padding
+          hide :padding
+        end
+      )
+      module_eval str
+      module_eval "def_delegators :@format, :#{field_name}"
+    end
+    # rubocop:enable MethodLength
+
+    def self.read(raw_data)
+      set_vlan = allocate
+      set_vlan.instance_variable_set :@format, const_get(:Format).read(raw_data)
+      set_vlan
+    end
+
+    def_delegators :@format, :type
+    def_delegators :@format, :message_length
+    def_delegator :@format, :to_binary_s, :to_binary
+  end
+end

data/lib/pio/set_vlan_priority.rb

@@ -0,0 +1,18 @@
+require 'pio/set_vlan'
+
+module Pio
+  # An action to modify the VLAN priority of a packet.
+  class SetVlanPriority < SetVlan
+    def_format :vlan_priority, 2
+
+    def initialize(number)
+      priority = number.to_i
+      if priority < 0 || priority > 7
+        fail ArgumentError, 'VLAN priority must be between 0 and 7 inclusive'
+      end
+      @format = Format.new(vlan_priority: priority)
+    rescue NoMethodError
+      raise TypeError, 'VLAN priority must be an Integer.'
+    end
+  end
+end

data/lib/pio/set_vlan_vid.rb

@@ -0,0 +1,30 @@
+require 'pio/set_vlan'
+
+module Pio
+  # An action to modify the VLAN ID of a packet.
+  class SetVlanVid < SetVlan
+    def_format :vlan_id, 1
+
+    # Creates an action to modify the VLAN ID of a packet. The VLAN ID
+    # is 16-bits long but the actual VID (VLAN Identifier) of the IEEE
+    # 802.1Q frame is 12-bits.
+    #
+    # @example
+    #   ActionSetVlanVid.new(number)
+    #
+    # @param [Integer] number
+    #   the VLAN ID to set to. Only the lower 12-bits are used.
+    #
+    # @raise [ArgumentError] if vlan_id not within 1 and 4095 inclusive.
+    # @raise [TypeError] if vlan_id is not an Integer.
+    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'
+      end
+      @format = Format.new(vlan_id: vlan_id)
+    rescue NoMethodError
+      raise TypeError, 'VLAN ID must be an Integer.'
+    end
+  end
+end

data/lib/pio/strip_vlan_header.rb

@@ -0,0 +1,19 @@
+require 'bindata'
+
+module Pio
+  # An action to strip the 802.1q header.
+  class StripVlanHeader < BinData::Record
+    endian :big
+
+    uint16 :type, value: 3
+    uint16 :message_length, value: 8
+    uint32 :padding
+    hide :padding
+
+    alias_method :to_binary, :to_binary_s
+
+    def snapshot
+      self
+    end
+  end
+end

data/lib/pio/type/ip_address.rb

@@ -8,11 +8,20 @@ module Pio
       array :octets, type: :uint8, initial_length: 4
 
       def set(value)
-        self.octets = value
+        case value
+        when String
+          self.octets = value.split('.').map(&:to_i)
+        else
+          self.octets = value
+        end
       end
 
       def get
-        IPv4Address.new octets.map { | each | format('%d', each) }.join('.')
+        IPv4Address.new octets.map { |each| format('%d', each) }.join('.')
+      end
+
+      def ==(other)
+        get == other
       end
     end
   end

data/lib/pio/type/ipv4_header.rb

@@ -4,6 +4,7 @@ module Pio
   module Type
     # IP Version 4 Header Format
     module IPv4Header
+      # This method smells of :reek:TooManyStatements
       # rubocop:disable MethodLength
       # rubocop:disable AbcSize
       def ipv4_header(options)

data/lib/pio/type/mac_address.rb

@@ -11,6 +11,8 @@ module Pio
         case value
         when String
           self.octets = value.split(':').map { |each| ('0x' + each).hex }
+        when Integer
+          self.octets = (0..5).map { |each| value >> ((5 - each) * 8) & 0xff }
         else
           self.octets = value.to_a
         end

data/lib/pio/version.rb

@@ -1,5 +1,5 @@
 # Base module.
 module Pio
   # gem version.
-  VERSION = '0.9.0'.freeze
+  VERSION = '0.10.0'.freeze
 end

data/pio.gemspec

@@ -37,11 +37,11 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'bindata', '~> 2.1.0'
 
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'bundler', '~> 1.7.9'
+  gem.add_development_dependency 'bundler', '~> 1.7.11'
   gem.add_development_dependency 'pry', '~> 0.10.1'
 
   # Guard
-  gem.add_development_dependency 'guard', '~> 2.10.4'
+  gem.add_development_dependency 'guard', '~> 2.10.5'
   gem.add_development_dependency 'guard-bundler', '~> 2.1.0'
   gem.add_development_dependency 'guard-cucumber', '~> 1.5.3'
   gem.add_development_dependency 'guard-rspec', '~> 4.5.0'
@@ -56,9 +56,9 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'yard', '~> 0.8.7.6'
 
   # Test
-  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.3'
+  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.4'
   gem.add_development_dependency 'coveralls', '~> 0.7.2'
-  gem.add_development_dependency 'cucumber', '~> 1.3.17'
+  gem.add_development_dependency 'cucumber', '~> 1.3.18'
   gem.add_development_dependency 'flay', '~> 2.5.0'
   gem.add_development_dependency 'flog', '~> 4.3.0'
   gem.add_development_dependency 'reek', '~> 1.5.1'