trema 0.1.3

data/spec/trema/error_spec.rb

@@ -0,0 +1,142 @@
+#
+# Author: Nick Karanatsios <nickkaranatsios@gmail.com>
+#
+# Copyright (C) 2008-2012 NEC Corporation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 2, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+
+require File.join( File.dirname( __FILE__ ), "..", "spec_helper" )
+require "trema"
+
+
+describe Error, ".new( VALID OPTIONS )" do
+  context "when using Error constants" do
+    subject { Error.constants }
+    it { should include "OFPET_HELLO_FAILED" }
+    it { should include "OFPET_BAD_REQUEST" }
+    it { should include "OFPET_BAD_ACTION" }
+    it { should include "OFPET_FLOW_MOD_FAILED" }
+    it { should include "OFPET_PORT_MOD_FAILED" }
+    it { should include "OFPET_QUEUE_OP_FAILED" }
+
+    it { should include "OFPHFC_INCOMPATIBLE" }
+    it { should include "OFPHFC_EPERM" }
+
+    it { should include "OFPBRC_BAD_VERSION" }
+    it { should include "OFPBRC_BAD_TYPE" }
+    it { should include "OFPBRC_BAD_STAT" }
+    it { should include "OFPBRC_BAD_VENDOR" }
+    it { should include "OFPBRC_BAD_SUBTYPE" }
+    it { should include "OFPBRC_EPERM" }
+    it { should include "OFPBRC_BAD_LEN" }
+    it { should include "OFPBRC_BUFFER_EMPTY" }
+    it { should include "OFPBRC_BUFFER_UNKNOWN" }
+
+    it { should include "OFPBAC_BAD_TYPE" }
+    it { should include "OFPBAC_BAD_LEN" }
+    it { should include "OFPBAC_BAD_VENDOR" }
+    it { should include "OFPBAC_BAD_VENDOR_TYPE" }
+    it { should include "OFPBAC_BAD_OUT_PORT" }
+    it { should include "OFPBAC_BAD_ARGUMENT" }
+    it { should include "OFPBAC_EPERM" }
+    it { should include "OFPBAC_TOO_MANY" }
+    it { should include "OFPBAC_BAD_QUEUE" }
+
+    it { should include "OFPFMFC_ALL_TABLES_FULL" }
+    it { should include "OFPFMFC_OVERLAP" }
+    it { should include "OFPFMFC_OVERLAP" }
+    it { should include "OFPFMFC_BAD_EMERG_TIMEOUT" }
+    it { should include "OFPFMFC_BAD_COMMAND" }
+    it { should include "OFPFMFC_UNSUPPORTED" }
+
+    it { should include "OFPPMFC_BAD_PORT" }
+    it { should include "OFPPMFC_BAD_HW_ADDR" }
+
+    it { should include "OFPQOFC_BAD_PORT" }
+    it { should include "OFPQOFC_BAD_QUEUE" }
+    it { should include "OFPQOFC_EPERM" }
+  end
+end
+
+
+describe Error, ".new( MANDATORY OPTIONS MISSING ) - type, code" do
+  subject{ Error.new }
+  exception = "Type and code are mandatory options"
+  it "should raise '#{ exception }'" do
+    expect { subject }.to raise_error( exception )
+  end
+end
+
+
+describe Error, ".new( MANDATORY OPTION MISSING ) - code" do
+  subject { Error.new( :type => Error::OFPET_BAD_REQUEST ) }
+  exception = "Code is a mandatory option"
+  it "should raise '#{ exception }'" do
+    expect { subject }.to raise_error( exception )
+  end
+end
+
+
+  
+describe Error, ".new( MANDATORY OPTION MISSING ) - type" do
+  subject { Error.new( :code => Error::OFPBRC_BAD_TYPE ) }
+  exception = "Type is a mandatory option"
+  it "should raise '#{ exception }'" do
+    expect { subject }.to raise_error( exception )
+  end
+end
+
+
+describe Error, ".new( OPTIONAL OPTION MISSING ) - transaction_id" do
+  subject { Error.new( :type => Error::OFPET_BAD_REQUEST, :code => Error::OFPBRC_BAD_TYPE ) }
+  it_should_behave_like "any Openflow message with default transaction ID"
+end
+
+
+describe Error, ".new( OPTIONAL OPTION MISSING ) - user_data" do
+    subject do 
+      Error.new(
+        :type => Error::OFPET_BAD_REQUEST,
+        :code => Error::OFPBRC_BAD_TYPE,
+        :transaction_id => 123
+      )
+    end
+    its( :user_data ) { should be_nil }
+  end
+
+
+describe Error, ".new( VALID OPTIONS )" do
+  subject do 
+    Error.new(
+      :type => Error::OFPET_BAD_REQUEST,
+      :code => Error::OFPBRC_BAD_TYPE,
+      :transaction_id => transaction_id,
+      :user_data => "this is a test"
+    )
+  end
+  let( :transaction_id ) { 1234 }
+  its( :error_type ) { should == Error::OFPET_BAD_REQUEST }
+  its( :code ) { should == Error::OFPBRC_BAD_TYPE }
+  its( :user_data ) { should eq "this is a test" }
+  it_should_behave_like "any OpenFlow message with transaction_id option"
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/spec/trema/executables_spec.rb

