pio 0.27.1 → 0.27.2

data/features/open_flow13/features_request.feature

@@ -10,7 +10,7 @@ Feature: Pio::Features::Request
       | field          | value |
       | ofp_version    |     4 |
       | message_type   |     5 |
-      | length         |     8 |
+      | message_length |     8 |
       | transaction_id |     0 |
       | xid            |     0 |
       | body           |       |
@@ -25,22 +25,7 @@ Feature: Pio::Features::Request
       | field          | value |
       | ofp_version    |     4 |
       | message_type   |     5 |
-      | length         |     8 |
-      | transaction_id |   123 |
-      | xid            |   123 |
-      | body           |       |
-
-  Scenario: new(xid: 123)
-    When I try to create an OpenFlow message with:
-      """
-      Pio::Features::Request.new(xid: 123)
-      """
-    Then it should finish successfully
-    And the message has the following fields and values:
-      | field          | value |
-      | ofp_version    |     4 |
-      | message_type   |     5 |
-      | length         |     8 |
+      | message_length |     8 |
       | transaction_id |   123 |
       | xid            |   123 |
       | body           |       |
@@ -59,7 +44,7 @@ Feature: Pio::Features::Request
       | field          | value |
       | ofp_version    |     4 |
       | message_type   |     5 |
-      | length         |     8 |
+      | message_length |     8 |
       | transaction_id |     0 |
       | xid            |     0 |
       | body           |       |

data/features/open_flow13/flow_mod.feature

@@ -10,7 +10,7 @@ Feature: Pio::FlowMod
       | field              |      value |
       | ofp_version        |          4 |
       | message_type       |         14 |
-      | length             |         56 |
+      | message_length     |         56 |
       | to_binary.length   |         56 |
       | transaction_id     |          0 |
       | xid                |          0 |
@@ -38,7 +38,7 @@ Feature: Pio::FlowMod
       | field                                  |                        value |
       | ofp_version                            |                            4 |
       | message_type                           |                           14 |
-      | length                                 |                           80 |
+      | message_length                         |                           80 |
       | transaction_id                         |                            0 |
       | xid                                    |                            0 |
       | cookie                                 |                            0 |
@@ -68,7 +68,7 @@ Feature: Pio::FlowMod
       | field                                  |                        value |
       | ofp_version                            |                            4 |
       | message_type                           |                           14 |
-      | length                                 |                           88 |
+      | message_length                         |                           88 |
       | transaction_id                         |                            0 |
       | xid                                    |                            0 |
       | cookie                                 |                            0 |
@@ -95,7 +95,7 @@ Feature: Pio::FlowMod
       | field              |      value |
       | ofp_version        |          4 |
       | message_type       |         14 |
-      | length             |         56 |
+      | message_length     |         56 |
       | transaction_id     |          0 |
       | xid                |          0 |
       | cookie             |          0 |
@@ -119,7 +119,7 @@ Feature: Pio::FlowMod
       | field                                  |                        value |
       | ofp_version                            |                            4 |
       | message_type                           |                           14 |
-      | length                                 |                           80 |
+      | message_length                         |                           80 |
       | transaction_id                         |                            0 |
       | xid                                    |                            0 |
       | cookie                                 |                            0 |

data/features/open_flow13/hello.feature

@@ -10,7 +10,7 @@ Feature: Pio::Hello
       | field              |          value |
       | ofp_version        |              4 |
       | message_type       |              0 |
-      | length             |             16 |
+      | message_length     |             16 |
       | transaction_id     |              0 |
       | xid                |              0 |
       | supported_versions | [:open_flow13] |
@@ -25,22 +25,7 @@ Feature: Pio::Hello
       | field              |          value |
       | ofp_version        |              4 |
       | message_type       |              0 |
-      | length             |             16 |
-      | transaction_id     |            123 |
-      | xid                |            123 |
-      | supported_versions | [:open_flow13] |
-
-  Scenario: new(xid: 123)
-    When I try to create an OpenFlow message with:
-      """
-      Pio::Hello.new(xid: 123)
-      """
-    Then it should finish successfully
-    And the message has the following fields and values:
-      | field              |          value |
-      | ofp_version        |              4 |
-      | message_type       |              0 |
-      | length             |             16 |
+      | message_length     |             16 |
       | transaction_id     |            123 |
       | xid                |            123 |
       | supported_versions | [:open_flow13] |
