pio 0.27.2 → 0.28.0

data/lib/pio/open_flow10/set_vlan_priority.rb

@@ -1,18 +1,23 @@
-require 'pio/open_flow10/set_vlan'
+require 'pio/open_flow/action'
 
 module Pio
-  # An action to modify the VLAN priority of a packet.
-  class SetVlanPriority < SetVlan
-    def_format :vlan_priority, 2
+  module OpenFlow10
+    # An action to modify the VLAN priority of a packet.
+    class SetVlanPriority < OpenFlow::Action
+      action_header action_type: 2, action_length: 8
+      uint16 :vlan_priority
+      string :padding, length: 2
+      hide :padding
 
-    def initialize(number)
-      priority = number.to_i
-      if priority < 0 || priority > 7
-        fail ArgumentError, 'VLAN priority must be between 0 and 7 inclusive'
+      def initialize(number)
+        priority = number.to_i
+        if priority < 0 || priority > 7
+          fail ArgumentError, 'VLAN priority must be between 0 and 7 inclusive'
+        end
+        super(vlan_priority: priority)
+      rescue NoMethodError
+        raise TypeError, 'VLAN priority must be an Integer.'
       end
-      @format = Format.new(vlan_priority: priority)
-    rescue NoMethodError
-      raise TypeError, 'VLAN priority must be an Integer.'
     end
   end
 end

data/lib/pio/open_flow10/set_vlan_vid.rb

@@ -1,18 +1,23 @@
-require 'pio/open_flow10/set_vlan'
+require 'pio/open_flow/action'
 
 module Pio
-  # An action to modify the VLAN ID of a packet.
-  class SetVlanVid < SetVlan
-    def_format :vlan_id, 1
+  module OpenFlow10
+    # An action to modify the VLAN ID of a packet.
+    class SetVlanVid < OpenFlow::Action
+      action_header action_type: 1, action_length: 8
+      uint16 :vlan_id
+      string :padding, length: 2
+      hide :padding
 
-    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'
+      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
+        super(vlan_id: vlan_id)
+      rescue NoMethodError
+        raise TypeError, 'VLAN ID must be an Integer.'
       end
-      @format = Format.new(vlan_id: vlan_id)
-    rescue NoMethodError
-      raise TypeError, 'VLAN ID must be an Integer.'
     end
   end
 end

data/lib/pio/open_flow10/stats_request.rb

@@ -1,3 +1,5 @@
+require 'pio/open_flow10/table_stats/request'
+require 'pio/open_flow10/port_stats/request'
 require 'pio/open_flow/message'
 
 module Pio
@@ -8,7 +10,9 @@ module Pio
         TYPES = {
           description: OpenFlow10::DescriptionStats::Request,
           flow: OpenFlow10::FlowStats::Request,
-          aggregate: OpenFlow10::AggregateStats::Request
+          aggregate: OpenFlow10::AggregateStats::Request,
+          table: OpenFlow10::TableStats::Request,
+          port: OpenFlow10::PortStats::Request
         }
 
         # Stats request format.

data/lib/pio/open_flow10/strip_vlan_header.rb

@@ -1,33 +1,16 @@
-require 'bindata'
-require 'forwardable'
+require 'pio/open_flow/action'
 
 module Pio
-  # An action to strip the 802.1q header.
-  class StripVlanHeader
-    # OpenFlow 1.0 OFPAT_STRIP_VLAN action format.
-    class Format < BinData::Record
-      endian :big
-
-      uint16 :action_type, value: 3
-      uint16 :action_length, value: 8
-      uint32 :padding
+  module OpenFlow10
+    # An action to strip the 802.1q header.
+    class StripVlanHeader < OpenFlow::Action
+      action_header action_type: 3, action_length: 8
+      string :padding, length: 4
       hide :padding
-    end
 
-    def self.read(raw_data)
-      allocate.tap do |strip_vlan|
-        strip_vlan.instance_variable_set :@format, Format.read(raw_data)
+      def initialize
+        super({})
       end
     end
-
-    extend Forwardable
-
-    def_delegators :@format, :action_type
-    def_delegator :@format, :action_length, :length
-    def_delegator :@format, :to_binary_s, :to_binary
-
-    def initialize
-      @format = Format.new
-    end
   end
 end

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

