pio 0.8.1 → 0.8.2

data/lib/pio/open_flow/type.rb

@@ -0,0 +1,12 @@
+module Pio
+  module OpenFlow
+    # OFPT_* constants.
+    module Type
+      HELLO = 0
+      ECHO_REQUEST = 2
+      ECHO_REPLY = 3
+      FEATURES_REQUEST = 5
+      FEATURES_REPLY = 6
+    end
+  end
+end

data/lib/pio/options.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Pio
   # User options utility.
   class Options

data/lib/pio/parse_error.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Pio
   # Raised when the packet data is in wrong format.
   class ParseError < StandardError; end

data/lib/pio/pcap.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'bindata'
 
 module Pio

data/lib/pio/type/ethernet_header.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'pio/type/mac_address'
 
 module Pio

data/lib/pio/type/ip_address.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'bindata'
 require 'pio/ipv4_address'
 

data/lib/pio/type/ipv4_header.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'pio/type/ip_address'
 
 module Pio
@@ -7,6 +5,7 @@ module Pio
     # IP Version 4 Header Format
     module IPv4Header
       # rubocop:disable MethodLength
+      # rubocop:disable AbcSize
       def ipv4_header(options)
         class_eval do
           bit4 :ip_version, initial_value: 0x4
@@ -25,6 +24,7 @@ module Pio
           ip_address :ip_destination_address
         end
       end
+      # rubocop:enable AbcSize
       # rubocop:enable MethodLength
     end
   end

data/lib/pio/type/mac_address.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'bindata'
 require 'pio/mac'
 
@@ -10,7 +8,12 @@ module Pio
       array :octets, type: :uint8, initial_length: 6
 
       def set(value)
-        self.octets = value.to_a
+        case value
+        when String
+          self.octets = value.split(':').map { |each| ('0x' + each).hex }
+        else
+          self.octets = value.to_a
+        end
       end
 
       def get

data/lib/pio/type/udp_header.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Pio
   module Type
     # UDP Header Format.

data/lib/pio/version.rb

@@ -1,7 +1,5 @@
-# encoding: utf-8
-
 # Base module.
 module Pio
   # gem version.
-  VERSION = '0.8.1'.freeze
+  VERSION = '0.8.2'.freeze
 end

data/pio.gemspec

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pio/version'
@@ -34,37 +32,37 @@ Gem::Specification.new do |gem|
   gem.test_files = Dir.glob('spec/**/*')
   gem.test_files += Dir.glob('features/**/*')
 
-  gem.required_ruby_version = '>= 1.9.3'
+  gem.required_ruby_version = '>= 2.0.0'
 
   gem.add_dependency 'bindata', '~> 2.1.0'
 
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'bundler', '~> 1.6.2'
-  gem.add_development_dependency 'pry', '~> 0.9.12.6'
+  gem.add_development_dependency 'bundler', '~> 1.7.6'
+  gem.add_development_dependency 'pry', '~> 0.10.1'
 
   # Guard
-  gem.add_development_dependency 'guard', '~> 2.6.1'
+  gem.add_development_dependency 'guard', '~> 2.8.2'
   gem.add_development_dependency 'guard-bundler', '~> 2.0.0'
-  gem.add_development_dependency 'guard-cucumber', '~> 1.4.1'
-  gem.add_development_dependency 'guard-rspec', '~> 4.2.9'
-  gem.add_development_dependency 'guard-rubocop', '~> 1.1.0'
+  gem.add_development_dependency 'guard-cucumber', '~> 1.5.1'
+  gem.add_development_dependency 'guard-rspec', '~> 4.3.1'
+  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'
-  gem.add_development_dependency 'rb-inotify', '~> 0.9.3'
-  gem.add_development_dependency 'terminal-notifier-guard', '~> 1.5.3'
+  gem.add_development_dependency 'rb-inotify', '~> 0.9.5'
+  gem.add_development_dependency 'terminal-notifier-guard', '~> 1.6.4'
 
   # Docs
-  gem.add_development_dependency 'inch', '~> 0.4.6'
-  gem.add_development_dependency 'yard', '~> 0.8.7.4'
+  gem.add_development_dependency 'inch', '~> 0.5.7'
+  gem.add_development_dependency 'yard', '~> 0.8.7.6'
 
   # Test
-  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.3.0'
-  gem.add_development_dependency 'coveralls', '~> 0.7.0'
-  gem.add_development_dependency 'cucumber', '~> 1.3.15'
+  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.1'
+  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.2.1'
-  gem.add_development_dependency 'reek', '~> 1.3.7'
-  gem.add_development_dependency 'rspec', '~> 3.0.0'
+  gem.add_development_dependency 'flog', '~> 4.3.0'
+  gem.add_development_dependency 'reek', '~> 1.4.0'
+  gem.add_development_dependency 'rspec', '~> 3.1.0'
   gem.add_development_dependency 'rspec-given', '~> 3.5.4'
