pio 0.24.2 → 0.25.0

data/features/open_flow13/meter.feature

@@ -6,7 +6,7 @@ Feature: Pio::Meter
     Pio::Meter.new(1)
     """
     Then it should finish successfully
-    And the message have the following fields and values:
+    And the message has the following fields and values:
     | field              |      value |
     | class              | Pio::Meter |
     | instruction_type   |          6 |
@@ -17,7 +17,7 @@ Feature: Pio::Meter
   Scenario: read
     When I try to parse a file named "open_flow13/instruction_meter.raw" with "Pio::Meter" class
     Then it should finish successfully
-    And the message have the following fields and values:
+    And the message has the following fields and values:
       | field              |      value |
       | class              | Pio::Meter |
       | instruction_type   |          6 |

data/features/open_flow13/packet_in.feature

@@ -6,7 +6,7 @@ Feature: Pio::PacketIn
       Pio::PacketIn.new
       """
     Then it should finish successfully
-    And the message have the following fields and values:
+    And the message has the following fields and values:
       | field                   |     value |
       | ofp_version             |         4 |
       | message_type            |        10 |
@@ -36,7 +36,7 @@ Feature: Pio::PacketIn
       Pio::PacketIn.new(raw_data: data_dump)
       """
     Then it should finish successfully
-    And the message have the following fields and values:
+    And the message has the following fields and values:
       | field                   |             value |
       | ofp_version             |                 4 |
       | message_length          |                94 |
@@ -55,7 +55,7 @@ Feature: Pio::PacketIn
   Scenario: read
     When I try to parse a file named "open_flow13/packet_in.raw" with "PacketIn" class
     Then it should finish successfully
-    And the message have the following fields and values:
+    And the message has the following fields and values:
       | field                         |             value |
       | ofp_version                   |                 4 |
       | message_type                  |                10 |

data/features/open_flow13/packet_out.feature

@@ -6,7 +6,7 @@ Feature: Pio::PacketOut
       Pio::PacketOut.new
       """
     Then it should finish successfully
-    And the message have the following fields and values:
+    And the message has the following fields and values:
       | field            |      value |
       | ofp_version      |          4 |
       | message_type     |         13 |
@@ -34,7 +34,7 @@ Feature: Pio::PacketOut
       Pio::PacketOut.new(raw_data: data_dump, actions: Pio::SendOutPort.new(1))
       """
     Then it should finish successfully
-    And the message have the following fields and values:
+    And the message has the following fields and values:
       | field                   |             value |
       | ofp_version             |                 4 |
       | message_type            |                13 |
@@ -63,7 +63,7 @@ Feature: Pio::PacketOut
   Scenario: read
     When I try to parse a file named "open_flow13/packet_out.raw" with "PacketOut" class
     Then it should finish successfully
-    And the message have the following fields and values:
+    And the message has the following fields and values:
       | field                    |                        value |
       | ofp_version              |                            4 |
       | message_type             |                           13 |

data/features/open_flow13/send_out_port.feature

@@ -6,7 +6,7 @@ Feature: Pio::SendOutPort
       Pio::SendOutPort.new(1)
       """
     Then it should finish successfully
-    And the message have the following fields and values:
+    And the message has the following fields and values:
       | field         |            value |
       | action_type   |                0 |
       | action_length |               16 |
@@ -16,7 +16,7 @@ Feature: Pio::SendOutPort
   Scenario: read
     When I try to parse a file named "open_flow13/send_out_port.raw" with "Pio::SendOutPort" class
     Then it should finish successfully
-    And the message have the following fields and values:
+    And the message has the following fields and values:
       | field         |            value |
       | action_type   |                0 |
       | action_length |               16 |

data/features/open_flow13/write_metadata.feature

