openflow-protocol 0.1.4 → 0.1.6

data/spec/messages/flow_removed_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe OFFlowRemoved do
+  it 'should read binary' do
+    msg = OFFlowRemoved.read [
+      1, 11, 0, 88, 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
+      0x0b, 0xb8,              # priority
+      0,                       # reason
+      0,                       # padding
+      0, 0, 0, 50,             # duration_seconds
+      0, 0, 0, 10,             # duration_nanoseconds
+      0, 100,                  # idle_timeout
+      0, 0,                    # padding
+      0, 0, 0, 0, 0, 0, 0, 10, # packet_count
+      0, 0, 0, 0, 0, 0, 0, 80  # byte_count
+    ].pack('C*')
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:flow_removed)
+    expect(msg.len).to eq(88)
+    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.priority).to eq(3000)
+    expect(msg.reason).to eq(:idle_timeout)
+    expect(msg.duration_seconds).to eq(50)
+    expect(msg.duration_nanoseconds).to eq(10)
+    expect(msg.idle_timeout).to eq(100)
+    expect(msg.packet_count).to eq(10)
+    expect(msg.byte_count).to eq(80)
+  end
+  it 'should initialize with default values' do
+    msg = OFFlowRemoved.new
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:flow_removed)
+    expect(msg.len).to eq(88)
+    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.priority).to eq(0)
+    expect(msg.reason).to eq(:idle_timeout)
+    expect(msg.duration_seconds).to eq(0)
+    expect(msg.duration_nanoseconds).to eq(0)
+    expect(msg.idle_timeout).to eq(0)
+    expect(msg.packet_count).to eq(0)
+    expect(msg.byte_count).to eq(0)
+  end
+  it 'should initialize with some values' do
+    msg = OFFlowRemoved.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,
+          destination_port: true
+        },
+        mac_protocol: :ipv4,
+        ip_protocol: :tcp,
+        ip_destination: '192.168.0.2',
+        destination_port: 3000
+      },
+      cookie: 1,
+      priority: 3000,
+      reason: :idle_timeout,
+      duration_seconds: 50,
+      duration_nanoseconds: 10,
+      idle_timeout: 100,
+      packet_count: 10,
+      byte_count: 80
+    )
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:flow_removed)
+    expect(msg.len).to eq(88)
+    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.priority).to eq(3000)
+    expect(msg.reason).to eq(:idle_timeout)
+    expect(msg.duration_seconds).to eq(50)
+    expect(msg.duration_nanoseconds).to eq(10)
+    expect(msg.idle_timeout).to eq(100)
+    expect(msg.packet_count).to eq(10)
+    expect(msg.byte_count).to eq(80)
+  end
+end

data/spec/messages/get_config_reply_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe OFGetConfigReply do
+  it 'should read binary' do
+    msg = OFGetConfigReply.read [
+      1, 8, 0, 12, 0, 0, 0, 1, # header
+      0, 0,                    # flags
+      0, 0xff                  # miss_send_length
+    ].pack('C*')
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:get_config_reply)
+    expect(msg.len).to eq(12)
+    expect(msg.xid).to eq(1)
+    expect(msg.flags).to eq(:fragments_normal)
+    expect(msg.miss_send_length).to eq(0xff)
+  end
+  it 'should initialize with default values' do
+    msg = OFGetConfigReply.new
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:get_config_reply)
+    expect(msg.len).to eq(12)
+    expect(msg.xid).to eq(0)
+    expect(msg.flags).to eq(:fragments_normal)
+    expect(msg.miss_send_length).to eq(0)
+  end
+  it 'should initialize with some values' do
+    msg = OFGetConfigReply.new(
+      xid: 1,
+      flags: :fragments_normal,
+      miss_send_length: 0xff
+    )
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:get_config_reply)
+    expect(msg.len).to eq(12)
+    expect(msg.xid).to eq(1)
+    expect(msg.flags).to eq(:fragments_normal)
+    expect(msg.miss_send_length).to eq(0xff)
+  end
+end

data/spec/messages/get_config_request_spec.rb

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

data/spec/messages/hello_spec.rb

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

