pio 0.10.1 → 0.11.0

data/lib/pio/echo/reply.rb

@@ -1,41 +0,0 @@
-require 'pio/echo/message'
-require 'pio/open_flow'
-
-module Pio
-  class Echo
-    # OpenFlow 1.0 Echo Reply message generator.
-    class Reply < Message
-      def_format Pio::OpenFlow::Type::ECHO_REPLY
-
-      # Creates an EchoReply OpenFlow message. This message can be
-      # used to measure the bandwidth of a controller/switch
-      # connection as well as to verify its liveness.
-      #
-      # @overload initialize()
-      #   @example
-      #     Pio::Echo::Reply.new
-      #
-      # @overload initialize(transaction_id)
-      #   @example
-      #     Pio::Echo::Reply.new(123)
-      #   @param [Number] transaction_id
-      #     An unsigned 32-bit integer number associated with this
-      #     message.
-      #
-      # @overload initialize(user_options)
-      #   @example
-      #     Pio::Echo::Reply.new(
-      #       transaction_id: transaction_id,
-      #       user_data: 'Thu Aug 25 13:09:00 +0900 2011'
-      #     )
-      #   @param [Hash] user_options The options to create a message with.
-      #   @option user_options [Number] :transaction_id
-      #   @option user_options [Number] :xid An alias to transaction_id.
-      #   @option user_options [String] :user_data
-      #     The user data field specified as a String may be a message
-      #     timestamp to check latency, various lengths to measure
-      #     bandwidth or zero-size(nil) to verify liveness between the
-      #     switch and controller.
-    end
-  end
-end

data/lib/pio/echo/request.rb

@@ -1,43 +0,0 @@
-require 'pio/echo/message'
-require 'pio/open_flow'
-
-module Pio
-  class Echo
-    # OpenFlow 1.0 Echo Request message.
-    class Request < Message
-      def_format Pio::OpenFlow::Type::ECHO_REQUEST
-
-      # Creates an EchoRequest OpenFlow message. This message can be
-      # used to measure the bandwidth of a controller/switch
-      # connection as well as to verify its liveness.
-      #
-      # @overload initialize()
-      #   @example
-      #     Pio::Echo::Request.new
-      #
-      # @overload initialize(transaction_id)
-      #   @example
-      #     Pio::Echo::Request.new(123)
-      #   @param [Number] transaction_id
-      #     An unsigned 32-bit integer number associated with this
-      #     message.
-      #
-      # @overload initialize(user_options)
-      #   @example
-      #     Pio::Echo::Request.new(
-      #       transaction_id: transaction_id,
-      #       user_data: 'Thu Aug 25 13:09:00 +0900 2011'
-      #     )
-      #   @param [Hash] user_options The options to create a message with.
-      #   @option user_options [Number] :transaction_id
-      #   @option user_options [Number] :xid An alias to transaction_id.
-      #   @option user_options [String] :user_data
-      #     The user data field specified as a String may be a message
-      #     timestamp to check latency, various lengths to measure
-      #     bandwidth or zero-size(nil) to verify liveness between the
-      #     switch and controller.
-      #
-      # rubocop:disable MethodLength
-    end
-  end
-end

data/lib/pio/features/reply.rb

@@ -1,88 +0,0 @@
-require 'bindata'
-require 'pio/open_flow'
-
-module Pio
-  # OpenFlow 1.0 Features messages
-  class Features
-    # OpenFlow 1.0 Features Reply message
-    class Reply < Pio::OpenFlow::Message
-      # Message body of features reply.
-      class Body < BinData::Record
-        extend Flags
-
-        # enum ofp_capabilities
-        def_flags :capabilities,
-                  [:flow_stats,
-                   :table_stats,
-                   :port_stats,
-                   :stp,
-                   :reserved,
-                   :ip_reasm,
-                   :queue_stats,
-                   :arp_match_ip]
-
-        # enum ofp_action_type
-        def_flags :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]
-
-        endian :big
-
-        uint64 :datapath_id
-        uint32 :n_buffers
-        uint8 :n_tables
-        uint24 :padding
-        hide :padding
-        capabilities :capabilities
-        actions :actions
-        array :ports, type: :phy_port, read_until: :eof
-
-        def empty?
-          false
-        end
-
-        def length
-          24 + ports.to_binary_s.length
-        end
-      end
-
-      def_format Pio::OpenFlow::Type::FEATURES_REPLY
-
-      def datapath_id
-        @format.body.datapath_id
-      end
-
-      def_delegators :body, :datapath_id
-      def_delegator :body, :datapath_id, :dpid
-      def_delegators :body, :n_buffers
-      def_delegators :body, :n_tables
-      def_delegators :body, :capabilities
-      def_delegators :body, :actions
-      def_delegators :body, :ports
-
-      # @reek This method smells of :reek:FeatureEnvy
-      def initialize(user_options)
-        body_options =
-          {
-            datapath_id: user_options[:dpid],
-            n_buffers: user_options[:n_buffers],
-            n_tables: user_options[:n_tables],
-            capabilities: user_options[:capabilities],
-            actions: user_options[:actions],
-            ports: user_options[:ports]
-          }
-        @format = Format.new(user_options.merge(body: body_options))
-      end
-    end
-  end
-end

