pio 0.19.0 → 0.20.0

data/features/open_flow13/features_reply.feature

@@ -0,0 +1,53 @@
+Feature: Pio::Features::Reply
+  Background:
+    Given I use OpenFlow 1.3
+
+  Scenario: new
+    When I try to create an OpenFlow message with:
+      """
+      Pio::Features::Reply.new(
+        dpid: 0x123,
+        n_buffers: 0x100,
+        n_tables: 0xfe,
+        capabilities: [:flow_stats, :table_stats, :port_stats, :group_stats, :ip_reasm, :queue_stats, :port_blocked]
+      )
+      """
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field          |                                                                                          value |
+      | class          |                                                                           Pio::Features::Reply |
+      | ofp_version    |                                                                                              4 |
+      | message_type   |                                                                                              6 |
+      | message_length |                                                                                             32 |
+      | transaction_id |                                                                                              0 |
+      | xid            |                                                                                              0 |
+      | datapath_id    |                                                                                            291 |
+      | dpid           |                                                                                            291 |
+      | n_buffers      |                                                                                            256 |
+      | n_tables       |                                                                                            254 |
+      | auxiliary_id   |                                                                                              0 |
+      | capabilities   | [:flow_stats, :table_stats, :port_stats, :group_stats, :ip_reasm, :queue_stats, :port_blocked] |
+      | reserved       |                                                                                              0 |
+  
+  Scenario: read
+    When I try to parse a file named "open_flow13/features_reply.raw" with "Pio::Features::Reply" class
+    Then it should finish successfully
+    And the message have the following fields and values:
+    | field          |                                                                                          value |
+    | class          |                                                                           Pio::Features::Reply |
+    | ofp_version    |                                                                                              4 |
+    | message_type   |                                                                                              6 |
+    | message_length |                                                                                             32 |
+    | transaction_id |                                                                                              0 |
+    | xid            |                                                                                              0 |
+    | datapath_id    |                                                                                281474976710657 |
+    | dpid           |                                                                                281474976710657 |
+    | n_buffers      |                                                                                            256 |
+    | n_tables       |                                                                                              1 |
+    | auxiliary_id   |                                                                                              0 |
+    | capabilities   | [:flow_stats, :table_stats, :port_stats, :group_stats, :ip_reasm, :queue_stats, :port_blocked] |
+    | reserved       |                                                                                              0 |
+
+  Scenario: parse error
+    When I try to parse a file named "open_flow10/echo_request.raw" with "Pio::Features::Reply" class
+    Then it should fail with "Pio::ParseError", "Invalid Features Reply 1.3 message."

data/features/open_flow13/features_request.feature

@@ -0,0 +1,89 @@
+Feature: Pio::Features::Request
+  Background:
+    Given I use OpenFlow 1.3
+
+  Scenario: new
+    When I try to create an OpenFlow message with:
+      """
+      Pio::Features::Request.new
+      """
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field          |                  value |
+      | class          | Pio::Features::Request |
+      | ofp_version    |                      4 |
+      | message_type   |                      5 |
+      | message_length |                      8 |
+      | transaction_id |                      0 |
+      | xid            |                      0 |
+      | body           |                        |
+
+  Scenario: new(transaction_id: 123)
+    When I try to create an OpenFlow message with:
+      """
+      Pio::Features::Request.new(transaction_id: 123)
+      """
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field          |                  value |
+      | class          | Pio::Features::Request |
+      | ofp_version    |                      4 |
+      | message_type   |                      5 |
+      | message_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 have the following fields and values:
+      | field          |                  value |
+      | class          | Pio::Features::Request |
+      | ofp_version    |                      4 |
+      | message_type   |                      5 |
+      | message_length |                      8 |
+      | transaction_id |                    123 |
+      | xid            |                    123 |
+      | body           |                        |
+
+  Scenario: new(xid: -1) and error
+    When I try to create an OpenFlow message with:
+      """
+      Pio::Features::Request.new(xid: -1)
+      """
+    Then it should fail with "ArgumentError", "Transaction ID should be an unsigned 32-bit integer."
+
+  Scenario: new(xid: 2**32) and error
+    When I try to create an OpenFlow message with:
+      """
+      Pio::Features::Request.new(xid: 2**32)
+      """
+    Then it should fail with "ArgumentError", "Transaction ID should be an unsigned 32-bit integer."
+
+  Scenario: new(unknown_attr: 'foo') and error
+    When I try to create an OpenFlow message with:
+      """
+      Pio::Features::Request.new(unknown_attr: 'foo')
+      """
+    Then it should fail with "RuntimeError", "Unknown keyword: unknown_attr"
+
+  Scenario: read
+    When I try to parse a file named "open_flow13/features_request.raw" with "Pio::Features::Request" class
+    Then it should finish successfully
+    And the message have the following fields and values:
+      | field          |                  value |
+      | class          | Pio::Features::Request |
+      | ofp_version    |                      4 |
+      | message_type   |                      5 |
+      | message_length |                      8 |
+      | transaction_id |                      0 |
+      | xid            |                      0 |
+      | body           |                        |
+
+  Scenario: parse error
+    When I try to parse a file named "open_flow10/hello.raw" with "Pio::Features::Request" class
+    Then it should fail with "Pio::ParseError", "Invalid Features Request 1.3 message."