@@ -0,0 +1,75 @@
+#
+# Author: Yasuhito Takamiya <yasuhito@gmail.com>
+#
+# Copyright (C) 2008-2012 NEC Corporation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 2, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+
+require File.join( File.dirname( __FILE__ ), "..", "spec_helper" )
+require "trema/executables"
+
+
+describe Trema::Executables do
+  it "should know the path of tremashark executable" do
+    Trema::Executables.should respond_to( :tremashark )
+  end
+
+
+  it "should know the path of switch_manager executable" do
+    Trema::Executables.should respond_to( :switch_manager )
+  end
+
+
+  it "should know the path of switch_manager executable" do
+    Trema::Executables.should respond_to( :switch_manager )
+  end
+
+
+  it "should know the path of packetin_filter executable" do
+    Trema::Executables.should respond_to( :packetin_filter )
+  end
+
+
+  it "should know the path of phost executable" do
+    Trema::Executables.should respond_to( :phost )
+  end
+
+
+  it "should know the path of phost's cli executable" do
+    Trema::Executables.should respond_to( :cli )
+  end
+
+
+  it "should know the path of ovs-openflowd executable" do
+    Trema::Executables.should respond_to( :ovs_openflowd )
+  end
+
+
+  it "should detect if all executables are compled or not" do
+    FileTest.stub!( :executable? ).and_return( true )
+    Trema::Executables.compiled?.should be_true
+
+    FileTest.stub!( :executable? ).and_return( false )
+    Trema::Executables.compiled?.should be_false
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/spec/trema/features-reply_spec.rb

@@ -0,0 +1,57 @@
+#
+# Author: Yasuhito Takamiya <yasuhito@gmail.com>
+#
+# Copyright (C) 2008-2012 NEC Corporation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 2, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+
+require File.join( File.dirname( __FILE__ ), "..", "spec_helper" )
+require "trema"
+
+
+describe FeaturesReply, ".new( VALID OPTIONS )" do
+  subject { FeaturesReply.new( :datapath_id => 123, 
+    :transaction_id => 1234,
+    :n_buffers => 256,
+    :n_tables => 2,
+    :capabilities => 135,
+    :actions => 2047,
+    :ports => ports 
+    )
+  }
+  its( :datapath_id ) { should == 123 }
+  its( :transaction_id ) { should == 1234 }
+  its( :n_buffers ) { should == 256 }
+  its( :n_tables ) { should == 2 }
+  its( :capabilities ) { should == 135 }
+  its( :actions ) { should == 2047 }
+  let( :ports ) { [ mock( "port #0" ), mock( "port #1" ), mock( "port #2" ) ] }
+  its( :ports ) { subject.size.should == 3 }
+end
+
+
+describe FeaturesReply, ".new( MANDATORY OPTIONS MISSING)" do
+  it "should raise ArgumentError" do
+    expect { subject }.to raise_error( ArgumentError ) 
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/spec/trema/features-request_spec.rb

@@ -0,0 +1,66 @@
+#
+# Author: Yasuhito Takamiya <yasuhito@gmail.com>
+#
+# Copyright (C) 2008-2012 NEC Corporation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 2, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+
+require File.join( File.dirname( __FILE__ ), "..", "spec_helper" )
+require "trema"
+
+
+describe FeaturesRequest, ".new( OPTIONAL OPTION MISSING )" do
+  it_should_behave_like "any Openflow message with default transaction ID"
+end
+
+
+describe FeaturesRequest, ".new( VALID OPTION )" do
+  subject { FeaturesRequest.new :transaction_id => transaction_id }
+  it_should_behave_like "any OpenFlow message with transaction_id option"
+
+
+  context "when #features_request is sent with transaction ID(1234)" do
+    it "should receive #features_reply with transaction ID(1234)" do
+      class FeaturesController < Controller; end
+      network {
+        vswitch { datapath_id 0xabc }
+      }.run( FeaturesController ) {
+        features_request = FeaturesRequest.new( :transaction_id => 1234 )
+        controller( "FeaturesController" ).send_message( 0xabc, features_request )
+        controller( "FeaturesController" ).should_receive( :features_reply ) do | arg |
+          arg.datapath_id.should == 0xabc
+          arg.transaction_id.should == 1234
+        end
+      }
+    end
+  end
+end
+
+
+describe FeaturesRequest, ".new( INVALID OPTION )" do
+  it "should raise TypeError" do
+    expect {
+      FeaturesRequest.new "INVALID_OPTION"
+    }.to raise_error( TypeError )
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/spec/trema/flow-removed_spec.rb