data/spec/messages/packet_in_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe OFPacketIn do
+  it 'should read binary' do
+    msg = OFPacketIn.read [
+      1, 10, 0, 64, 0, 0, 0, 1, # header
+      0, 0, 0, 1,               # buffer_id
+      0, 46,                    # total_length
+      0, 1,                     # in_port
+      0,                        # reason
+      0,                        # padding
+      # 1, 2                      # data
+
+      # ethernet
+      0, 0, 0, 0, 0, 2, # mac_destination
+      0, 0, 0, 0, 0, 1, # mac_source
+      0x81, 0,          # protocol
+
+      # vlan
+      0x20, 1, # pcp & cfi & vlan_id
+      8, 6,    # protocol
+
+      # arp
+      0, 1,             # hardware
+      8, 0,             # protocol
+      6,                # hardware_length
+      4,                # protocol_length
+      0, 2,             # operation
+      0, 0, 0, 0, 0, 1, # mac_source
+      192, 168, 0, 1,   # ip_source
+      0, 0, 0, 0, 0, 2, # mac_destination
+      192, 168, 0, 2    # ip_destination
+    ].pack('C*')
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:packet_in)
+    expect(msg.len).to eq(64)
+    expect(msg.xid).to eq(1)
+    expect(msg.buffer_id).to eq(1)
+    expect(msg.total_length).to eq(46)
+    expect(msg.in_port).to eq(1)
+    expect(msg.reason).to eq(:no_match)
+    expect(msg.data.length).to eq(46)
+    expect(msg.parsed_data.length).to eq(46)
+    expect(msg.parsed_data.mac_destination).to eq('00:00:00:00:00:02')
+  end
+  it 'should initialize with default values' do
+    msg = OFPacketIn.new
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:packet_in)
+    expect(msg.len).to eq(18)
+    expect(msg.xid).to eq(0)
+    expect(msg.buffer_id).to eq(:none)
+    expect(msg.total_length).to eq(0)
+    expect(msg.in_port).to eq(:none)
+    expect(msg.reason).to eq(:no_match)
+    expect(msg.data).to be_empty
+  end
+  it 'should initialize with some values' do
+    msg = OFPacketIn.new(
+      xid: 1,
+      buffer_id: 1,
+      in_port: 1,
+      reason: :no_match,
+      data: [1, 2].pack('C*')
+    )
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:packet_in)
+    expect(msg.len).to eq(20)
+    expect(msg.xid).to eq(1)
+    expect(msg.buffer_id).to eq(1)
+    expect(msg.total_length).to eq(2)
+    expect(msg.in_port).to eq(1)
+    expect(msg.reason).to eq(:no_match)
+    expect(msg.data.length).to eq(2)
+  end
+end

data/spec/messages/packet_out_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe OFPacketOut do
+  it 'should read binary' do
+    msg = OFPacketOut.read [
+      1, 13, 0, 26, 0, 0, 0, 1, # header
+      0xff, 0xff, 0xff, 0xff,   # buffer_id
+      0, 1,                     # in_port
+      0, 8,                     # actions_length
+      # actions
+      #   output
+      0, 0, 0, 8, # header
+      0, 1,       # port
+      0xff, 0xff, # max_length
+      # data
+      1, 2
+    ].pack('C*')
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:packet_out)
+    expect(msg.len).to eq(26)
+    expect(msg.xid).to eq(1)
+    expect(msg.buffer_id).to eq(:none)
+    expect(msg.in_port).to eq(1)
+    expect(msg.actions.length).to eq(1)
+    expect(msg.actions.first.type).to eq(:output)
+    expect(msg.data.length).to eq(2)
+  end
+  it 'should initialize with default values' do
+    msg = OFPacketOut.new
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:packet_out)
+    expect(msg.len).to eq(16)
+    expect(msg.xid).to eq(0)
+    expect(msg.buffer_id).to eq(:none)
+    expect(msg.in_port).to eq(:none)
+    expect(msg.actions).to be_empty
+    expect(msg.data).to be_empty
+  end
+  it 'should initialize with some values' do
+    msg = OFPacketOut.new(
+      xid: 1,
+      in_port: 1,
+      actions: [OFActionOutput.new(port: 1)],
+      data: [1, 2].pack('C*')
+    )
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:packet_out)
+    expect(msg.len).to eq(26)
+    expect(msg.xid).to eq(1)
+    expect(msg.buffer_id).to eq(:none)
+    expect(msg.in_port).to eq(1)
+    expect(msg.actions.length).to eq(1)
+    expect(msg.actions.first.type).to eq(:output)
+    expect(msg.data.length).to eq(2)
+  end
+end