@@ -52,7 +37,7 @@ Feature: Pio::Hello
       | field              | value |
       | ofp_version        |     4 |
       | message_type       |     0 |
-      | length             |     8 |
+      | message_length     |     8 |
       | transaction_id     |     0 |
       | xid                |     0 |
       | supported_versions |    [] |
@@ -64,7 +49,7 @@ Feature: Pio::Hello
       | field              |                        value |
       | ofp_version        |                            4 |
       | message_type       |                            0 |
-      | length             |                           16 |
+      | message_length     |                           16 |
       | transaction_id     |                            0 |
       | xid                |                            0 |
       | supported_versions | [:open_flow10, :open_flow13] |

data/features/open_flow13/hello_failed.feature

@@ -13,7 +13,7 @@ Feature: Pio::Error::HelloFailed
       | field          |         value |
       | ofp_version    |             4 |
       | message_type   |             1 |
-      | length         |            12 |
+      | message_length |            12 |
       | transaction_id |             0 |
       | xid            |             0 |
       | error_type     | :hello_failed |
@@ -30,7 +30,7 @@ Feature: Pio::Error::HelloFailed
       | field          |             value |
       | ofp_version    |                 4 |
       | message_type   |                 1 |
-      | length         |                29 |
+      | message_length |                29 |
       | transaction_id |                 0 |
       | xid            |                 0 |
       | error_type     |     :hello_failed |
@@ -47,7 +47,7 @@ Feature: Pio::Error::HelloFailed
       | field          |              value |
       | ofp_version    |                  4 |
       | message_type   |                  1 |
-      | length         |                 12 |
+      | message_length |                 12 |
       | transaction_id |                  0 |
       | xid            |                  0 |
       | error_type     |      :hello_failed |
@@ -61,7 +61,7 @@ Feature: Pio::Error::HelloFailed
       | field          |             value |
       | ofp_version    |                 4 |
       | message_type   |                 1 |
-      | length         |                29 |
+      | message_length |                29 |
       | transaction_id |                 0 |
       | xid            |                 0 |
       | error_type     |     :hello_failed |

data/features/open_flow13/match.feature

@@ -784,7 +784,7 @@ Feature: Pio::Match
     When I try to parse a file named "open_flow13/oxm_experimenter_stratos_basic_dot11.raw" with "Pio::Match" class
     Then it should finish successfully
     And the message has the following fields and values:
-      | field                           |               value |
-      | match_fields.at(0).oxm_field    |                   0 |
-      | match_fields.at(0).experimenter |          4278247501 |
-      | match_fields.at(0).data.inspect |      "\x00\x01\x01" |
+      | field                                |      value |
+      | match_fields.at(0).oxm_field         |          0 |
+      | match_fields.at(0).experimenter      | 4278247501 |
+      | match_fields.at(0).data.unpack('C*') |  [0, 1, 1] |

data/features/open_flow13/packet_in.feature

@@ -10,7 +10,7 @@ Feature: Pio::PacketIn
       | field                   |     value |
       | ofp_version             |         4 |
       | message_type            |        10 |
-      | length                  |        34 |
+      | message_length          |        34 |
       | transaction_id          |         0 |
       | xid                     |         0 |
       | buffer_id               |         0 |
@@ -39,7 +39,7 @@ Feature: Pio::PacketIn
     And the message has the following fields and values:
       | field                   |             value |
       | ofp_version             |                 4 |
-      | length                  |                94 |
+      | message_length          |                94 |
       | transaction_id          |                 0 |
       | xid                     |                 0 |
       | buffer_id               |                 0 |
@@ -59,7 +59,7 @@ Feature: Pio::PacketIn
       | field                         |             value |
       | ofp_version                   |                 4 |
       | message_type                  |                10 |
-      | length                        |               102 |
+      | message_length                |               102 |
       | transaction_id                |               123 |
       | xid                           |               123 |
       | buffer_id.to_hex              |        0xcafebabe |

data/features/open_flow13/packet_out.feature