data/lib/pio/features/request.rb

@@ -1,68 +0,0 @@
-require 'forwardable'
-require 'pio/open_flow'
-
-module Pio
-  # OpenFlow 1.0 Features messages
-  class Features
-    # OpenFlow 1.0 Features Request message
-    class Request < Pio::OpenFlow::Message
-      # Message body of Features Request
-      class Body < BinData::Record
-        endian :big
-
-        string :body # ignored
-
-        def length
-          0
-        end
-
-        def empty?
-          true
-        end
-      end
-
-      def_format Pio::OpenFlow::Type::FEATURES_REQUEST
-
-      # Creates a Features Request OpenFlow message.
-      #
-      # @overload initialize()
-      #   @example
-      #     Pio::Features::Request.new
-      #
-      # @overload initialize(transaction_id)
-      #   @example
-      #     Pio::Features::Request.new(123)
-      #   @param [Number] transaction_id
-      #     An unsigned 32-bit integer number associated with this
-      #     message.
-      #
-      # @overload initialize(user_options)
-      #   @example
-      #     Pio::Features::Request.new(transaction_id: 123)
-      #     Pio::Features::Request.new(xid: 123)
-      #   @param [Hash] user_options
-      #     The options to create a message with.
-      #   @option user_options [Number] :transaction_id
-      #   @option user_options [Number] :xid An alias to transaction_id.
-      #
-      # @reek This method smells of :reek:FeatureEnvy
-      # rubocop:disable MethodLength
-      def initialize(user_options = {})
-        options = if user_options.respond_to?(:to_i)
-                    { open_flow_header: { transaction_id: user_options.to_i } }
-                  elsif user_options.respond_to?(:fetch)
-                    transaction_id =
-                      user_options[:transaction_id] || user_options[:xid] || 0
-                    { open_flow_header: { transaction_id: transaction_id } }
-                  else
-                    fail TypeError
-                  end
-        if options[:open_flow_header][:transaction_id] >= 2**32
-          fail ArgumentError, 'Transaction ID >= 2**32'
-        end
-        @format = Format.new(options)
-      end
-      # rubocop:enable MethodLength
-    end
-  end
-end

data/lib/pio/open_flow/parser.rb

@@ -1,22 +0,0 @@
-require 'pio/open_flow'
-require 'pio/parse_error'
-
-module Pio
-  module OpenFlow
-    # OpenFlow message parser interface.
-    module Parser
-      # This method smells of :reek:TooManyStatements
-      # This method smells of :reek:FeatureEnvy
-      def read(raw_data)
-        header = Pio::Type::OpenFlow::OpenFlowHeader.read(raw_data)
-        klass = const_get(:KLASS).fetch(header.message_type)
-        format = klass.const_get(:Format).read(raw_data)
-        message = klass.allocate
-        message.instance_variable_set :@format, format
-        message
-      rescue KeyError
-        raise Pio::ParseError, 'Invalid OpenFlow message.'
-      end
-    end
-  end
-end

data/spec/pio/echo_spec.rb

@@ -1,49 +0,0 @@
-require 'pio/echo'
-
-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.ofp_version == 1 }
-      Then { echo_request.message_type == Pio::OpenFlow::Type::ECHO_REQUEST }
-      Then { echo_request.message_length == 8 }
-      Then { echo_request.xid == 0 }
-      Then { echo_request.user_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.ofp_version == 1 }
-      Then { echo_reply.message_type == Pio::OpenFlow::Type::ECHO_REPLY }
-      Then { echo_reply.message_length == 8 }
-      Then { echo_reply.xid == 0 }
-      Then { echo_reply.user_data == '' }
-      Then { echo_reply.to_binary == echo_reply_dump }
-    end
-
-    context 'with a Features Request message' do
-      Given(:features_request_dump) { [1, 5, 0, 8, 0, 0, 0, 0].pack('C*') }
-
-      When(:result) { Pio::Echo.read(features_request_dump) }
-
-      Then { result == Failure(Pio::ParseError) }
-    end
-  end
-end

