pio 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7440562aee407d80e2f3f795a40fb065b6a6189a
-  data.tar.gz: f28861cef1a8a0a3e2807b77a62ddd5bbc98ac47
+  metadata.gz: 24250e762b41db6e78d190ece32de1a57bbba89c
+  data.tar.gz: df8706edd1b12d95750bb240b21ea93021b09d1d
 SHA512:
-  metadata.gz: dc1f92d485a60ec4e53bb6e260962ed56186d89ddf4e79c4e4abcb4c2a3dd7140101e41a765c93502936d170082bd83fc669c165efcc49c3a0a14c44331dc7d1
-  data.tar.gz: 5af6281ba069a05d1ebd7f7608d5e2a01f2c80c60f5c0d6de22ab0463ae8c377841e11ae41c9faca5c078b5dcfb2e9546ebddbd6aa5361a223d9ded017993b58
+  metadata.gz: 008fe84cace5c6050f941180a8122dbcfbcdb475936efef993002dc33b6f939149d000c7d5955c9396defaef49a6e6a85e6d6c5f1ca460fa50b772e8ed5ae182
+  data.tar.gz: af12f5c7bca4549a0c2ce34531def8ece2d530b88ef091763f84c782d0fbaa5c8081936982c074325391e4bed7d43b22b7b014362e6a9f72ac76ae04e2b95f2d

data/CHANGELOG.md

@@ -1,11 +1,23 @@
 # Changelog
 
+## 0.6.0 (4/15/2014)
+
+### New features
+* Added new class `Pio::Echo`, `Pio::Echo::Request` and `Pio::Echo::Reply`.
+
+
+## 0.5.1 (4/15/2014)
+
+### Bugs fixed
+* Set hello message type = 0.
+
+
 ## 0.5.0 (4/14/2014)
 
+### New features
 * Added new class `Pio::Hello`.
 
 ### Misc
-
 * Added new rake task `cucumber`.
 * Added new rake task `dump_pcap`.
 

data/README.md

@@ -16,8 +16,9 @@ supports the following packet formats:
 -   ARP
 -   LLDP
 -   DHCP
--   OpenFlow 1.0 messages
+-   OpenFlow 1.0
     -   Hello