@@ -0,0 +1,19 @@
+require 'pio/open_flow10/stats_type'
+require 'pio/open_flow/message'
+
+module Pio
+  module OpenFlow10
+    # OpenFlow 1.0 Table Stats messages
+    module TableStats
+      # OpenFlow 1.0 Table Stats Request message
+      class Request < OpenFlow::Message
+        open_flow_header version: 1,
+                         message_type: 16,
+                         message_length: 12
+        stats_type :stats_type, value: -> { :table }
+        uint16 :flags
+        string :body, value: ''
+      end
+    end
+  end
+end

data/lib/pio/open_flow13/actions.rb

@@ -32,7 +32,7 @@ module Pio
                  else
                    UnsupportedAction.read(tmp)
                  end
-        tmp = tmp[action.length..-1]
+        tmp = tmp[action.action_length..-1]
         actions << action
       end
       actions

data/lib/pio/open_flow13/match.rb

@@ -54,12 +54,12 @@ module Pio
       end
 
       # The value of OXM_OF_ETH_DST match field.
-      class EtherDestinationAddress < BinData::Record
+      class DestinationMacAddress < BinData::Record
         OXM_FIELD = 3
 
         endian :big
 
-        mac_address :ether_destination_address
+        mac_address :destination_mac_address
 
         def length
           6
@@ -67,12 +67,12 @@ module Pio
       end
 
       # The value of OXM_OF_ETH_SRC match field.
-      class EtherSourceAddress < BinData::Record
+      class SourceMacAddress < BinData::Record
         OXM_FIELD = 4
 
         endian :big
 
-        mac_address :ether_source_address
+        mac_address :source_mac_address
 
         def length
           6
@@ -80,11 +80,11 @@ module Pio
       end
 
       # Masked OXM_OF_ETH_DST match field.
-      class MaskedEtherDestinationAddress < BinData::Record
+      class MaskedDestinationMacAddress < BinData::Record
         endian :big
 
-        mac_address :ether_destination_address
-        mac_address :ether_destination_address_mask
+        mac_address :destination_mac_address
+        mac_address :destination_mac_address_mask
 
         def length
           12
@@ -92,11 +92,11 @@ module Pio
       end
 
       # Masked OXM_OF_ETH_SRC match field.
-      class MaskedEtherSourceAddress < BinData::Record
+      class MaskedSourceMacAddress < BinData::Record
         endian :big
 
-        mac_address :ether_source_address
-        mac_address :ether_source_address_mask
+        mac_address :source_mac_address
+        mac_address :source_mac_address_mask
 
         def length
           12
@@ -577,10 +577,10 @@ module Pio
             in_port InPort
             metadata Metadata
             masked_metadata MaskedMetadata
-            ether_destination_address EtherDestinationAddress
-            masked_ether_destination_address MaskedEtherDestinationAddress
-            ether_source_address EtherSourceAddress
-            masked_ether_source_address MaskedEtherSourceAddress
+            destination_mac_address DestinationMacAddress
+            masked_destination_mac_address MaskedDestinationMacAddress
+            source_mac_address SourceMacAddress
+            masked_source_mac_address MaskedSourceMacAddress
             ether_type EtherType
             vlan_vid VlanVid
             vlan_pcp VlanPcp
@@ -640,10 +640,10 @@ module Pio
               InPort
             when Metadata::OXM_FIELD
               masked? ? MaskedMetadata : Metadata
-            when EtherDestinationAddress::OXM_FIELD
-              masked? ? MaskedEtherDestinationAddress : EtherDestinationAddress
-            when EtherSourceAddress::OXM_FIELD
-              masked? ? MaskedEtherSourceAddress : EtherSourceAddress
+            when DestinationMacAddress::OXM_FIELD
+              masked? ? MaskedDestinationMacAddress : DestinationMacAddress
+            when SourceMacAddress::OXM_FIELD
+              masked? ? MaskedSourceMacAddress : SourceMacAddress
             when EtherType::OXM_FIELD
               EtherType
             when VlanVid::OXM_FIELD
@@ -827,7 +827,7 @@ module Pio
                 tlv_value: { each => user_attrs.fetch(each) } } }
           end
 