@@ -0,0 +1,146 @@
+#
+# Author: Nick Karanatsios <nickkaranatsios@gmail.com>
+#
+# Copyright (C) 2008-2012 NEC Corporation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 2, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+
+require File.join( File.dirname( __FILE__ ), "..", "spec_helper" )
+require "trema"
+
+
+describe Trema::FlowRemoved, ".new( VALID OPTIONS )" do
+  context "when an instance is created" do
+    subject do
+      match = Match.new(
+        :in_port => 1,
+        :dl_src => "00:00:00:00:00:01",
+        :dl_dst => "00:00:00:00:00:02",
+        :dl_vlan => 65535,
+        :dl_vlan_pcp => 0,
+        :dl_type => 0x800,
+        :nw_tos => 0,
+        :nw_proto => 17,
+        :nw_src => "192.168.0.1",
+        :nw_dst => "192.168.0.2",
+        :tp_src => 1,
+        :tp_dst => 1
+      )
+      
+      FlowRemoved.new(
+        :datapath_id=>2748,
+        :transaction_id=>0,
+        :match => match,
+        :cookie => 123456789,
+        :priority => 65535,
+        :reason => 0,
+        :duration_sec=>1, 
+        :duration_nsec=>779000000,
+        :idle_timeout=>1,  
+        :packet_count=> 6,
+        :byte_count => 256
+      )
+    end
+    its ( :datapath_id ) { should == 2748 }
+    its ( :transaction_id ) { should == 0 }
+    its ( :match ) { should be_instance_of( Match ) }
+    its ( :cookie ) { should == 123456789 }
+    its ( :priority ) { should == 65535 }
+    its ( :reason ) { should == 0 }
+    its ( :duration_sec ) { should == 1 }
+    its ( :duration_nsec ) { should == 779000000 }
+    its ( :idle_timeout ) { should == 1 }
+    its ( :packet_count ) { should == 6 }
+    its ( :byte_count ) { should == 256 }
+  end
+  
+  
+  context "when a flow expires" do
+    it "should #flow_removed" do
+      class FlowRemovedController < Controller; end
+      network {
+        vswitch { datapath_id 0xabc }
+      }.run( FlowRemovedController ) {
+        controller( "FlowRemovedController" ).should_receive( :flow_removed )
+        controller( "FlowRemovedController" ).send_flow_mod_add(
+          0xabc,
+          :idle_timeout => 1,
+          :send_flow_rem => true
+        )
+        sleep 2 # FIXME: wait to receive flow_removed
+      }
+    end
+    
+    
+    it "should #flow_removed with valid attributes as per flow mod add" do
+      class FlowRemovedController < Controller; end
+      match = Match.new( 
+        :in_port=> 1, 
+        :dl_src => "00:00:00:00:00:01",
+        :dl_dst => "00:00:00:00:00:02",
+        :dl_type => 0x800,
+        :dl_vlan => 65535,
+        :dl_vlan_pcp => 0,
+        :nw_tos => 0,
+        :nw_proto => 17,
+        :nw_src => "192.168.0.1",
+        :nw_dst => "192.168.0.2",
+        :tp_src => 1,
+        :tp_dst => 1
+      )
+      network {
+        vswitch { datapath_id 0xabc }
+      }.run( FlowRemovedController ) {
+        controller( "FlowRemovedController" ).should_receive( :flow_removed ) do | datapath_id, message |
+          datapath_id.should == 0xabc
+          message.match.in_port.should == 1
+          message.match.dl_src.to_s.should == "00:00:00:00:00:01"
+          message.match.dl_dst.to_s.should == "00:00:00:00:00:02"
+          message.match.dl_type.should == 0x800
+          message.match.dl_vlan.should == 65535
+          message.match.dl_vlan_pcp.should == 0
+          message.match.nw_tos.should == 0
+          message.match.nw_proto.should == 17
+          Trema::IP.new( message.match.nw_src ).to_s.should == "192.168.0.1"
+          Trema::IP.new( message.match.nw_dst ).to_s.should == "192.168.0.2"
+          message.match.tp_src.should == 1
+          message.match.tp_dst.should == 1
+          message.cookie.should == 123456789
+          message.idle_timeout.should == 1
+          message.reason.should == 0
+          message.duration_sec.should >= 1
+          message.packet_count.should == 0
+          message.byte_count.should == 0
+        end
+        controller( "FlowRemovedController" ).send_flow_mod_add(
+          0xabc,
+          :match => match,
+          :cookie => 123456789,
+          :idle_timeout => 1,
+          :send_flow_rem => true
+        )
+        sleep 2 # FIXME: wait to receive flow_removed
+      }
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End: