pio 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf86d154a2025304879d8c6d252b71a2eda73ef8
-  data.tar.gz: 18e3dda3e1ca8061b51d9ef4d8db29e0ffbde9c8
+  metadata.gz: ddcd50819881ef3e84f8efe948b846b346527afc
+  data.tar.gz: 8e66cab7abcc66b81908bc278fc4a0ac3b91519f
 SHA512:
-  metadata.gz: 3a66499af05e0a468ca0d272237d6fabf489f868407d78d62c43083d30b2c7ee01e3b66cdff45533adb44e6aa11a45027e0074934a0b551de68188a53cd0cad9
-  data.tar.gz: 49e01b280cddef5a2400f46a19ef1d622c0da2eeeb4165c1a53fdc5e86b892b95110b027868c6def6f92127dfd95f395bb86ea51b2f162b66e7014688e90ebcb
+  metadata.gz: f12db68f58ac7b90230f5fd4fb190ec0d939ad9c2895305393066b08e37d8ad5aa3604558f179fc5d29f8b5c25beb26faa4697b3ecfdb8cda2c856d718ba9cb6
+  data.tar.gz: 969ee297aa80eb58ad0e5f3a3aff999f49aea84eb2ef88db78058bc77aed050154faaa43eeb78530641bd336024efed1044589b8c8e7a12771c0d5be5bcd5b84

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.9.0 (12/22/2014)
+
+### New features
+* [#102](https://github.com/trema/pio/pull/102): Added new class `Pio::PacketIn`.
+
+
 ## 0.8.2 (12/18/2014)
 
 ### Bugs fixed

data/README.md

@@ -21,6 +21,7 @@ supports the following packet formats:
     -   Hello
     -   Echo
     -   Features
+    -   Packet-In
 -   (…currently there are just a few formats supported but I'm sure this list will grow)
 
 ## Features Overview
@@ -248,6 +249,41 @@ generate an Features Request/Reply message like below:
             )
     reply.to_binary  # => Features Reply message in binary format.
 
+### Packet-In
+
+To parse an OpenFlow 1.0 Packet-In message, use the API
+`Pio::PacketIn.read` and you can access each field of the parsed
+Packet-In message.
+
+    require 'pio'
+
+    packet_in = Pio::PacketIn.read(binary_data)
+    packet_in.in_port # => 1
+    packet_in.buffer_id # => 4294967040
+
+Also you can use `Pio::PacketIn#new` to generate a Packet-In message
+like below:
+
+    require 'pio'
+
+    data_dump = [
+      0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xac, 0x5d, 0x10, 0x31, 0x37,
+      0x79, 0x08, 0x06, 0x00, 0x01, 0x08, 0x00, 0x06, 0x04, 0x00, 0x01,
+      0xac, 0x5d, 0x10, 0x31, 0x37, 0x79, 0xc0, 0xa8, 0x02, 0xfe, 0xff,
+      0xff, 0xff, 0xff, 0xff, 0xff, 0xc0, 0xa8, 0x02, 0x05, 0x00, 0x00,
+      0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+      0x00, 0x00, 0x00, 0x00, 0x00
+    ].pack('C*')
+
+    packet_in = Pio::PacketIn.new(
+                  transaction_id: 0,
+                  buffer_id: 0xffffff00,
+                  in_port: 1,
+                  reason: :no_match,
+                  data: data_dump
+                )
+    packet_in.to_binary  # => Packet-In message in binary format.
+
 ## Installation
 
 The simplest way to install Pio is to use [Bundler](http://gembundler.com/).

data/examples/packet_in_new.rb

@@ -0,0 +1,19 @@
+require 'pio'
+
+data_dump = [
+  0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xac, 0x5d, 0x10, 0x31, 0x37,
+  0x79, 0x08, 0x06, 0x00, 0x01, 0x08, 0x00, 0x06, 0x04, 0x00, 0x01,
+  0xac, 0x5d, 0x10, 0x31, 0x37, 0x79, 0xc0, 0xa8, 0x02, 0xfe, 0xff,
+  0xff, 0xff, 0xff, 0xff, 0xff, 0xc0, 0xa8, 0x02, 0x05, 0x00, 0x00,
+  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+  0x00, 0x00, 0x00, 0x00, 0x00
+].pack('C*')
+
+packet_in = Pio::PacketIn.new(
+              transaction_id: 0,
+              buffer_id: 0xffffff00,
+              in_port: 1,
+              reason: :no_match,
+              data: data_dump
+            )
+packet_in.to_binary  # => Packet-In message in binary format.

data/examples/packet_in_read.rb

@@ -0,0 +1,5 @@
+require 'pio'
+
+packet_in = Pio::PacketIn.read(binary_data)
+packet_in.in_port # => 1
+packet_in.buffer_id # => 4294967040

data/features/packet_in_read.feature

@@ -0,0 +1,5 @@
+Feature: Pio::PacketIn.read
+  Scenario: packet_in.raw
+    Given a packet data file "packet_in.raw"
+    When I try to parse the file with "PacketIn" class
+    Then it should finish successfully

data/lib/pio.rb

@@ -8,3 +8,4 @@ require 'pio/hello'
 require 'pio/icmp'
 require 'pio/lldp'
 require 'pio/mac'
+require 'pio/packet_in'

data/lib/pio/open_flow/type.rb

@@ -7,6 +7,7 @@ module Pio
       ECHO_REPLY = 3
       FEATURES_REQUEST = 5
       FEATURES_REPLY = 6
+      PACKET_IN = 10
     end
   end
 end

data/lib/pio/packet_in.rb

@@ -0,0 +1,28 @@
+require 'pio/packet_in/format'
+require 'pio/parse_error'
+
+module Pio
+  # OpenFlow 1.0 Packet-In message
+  class PacketIn
+    def self.read(raw_data)
+      packet_in = allocate
+      packet_in.instance_variable_set :@format, Format.read(raw_data)
+      packet_in
+    rescue BinData::ValidityError
+      raise Pio::ParseError, 'Invalid Packet-In message.'
+    end
+
+    def_delegators :body, :buffer_id
+    def_delegators :body, :total_len
+    def_delegators :body, :in_port
+    def_delegators :body, :reason
+    def_delegators :body, :data
+
+    # @reek This method smells of :reek:FeatureEnvy
+    def initialize(user_options)
+      header_options = { transaction_id: user_options[:transaction_id] ||
+                                         user_options[:xid] || 0 }
+      @format = Format.new(open_flow_header: header_options, body: user_options)
+    end
+  end
+end

data/lib/pio/packet_in/format.rb

@@ -0,0 +1,55 @@
+require 'bindata'
+require 'pio/open_flow'
+
+module Pio
+  class PacketIn < Pio::OpenFlow::Message
+    # Why is this packet being sent to the controller?
+    # (enum ofp_packet_in_reason)
+    class Reason < BinData::Primitive
+      REASONS = { no_match: 0, action: 1 }
+
+      uint8 :reason
+
+      def get
+        REASONS.invert.fetch(reason)
+      end
+
+      def set(value)
+        self.reason = REASONS.fetch(value)
+      end
+    end
+
+    # Message body of Packet-In.
+    class Body < BinData::Record
+      endian :big
+
+      uint32 :buffer_id
+      uint16 :total_len, value: -> { data.length }
+      uint16 :in_port
+      reason :reason
+      uint8 :padding
+      hide :padding
+      string :data, read_length: :total_len
+
+      def empty?
+        false
+      end
+
+      def length
+        10 + data.length
+      end
+    end
+
+    # OpenFlow 1.0 Packet-In message parser and generator.
+    class Format < BinData::Record
+      include Pio::OpenFlow::Type
+
+      endian :big
+
+      open_flow_header :open_flow_header, message_type_value: PACKET_IN
+      virtual assert: -> { open_flow_header.message_type == PACKET_IN }
+
+      body :body
+    end
+  end
+end

data/lib/pio/version.rb

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

data/pio.gemspec

@@ -37,14 +37,14 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'bindata', '~> 2.1.0'
 
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'bundler', '~> 1.7.6'
+  gem.add_development_dependency 'bundler', '~> 1.7.9'
   gem.add_development_dependency 'pry', '~> 0.10.1'
 
   # Guard
-  gem.add_development_dependency 'guard', '~> 2.8.2'
-  gem.add_development_dependency 'guard-bundler', '~> 2.0.0'
-  gem.add_development_dependency 'guard-cucumber', '~> 1.5.1'
-  gem.add_development_dependency 'guard-rspec', '~> 4.3.1'
+  gem.add_development_dependency 'guard', '~> 2.10.4'
+  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'
   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.4'
@@ -52,17 +52,17 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'terminal-notifier-guard', '~> 1.6.4'
 
   # Docs
-  gem.add_development_dependency 'inch', '~> 0.5.7'
+  gem.add_development_dependency 'inch', '~> 0.5.8'
   gem.add_development_dependency 'yard', '~> 0.8.7.6'
 
   # Test
-  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.1'
+  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.3'
   gem.add_development_dependency 'coveralls', '~> 0.7.2'
   gem.add_development_dependency 'cucumber', '~> 1.3.17'
   gem.add_development_dependency 'flay', '~> 2.5.0'
   gem.add_development_dependency 'flog', '~> 4.3.0'
-  gem.add_development_dependency 'reek', '~> 1.4.0'
+  gem.add_development_dependency 'reek', '~> 1.5.1'
   gem.add_development_dependency 'rspec', '~> 3.1.0'
   gem.add_development_dependency 'rspec-given', '~> 3.5.4'
-  gem.add_development_dependency 'rubocop', '~> 0.27.1'
+  gem.add_development_dependency 'rubocop', '~> 0.28.0'
 end

data/spec/pio/packet_in_spec.rb

@@ -0,0 +1,143 @@
+require 'pio/packet_in'
+
+describe Pio::PacketIn do
+  Given(:data_dump) do
+    [
+      0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xac, 0x5d, 0x10, 0x31,
+      0x37, 0x79, 0x08, 0x06, 0x00, 0x01, 0x08, 0x00, 0x06, 0x04,
+      0x00, 0x01, 0xac, 0x5d, 0x10, 0x31, 0x37, 0x79, 0xc0, 0xa8,
+      0x02, 0xfe, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xc0, 0xa8,
+      0x02, 0x05, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+      0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
+    ].pack('C*')
+  end
+
+  describe '.read' do
+    context 'with a packet_in message' do
+      Given(:header_dump) do
+        [
+          0x01,
+          0x0a,
+          0x00, 0x4e,
+          0x00, 0x00, 0x00, 0x00
+        ].pack('C*')
+      end
+      Given(:body_dump) do
+        [
+          0xff, 0xff, 0xff, 0x00,
+          0x00, 0x3c,
+          0x00, 0x01,
+          0x00,
+          0x00
+        ].pack('C*') + data_dump
+      end
+
+      When(:packet_in) do
+        Pio::PacketIn.read(header_dump + body_dump)
+      end
+
+      Then { packet_in.class == Pio::PacketIn }
+      Then { packet_in.ofp_version == 0x1 }
+      Then { packet_in.message_type == 0xa }
+      Then { packet_in.message_length == 0x4e }
+      Then { packet_in.transaction_id == 0 }
+      Then { packet_in.xid == 0 }
+
+      Then { !packet_in.body.empty? }
+      Then { packet_in.buffer_id == 0xffffff00 }
+      Then { packet_in.total_len == 0x3c }
+      Then { packet_in.in_port == 1 }
+      Then { packet_in.reason == :no_match }
+      Then { packet_in.data == data_dump }
+    end
+
+    context 'with a packet_in message generated with PacketIn.new' do
+      Given(:packet_in_dump) do
+        Pio::PacketIn.new(
+          transaction_id: 0,
+          buffer_id: 0xffffff00,
+          in_port: 1,
+          reason: :no_match,
+          data: data_dump
+        ).to_binary
+      end
+      When(:packet_in) { Pio::PacketIn.read(packet_in_dump) }
+
+      Then { packet_in.class == Pio::PacketIn }
+      Then { packet_in.ofp_version == 0x1 }
+      Then { packet_in.message_type == 0xa }
+      Then { packet_in.message_length == 0x4e }
+      Then { packet_in.transaction_id == 0 }
+      Then { packet_in.xid == 0 }
+
+      Then { !packet_in.body.empty? }
+      Then { packet_in.buffer_id == 0xffffff00 }
+      Then { packet_in.total_len == 0x3c }
+      Then { packet_in.in_port == 1 }
+      Then { packet_in.reason == :no_match }
+      Then { packet_in.data == data_dump }
+    end
+
+    context 'with a Hello message' do
+      Given(:hello_dump) { [1, 0, 0, 8, 0, 0, 0, 0].pack('C*') }
+
+      When(:result) { Pio::PacketIn.read(hello_dump) }
+
+      Then do
+        result == Failure(Pio::ParseError, 'Invalid Packet-In message.')
+      end
+    end
+  end
+
+  describe '.new' do
+    When(:packet_in) { Pio::PacketIn.new(user_options) }
+
+    context 'with transaction_id: option' do
+      When(:user_options) do
+        {
+          transaction_id: 0x123,
+          buffer_id: 0xffffff00,
+          in_port: 1,
+          reason: :no_match,
+          data: data_dump
+        }
+      end
+
+      Then { packet_in.ofp_version == 1 }
+      Then { packet_in.message_type == 10 }
+      Then { packet_in.message_length == 78 }
+      Then { packet_in.transaction_id == 0x123 }
+      Then { packet_in.xid == 0x123 }
+
+      Then { !packet_in.body.empty? }
+      Then { packet_in.buffer_id == 0xffffff00 }
+      Then { packet_in.in_port == 1 }
+      Then { packet_in.reason == :no_match }
+      Then { packet_in.data == data_dump }
+    end
+
+    context 'with xid: option' do
+      When(:user_options) do
+        {
+          xid: 0x123,
+          buffer_id: 0xffffff00,
+          in_port: 1,
+          reason: :no_match,
+          data: data_dump
+        }
+      end
+
+      Then { packet_in.ofp_version == 1 }
+      Then { packet_in.message_type == 10 }
+      Then { packet_in.message_length == 78 }
+      Then { packet_in.transaction_id == 0x123 }
+      Then { packet_in.xid == 0x123 }
+
+      Then { !packet_in.body.empty? }
+      Then { packet_in.buffer_id == 0xffffff00 }
+      Then { packet_in.in_port == 1 }
+      Then { packet_in.reason == :no_match }
+      Then { packet_in.data == data_dump }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pio
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Yasuhito Takamiya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-17 00:00:00.000000000 Z
+date: 2014-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.6
+        version: 1.7.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.6
+        version: 1.7.9
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -72,56 +72,56 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.2
+        version: 2.10.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.2
+        version: 2.10.4
 - !ruby/object:Gem::Dependency
   name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: guard-cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 1.5.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 1.5.3
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.3.1
+        version: 4.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.3.1
+        version: 4.5.0
 - !ruby/object:Gem::Dependency
   name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -198,14 +198,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.7
+        version: 0.5.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.7
+        version: 0.5.8
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -226,14 +226,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.4.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.4.3
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -296,14 +296,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -338,14 +338,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.27.1
+        version: 0.28.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.27.1
+        version: 0.28.0
 description: Pure ruby packet parser and generator.
 email:
 - yasuhito@gmail.com
@@ -376,6 +376,8 @@ files:
 - examples/icmp_read.rb
 - examples/lldp_new.rb
 - examples/lldp_read.rb
+- examples/packet_in_new.rb
+- examples/packet_in_read.rb
 - features/arp_read.feature
 - features/dhcp_read.feature
 - features/echo_read.feature
@@ -422,6 +424,7 @@ files:
 - features/packet_data/table_stats_request.raw
 - features/packet_data/vendor.raw
 - features/packet_data/vendor_stats_request.raw
+- features/packet_in_read.feature
 - features/step_definitions/packet_data_steps.rb
 - features/step_definitions/pending_steps.rb
 - features/support/env.rb
@@ -490,6 +493,8 @@ files:
 - lib/pio/open_flow/phy_port.rb
 - lib/pio/open_flow/type.rb
 - lib/pio/options.rb
+- lib/pio/packet_in.rb
+- lib/pio/packet_in/format.rb
 - lib/pio/parse_error.rb
 - lib/pio/pcap.rb
 - lib/pio/type/ethernet_header.rb
@@ -525,6 +530,7 @@ files:
 - spec/pio/mac_spec.rb
 - spec/pio/open_flow/phy_port_spec.rb
 - spec/pio/open_flow/type_spec.rb
+- spec/pio/packet_in_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/trema/pio
 licenses:
@@ -577,6 +583,7 @@ test_files:
 - spec/pio/mac_spec.rb
 - spec/pio/open_flow/phy_port_spec.rb
 - spec/pio/open_flow/type_spec.rb
+- spec/pio/packet_in_spec.rb
 - spec/spec_helper.rb
 - features/arp_read.feature
 - features/dhcp_read.feature
@@ -624,6 +631,7 @@ test_files:
 - features/packet_data/table_stats_request.raw
 - features/packet_data/vendor.raw
 - features/packet_data/vendor_stats_request.raw
+- features/packet_in_read.feature
 - features/step_definitions/packet_data_steps.rb
 - features/step_definitions/pending_steps.rb
 - features/support/env.rb