-          [:metadata, :ether_destination_address, :ether_source_address,
+          [:metadata, :destination_mac_address, :source_mac_address,
            :ipv4_source_address, :ipv4_destination_address,
            :arp_sender_protocol_address, :arp_target_protocol_address,
            :arp_sender_hardware_address, :arp_target_hardware_address,

data/lib/pio/open_flow13/send_out_port.rb

@@ -1,44 +1,25 @@
-require 'forwardable'
+require 'pio/open_flow/action'
 require 'pio/open_flow13/port32'
 
 # Base module.
 module Pio
   module OpenFlow13
     # Output to switch port.
-    class SendOutPort
-      # OpenFlow 1.3.4 OFPAT_OUTPUT action format.
-      class Format < BinData::Record
-        NO_BUFFER = 0xffff
+    class SendOutPort < OpenFlow::Action
+      NO_BUFFER = 0xffff
 
-        endian :big
-
-        uint16 :action_type, value: 0
-        uint16 :action_length, value: 16
-        port32 :port
-        uint16 :max_length, initial_value: NO_BUFFER
-        uint48 :padding
-      end
-
-      def self.read(raw_data)
-        allocate.tap do |send_out_port|
-          send_out_port.instance_variable_set :@format, Format.read(raw_data)
-        end
-      end
-
-      extend Forwardable
-
-      def_delegators :@format, :action_type
-      def_delegator :@format, :action_length, :length
-      def_delegators :@format, :port
-      def_delegator :@format, :to_binary_s, :to_binary
+      action_header action_type: 0, action_length: 16
+      port32 :port
+      uint16 :max_length, initial_value: NO_BUFFER
+      uint48 :padding
 
       def initialize(port)
-        @format = Format.new(port: port)
+        super(port: port)
       end
 
       def max_length
         case @format.max_length
-        when Format::NO_BUFFER
+        when NO_BUFFER
           :no_buffer
         else
           @format.max_length

data/lib/pio/udp_header.rb

@@ -8,8 +8,8 @@ module Pio
     # Pseudo UDP header
     class PseudoUdpHeader < BinData::Record
       endian :big
-      ip_address :ip_source_address
-      ip_address :ip_destination_address
+      ip_address :source_ip_address
+      ip_address :destination_ip_address
       uint8 :padding
       uint8 :ip_protocol, value: IPv4Header::ProtocolNumber::UDP
       uint16 :udp_length
@@ -44,8 +44,8 @@ module Pio
     end
 
     def pseudo_udp_header
-      PseudoUdpHeader.new(ip_source_address: ip_source_address,
-                          ip_destination_address: ip_destination_address,
+      PseudoUdpHeader.new(source_ip_address: source_ip_address,
+                          destination_ip_address: destination_ip_address,
                           udp_length: udp_length).to_binary_s
     end
 

data/lib/pio/version.rb

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

data/pio.gemspec

@@ -30,9 +30,10 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'bindata', '~> 2.1.0'
 
-  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'bundler', '~> 1.10.6'
+  gem.add_development_dependency 'byebug', '~> 7.0.0'
   gem.add_development_dependency 'pry', '~> 0.10.3'
+  gem.add_development_dependency 'rake'
 
   # Guard
   gem.add_development_dependency 'guard', '~> 2.13.0'
@@ -56,7 +57,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'cucumber', '~> 2.1.0'
   gem.add_development_dependency 'flay', '~> 2.6.1'
   gem.add_development_dependency 'flog', '~> 4.3.2'
-  gem.add_development_dependency 'reek', '~> 3.5.0'
+  gem.add_development_dependency 'reek', '~> 3.6.0'
   gem.add_development_dependency 'rspec', '~> 3.3.0'
   gem.add_development_dependency 'rspec-given', '~> 3.7.1'
   gem.add_development_dependency 'rubocop', '~> 0.34.2'

data/spec/pio/dhcp/ack_spec.rb

@@ -10,8 +10,8 @@ describe Pio::Dhcp::Ack, '.new' do
       Pio::Dhcp::Ack.new(
         source_mac: source_mac,
         destination_mac: destination_mac,
-        ip_source_address: ip_source_address,
-        ip_destination_address: ip_destination_address,
+        source_ip_address: source_ip_address,
+        destination_ip_address: destination_ip_address,
         transaction_id: 0xdeadbeef,
         renewal_time_value: 0xdeadbeef,
         rebinding_time_value: 0xdeadbeef,
@@ -134,8 +134,8 @@ describe Pio::Dhcp::Ack, '.new' do
     context 'with Pio::MAC Address and Pio::IPv4Address Address' do
       let(:source_mac) { Pio::Mac.new('aa:bb:cc:dd:ee:ff') }
       let(:destination_mac) { Pio::Mac.new('11:22:33:44:55:66') }
-      let(:ip_source_address) { Pio::IPv4Address.new('192.168.0.10') }
-      let(:ip_destination_address) { Pio::IPv4Address.new('192.168.0.1') }
+      let(:source_ip_address) { Pio::IPv4Address.new('192.168.0.10') }
+      let(:destination_ip_address) { Pio::IPv4Address.new('192.168.0.1') }
       let(:subnet_mask) { Pio::IPv4Address.new('255.255.255.0') }
 
       context '#to_binary' do
@@ -152,8 +152,8 @@ describe Pio::Dhcp::Ack, '.new' do
     context 'with String MAC Address' do
       let(:source_mac) { 'aa:bb:cc:dd:ee:ff' }
       let(:destination_mac) { '11:22:33:44:55:66' }
-      let(:ip_source_address) { '192.168.0.10' }
-      let(:ip_destination_address) { '192.168.0.1' }
+      let(:source_ip_address) { '192.168.0.10' }
+      let(:destination_ip_address) { '192.168.0.1' }
       let(:subnet_mask) { '255.255.255.0' }
 
       context '#to_binary' do
@@ -173,8 +173,8 @@ describe Pio::Dhcp::Ack, '.new' do
       Pio::Dhcp::Ack.new(
         source_mac: 'aa:bb:cc:dd:ee:ff',
         destination_mac: '11:22:33:44:55:66',
-        ip_source_address: '192.168.0.10',
-        ip_destination_address: '192.168.0.1'
+        source_ip_address: '192.168.0.10',
+        destination_ip_address: '192.168.0.1'
       )
     end
 

data/spec/pio/dhcp/offer_spec.rb

@@ -10,8 +10,8 @@ describe Pio::Dhcp::Offer, '.new' do
       Pio::Dhcp::Offer.new(
         source_mac: source_mac,
         destination_mac: destination_mac,
-        ip_source_address: ip_source_address,
-        ip_destination_address: ip_destination_address,
+        source_ip_address: source_ip_address,
+        destination_ip_address: destination_ip_address,
         transaction_id: 0xdeadbeef,
         renewal_time_value: 0xdeadbeef,
         rebinding_time_value: 0xdeadbeef,
@@ -134,8 +134,8 @@ describe Pio::Dhcp::Offer, '.new' do
     context 'with Pio::MAC Address and Pio::IPv4Address Address' do
       let(:source_mac) { Pio::Mac.new('aa:bb:cc:dd:ee:ff') }
       let(:destination_mac) { Pio::Mac.new('11:22:33:44:55:66') }
-      let(:ip_source_address) { Pio::IPv4Address.new('192.168.0.10') }
-      let(:ip_destination_address) { Pio::IPv4Address.new('192.168.0.1') }
+      let(:source_ip_address) { Pio::IPv4Address.new('192.168.0.10') }
+      let(:destination_ip_address) { Pio::IPv4Address.new('192.168.0.1') }
       let(:subnet_mask) { Pio::IPv4Address.new('255.255.255.0') }
 
       context '#to_binary' do
@@ -152,8 +152,8 @@ describe Pio::Dhcp::Offer, '.new' do
     context 'with String MAC Address' do
       let(:source_mac) { 'aa:bb:cc:dd:ee:ff' }
       let(:destination_mac) { '11:22:33:44:55:66' }
-      let(:ip_source_address) { '192.168.0.10' }
-      let(:ip_destination_address) { '192.168.0.1' }
+      let(:source_ip_address) { '192.168.0.10' }
+      let(:destination_ip_address) { '192.168.0.1' }
       let(:subnet_mask) { '255.255.255.0' }
 
       context '#to_binary' do
@@ -173,8 +173,8 @@ describe Pio::Dhcp::Offer, '.new' do
       Pio::Dhcp::Offer.new(
         source_mac: 'aa:bb:cc:dd:ee:ff',
         destination_mac: '11:22:33:44:55:66',
-        ip_source_address: '192.168.0.10',
-        ip_destination_address: '192.168.0.1'
+        source_ip_address: '192.168.0.10',
+        destination_ip_address: '192.168.0.1'
       )
     end