-  gem.add_development_dependency 'rubocop', '~> 0.23.0'
+  gem.add_development_dependency 'rubocop', '~> 0.27.1'
 end

data/spec/pio/arp/reply/options_spec.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'pio'
 
 describe Pio::Arp::Reply::Options, '.new' do

data/spec/pio/arp/reply_spec.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'pio'
 
 describe Pio::ARP::Reply do

data/spec/pio/arp/request/options_spec.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'pio'
 
 describe Pio::Arp::Request::Options, '.new' do

data/spec/pio/arp/request_spec.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'pio'
 
 describe Pio::ARP::Request do

data/spec/pio/arp_spec.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'pio'
 
 describe Pio::ARP do

data/spec/pio/dhcp/ack_spec.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'pio'
 
 describe Pio::DHCP::Ack do

data/spec/pio/dhcp/discover_spec.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'pio'
 
 describe Pio::DHCP::Discover do

data/spec/pio/dhcp/offer_spec.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'pio'
 
 describe Pio::DHCP::Offer do

data/spec/pio/dhcp/request_spec.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'pio'
 
 describe Pio::Dhcp::Request do

data/spec/pio/dhcp_spec.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'pio'
 
 describe Pio::DHCP do

data/spec/pio/echo/reply_spec.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-require 'pio'
+require 'pio/echo'
 
 describe Pio::Echo::Reply do
   describe '.new' do
@@ -8,11 +6,11 @@ describe Pio::Echo::Reply do
       When(:echo_reply) { Pio::Echo::Reply.new }
 
       Then { echo_reply.ofp_version == 1 }
-      Then { echo_reply.message_type == Pio::Echo::REPLY }
+      Then { echo_reply.message_type == Pio::OpenFlow::Type::ECHO_REPLY }
       Then { echo_reply.message_length == 8 }
       Then { echo_reply.transaction_id == 0 }
       Then { echo_reply.xid == 0 }
-      Then { echo_reply.data == '' }
+      Then { echo_reply.user_data == '' }
       Then { echo_reply.to_binary == [1, 3, 0, 8, 0, 0, 0, 0].pack('C*') }
     end
 
@@ -20,11 +18,11 @@ describe Pio::Echo::Reply do
       When(:echo_reply) { Pio::Echo::Reply.new(123) }
 
       Then { echo_reply.ofp_version == 1 }
-      Then { echo_reply.message_type == Pio::Echo::REPLY }
+      Then { echo_reply.message_type == Pio::OpenFlow::Type::ECHO_REPLY }
       Then { echo_reply.message_length == 8 }
       Then { echo_reply.transaction_id == 123 }
       Then { echo_reply.xid == 123 }
-      Then { echo_reply.data == '' }
+      Then { echo_reply.user_data == '' }
       Then { echo_reply.to_binary == [1, 3, 0, 8, 0, 0, 0, 123].pack('C*') }
     end
 
@@ -41,11 +39,11 @@ describe Pio::Echo::Reply do
       When(:echo_reply) { Pio::Echo::Reply.new(transaction_id: 123) }
 
       Then { echo_reply.ofp_version == 1 }
-      Then { echo_reply.message_type == Pio::Echo::REPLY }
+      Then { echo_reply.message_type == Pio::OpenFlow::Type::ECHO_REPLY }
       Then { echo_reply.message_length == 8 }
       Then { echo_reply.transaction_id == 123 }
       Then { echo_reply.xid == 123 }
-      Then { echo_reply.data == '' }
+      Then { echo_reply.user_data == '' }
       Then { echo_reply.to_binary == [1, 3, 0, 8, 0, 0, 0, 123].pack('C*') }
     end
 
@@ -53,23 +51,23 @@ describe Pio::Echo::Reply do
       When(:echo_reply) { Pio::Echo::Reply.new(xid: 123) }
 
       Then { echo_reply.ofp_version == 1 }
-      Then { echo_reply.message_type == Pio::Echo::REPLY }
+      Then { echo_reply.message_type == Pio::OpenFlow::Type::ECHO_REPLY }
       Then { echo_reply.message_length == 8 }
       Then { echo_reply.transaction_id == 123 }
       Then { echo_reply.xid == 123 }
-      Then { echo_reply.data == '' }
+      Then { echo_reply.user_data == '' }
       Then { echo_reply.to_binary == [1, 3, 0, 8, 0, 0, 0, 123].pack('C*') }
     end
 