@@ -10,7 +10,7 @@ Feature: Pio::PacketOut
       | field            |      value |
       | ofp_version      |          4 |
       | message_type     |         13 |
-      | length           |         24 |
+      | message_length   |         24 |
       | to_binary.length |         24 |
       | transaction_id   |          0 |
       | xid              |          0 |
@@ -38,7 +38,7 @@ Feature: Pio::PacketOut
       | field                   |             value |
       | ofp_version             |                 4 |
       | message_type            |                13 |
-      | length                  |               100 |
+      | message_length          |               100 |
       | to_binary.length        |               100 |
       | transaction_id          |                 0 |
       | xid                     |                 0 |
@@ -67,7 +67,7 @@ Feature: Pio::PacketOut
       | field                    |                        value |
       | ofp_version              |                            4 |
       | message_type             |                           13 |
-      | length                   |                          100 |
+      | message_length           |                          100 |
       | transaction_id           |                          123 |
       | xid                      |                          123 |
       | buffer_id                |                   :no_buffer |

data/features/parser.feature

@@ -0,0 +1,10 @@
+Feature: Pio::Parser
+  Scenario: parse icmpv6.pcap
+    When I try to parse a file named "icmpv6.pcap" with "Pio::Parser" class
+    Then it should finish successfully
+    And the message #1 have the following fields and values:
+    | field           | value                      |
+    | class           | Pio::Parser::EthernetFrame |
+    | destination_mac | 00:60:97:07:69:ea          |
+    | source_mac      | 00:00:86:05:80:da          |
+    | ether_type      | 34525                      |

data/lib/pio/arp/format.rb

@@ -27,6 +27,26 @@ module Pio
         operation
       end
 
+      # rubocop:disable MethodLength
+      def to_exact_match(in_port)
+        match_options = {
+          in_port: in_port,
+          ether_source_address: source_mac,
+          ether_destination_address: destination_mac,
+          vlan_vid: vlan_vid,
+          vlan_priority: vlan_pcp,
+          ether_type: ether_type,
+          ip_tos: 0,
+          ip_protocol: operation,
+          ip_source_address: sender_protocol_address,
+          ip_destination_address: target_protocol_address,
+          transport_source_port: 0,
+          transport_destination_port: 0
+        }
+        Pio::OpenFlow10::Match.new(match_options)
+      end
+      # rubocop:enable MethodLength
+
       def to_binary
         to_binary_s + "\000" * (64 - num_bytes)
       end

data/lib/pio/ipv4_header.rb

@@ -33,6 +33,26 @@ module Pio
     end
     # rubocop:enable MethodLength
 
+    # rubocop:disable MethodLength
+    def to_exact_match(in_port)
+      match_options = {
+        in_port: in_port,
+        ether_source_address: source_mac,
+        ether_destination_address: destination_mac,
+        vlan_vid: vlan_vid,
+        vlan_priority: vlan_pcp,
+        ether_type: ether_type,
+        ip_tos: ip_type_of_service,
+        ip_protocol: ip_protocol,
+        ip_source_address: ip_source_address,
+        ip_destination_address: ip_destination_address,
+        transport_source_port: transport_source_port,
+        transport_destination_port: transport_destination_port
+      }
+      Pio::OpenFlow10::Match.new match_options
+    end
+    # rubocop:enable MethodLength
+
     private
 
     def calculate_ip_length

data/lib/pio/open_flow.rb

@@ -1,7 +1,6 @@
 require 'pio/open_flow/datapath_id'
 require 'pio/open_flow/error'
 require 'pio/open_flow/flags'
-require 'pio/open_flow/format'
 require 'pio/open_flow/message'
 require 'pio/open_flow/open_flow_header'
 require 'pio/open_flow10'

data/lib/pio/open_flow/message.rb

@@ -1,40 +1,66 @@
 require 'bindata'
 require 'pio/parse_error'
+require 'pio/open_flow/open_flow_header'
 
 module Pio
   module OpenFlow
     # OpenFlow messages.
     class Message
