openflow-protocol 0.1.4 → 0.1.6

data/spec/messages/echo_reply_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe OFEchoReply do
+  it 'should read binary' do
+    msg = OFEchoReply.read [1, 3, 0, 8, 0, 0, 0, 1].pack('C*')
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:echo_reply)
+    expect(msg.len).to eq(8)
+    expect(msg.xid).to eq(1)
+    expect(msg.data).to be_empty
+  end
+  it 'should read binary with data' do
+    msg = OFEchoReply.read [1, 3, 0, 10, 0, 0, 0, 1, 10, 20].pack('C*')
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:echo_reply)
+    expect(msg.len).to eq(10)
+    expect(msg.xid).to eq(1)
+    expect(msg.data.length).to eq(2)
+  end
+  it 'should initialize with default values' do
+    msg = OFEchoReply.new
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:echo_reply)
+    expect(msg.len).to eq(8)
+    expect(msg.xid).to eq(0)
+    expect(msg.data).to be_empty
+  end
+  it 'should initialize with some values' do
+    msg = OFEchoReply.new(xid: 1)
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:echo_reply)
+    expect(msg.len).to eq(8)
+    expect(msg.xid).to eq(1)
+    expect(msg.data).to be_empty
+  end
+  it 'should initialize with data' do
+    msg = OFEchoReply.new(data: [10, 20].pack('C*'))
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:echo_reply)
+    expect(msg.len).to eq(10)
+    expect(msg.xid).to eq(0)
+    expect(msg.data.length).to eq(2)
+  end
+end

data/spec/messages/echo_request_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe OFEchoRequest do
+  it 'should read binary' do
+    msg = OFEchoRequest.read [1, 2, 0, 8, 0, 0, 0, 1].pack('C*')
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:echo_request)
+    expect(msg.len).to eq(8)
+    expect(msg.xid).to eq(1)
+    expect(msg.data).to be_empty
+  end
+  it 'should read binary with data' do
+    msg = OFEchoRequest.read [1, 2, 0, 10, 0, 0, 0, 1, 10, 20].pack('C*')
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:echo_request)
+    expect(msg.len).to eq(10)
+    expect(msg.xid).to eq(1)
+    expect(msg.data.length).to eq(2)
+  end
+  it 'should initialize with default values' do
+    msg = OFEchoRequest.new
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:echo_request)
+    expect(msg.len).to eq(8)
+    expect(msg.xid).to eq(0)
+    expect(msg.data).to be_empty
+  end
+  it 'should initialize with some values' do
+    msg = OFEchoRequest.new(xid: 1)
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:echo_request)
+    expect(msg.len).to eq(8)
+    expect(msg.xid).to eq(1)
+    expect(msg.data).to be_empty
+  end
+  it 'should initialize with data' do
+    msg = OFEchoRequest.new(data: [10, 20].pack('C*'))
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:echo_request)
+    expect(msg.len).to eq(10)
+    expect(msg.xid).to eq(0)
+    expect(msg.data.length).to eq(2)
+  end
+  it 'should convert to OFEchoReply' do
+    msg = OFEchoRequest.new(xid: 1, data: [10, 20].pack('C*'))
+    msg_reply = msg.to_reply
+    expect(msg_reply.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg_reply.type).to eq(:echo_reply)
+    expect(msg.len).to eq(msg_reply.len)
+    expect(msg.xid).to eq(msg_reply.xid)
+    expect(msg.data).to eq(msg_reply.data)
+  end
+end