-    context "with transaction_id: 123, data: 'foobar'" do
-      When(:echo_reply) { Pio::Echo::Reply.new(xid: 123, data: 'foobar') }
+    context "with transaction_id: 123, user_data: 'foobar'" do
+      When(:echo_reply) { Pio::Echo::Reply.new(xid: 123, user_data: 'foobar') }
 
       Then { echo_reply.ofp_version == 1 }
-      Then { echo_reply.message_type == Pio::Echo::REPLY }
+      Then { echo_reply.message_type == Pio::OpenFlow::Type::ECHO_REPLY }
       Then { echo_reply.message_length == 14 }
       Then { echo_reply.transaction_id == 123 }
       Then { echo_reply.xid == 123 }
-      Then { echo_reply.data == 'foobar' }
+      Then { echo_reply.user_data == 'foobar' }
       Then do
         echo_reply.to_binary ==
           [1, 3, 0, 14, 0, 0, 0, 123, 102, 111, 111, 98, 97, 114].pack('C*')

data/spec/pio/echo/request_spec.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-require 'pio'
+require 'pio/echo'
 
 describe Pio::Echo::Request do
   describe '.new' do
@@ -8,11 +6,11 @@ describe Pio::Echo::Request do
       When(:echo_request) { Pio::Echo::Request.new }
 
       Then { echo_request.ofp_version == 1 }
-      Then { echo_request.message_type == Pio::Echo::REQUEST }
+      Then { echo_request.message_type == Pio::OpenFlow::Type::ECHO_REQUEST }
       Then { echo_request.message_length == 8 }
       Then { echo_request.transaction_id == 0 }
       Then { echo_request.xid == 0 }
-      Then { echo_request.data == '' }
+      Then { echo_request.user_data == '' }
       Then { echo_request.to_binary == [1, 2, 0, 8, 0, 0, 0, 0].pack('C*') }
     end
 
@@ -20,11 +18,11 @@ describe Pio::Echo::Request do
       When(:echo_request) { Pio::Echo::Request.new(123) }
 
       Then { echo_request.ofp_version == 1 }
-      Then { echo_request.message_type == Pio::Echo::REQUEST }
+      Then { echo_request.message_type == Pio::OpenFlow::Type::ECHO_REQUEST }
       Then { echo_request.message_length == 8 }
       Then { echo_request.transaction_id == 123 }
       Then { echo_request.xid == 123 }
-      Then { echo_request.data == '' }
+      Then { echo_request.user_data == '' }
       Then { echo_request.to_binary == [1, 2, 0, 8, 0, 0, 0, 123].pack('C*') }
     end
 
@@ -41,11 +39,11 @@ describe Pio::Echo::Request do
       When(:echo_request) { Pio::Echo::Request.new(transaction_id: 123) }
 
       Then { echo_request.ofp_version == 1 }
-      Then { echo_request.message_type == Pio::Echo::REQUEST }
+      Then { echo_request.message_type == Pio::OpenFlow::Type::ECHO_REQUEST }
       Then { echo_request.message_length == 8 }
       Then { echo_request.transaction_id == 123 }
       Then { echo_request.xid == 123 }
-      Then { echo_request.data == '' }
+      Then { echo_request.user_data == '' }
       Then { echo_request.to_binary == [1, 2, 0, 8, 0, 0, 0, 123].pack('C*') }
     end
 
@@ -53,23 +51,25 @@ describe Pio::Echo::Request do
       When(:echo_request) { Pio::Echo::Request.new(xid: 123) }
 
       Then { echo_request.ofp_version == 1 }
-      Then { echo_request.message_type == Pio::Echo::REQUEST }
+      Then { echo_request.message_type == Pio::OpenFlow::Type::ECHO_REQUEST }
       Then { echo_request.message_length == 8 }
       Then { echo_request.transaction_id == 123 }
       Then { echo_request.xid == 123 }
-      Then { echo_request.data == '' }
+      Then { echo_request.user_data == '' }
       Then { echo_request.to_binary == [1, 2, 0, 8, 0, 0, 0, 123].pack('C*') }
     end
 
-    context "with transaction_id: 123, data: 'foobar'" do
-      When(:echo_request) { Pio::Echo::Request.new(xid: 123, data: 'foobar') }
+    context "with transaction_id: 123, user_data: 'foobar'" do
+      When(:echo_request) do
+        Pio::Echo::Request.new(xid: 123, user_data: 'foobar')
+      end
 
       Then { echo_request.ofp_version == 1 }
-      Then { echo_request.message_type == Pio::Echo::REQUEST }
+      Then { echo_request.message_type == Pio::OpenFlow::Type::ECHO_REQUEST }
       Then { echo_request.message_length == 14 }
       Then { echo_request.transaction_id == 123 }
       Then { echo_request.xid == 123 }
-      Then { echo_request.data == 'foobar' }
+      Then { echo_request.user_data == 'foobar' }
       Then do
         echo_request.to_binary ==
           [1, 2, 0, 14, 0, 0, 0, 123, 102, 111, 111, 98, 97, 114].pack('C*')