data/features/open_flow13/hello.feature

@@ -1,13 +1,16 @@
-Feature: Hello
-  Scenario: create
+Feature: Pio::Hello
+  Background:
+    Given I use OpenFlow 1.3
+
+  Scenario: new
     When I try to create an OpenFlow message with:
       """
-      Pio::Hello13.new
+      Pio::Hello.new
       """
     Then it should finish successfully
     And the message have the following fields and values:
       | field              |          value |
-      | class              |   Pio::Hello13 |
+      | class              |     Pio::Hello |
       | ofp_version        |              4 |
       | message_type       |              0 |
       | message_length     |             16 |
@@ -15,15 +18,15 @@ Feature: Hello
       | xid                |              0 |
       | supported_versions | [:open_flow13] |
 
-  Scenario: create (transaction_id: 123)
+  Scenario: new(transaction_id: 123)
     When I try to create an OpenFlow message with:
       """
-      Pio::Hello13.new(transaction_id: 123)
+      Pio::Hello.new(transaction_id: 123)
       """
     Then it should finish successfully
     And the message have the following fields and values:
       | field              |          value |
-      | class              |   Pio::Hello13 |
+      | class              |     Pio::Hello |
       | ofp_version        |              4 |
       | message_type       |              0 |
       | message_length     |             16 |
@@ -31,15 +34,15 @@ Feature: Hello
       | xid                |            123 |
       | supported_versions | [:open_flow13] |
 
-  Scenario: create (xid: 123)
+  Scenario: new(xid: 123)
     When I try to create an OpenFlow message with:
       """
-      Pio::Hello13.new(xid: 123)
+      Pio::Hello.new(xid: 123)
       """
     Then it should finish successfully
     And the message have the following fields and values:
       | field              |          value |
-      | class              |   Pio::Hello13 |
+      | class              |     Pio::Hello |
       | ofp_version        |              4 |
       | message_type       |              0 |
       | message_length     |             16 |
@@ -47,25 +50,25 @@ Feature: Hello
       | xid                |            123 |
       | supported_versions | [:open_flow13] |
 
-  Scenario: parse (no version bitmap)
-    When I try to parse a file named "hello13_no_version_bitmap.raw" with "Hello13" class
+  Scenario: read (no version bitmap)
+    When I try to parse a file named "open_flow13/hello_no_version_bitmap.raw" with "Pio::Hello" class
     Then it should finish successfully
     And the message have the following fields and values:
-      | field              |        value |
-      | class              | Pio::Hello13 |
-      | ofp_version        |            4 |
-      | message_type       |            0 |
-      | message_length     |            8 |
-      | transaction_id     |            0 |
-      | xid                |            0 |
-      | supported_versions |           [] |
+      | field              |      value |
+      | class              | Pio::Hello |
+      | ofp_version        |          4 |
+      | message_type       |          0 |
+      | message_length     |          8 |
+      | transaction_id     |          0 |
+      | xid                |          0 |
+      | supported_versions |         [] |
 
-  Scenario: parse
-    When I try to parse a file named "hello13_version_bitmap.raw" with "Hello13" class
+  Scenario: read
+    When I try to parse a file named "open_flow13/hello_version_bitmap.raw" with "Pio::Hello" class
     Then it should finish successfully
     And the message have the following fields and values:
       | field              |                        value |