data/spec/messages/parser_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe OFParser do
+  let(:hello_msg) { [1, 0, 0, 8, 0, 0, 0, 1].pack('C*') }
+  let(:packet_out_msg) {
+    [
+      1, 13, 0, 26, 0, 0, 0, 1, # header
+      0xff, 0xff, 0xff, 0xff,   # buffer_id
+      0, 1,                     # in_port
+      0, 8,                     # actions_length
+      # actions
+      #   output
+      0, 0, 0, 8, # header
+      0, 1,       # port
+      0xff, 0xff, # max_length
+      # data
+      1, 2
+    ].pack('C*')
+  }
+
+  it 'should read binary Hello Message' do
+    msg = OFParser.read(hello_msg)
+    expect(msg.class).to be(OFHello)
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:hello)
+    expect(msg.len).to eq(8)
+    expect(msg.xid).to eq(1)
+  end
+
+  it 'should read binary PacketOut Message' do
+    msg = OFParser.read(packet_out_msg)
+    expect(msg.class).to be(OFPacketOut)
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:packet_out)
+    expect(msg.len).to eq(26)
+    expect(msg.xid).to eq(1)
+    expect(msg.buffer_id).to eq(:none)
+    expect(msg.in_port).to eq(1)
+    expect(msg.actions.length).to eq(1)
+    expect(msg.actions.first.type).to eq(:output)
+    expect(msg.data.length).to eq(2)
+  end
+end

data/spec/messages/port_mod_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe OFPortMod do
+  it 'should read binary' do
+    msg = OFPortMod.read [
+      1, 15, 0, 32, 0, 0, 0, 1, # header
+      0, 1,                     # port_number
+      0, 0, 0, 0, 0, 1,         # hardware_address
+      0, 0, 0, 3,               # config
+      0, 0, 0, 1,               # mask
+      0, 0, 0, 3,               # advertise
+      0, 0, 0, 0                # padding
+    ].pack('C*')
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:port_mod)
+    expect(msg.len).to eq(32)
+    expect(msg.xid).to eq(1)
+    expect(msg.port_number).to eq(1)
+    expect(msg.hardware_address).to eq('00:00:00:00:00:01')
+    expect(msg.config).to eq([:port_down, :no_spanning_tree])
+    expect(msg.mask).to eq([:port_down])
+    expect(msg.advertise).to eq([
+      :port_10mb_half_duplex,
+      :port_10mb_full_duplex
+    ])
+  end
+  it 'should initialize with default values' do
+    msg = OFPortMod.new
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:port_mod)
+    expect(msg.len).to eq(32)
+    expect(msg.xid).to eq(0)
+    expect(msg.port_number).to eq(:none)
+    expect(msg.hardware_address).to eq('00:00:00:00:00:00')
+    expect(msg.config).to be_empty
+    expect(msg.mask).to be_empty
+    expect(msg.advertise).to be_empty
+  end
+  it 'should initialize with some values' do
+    msg = OFPortMod.new(
+      xid: 1,
+      port_number: 1,
+      hardware_address: '00:00:00:00:00:01',
+      config: [:port_down, :no_spanning_tree],
+      mask: [:port_down],
+      advertise: [
+        :port_10mb_half_duplex,
+        :port_10mb_full_duplex
+      ]
+    )
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:port_mod)
+    expect(msg.len).to eq(32)
+    expect(msg.xid).to eq(1)
+    expect(msg.port_number).to eq(1)
+    expect(msg.hardware_address).to eq('00:00:00:00:00:01')
+    expect(msg.config).to eq([:port_down, :no_spanning_tree])
+    expect(msg.mask).to eq([:port_down])
+    expect(msg.advertise).to eq([
+      :port_10mb_half_duplex,
+      :port_10mb_full_duplex
+    ])
+  end
+end

data/spec/messages/port_status_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe OFPortStatus do
+  it 'should read binary' do
+    msg = OFPortStatus.read [
+      1, 12, 0, 64, 0, 0, 0, 1, # header
+      1,                        # reason
+      0, 0, 0, 0, 0, 0, 0,      # padding
+      # port
+      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
+    ].pack('C*')
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:port_status)
+    expect(msg.len).to eq(64)
+    expect(msg.xid).to eq(1)
+    expect(msg.reason).to eq(:delete)
+    expect(msg.desc.port_number).to eq(1)
+  end
+  it 'should initialize with default values' do
+    msg = OFPortStatus.new
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:port_status)
+    expect(msg.len).to eq(64)
+    expect(msg.xid).to eq(0)
+    expect(msg.reason).to eq(:add)
+    expect(msg.desc.port_number).to eq(0)
+  end
+  it 'should initialize with some values' do
+    msg = OFPortStatus.new(
+      xid: 1,
+      reason: :delete,
+      desc: OFPhysicalPort.new(port_number: 1)
+    )
+    expect(msg.version).to eq(OFMessage::OFP_VERSION)
+    expect(msg.type).to eq(:port_status)
+    expect(msg.len).to eq(64)
+    expect(msg.xid).to eq(1)
+    expect(msg.reason).to eq(:delete)
+    expect(msg.desc.port_number).to eq(1)
+  end
+end