data/spec/pio/echo_spec.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-require 'pio'
+require 'pio/echo'
 
 describe Pio::Echo do
   describe '.read' do
@@ -15,10 +13,10 @@ describe Pio::Echo do
 
       Then { echo_request.class == Pio::Echo::Request }
       Then { echo_request.ofp_version == 1 }
-      Then { echo_request.message_type == Pio::Echo::REQUEST }
+      Then { echo_request.message_type == Pio::OpenFlow::Type::ECHO_REQUEST }
       Then { echo_request.message_length == 8 }
       Then { echo_request.xid == 0 }
-      Then { echo_request.data == '' }
+      Then { echo_request.user_data == '' }
       Then { echo_request.to_binary == echo_request_dump }
     end
 
@@ -33,10 +31,10 @@ describe Pio::Echo do
 
       Then { echo_reply.class == Pio::Echo::Reply }
       Then { echo_reply.ofp_version == 1 }
-      Then { echo_reply.message_type == Pio::Echo::REPLY }
+      Then { echo_reply.message_type == Pio::OpenFlow::Type::ECHO_REPLY }
       Then { echo_reply.message_length == 8 }
       Then { echo_reply.xid == 0 }
-      Then { echo_reply.data == '' }
+      Then { echo_reply.user_data == '' }
       Then { echo_reply.to_binary == echo_reply_dump }
     end
 

data/spec/pio/features/reply_spec.rb

@@ -1,30 +1,60 @@
-# encoding: utf-8
-
-require 'pio'
+require 'pio/features'
 
 describe Pio::Features::Reply do
-  describe '.new' do
-    Given(:options) do
-      {
-        dpid: 0x123,
-        n_buffers: 0x100,
-        n_tables: 0xfe,
-        capabilities: 0xc7,
-        actions: 0xfff
-      }
-    end
+  Given(:options) do
+    {
+      dpid: 0x123,
+      n_buffers: 0x100,
+      n_tables: 0xfe,
+      capabilities: [:flow_stats, :table_stats, :port_stats, :queue_stats,
+                     :arp_match_ip],
+      actions: [:output, :set_vlan_vid, :set_vlan_pcp, :strip_vlan,
+                :set_dl_src, :set_dl_dst, :set_nw_src, :set_nw_dst,
+                :set_nw_tos, :set_tp_src, :set_tp_dst, :enqueue],
+      ports: [{ port_no: 1,
+                hardware_address: '11:22:33:44:55:66',
+                name: 'port123',
+                config: [:port_down],
+                state: [:link_down],
+                curr: [:port_10gb_fd, :port_copper] }]
+    }
+  end
 
+  describe '.new' do
     When(:features_reply) { Pio::Features::Reply.new(options) }
 
     Then { features_reply.ofp_version == 1 }
-    Then { features_reply.message_type == Pio::Features::REPLY }
+    Then { features_reply.message_type == Pio::OpenFlow::Type::FEATURES_REPLY }
     Then { features_reply.transaction_id == 0 }
     Then { features_reply.xid == 0 }
     Then { features_reply.dpid == 0x123 }
     Then { features_reply.n_buffers == 0x100 }
     Then { features_reply.n_tables == 0xfe }
-    Then { features_reply.capabilities == 0xc7 }
-    Then { features_reply.actions == 0xfff }
-    Then { features_reply.ports == [] }
+    Then do
+      features_reply.capabilities ==
+        [:flow_stats, :table_stats, :port_stats, :queue_stats, :arp_match_ip]
+    end
+    Then do
+      features_reply.actions ==
+        [:output, :set_vlan_vid, :set_vlan_pcp, :strip_vlan, :set_dl_src,
+         :set_dl_dst, :set_nw_src, :set_nw_dst, :set_nw_tos, :set_tp_src,
+         :set_tp_dst, :enqueue]
+    end
+    Then { features_reply.ports.length == 1 }
+    Then { features_reply.ports[0].port_no == 1 }
+    Then { features_reply.ports[0].hardware_address == '11:22:33:44:55:66' }
+    Then { features_reply.ports[0].name == 'port123' }
+    Then { features_reply.ports[0].config == [:port_down] }
+    Then { features_reply.ports[0].state == [:link_down] }
+    Then { features_reply.ports[0].curr == [:port_10gb_fd, :port_copper] }
+    Then { features_reply.ports[0].advertised.empty? }
+    Then { features_reply.ports[0].supported.empty? }
+    Then { features_reply.ports[0].peer.empty? }
+  end
+
+  describe '#to_binary' do
+    When(:binary) { Pio::Features::Reply.new(options).to_binary }
+
+    Then { binary.length > 0 }
   end
 end