-      | class              |                 Pio::Hello13 |
+      | class              |                   Pio::Hello |
       | ofp_version        |                            4 |
       | message_type       |                            0 |
       | message_length     |                           16 |

data/features/step_definitions/open_flow_steps.rb

@@ -0,0 +1,3 @@
+Given(/^I use OpenFlow 1\.3$/) do
+  require 'pio/open_flow13'
+end

data/features/step_definitions/packet_data_steps.rb

@@ -11,9 +11,9 @@ When(/^I try to create an OpenFlow message with:$/) do |ruby_code|
 end
 
 # rubocop:disable LineLength
-When(/^I try to parse a file named "(.*?)\.raw" with "(.*?)" class$/) do |file_name, klass|
-  path = File.expand_path(File.join(__dir__, '..', 'packet_data', file_name + '.raw'))
-  raw_data = IO.read(path)
+When(/^I try to parse a file named "(.*?\.raw)" with "(.*?)" class$/) do |path, klass|
+  full_path = File.expand_path(File.join(__dir__, '..', path))
+  raw_data = IO.read(full_path)
   parser_klass = Pio.const_get(klass)
   begin
     @result = parser_klass.read(raw_data)
@@ -24,9 +24,9 @@ end
 # rubocop:enable LineLength
 
 # rubocop:disable LineLength
-When(/^I try to parse a file named "(.*?)\.pcap" with "(.*?)" class$/) do |file_name, klass|
-  path = File.expand_path(File.join(__dir__, '..', 'packet_data', file_name + '.pcap'))
-  pcap = Pio::Pcap::Frame.read(IO.read(path))
+When(/^I try to parse a file named "(.*?\.pcap)" with "(.*?)" class$/) do |path, klass|
+  full_path = File.expand_path(File.join(__dir__, '..', path))
+  pcap = Pio::Pcap::Frame.read(IO.read(full_path))
   parser_klass = Pio.const_get(klass)
   begin
     @result = pcap.records.each_with_object([]) do |each, result|
@@ -47,9 +47,9 @@ Then(/^it should fail with "([^"]*)", "([^"]*)"$/) do |error, message|
   expect(@last_error.message).to eq(message)
 end
 
-When(/^I create an exact match from "(.*?)"$/) do |file_name|
-  path = File.expand_path(File.join(__dir__, '..', 'packet_data', file_name))
-  @result = Pio::ExactMatch.new(Pio::PacketIn.read(IO.read(path)))
+When(/^I create an exact match from "(.*?)"$/) do |path|
+  full_path = File.expand_path(File.join(__dir__, '..', path))
+  @result = Pio::ExactMatch.new(Pio::PacketIn.read(IO.read(full_path)))
 end
 
 Then(/^the packet have the following fields and values:$/) do |table|

data/features/udp.feature

@@ -1,6 +1,6 @@
-Feature: UDP
-  Scenario: dhcp.pcap
-    When I try to parse a file named "dhcp.pcap" with "Udp" class
+Feature: Pio::Udp
+  Scenario: parse dhcp.pcap
+    When I try to parse a file named "dhcp.pcap" with "Pio::Udp" class
     Then it should finish successfully
     And the message #1 have the following fields and values:
     | field                  |             value |

data/lib/pio.rb

@@ -2,16 +2,8 @@ require 'pio/parse_error'
 
 require 'pio/arp'
 require 'pio/dhcp'
-require 'pio/echo'
-require 'pio/exact_match'
-require 'pio/features'
-require 'pio/flow_mod'
-require 'pio/hello'
-require 'pio/hello13'
 require 'pio/icmp'
 require 'pio/lldp'
 require 'pio/mac'
-require 'pio/packet_in'
-require 'pio/packet_out'
-require 'pio/port_status'
+require 'pio/open_flow10'
 require 'pio/udp'

data/lib/pio/open_flow/actions.rb

@@ -1,8 +1,8 @@
 require 'bindata'
 require 'pio/enqueue'
 require 'pio/send_out_port'
-require 'pio/set_eth_addr'
-require 'pio/set_ip_addr'
+require 'pio/set_ether_address'
+require 'pio/set_ip_address'
 require 'pio/set_ip_tos'
 require 'pio/set_transport_port'
 require 'pio/set_vlan_priority'
@@ -18,13 +18,13 @@ module Pio
         1 => Pio::SetVlanVid,
         2 => Pio::SetVlanPriority,
         3 => Pio::StripVlanHeader,
-        4 => Pio::SetEthSrcAddr,
-        5 => Pio::SetEthDstAddr,
-        6 => Pio::SetIpSrcAddr,
-        7 => Pio::SetIpDstAddr,
+        4 => Pio::SetEtherSourceAddr,
+        5 => Pio::SetEtherDestinationAddr,
+        6 => Pio::SetIpSourceAddress,
+        7 => Pio::SetIpDestinationAddress,
         8 => Pio::SetIpTos,
-        9 => Pio::SetTransportSrcPort,
-        10 => Pio::SetTransportDstPort,
+        9 => Pio::SetTransportSourcePort,
+        10 => Pio::SetTransportDestinationPort,
         11 => Pio::Enqueue
       }
 