data/spec/messages/error_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe OFError do
+  it 'should read binary' do
+    msg = OFError.read [
+      1, 1, 0, 16, 0, 0, 0, 1, # header
+      0, 0,                    # type
+      0, 0,                    # code
+      1, 2, 3, 4               # data
+    ].pack('C*')
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:error)
+    expect(msg.len).to eq(16)
+    expect(msg.xid).to eq(1)
+    expect(msg.error_type).to eq(:hello_failed)
+    expect(msg.error_code).to eq(:incompatible)
+    expect(msg.data).to eq([1, 2, 3, 4].pack('C*'))
+  end
+  it 'should read binary' do
+    msg = OFError.read [
+      1, 1, 0, 12, 0, 0, 0, 1, # header
+      0, 2,                    # type
+      0, 4                     # code
+    ].pack('C*')
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:error)
+    expect(msg.len).to eq(12)
+    expect(msg.xid).to eq(1)
+    expect(msg.error_type).to eq(:bad_action)
+    expect(msg.error_code).to eq(:bad_out_port)
+    expect(msg.data).to be_empty
+  end
+  it 'should initialize with default values' do
+    msg = OFError.new
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:error)
+    expect(msg.len).to eq(12)
+    expect(msg.xid).to eq(0)
+    expect(msg.error_type).to eq(:hello_failed)
+    expect(msg.error_code).to eq(:incompatible)
+    expect(msg.data).to be_empty
+  end
+  it 'should initialize with some values' do
+    msg = OFError.new(
+      xid: 1,
+      error_type: :port_mod_failed,
+      error_code: :bad_port
+    )
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:error)
+    expect(msg.len).to eq(12)
+    expect(msg.xid).to eq(1)
+    expect(msg.error_type).to eq(:port_mod_failed)
+    expect(msg.error_code).to eq(:bad_port)
+  end
+end

data/spec/messages/features_reply_spec.rb

@@ -0,0 +1,204 @@
+require 'spec_helper'
+
+describe OFFeaturesReply do
+  it 'should read binary' do
+    msg = OFFeaturesReply.read [
+      1, 6, 0, 128, 0, 0, 0, 1, # header
+      0, 0, 0, 0, 0, 0, 0, 42,  # datapath_id
+      0, 0, 0, 10,              # n_buffers
+      5,                        # n_tables
+      0, 0, 0,                  # padding
+      0, 0, 0, 0xff,            # capabilities
+      0, 0, 0x0f, 0xff,         # actions
+      # port 1
+      0, 1,               # port_number
+      0, 0, 0, 0, 0, 1,   # hardware_address
+      112, 111, 114, 116, # name
+      45, 49, 0, 0,
+      0, 0, 0, 0,
+      0, 0, 0, 0,
+      0, 0, 0, 1,         # config
+      0, 0, 0, 1,         # state
+      0, 0, 0x0f, 0xff,   # current_features
+      0, 0, 0x0f, 0xff,   # advertised_features
+      0, 0, 0x0f, 0xff,   # supported_features
+      0, 0, 0x0f, 0xff,   # peer_features
+      # port 2
+      0, 2,               # port_number
+      0, 0, 0, 0, 0, 2,   # hardware_address
+      112, 111, 114, 116, # name
+      45, 50, 0, 0,
+      0, 0, 0, 0,
+      0, 0, 0, 0,
+      0, 0, 0, 1,         # config
+      0, 0, 0, 1,         # state
+      0, 0, 0x0f, 0xff,   # current_features
+      0, 0, 0x0f, 0xff,   # advertised_features
+      0, 0, 0x0f, 0xff,   # supported_features
+      0, 0, 0x0f, 0xff    # peer_features
+    ].pack('C*')
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:features_reply)
+    expect(msg.len).to eq(128)
+    expect(msg.xid).to eq(1)
+    expect(msg.datapath_id).to eq(42)
+    expect(msg.n_buffers).to eq(10)
+    expect(msg.n_tables).to eq(5)
+    expect(msg.capabilities).to eq([
+      :flow_stats,
+      :table_stats,
+      :port_stats,
+      :stp,
+      :reserved,
+      :ip_reasm,
+      :queue_stats,
+      :arp_match_ip
+    ])
+    expect(msg.actions).to eq([
+      :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
+    ])
+    expect(msg.ports.length).to eq(2)
+    expect(msg.ports[0].port_number).to eq(1)
+    expect(msg.ports[1].port_number).to eq(2)
+  end
+  it 'should read a real binary message' do
+    msg = OFFeaturesReply.read [
+      1, 6, 0, 176, 0, 0, 0, 0,
+      0, 0, 0, 0, 0, 0, 0, 1,
+      0, 0, 1, 0,
+      255,
+      0, 0, 0,
+      0, 0, 0, 199,
+      0, 0, 15, 255,
+      # port-2
+      0, 2,
+      90, 50, 48, 40, 143, 254,
+      115, 49, 45, 101,
+      116, 104, 50, 0,
+      0, 0, 0, 0,
+      0, 0, 0, 0,
+      0, 0, 0, 0,
+      0, 0, 0, 0,
+      0, 0, 0, 192,
+      0, 0, 0, 0,
+      0, 0, 0, 0,
+      0, 0, 0, 0,
+      # port-local
+      255, 254,
+      226, 183, 195, 44, 245, 74,
+      115, 49, 0, 0,
+      0, 0, 0, 0,
+      0, 0, 0, 0,
+      0, 0, 0, 0,
+      0, 0, 0, 1,
+      0, 0, 0, 1,
+      0, 0, 0, 0,
+      0, 0, 0, 0,
+      0, 0, 0, 0,
+      0, 0, 0, 0,
+      # port-1
+      0, 1,
+      42, 94, 179, 106, 57, 71,
+      115, 49, 45, 101,
+      116, 104, 49, 0,
+      0, 0, 0, 0,
+      0, 0, 0, 0,
+      0, 0, 0, 0,
+      0, 0, 0, 1,
+      0, 0, 0, 192,
+      0, 0, 0, 0,
+      0, 0, 0, 0,
+      0, 0, 0, 0
+    ].pack('C*')
+    expect(msg.ports.length).to eq(3)
+  end
+  it 'should initialize with default values' do
+    msg = OFFeaturesReply.new
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:features_reply)
+    expect(msg.len).to eq(32)
+    expect(msg.xid).to eq(0)
+    expect(msg.datapath_id).to eq(0)
+    expect(msg.n_buffers).to eq(0)
+    expect(msg.n_tables).to eq(0)
+    expect(msg.capabilities).to eq([])
+    expect(msg.actions).to eq([])
+    expect(msg.ports).to be_empty
+  end
+  it 'should initialize with some values' do
+    msg = OFFeaturesReply.new(
+      xid: 1,
+      datapath_id: 42,
+      n_buffers: 10,
+      n_tables: 5,
+      capabilities: [
+        :flow_stats,
+        :table_stats,
+        :port_stats,
+        :stp,
+        :reserved,
+        :ip_reasm,
+        :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: [OFPhysicalPort.new]
+    )
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:features_reply)
+    expect(msg.len).to eq(80)
+    expect(msg.xid).to eq(1)
+    expect(msg.datapath_id).to eq(42)
+    expect(msg.n_buffers).to eq(10)
+    expect(msg.n_tables).to eq(5)
+    expect(msg.capabilities).to eq([
+      :flow_stats,
+      :table_stats,
+      :port_stats,
+      :stp,
+      :reserved,
+      :ip_reasm,
+      :queue_stats,
+      :arp_match_ip
+    ])
+    expect(msg.actions).to eq([
+      :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
+    ])
+    expect(msg.ports.length).to eq(1)
+  end
+end