-      # rubocop:disable MethodLength
-      def self.inherited(child)
-        child.class_eval <<-EOS
-          def self.read(raw_data)
-            allocate.tap do |message|
-              format_klass = self.const_get(:Format)
-              message.instance_variable_set(:@format,
-                                            format_klass.read(raw_data))
-            end
-          rescue BinData::ValidityError
-            message_name = name.split('::')[1..-1].join(' ')
-            raise Pio::ParseError, "Invalid \#{message_name} message."
-          end
-        EOS
+      def self.inherited(child_klass)
+        child_klass.const_set :Format, Class.new(BinData::Record)
+        child_klass.class_variable_set(:@@valid_options, [])
       end
-      # rubocop:enable MethodLength
 
-      def self.body_option(name)
-        unless class_variable_defined?(:@@valid_body_options)
-          class_variable_set(:@@valid_body_options, [])
+      def self.read(raw_data)
+        allocate.tap do |message|
+          message.instance_variable_set(:@format,
+                                        const_get(:Format).read(raw_data))
         end
-        class_variable_set(:@@valid_body_options,
-                           class_variable_get(:@@valid_body_options) + [name])
+      rescue BinData::ValidityError
+        message_name = name.split('::')[1..-1].join(' ')
+        raise Pio::ParseError, "Invalid #{message_name} message."
       end
 
+      def self.method_missing(method, *args, &block)
+        const_get(:Format).__send__ method, *args, &block
+
+        return if method == :endian || method == :virtual
+        define_method(args.first) do
+          @format.__send__ args.first
+        end
+        class_variable_set(:@@valid_options,
+                           class_variable_get(:@@valid_options) + [args.first])
+      end
+
+      # rubocop:disable AbcSize
+      # rubocop:disable MethodLength
+      def self.open_flow_header(opts)
+        module_eval do
+          endian :big
+
+          uint8 :ofp_version, value: opts.fetch(:version)
+          virtual assert: -> { ofp_version == opts.fetch(:version) }
+          uint8 :message_type, value: opts.fetch(:message_type)
+          virtual assert: -> { message_type == opts.fetch(:message_type) }
+          uint16 :message_length,
+                 initial_value: opts[:message_length] || -> { 8 + body.length }
+          transaction_id :transaction_id, initial_value: 0
+
+          alias_method :xid, :transaction_id
+        end
+      end
+      # rubocop:enable AbcSize
+      # rubocop:enable MethodLength
+
       def initialize(user_options = {})
         validate_user_options user_options
         @format = self.class.const_get(:Format).new(parse_options(user_options))
       end
 
+      def to_binary
+        @format.to_binary_s
+      end
+
       def method_missing(method, *args, &block)
         @format.__send__ method, *args, &block
       end
@@ -43,48 +69,16 @@ module Pio
 
       def validate_user_options(user_options)
         unknown_options =
-          user_options.keys - valid_header_options - valid_body_options
+          user_options.keys - self.class.class_variable_get(:@@valid_options)
         return if unknown_options.empty?
         fail "Unknown option: #{unknown_options.first}"
       end
 
       def parse_options(user_options)
-        if valid_body_options.empty?
-          { header: parse_header_options(user_options) }
-        else
-          { header: parse_header_options(user_options),
-            body: parse_body_options(user_options) }
-        end
-      end
-
-      def parse_header_options(user_options)
-        transaction_id =
-          user_options[:transaction_id] || user_options[:xid] || 0
-        { transaction_id: transaction_id }
-      end
-
-      def parse_body_options(user_options)
-        if valid_body_options.include?(:body)
-          return user_options[:body] || user_options[:user_data] || ''
-        end
-        options = user_options.dup
-        options.delete :transaction_id
-        options.delete :xid
-        dpid = options[:dpid]
-        options[:datapath_id] = dpid if dpid
-        options.empty? ? {} : options
-      end
-
-      def valid_header_options
-        [:transaction_id, :xid]
-      end
-
-      def valid_body_options
-        if self.class.class_variable_defined?(:@@valid_body_options)
-          self.class.class_variable_get(:@@valid_body_options)
-        else
-          []
-        end
+        parsed_options = user_options.dup
+        parsed_options[:transaction_id] = user_options[:transaction_id] || 0
+        parsed_options[:body] = user_options[:body] || ''
+        parsed_options
       end
     end
   end