@@ -6,7 +6,7 @@ Feature: Pio::WriteMetadata
       Pio::WriteMetadata.new(metadata: 1)
       """
     Then it should finish successfully
-    And the message have the following fields and values:
+    And the message has the following fields and values:
       | field              |              value |
       | class              | Pio::WriteMetadata |
       | instruction_type   |                  2 |
@@ -18,7 +18,7 @@ Feature: Pio::WriteMetadata
   Scenario: read
     When I try to parse a file named "open_flow13/instruction_write_metadata.raw" with "Pio::WriteMetadata" class
     Then it should finish successfully
-    And the message have the following fields and values:
+    And the message has the following fields and values:
       | field              |              value |
       | class              | Pio::WriteMetadata |
       | instruction_type   |                  2 |

data/features/open_flow_read.feature

@@ -2,13 +2,15 @@ Feature: Pio::OpenFlow.read
   Scenario: OpenFlow10
     Given I switch the Pio::OpenFlow version to "OpenFlow10"
     Then the following each raw file should be parsed into its corresponding object using OpenFlow.read
-      | raw file                         | result object                      |
-      | open_flow10/hello.raw            | Pio::OpenFlow10::Hello             |
-      | open_flow10/echo_request.raw     | Pio::OpenFlow10::Echo::Request     |
-      | open_flow10/echo_reply.raw       | Pio::OpenFlow10::Echo::Reply       |
-      | open_flow10/features_request.raw | Pio::OpenFlow10::Features::Request |
-      | open_flow10/features_reply.raw   | Pio::OpenFlow10::Features::Reply   |
-      | open_flow10/packet_in.raw        | Pio::OpenFlow10::PacketIn          |
-      | open_flow10/port_status.raw      | Pio::OpenFlow10::PortStatus        |
-      | open_flow10/barrier_request.raw  | Pio::OpenFlow10::Barrier::Request  |
-      | open_flow10/barrier_reply.raw    | Pio::OpenFlow10::Barrier::Reply    |
+      | raw file                           | result object                       |
+      | open_flow10/hello.raw              | Pio::OpenFlow10::Hello              |
+      | open_flow10/echo_request.raw       | Pio::OpenFlow10::Echo::Request      |
+      | open_flow10/echo_reply.raw         | Pio::OpenFlow10::Echo::Reply        |
+      | open_flow10/features_request.raw   | Pio::OpenFlow10::Features::Request  |
+      | open_flow10/features_reply.raw     | Pio::OpenFlow10::Features::Reply    |
+      | open_flow10/packet_in.raw          | Pio::OpenFlow10::PacketIn           |
+      | open_flow10/port_status.raw        | Pio::OpenFlow10::PortStatus         |
+      | open_flow10/barrier_request.raw    | Pio::OpenFlow10::Barrier::Request   |
+      | open_flow10/barrier_reply.raw      | Pio::OpenFlow10::Barrier::Reply     |
+      | open_flow10/flow_stats_request.raw | Pio::OpenFlow10::FlowStats::Request |
+      | open_flow10/flow_stats_reply.raw   | Pio::OpenFlow10::FlowStats::Reply   |

data/features/step_definitions/packet_data_steps.rb

@@ -44,7 +44,7 @@ Then(/^the message should be a "([^"]*)"$/) do |expected_klass|
   expect(@result.class.to_s).to eq(expected_klass)
 end
 
-Then(/^the packet have the following fields and values:$/) do |table|
+Then(/^the packet has the following fields and values:$/) do |table|
   table.hashes.each do |each|
     output = @result.instance_eval("self.#{each['field']}")
     if /^:/ =~ output.inspect
@@ -55,8 +55,8 @@ Then(/^the packet have the following fields and values:$/) do |table|
   end
 end
 
-Then(/^the message have the following fields and values:$/) do |table|
-  step 'the packet have the following fields and values:', table
+Then(/^the message has the following fields and values:$/) do |table|
+  step 'the packet has the following fields and values:', table
 end
 
 # rubocop:disable LineLength

data/lib/pio/open_flow.rb

@@ -18,7 +18,8 @@ module Pio
 
     def self.switch_version(version)
       [:Barrier, :Echo, :Features, :FlowMod, :Hello, :Match,
-       :PacketIn, :PacketOut, :SendOutPort, :PortStatus].each do |each|
+       :PacketIn, :PacketOut, :SendOutPort, :PortStatus,
+       :FlowStats].each do |each|
         set_message_class_name each, version
         @version = version.to_s
       end
@@ -34,6 +35,8 @@ module Pio
         6 => Pio::Features::Reply,
         10 => Pio::PacketIn,
         12 => Pio::PortStatus,
+        16 => Pio::FlowStats::Request,
+        17 => Pio::FlowStats::Reply,
         18 => Pio::Barrier::Request,
         19 => Pio::Barrier::Reply
       }

data/lib/pio/open_flow/message.rb

@@ -1,3 +1,6 @@
+require 'bindata'
+require 'pio/parse_error'
+
 module Pio
   module OpenFlow
     # OpenFlow messages.

data/lib/pio/open_flow10.rb

@@ -4,6 +4,8 @@ require 'pio/open_flow10/echo'
 require 'pio/open_flow10/exact_match'
 require 'pio/open_flow10/features'
 require 'pio/open_flow10/flow_mod'
+require 'pio/open_flow10/flow_stats_reply'
+require 'pio/open_flow10/flow_stats_request'
 require 'pio/open_flow10/hello'
 require 'pio/open_flow10/packet_in'
 require 'pio/open_flow10/packet_out'

data/lib/pio/open_flow10/flow_mod.rb

@@ -31,21 +31,6 @@ module Pio
 
       # Message body of FlowMod.
       class Body < BinData::Record
-        # Pio::MatchFormat wrapper.
-        class Match < BinData::Primitive
-          endian :big
-
-          string :match, read_length: 40
-
-          def set(object)
-            self.match = object.to_binary_s
-          end
-
-          def get
-            Pio::OpenFlow10::Match.read match
-          end
-        end
-
         extend OpenFlow::Flags
 
         flags_16bit :flags,
@@ -55,7 +40,7 @@ module Pio
 
         endian :big
 
-        match :match
+        match_open_flow10 :match
         uint64 :cookie
         command :command
         uint16 :idle_timeout

data/lib/pio/open_flow10/flow_stats_reply.rb

@@ -0,0 +1,59 @@
+require 'pio/open_flow10/actions'
+require 'pio/open_flow10/stats_type'
+
+# Base module.
+module Pio
+  # OpenFlow 1.0 messages
+  module OpenFlow10
+    # OpenFlow 1.0 FlowStats messages
+    module FlowStats
+      # OpenFlow 1.0 Flow Stats Reply message
+      class Reply < OpenFlow::Message
+        # Body of reply to Flow Stats Request.
+        class FlowStatsEntry < BinData::Record
+          endian :big
+
+          uint16 :entry_length
+          uint8 :table_id
+          string :padding1, length: 1
+          hide :padding1
+          match_open_flow10 :match
+          uint32 :duration_sec
+          uint32 :duration_nsec
+          uint16 :priority
+          uint16 :idle_timeout
+          uint16 :hard_timeout
+          string :padding2, length: 6
+          hide :padding2
+          uint64 :cookie
+          uint64 :packet_count
+          uint64 :byte_count
+          actions :actions, length: -> { entry_length - 88 }
+        end
+
+        # Message body of Flow Stats Reply.
+        class Body < BinData::Record
+          endian :big
+
+          stats_type :stats_type, value: -> { :flow }
+          uint16 :flags
+          array(:stats,
+                type: :flow_stats_entry,
+                read_until: :eof)
+
+          def length
+            4 + stats.to_binary_s.length
+          end
+        end
+
+        # OpenFlow 1.0 Flow Stats Reply message format.
+        class Format < BinData::Record
+          extend OpenFlow::Format
+
+          header version: 1, message_type: 17
+          body :body
+        end
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/flow_stats_request.rb

@@ -0,0 +1,64 @@
+require 'pio/open_flow10/match'
+require 'pio/open_flow10/stats_type'
+require 'pio/open_flow/format'
+require 'pio/open_flow/message'
+
+# Base module.
+module Pio
+  # OpenFlow 1.0 messages
+  module OpenFlow10
+    # OpenFlow 1.0 FlowStats messages
+    module FlowStats
+      # OpenFlow 1.0 Flow Stats Request message
+      class Request < OpenFlow::Message
+        # Body for Stats Request of type :flow
+        class FlowStatsRequestBody < BinData::Record
+          endian :big
+
+          match_open_flow10 :match
+          uint8 :table_id, initial_value: 0xff
+          string :padding, length: 1
+          hide :padding
+          port_number :out_port, initial_value: -> { :none }
+        end
+
+        # Message body of Flow Stats Request.
+        class Body < BinData::Record
+          endian :big
+
+          stats_type :stats_type, value: -> { :flow }
+          uint16 :flags
+          choice :stats_request_body, selection: -> { stats_type.to_s } do
+            flow_stats_request_body 'flow'
+            string :default
+          end
+
+          def length
+            48
+          end
+
+          def method_missing(method, *args, &block)
+            stats_request_body.__send__(method, *args, &block)
+          end
+        end
+
+        # OpenFlow 1.0 Flow Stats Request message format.
+        class Format < BinData::Record
+          extend OpenFlow::Format
+
+          header version: 1, message_type: 16
+          body :body
+        end
+
+        body_option :match
+
+        def initialize(user_options = {})
+          validate_user_options user_options
+          header_options = parse_header_options(user_options)
+          @format = Format.new(header: header_options,
+                               body: { stats_request_body: user_options })
+        end
+      end
+    end
+  end
+end

data/lib/pio/open_flow10/match.rb

@@ -161,5 +161,22 @@ module Pio
         @format.__send__ method, *args, &block
       end
     end
+
+    # Pio::MatchFormat wrapper.
+    class MatchOpenFlow10 < BinData::Primitive
+      endian :big
+
+      string :match,
+             read_length: 40,
+             initial_value: Pio::OpenFlow10::Match.new.to_binary_s
+
+      def set(object)
+        self.match = object.to_binary_s
+      end
+
+      def get
+        Pio::OpenFlow10::Match.read match
+      end
+    end
   end
 end

data/lib/pio/open_flow10/stats_type.rb

@@ -0,0 +1,27 @@
+module Pio
+  module OpenFlow10
+    # enum ofp_stats_types
+    class StatsType < BinData::Primitive
+      STATS_TYPES = {
+        description: 0,
+        flow: 1,
+        aggregate: 2,
+        table: 3,
+        port: 4,
+        queue: 5,
+        vendor: 0xffff
+      }
+
+      endian :big
+      uint16 :command
+
+      def get
+        STATS_TYPES.invert.fetch(command)
+      end
+
+      def set(value)
+        self.command = STATS_TYPES.fetch(value)
+      end
+    end
+  end
+end

data/lib/pio/version.rb

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

data/pio.gemspec

@@ -38,7 +38,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'guard', '~> 2.13.0'
   gem.add_development_dependency 'guard-bundler', '~> 2.1.0'
   gem.add_development_dependency 'guard-cucumber', '~> 1.6.0'
-  gem.add_development_dependency 'guard-rspec', '~> 4.6.3'
+  gem.add_development_dependency 'guard-rspec', '~> 4.6.4'
   gem.add_development_dependency 'guard-rubocop', '~> 1.2.0'
   gem.add_development_dependency 'rb-fchange', '~> 0.0.6'
   gem.add_development_dependency 'rb-fsevent', '~> 0.9.5'
@@ -59,5 +59,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'reek', '~> 3.1'
   gem.add_development_dependency 'rspec', '~> 3.3.0'
   gem.add_development_dependency 'rspec-given', '~> 3.7.1'
-  gem.add_development_dependency 'rubocop', '~> 0.32.1'
+  gem.add_development_dependency 'rubocop', '~> 0.33.0'
 end

data/spec/pio/open_flow10/flow_stats_reply_spec.rb

@@ -0,0 +1,39 @@
+require 'pio/open_flow10/flow_stats_reply'
+
+describe Pio::OpenFlow10::FlowStats::Reply do
+  describe '.read' do
+    context 'with a Flow Stats Reply binary' do
+      Given(:binary) do
+        [0x01, 0x11, 0x00, 0xe4, 0x00, 0x00, 0x00, 0x06, 0x00, 0x01,
+         0x00, 0x00, 0x00, 0x68, 0x03, 0x00, 0x00, 0x3f, 0xff, 0xff,
+         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01,
+         0x00, 0x00, 0x00, 0x02, 0x00, 0x64, 0x00, 0x05, 0x00, 0x0a,
+         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x23, 0x45, 0x67,
+         0x89, 0xab, 0xcd, 0xef, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+         0x00, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0xe8,
+         0x00, 0x00, 0x00, 0x08, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00,
+         0x00, 0x08, 0x00, 0x02, 0x00, 0x00, 0x00, 0x70, 0x04, 0x00,
+         0x00, 0x3f, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+         0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x02, 0x00, 0x64,
+         0x00, 0x05, 0x00, 0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+         0x01, 0x23, 0x45, 0x67, 0x89, 0xab, 0xcd, 0xef, 0x00, 0x00,
+         0x00, 0x00, 0x00, 0x00, 0x00, 0x0a, 0x00, 0x00, 0x00, 0x00,
+         0x00, 0x00, 0x03, 0xe8, 0x00, 0x00, 0x00, 0x08, 0x00, 0x01,
+         0x00, 0x00, 0x00, 0x00, 0x00, 0x08, 0x00, 0x02, 0x00, 0x00,
+         0x00, 0x00, 0x00, 0x08, 0x00, 0x03, 0x00, 0x00].pack('C*')
+      end
+
+      When(:flow_stats_reply) do
+        Pio::OpenFlow10::FlowStats::Reply.read(binary)
+      end
+
+      Then { flow_stats_reply.class == Pio::OpenFlow10::FlowStats::Reply }
+    end
+  end
+end