data/spec/pio/features_spec.rb

@@ -1,96 +0,0 @@
-require 'pio/features'
-
-describe Pio::Features do
-  describe '.read' do
-    context 'with a Features Request message' do
-      Given(:request_dump) { [1, 5, 0, 8, 0, 0, 0, 0].pack('C*') }
-
-      When(:request) { Pio::Features.read(request_dump) }
-
-      Then { request.class == Pio::Features::Request }
-      Then { request.ofp_version == 1 }
-      Then do
-        request.message_type ==
-          Pio::OpenFlow::Type::FEATURES_REQUEST
-      end
-      Then { request.message_length == 8 }
-      Then { request.transaction_id == 0 }
-      Then { request.xid == 0 }
-      Then { request.body.empty? }
-    end
-
-    context 'with a Features Reply message' do
-      Given(:reply_dump) do
-        [0x01, 0x06, 0x00, 0xb0, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00,
-         0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x01, 0x00,
-         0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x87, 0x00, 0x00,
-         0x0f, 0xff, 0x00, 0x02, 0x16, 0x7d, 0xa4, 0x37, 0xba, 0x10,
-         0x74, 0x72, 0x65, 0x6d, 0x61, 0x30, 0x2d, 0x30, 0x00, 0x00,
-         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xc0, 0x00, 0x00,
-         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-         0xff, 0xfe, 0x2a, 0xb4, 0xd6, 0x3c, 0x66, 0xba, 0x76, 0x73,
-         0x77, 0x5f, 0x30, 0x78, 0x31, 0x00, 0x00, 0x00, 0x00, 0x00,
-         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00,
-         0x00, 0x01, 0x00, 0x00, 0x00, 0x82, 0x00, 0x00, 0x00, 0x00,
-         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01,
-         0x62, 0x94, 0x3a, 0xf6, 0x40, 0xdb, 0x74, 0x72, 0x65, 0x6d,
-         0x61, 0x31, 0x2d, 0x30, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-         0x00, 0x00, 0x00, 0xc0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-         0x00, 0x00, 0x00, 0x00, 0x00, 0x00].pack('C*')
-      end
-
-      When(:reply) { Pio::Features.read(reply_dump) }
-
-      Then { reply.class == Pio::Features::Reply }
-      Then { reply.ofp_version == 1 }
-      Then do
-        reply.message_type ==
-          Pio::OpenFlow::Type::FEATURES_REPLY
-      end
-      Then { reply.message_length == 176 }
-      Then { reply.transaction_id == 2 }
-      Then { reply.xid == 2 }
-      Then { !reply.body.empty? }
-      Then { reply.datapath_id == 1 }
-      Then { reply.n_buffers == 0x100 }
-      Then { reply.n_tables == 1 }
-      Then do
-        reply.capabilities ==
-          [:flow_stats, :table_stats, :port_stats, :arp_match_ip]
-      end
-      Then do
-        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 { reply.ports.size == 3 }
-      Then { reply.ports.all? { |each| each.port_no > 0 } }
-      Then do
-        reply.ports.all? do |each|
-          /^([0-9a-fA-F]{2}[:-]){5}[0-9a-fA-F]{2}$/i=~
-            each.hardware_address.to_s
-        end
-      end
-      Then { reply.ports.all? { |each| !each.name.empty? } }
-      Then { reply.ports.any? { |each| each.config == [:port_down] } }
-      Then { reply.ports.any? { |each| each.state == [:link_down] } }
-      Then { reply.ports.all? { |each| each.curr.include? :port_copper } }
-      Then { reply.ports.all? { |each| each.advertised.empty? } }
-      Then { reply.ports.all? { |each| each.supported.empty? } }
-      Then { reply.ports.all? { |each| each.peer.empty? } }
-    end
-
-    context 'with a Hello message' do
-      Given(:hello_dump) { [1, 0, 0, 8, 0, 0, 0, 0].pack('C*') }
-
-      When(:result) { Pio::Features.read(hello_dump) }
-
-      Then do
-        result == Failure(Pio::ParseError, 'Invalid OpenFlow message.')
-      end
-    end
-  end
-end