+    -   Echo Request and Reply
 -   (…currently there are just a few formats supported but I'm sure this list will grow)
 
 ## Features Overview
@@ -178,6 +179,29 @@ below:
     hello = Pio::Hello.new(transaction_id: 123)
     hello.to_binary  # => HELLO message in binary format.
 
+## Echo
+
+To parse an OpenFlow 1.0 ECHO message, use the API `Pio::Echo.read`
+and you can access each field of the parsed ECHO message.
+
+    require 'pio'
+
+    echo = Pio::Echo.read(binary_data)
+    echo.xid # => 123
+
+Also you can use `Pio::Echo::Request#new` or `Pio::Echo::Reply#new` to
+generate an Echo Request/Reply message like below:
+
+    require 'pio'
+
+    request = Pio::Echo::Request.new
+    request.to_binary  # => ECHO Request message in binary format.
+
+    # The ECHO xid (transaction_id)
+    # should be same as that of the request.
+    reply = Pio::Echo::Reply.new(xid: request.xid)
+    reply.to_binary  # => ECHO Reply message in binary format.
+
 ## Installation
 
 The simplest way to install Pio is to use [Bundler](http://gembundler.com/).

data/examples/echo_new.rb

@@ -0,0 +1,9 @@
+require 'pio'
+
+request = Pio::Echo::Request.new
+request.to_binary  # => ECHO Request message in binary format.
+
+# The ECHO xid (transaction_id)
+# should be same as that of the request.
+reply = Pio::Echo::Reply.new(xid: request.xid)
+reply.to_binary  # => ECHO Reply message in binary format.

data/examples/echo_read.rb

@@ -0,0 +1,4 @@
+require 'pio'
+
+echo = Pio::Echo.read(binary_data)
+echo.xid # => 123

data/lib/pio.rb

@@ -4,6 +4,7 @@ require 'pio/parse_error'
 
 require 'pio/arp'
 require 'pio/dhcp'
+require 'pio/echo'
 require 'pio/hello'
 require 'pio/icmp'
 require 'pio/lldp'

data/lib/pio/echo.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'pio/echo/format'
+require 'pio/echo/reply'
+require 'pio/echo/request'
+
+module Pio
+  # OpenFlow Echo Request and Reply message parser.
+  class Echo
+    REQUEST = 2
+    REPLY = 3
+
+    def self.read(raw_data)
+      echo = Echo::Format.read(raw_data)
+      case echo.message_type
+      when REQUEST
+        Echo::Request.create_from(echo)
+      when REPLY
+        Echo::Reply.create_from(echo)
+      else
+        fail 'Unknown Echo message type.'
+      end
+    end
+  end
+end

data/lib/pio/echo/format.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require 'bindata'
+
+module Pio
+  class Echo
+    # OpenFlow 1.0 Echo message format.
+    class Format < BinData::Record
+      endian :big
+
+      uint8 :version, value: 1
+      uint8 :message_type
+      uint16 :message_length, value: -> { 8 + data.length }
+      uint32 :transaction_id, initial_value: 0
+      string :data
+    end
+  end
+end

data/lib/pio/echo/message.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+require 'forwardable'
+require 'bindata'
+
+module Pio
+  class Echo
+    # Base class of Echo request and reply.
+    class Message
+      extend Forwardable
+
+      def_delegators :@echo, :version
+      def_delegators :@echo, :message_type
+      def_delegators :@echo, :message_length
+      def_delegators :@echo, :transaction_id
+      def_delegator :@echo, :transaction_id, :xid
+      def_delegators :@echo, :data
+      def_delegator :@echo, :to_binary_s, :to_binary
+
+      def self.create_from(echo)
+        message = allocate
+        message.instance_variable_set :@echo, echo
+        message
+      end
+
+      def initialize(message_type, user_options = {})
+        @options = user_options.dup.merge(message_type: message_type)
+        handle_option_aliases
+        @echo = Format.new(@options)
+      end
+
+      private
+
+      def handle_option_aliases
+        @options[:transaction_id] ||= @options[:xid]
+      end
+    end
+  end
+end

data/lib/pio/echo/reply.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'pio/echo/format'
+require 'pio/echo/message'
+
+module Pio
+  # OpenFlow Echo Request and Reply message parser.
+  class Echo
+    # OpenFlow 1.0 Echo Reply message.
+    class Reply < Message
+      def initialize(user_options = {})
+        super REPLY, user_options
+      end
+    end
+  end
+end

data/lib/pio/echo/request.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'pio/echo/format'
+require 'pio/echo/message'
+
+module Pio
+  # OpenFlow Echo Request and Reply message parser.
+  class Echo
+    # OpenFlow 1.0 Echo Request message.
+    class Request < Message
+      def initialize(user_options = {})
+        super REQUEST, user_options
+      end
+    end
+  end
+end

data/lib/pio/hello/format.rb

@@ -9,7 +9,7 @@ module Pio
       endian :big
 
       uint8 :version, value: 1
-      uint8 :message_type
+      uint8 :message_type, initial_value: 0, assert: -> { value == 0 }
       uint16 :message_length, initial_value: 8
       uint32 :transaction_id
       string :body  # ignored

data/lib/pio/version.rb

@@ -3,5 +3,5 @@
 # Base module.
 module Pio
   # gem version.
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/spec/pio/echo/reply_spec.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+require 'pio'
+
+describe Pio::Echo::Reply do
+  describe '.new' do
+    context 'with no additional data' do
+      When(:echo_reply) do
+        Pio::Echo::Reply.new(xid: 123)
+      end
+
+      Then { echo_reply.class == Pio::Echo::Reply }
+      Then { echo_reply.version == 1 }
+      Then { echo_reply.message_type == Pio::Echo::REPLY }
+      Then { echo_reply.message_length == 8 }
+      Then { echo_reply.xid == 123 }
+      Then { echo_reply.data == '' }
+    end
+  end
+end

data/spec/pio/echo/request_spec.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+require 'pio'
+
+describe Pio::Echo::Request do
+  describe '.new' do
+    Given(:echo_request) do
+      Pio::Echo::Request.new(user_options)
+    end
+
+    context 'with no arguments' do
+      When(:user_options) { {} }
+
+      Then { echo_request.class == Pio::Echo::Request }
+      Then { echo_request.version == 1 }
+      Then { echo_request.message_type == Pio::Echo::REQUEST }
+      Then { echo_request.message_length == 8 }
+      Then { echo_request.transaction_id == 0 }
+      Then { echo_request.xid == 0 }
+      Then { echo_request.data == '' }
+    end
+
+    context 'with transaction_id: 123' do
+      When(:user_options) { { transaction_id: 123 } }
+
+      Then { echo_request.class == Pio::Echo::Request }
+      Then { echo_request.version == 1 }
+      Then { echo_request.message_type == Pio::Echo::REQUEST }
+      Then { echo_request.message_length == 8 }
+      Then { echo_request.transaction_id == 123 }
+      Then { echo_request.xid == 123 }
+      Then { echo_request.data == '' }
+    end
+
+    context 'with xid: 123' do
+      When(:user_options) { { xid: 123 } }
+
+      Then { echo_request.class == Pio::Echo::Request }
+      Then { echo_request.version == 1 }
+      Then { echo_request.message_type == Pio::Echo::REQUEST }
+      Then { echo_request.message_length == 8 }
+      Then { echo_request.transaction_id == 123 }
+      Then { echo_request.xid == 123 }
+      Then { echo_request.data == '' }
+    end
+  end
+end

data/spec/pio/echo_spec.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+require 'pio'
+
+describe Pio::Echo do
+  describe '.read' do
+    context 'with an Echo Request message' do
+      Given(:echo_request_dump) do
+        [1, 2, 0, 8, 0, 0, 0, 0].pack('C*')
+      end
+
+      When(:echo_request) do
+        Pio::Echo.read echo_request_dump
+      end
+
+      Then { echo_request.class == Pio::Echo::Request }
+      Then { echo_request.version == 1 }
+      Then { echo_request.message_type == Pio::Echo::REQUEST }
+      Then { echo_request.message_length == 8 }
+      Then { echo_request.xid == 0 }
+      Then { echo_request.data == '' }
+      Then { echo_request.to_binary == echo_request_dump }
+    end
+
+    context 'with an Echo Reply message' do
+      Given(:echo_reply_dump) do
+        [1, 3, 0, 8, 0, 0, 0, 0].pack('C*')
+      end
+
+      When(:echo_reply) do
+        Pio::Echo.read echo_reply_dump
+      end
+
+      Then { echo_reply.class == Pio::Echo::Reply }
+      Then { echo_reply.version == 1 }
+      Then { echo_reply.message_type == Pio::Echo::REPLY }
+      Then { echo_reply.message_length == 8 }
+      Then { echo_reply.xid == 0 }
+      Then { echo_reply.data == '' }
+      Then { echo_reply.to_binary == echo_reply_dump }
+    end
+  end
+end

data/spec/pio/hello_spec.rb

@@ -16,6 +16,13 @@ describe Pio::Hello do
       Then { hello.xid == 0 }
       Then { hello.body.empty? }
     end
+
+    context 'with an features-request message' do
+      Given(:features_request_dump) { [1, 5, 0, 8, 0, 0, 0, 0].pack('C*') }
+
+      When(:result) { Pio::Hello.read(features_request_dump) }
+      Then { result == Failure(BinData::ValidityError) }
+    end
   end
 
   describe '.new' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pio
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Yasuhito Takamiya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -58,6 +58,8 @@ files:
 - examples/arp_read.rb
 - examples/dhcp_new.rb
 - examples/dhcp_read.rb
+- examples/echo_new.rb
+- examples/echo_read.rb
 - examples/hello_new.rb
 - examples/hello_read.rb
 - examples/icmp_new.rb
@@ -101,6 +103,11 @@ files:
 - lib/pio/dhcp/optional_tlv.rb
 - lib/pio/dhcp/parameter_list.rb
 - lib/pio/dhcp/request.rb
+- lib/pio/echo.rb
+- lib/pio/echo/format.rb
+- lib/pio/echo/message.rb
+- lib/pio/echo/reply.rb
+- lib/pio/echo/request.rb
 - lib/pio/hello.rb
 - lib/pio/hello/format.rb
 - lib/pio/icmp.rb
@@ -146,6 +153,9 @@ files:
 - spec/pio/dhcp/offer_spec.rb
 - spec/pio/dhcp/request_spec.rb
 - spec/pio/dhcp_spec.rb
+- spec/pio/echo/reply_spec.rb
+- spec/pio/echo/request_spec.rb
+- spec/pio/echo_spec.rb
 - spec/pio/hello_spec.rb
 - spec/pio/icmp/reply_spec.rb
 - spec/pio/icmp/request_spec.rb
@@ -186,6 +196,7 @@ test_files:
 - spec/pio/dhcp/offer_spec.rb
 - spec/pio/dhcp/ack_spec.rb
 - spec/pio/dhcp/discover_spec.rb
+- spec/pio/echo_spec.rb
 - spec/pio/arp/request_spec.rb
 - spec/pio/arp/reply/options_spec.rb
 - spec/pio/arp/request/options_spec.rb
@@ -198,6 +209,8 @@ test_files:
 - spec/pio/dhcp_spec.rb
 - spec/pio/lldp_spec.rb
 - spec/pio/arp_spec.rb
+- spec/pio/echo/request_spec.rb
+- spec/pio/echo/reply_spec.rb
 - spec/spec_helper.rb
 - features/pcap/dhcp.pcap
 - features/pcap/arp.pcap