data/spec/messages/features_request_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe OFFeaturesRequest do
+  it 'should read binary' do
+    msg = OFFeaturesRequest.read [1, 5, 0, 8, 0, 0, 0, 1].pack('C*')
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:features_request)
+    expect(msg.len).to eq(8)
+    expect(msg.xid).to eq(1)
+  end
+  it 'should initialize with default values' do
+    msg = OFFeaturesRequest.new
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:features_request)
+    expect(msg.len).to eq(8)
+    expect(msg.xid).to eq(0)
+  end
+  it 'should initialize with some values' do
+    msg = OFFeaturesRequest.new(xid: 1)
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:features_request)
+    expect(msg.len).to eq(8)
+    expect(msg.xid).to eq(1)
+  end
+end

data/spec/messages/flow_mod_spec.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+
+describe OFFlowMod do
+  it 'should read binary' do
+    msg = OFFlowMod.read [
+      1, 14, 0, 80, 0, 0, 0, 1, # header
+
+      # match
+      0, 0x30, 0x20, 0x4f, # wildcards
+      0, 0,                # in_port
+      0, 0, 0, 0, 0, 0,    # mac_source
+      0, 0, 0, 0, 0, 0,    # mac_destination
+      0xff, 0xff,          # vlan_id
+      0,                   # vlan_pcp
+      0,                   # padding
+      8, 0,                # mac_protocol
+      0,                   # ip_tos
+      6,                   # ip_protocol
+      0, 0,                # padding
+      0, 0, 0, 0,          # ip_source
+      192, 168, 0, 2,      # ip_destination
+      0, 0,                # source_port
+      0x0b, 0xb8,          # destination_port
+
+      0, 0, 0, 0, 0, 0, 0, 1, # cookie
+      0, 0,                   # command
+      0, 100,                 # idle_timeout
+      1, 0x2c,                # hard_timeout
+      0x0b, 0xb8,             # priority
+      0, 0, 0, 1,             # buffer_id
+      0, 0,                   # out_port
+      0, 1,                   # flags
+
+      # actions
+      #   output
+      0, 0, 0, 8, # header
+      0, 1,       # port
+      0xff, 0xff, # max_length
+    ].pack('C*')
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:flow_mod)
+    expect(msg.len).to eq(80)
+    expect(msg.xid).to eq(1)
+    expect(msg.match.ip_destination).to eq('192.168.0.2')
+    expect(msg.cookie).to eq(1)
+    expect(msg.command).to eq(:add)
+    expect(msg.idle_timeout).to eq(100)
+    expect(msg.hard_timeout).to eq(300)
+    expect(msg.priority).to eq(3000)
+    expect(msg.buffer_id).to eq(1)
+    expect(msg.out_port).to eq(0)
+    expect(msg.flags).to eq([:send_flow_removed])
+    expect(msg.actions.length).to eq(1)
+    expect(msg.actions.first.type).to eq(:output)
+  end
+  it 'should initialize with default values' do
+    msg = OFFlowMod.new
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:flow_mod)
+    expect(msg.len).to eq(72)
+    expect(msg.xid).to eq(0)
+    expect(msg.match.ip_destination).to eq('0.0.0.0')
+    expect(msg.cookie).to eq(0)
+    expect(msg.command).to eq(:add)
+    expect(msg.idle_timeout).to eq(0)
+    expect(msg.hard_timeout).to eq(0)
+    expect(msg.priority).to eq(0)
+    expect(msg.buffer_id).to eq(:none)
+    expect(msg.out_port).to eq(0)
+    expect(msg.flags).to be_empty
+    expect(msg.actions).to be_empty
+  end
+  it 'should initialize with some values' do
+    msg = OFFlowMod.new(
+      xid: 1,
+      match: {
+        wildcards: {
+          in_port: true,
+          mac_source: true,
+          mac_destination: true,
+          vlan_id: true,
+          vlan_pcp: true,
+          ip_tos: true,
+          ip_source_all: true,
+          ip_destination: 16,
+          source_port: true
+        },
+        mac_protocol: :ipv4,
+        ip_protocol: :tcp,
+        ip_destination: '192.168.0.2',
+        destination_port: 3000
+      },
+      cookie: 1,
+      command: :add,
+      idle_timeout: 100,
+      hard_timeout: 300,
+      priority: 3000,
+      buffer_id: 1,
+      flags: [:send_flow_removed],
+      actions: [OFActionOutput.new(port: 1)]
+    )
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:flow_mod)
+    expect(msg.len).to eq(80)
+    expect(msg.xid).to eq(1)
+    expect(msg.match.ip_destination).to eq('192.168.0.2')
+    expect(msg.cookie).to eq(1)
+    expect(msg.command).to eq(:add)
+    expect(msg.idle_timeout).to eq(100)
+    expect(msg.hard_timeout).to eq(300)
+    expect(msg.priority).to eq(3000)
+    expect(msg.buffer_id).to eq(1)
+    expect(msg.out_port).to eq(0)
+    expect(msg.flags).to eq([:send_flow_removed])
+    expect(msg.actions.length).to eq(1)
+    expect(msg.actions.first.type).to eq(:output)
+  end
+  it 'should initialize with some other values' do
+    msg = OFFlowMod.new(
+      xid: 1,
+      cookie: 2,
+      command: :delete
+    )
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:flow_mod)
+    expect(msg.len).to eq(72)
+    expect(msg.xid).to eq(1)
+    expect(msg.match.ip_destination).to eq('0.0.0.0')
+    expect(msg.cookie).to eq(2)
+    expect(msg.command).to eq(:delete)
+    expect(msg.idle_timeout).to eq(0)
+    expect(msg.hard_timeout).to eq(0)
+    expect(msg.priority).to eq(0)
+    expect(msg.buffer_id).to eq(:none)
+    expect(msg.out_port).to eq(:none)
+    expect(msg.flags).to be_empty
+    expect(msg.actions).to be_empty
+  end
+end