data/lib/pio/open_flow/open_flow_header.rb

@@ -2,6 +2,16 @@ require 'bindata'
 require 'pio/open_flow/transaction_id'
 
 module Pio
+  # OpenFlow message header parser
+  class OpenFlowHeaderParser < BinData::Record
+    endian :big
+
+    uint8 :ofp_version
+    uint8 :message_type
+    uint16 :message_length
+    transaction_id :transaction_id
+  end
+
   # OpenFlow message header.
   class OpenFlowHeader < BinData::Record
     endian :big

data/lib/pio/open_flow10.rb

@@ -0,0 +1,15 @@
+module Pio
+  # OpenFlow specific types.
+  module OpenFlow
+    VERSION = 1
+  end
+end
+
+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/hello'
+require 'pio/open_flow10/packet_in'
+require 'pio/open_flow10/packet_out'
+require 'pio/open_flow10/port_status'

data/lib/pio/open_flow10/echo.rb

@@ -0,0 +1,15 @@
+require 'forwardable'
+require 'pio/open_flow'
+
+module Pio
+  # OpenFlow 1.0 Echo Request and Reply message.
+  module Echo
+    # OpenFlow 1.0 Echo Request message.
+    class Request; end
+    OpenFlow::Message.factory(Request, OpenFlow::ECHO_REQUEST)
+
+    # OpenFlow 1.0 Echo Reply message.
+    class Reply; end
+    OpenFlow::Message.factory(Reply, OpenFlow::ECHO_REPLY)
+  end
+end

data/lib/pio/open_flow10/exact_match.rb

@@ -0,0 +1,51 @@
+require 'pio/open_flow10/match'
+
+module Pio
+  # OpenFlow 1.0 exact match
+  class ExactMatch
+    # rubocop:disable MethodLength
+    # rubocop:disable AbcSize
+    def initialize(packet_in)
+      data = packet_in.data
+      case data
+      when PacketIn::DataParser::IPv4Packet
+        options = {
+          in_port: packet_in.in_port,
+          ether_source_address: packet_in.source_mac,
+          ether_destination_address: packet_in.destination_mac,
+          vlan_vid: data.vlan_vid,
+          vlan_priority: data.vlan_pcp,
+          ether_type: data.ether_type,
+          ip_tos: data.ip_type_of_service,
+          ip_protocol: data.ip_protocol,
+          ip_source_address: data.ip_source_address,
+          ip_destination_address: data.ip_destination_address,
+          transport_source_port: data.transport_source_port,
+          transport_destination_port: data.transport_destination_port
+        }
+      when Arp::Request
+        options = {
+          in_port: packet_in.in_port,
+          ether_source_address: packet_in.source_mac,
+          ether_destination_address: packet_in.destination_mac,
+          vlan_vid: data.vlan_vid,
+          vlan_priority: data.vlan_pcp,
+          ether_type: data.ether_type,
+          ip_tos: 0,
+          ip_protocol: data.operation,
+          ip_source_address: data.sender_protocol_address,
+          ip_destination_address: data.target_protocol_address,
+          transport_source_port: 0,
+          transport_destination_port: 0
+        }
+      end
+      @match = Pio::Match.new(options)
+    end
+    # rubocop:enable MethodLength
+    # rubocop:enable AbcSize
+
+    def method_missing(method, *args, &block)
+      @match.__send__ method, *args, &block
+    end
+  end
+end