Sipper 1.1.3

data/sipper_test/test_session_recorder.rb

@@ -0,0 +1,145 @@
+require 'sip_test_case'
+require 'flexmock'
+require 'session_recorder'
+
+class TestSessionRecorder < SipTestCase
+  include FlexMock::TestCase
+  
+  def setup
+    SipperConfigurator[:SessionRecordPath] = File.join(SipperConfigurator[:SipperBasePath], "sipper", "logs")
+  end
+  
+  def test_create_and_record
+    m = FlexMock.new
+    m.should_receive(:call_id).and_return("my_call_id")
+    m.should_receive(:p_session_record).and_return("msg-info")
+    m.should_receive(:[]).with_any_args.and_return(true)
+    m.should_receive(:class).and_return(Request)
+    m.should_receive(:method).and_return("INVITE") 
+    sr = SessionRecorder.create_and_record(nil, m, nil, "in")
+    sr.save 
+    assert_equal("< INVITE", get_in_recording.get_recording[0])
+    teardown
+    sr = SessionRecorder.create_and_record(nil, m, nil, "out")
+    sr.record("in", m)
+    sr.save 
+    assert_equal("> INVITE", get_out_recording.get_recording[0])
+    assert_equal("< INVITE", get_out_recording.get_recording[1])
+  end
+  
+  def test_with_external_io
+    m = FlexMock.new
+    m.should_receive(:call_id).and_return("my_call_id")
+    m.should_receive(:p_session_record).and_return("msg-info")
+    m.should_receive(:[]).with_any_args.and_return(true)
+    m.should_receive(:class).and_return(Response)
+    m.should_receive(:code).and_return(200) 
+    @rio = StringIO.new
+    sr = SessionRecorder.create_and_record(@rio, m, nil, "out")
+    sr.record("in", m)
+    sr.save 
+    recording = get_out_recording
+    assert_equal("> 200", recording.get_recording[0])
+    assert_equal("< 200", recording.get_recording[1])
+  end
+    
+  def test_with_config_level
+    assert_nil(SipperConfigurator[:SessionRecord])
+    SipperConfigurator[:SessionRecord] = "msg-info"
+    assert_not_nil(SipperConfigurator[:SessionRecord])
+    m = FlexMock.new
+    m.should_receive(:call_id).and_return("my_call_id")
+    m.should_receive(:class).and_return(Request)
+    m.should_receive(:method).and_return("INVITE")
+    m.should_receive(:[]).with_any_args.and_return(false)
+    sr = SessionRecorder.create_and_record(nil, m, nil, "in")
+    sr.record("neutral", m)
+    sr.save 
+    assert_equal("< INVITE", get_in_recording.get_recording[0])
+    assert_equal("! INVITE", get_in_recording.get_recording[1])
+    SipperConfigurator[:SessionRecord] = nil
+  end
+  
+  def test_debug_level
+    m = FlexMock.new
+    m.should_receive(:call_id).and_return("my_call_id")
+    m.should_receive(:p_session_record).and_return("msg-debug")
+    m.should_receive(:[]).with_any_args.and_return(true)
+    m.should_receive(:class).and_return(Request)
+    m.should_receive(:method).and_return("INVITE") 
+    m.should_receive(:to_s).and_return("INVITE sip:nasir@agnity.com SIP/2.0
+Contact: <sip:127.0.0.1:5060;transport=UDP>
+P-Asserted-Identity: sip:nina@home.com
+Max-Forwards: 70
+Call-Id: 1-_PID_@127.0.0.1
+Via: SIP/2.0/UDP 127.0.0.1:5060;branch=z9hG4bK-1-0-1
+From: Sipper <sip:sipper@127.0.0.1:5060>;tag=1
+To: Sut <sip:sut@127.0.0.1:5061>
+Cseq: 1 INVITE
+Content-Length: 0")
+    sr = SessionRecorder.create_and_record(nil, m, nil, "in")
+    sr.save 
+    assert_equal("< INVITE sip:nasir@agnity.com SIP/2.0", get_in_recording.get_recording[0][0..36])
+    assert_equal("< INVITE", get_in_recording.get_info_only_recording[0])
+  end
+  
+  def test_debug_non_sip
+    m = FlexMock.new
+    m.should_receive(:call_id).and_return("my_call_id")
+    m.should_receive(:to_s).and_return("This is a non SIP message")
+    SipperConfigurator[:SessionRecord] = "msg-debug"
+    m.should_receive(:[]).with_any_args.and_return(false)
+    sr = SessionRecorder.create_and_record(nil, m, nil, "in")
+    sr.save 
+    assert_equal("< This is a non SIP message", get_in_recording.get_recording[0][0..26])
+    assert_equal("< This is a non SIP message", get_in_recording.get_info_only_recording[0])
+  end
+  
+  def test_unknown_record_level
+    m = FlexMock.new
+    m.should_receive(:call_id).and_return("my_call_id")
+    m.should_receive(:p_session_record).and_return("unknown")
+    m.should_receive(:[]).with_any_args.and_return(true)
+    m.should_receive(:class).and_return(Request)
+    m.should_receive(:method).and_return("INVITE") 
+    sr = SessionRecorder.create_and_record(nil, m, nil, "neutral")
+    sr.save 
+    str = "Unknown_record_level"
+    assert_equal("! Unknown_record_level", get_neutral_recording.get_recording[0][0...str.size+2])
+  end
+  
+  def test_unknown_direction
+    m = FlexMock.new
+    m.should_receive(:call_id).and_return("my_call_id")
+    m.should_receive(:p_session_record).and_return("unknown")
+    m.should_receive(:[]).with_any_args.and_return(true)
+    m.should_receive(:class).and_return(Request)
+    m.should_receive(:method).and_return("INVITE") 
+    sr = SessionRecorder.create_and_record(nil, m, nil, "neutral")
+    sr.record("unknown", m)
+    sr.save 
+    str = "UNKNOWN DIRECTION Unknown_record_level"
+    assert_equal(str, get_neutral_recording.get_recording[1][0...str.size])
+  end
+  
+  def test_recordable
+    m = FlexMock.new
+    m.should_receive(:call_id).and_return("my_call_id")
+    m.should_receive(:p_session_record).and_return("msg-info")
+    m.should_receive(:[]).with_any_args.and_return(true)
+    m.should_receive(:class).and_return(Request)
+    m.should_receive(:method).and_return("INVITE") 
+    sr = SessionRecorder.create_and_record(nil, m, nil, "in")
+    sr.save 
+    assert_raise(RuntimeError) { sr.io = StringIO.new }
+    assert_raise(RuntimeError) { sr.record("in", "Hello") }
+    assert_raise(RuntimeError) { sr.save }
+    assert_equal("< INVITE", get_in_recording.get_recording[0])
+  end
+  
+  def teardown
+    SipperConfigurator[:SessionRecord] = nil
+    super
+  end
+  
+end

data/sipper_test/test_session_state_user_defined.rb

@@ -0,0 +1,84 @@
+
+require 'driven_sip_test_case'
+
+# 
+# A very simple inlined smoke test.
+#
+class TestSessionStateUserDefined < DrivenSipTestCase
+
+  def setup
+    super
+    str = <<-EOF
+    
+    require 'sip_test_driver_controller'
+    
+    module SipInline
+      class UasSudController < SIP::SipTestDriverController
+      
+        transaction_usage :use_transactions=>true
+        
+        def on_invite(session)
+          session.respond_with(200)
+          session.do_record(session.last_state)
+          session.set_state("my_state")
+          session.do_record(session.last_state)
+          logd("Received INVITE sent a 200 from "+name)
+        end
+        
+        def on_ack(session)
+          session.do_record(session.get_state_array.length.to_s)
+          session.request_with("bye")
+        end
+        
+        def on_success_res(session)
+          session.do_record(session.last_state)
+          session.invalidate(true)
+          session.flow_completed_for("TestSessionStateUserDefined")
+        end
+        
+        def order
+          0
+        end
+        
+      end
+      
+      class UacSudController < SIP::SipTestDriverController
+      
+        transaction_usage :use_transactions=>true  
+        
+        def start
+          r = Request.create_initial("invite", "sip:nasir@sipper.com", :p_session_record=>"msg-info")
+          u = create_udp_session(SipperConfigurator[:LocalSipperIP], SipperConfigurator[:LocalTestPort])
+          u.send(r)
+          logd("Sent a new INVITE from "+name)
+        end
+     
+        
+        def on_success_res(session)
+          session.request_with('ACK')
+        end
+        
+        def on_bye(session)
+          session.respond_with(200)
+          session.invalidate(true)
+        end
+         
+      end
+    end
+    EOF
+    define_controller_from(str)
+    set_controller("SipInline::UacSudController")
+  end
+  
+  
+  def test_smoke_controllers
+    self.expected_flow = ["> INVITE", "< 100", "< 200", "> ACK", "< BYE", "> 200"]
+    start_controller
+    verify_call_flow(:out)
+    self.expected_flow = ["< INVITE", "> 100", "> 200", "! sent_200", "! my_state",  "< ACK", "! 1", "> BYE", "< 200", "! my_state"]
+    verify_call_flow(:in)
+  end
+
+  
+end
+

data/sipper_test/test_session_states.rb

@@ -0,0 +1,91 @@
+
+
+require 'driven_sip_test_case'
+
+
+class TestSessionStates < DrivenSipTestCase
+
+  def setup
+    super
+    str = <<-EOF
+    
+    require 'sip_test_driver_controller'
+    
+    module SipInline
+      class UasSsController < SIP::SipTestDriverController
+      
+        transaction_usage :use_transactions=>true
+        
+        def on_invite(session)
+          session.get_state_array.each do |s|
+            session.do_record(s)
+          end
+          session.respond_with(200)
+          session.do_record(session.last_state)
+          logd("Received INVITE sent a 200 from "+name)
+        end
+        
+        def on_ack(session)
+          session.request_with("bye")
+        end
+        
+        def on_success_res(session)
+          session.invalidate(true)
+          session.flow_completed_for("TestSessionStates")
+        end
+        
+        def order
+          0
+        end
+        
+      end
+      
+      class UacSsController < SIP::SipTestDriverController
+      
+        transaction_usage :use_transactions=>true  
+        
+        def start
+          r = Request.create_initial("invite", "sip:nasir@sipper.com", :p_session_record=>"msg-info")
+          u = create_udp_session(SipperConfigurator[:LocalSipperIP], SipperConfigurator[:LocalTestPort])
+          u.send(r)
+          u.do_record(u.last_state)
+          logd("Sent a new INVITE from "+name)
+        end
+     
+        
+        def on_success_res(session)
+          session.do_record(session.last_state)
+          session.request_with('ACK')
+        end
+        
+        def on_provisional_res(session)
+          session.do_record(session.last_state)
+        end
+        
+        def on_bye(session)
+          session.get_state_array.each do |s|
+            session.do_record(s)
+          end
+          session.respond_with(200)
+          session.invalidate(true)
+        end
+         
+      end
+    end
+    EOF
+    define_controller_from(str)
+    set_controller("SipInline::UacSsController")
+  end
+  
+  
+  def test_ss
+    self.expected_flow = ["> INVITE", "! sent_invite", "< 100", "< 200", "! received_200", "> ACK", "< BYE", "! initial", "! sent_invite","! received_100", "! received_200", "! sent_ack",  "! received_bye", "> 200"]
+    start_controller
+    verify_call_flow(:out)
+    self.expected_flow = ["< INVITE", "> 100", "! initial", "! received_invite", "! sent_100", "> 200", "! sent_200", "< ACK", "> BYE", "< 200"]
+    verify_call_flow(:in)
+  end
+  
+
+  
+end

data/sipper_test/test_simple_dialog_state.rb

@@ -0,0 +1,86 @@
+
+require 'driven_sip_test_case'
+
+
+class TestSimpleDialogState < DrivenSipTestCase
+
+  def setup
+    super
+    str = <<-EOF
+    
+    require 'sip_test_driver_controller'
+    
+    module SipInline
+      class UasDsController < SIP::SipTestDriverController
+      
+        transaction_usage :use_transactions=>true
+        
+        def on_invite(session)
+          session.do_record(session.last_state)
+          session.respond_with(200)
+          session.do_record(session.last_state)
+          logd("Received INVITE sent a 200 from "+name)
+        end
+        
+        def on_ack(session)
+          session.request_with("bye")
+        end
+        
+        def on_success_res(session)
+          session.invalidate(true)
+          session.flow_completed_for("TestSimpleDialogState")
+        end
+        
+        def order
+          0
+        end
+        
+      end
+      
+      class UacDsController < SIP::SipTestDriverController
+      
+        transaction_usage :use_transactions=>true  
+        
+        def start
+          r = Request.create_initial("invite", "sip:nasir@sipper.com", :p_session_record=>"msg-info")
+          u = create_udp_session(SipperConfigurator[:LocalSipperIP], SipperConfigurator[:LocalTestPort])
+          u.send(r)
+          u.do_record(u.last_state)
+          logd("Sent a new INVITE from "+name)
+        end
+     
+        
+        def on_success_res(session)
+          session.do_record(session.last_state)
+          session.request_with('ACK')
+        end
+        
+        def on_provisional_res(session)
+          session.do_record(session.last_state)
+        end
+        
+        def on_bye(session)
+          session.do_record(session.last_state)
+          session.respond_with(200)
+          session.invalidate(true)
+        end
+         
+      end
+    end
+    EOF
+    define_controller_from(str)
+    set_controller("SipInline::UacDsController")
+  end
+  
+  
+  def test_ds
+    self.expected_flow = ["> INVITE", "! sent_invite", "< 100", "< 200", "! received_200", "> ACK", "< BYE", "! received_bye", "> 200"]
+    start_controller
+    verify_call_flow(:out)
+    self.expected_flow = ["< INVITE", "> 100", "! sent_100", "> 200", "! sent_200", "< ACK", "> BYE", "< 200"]
+    verify_call_flow(:in)
+  end
+  
+
+  
+end

data/sipper_test/test_simple_re_invite.rb

@@ -0,0 +1,86 @@
+require 'driven_sip_test_case'
+
+# After an INVITE dialog is established, the original UAS sends a re-invite that updates
+# the target. Also the peer sends a new target with the 2xx response to the re-invite.
+#  
+class TestSimpleReInvite < DrivenSipTestCase
+
+  def setup
+    super
+    str = <<-EOF
+    
+    require 'sip_test_driver_controller'
+    
+    module SipInline
+      class UasReInviteController < SIP::SipTestDriverController
+      
+        transaction_usage :use_transactions=>true
+     
+        def on_invite(session)
+          r = session.create_response(200)
+          r.contact = '<sip:nk@sipper.com>'
+          session.send(r)
+        end
+        
+        def on_ack(session)
+          r = session.create_subsequent_request("invite")
+          r.contact = '<sip:nk@goblet.com>'
+          session.send(r)
+        end
+        
+        def on_success_res(session)
+          session.do_record(session.remote_target)
+          session.request_with('ack')
+          session.invalidate(true)
+        end
+        
+        def order
+          0
+        end
+      end
+      
+      class UacReInviteController < SIP::SipTestDriverController
+
+        transaction_usage :use_transactions=>true
+
+        def start
+          u = create_udp_session(SipperConfigurator[:LocalSipperIP], SipperConfigurator[:LocalTestPort])
+          u.request_with("invite", "sip:nasir@sipper.com", :p_session_record=>"msg-info")
+          logd("Sent a new INVITE from "+name)
+        end
+     
+        def on_success_res(session)
+          session.do_record(session.remote_target)
+          session.request_with('ack')   
+        end
+        
+        def on_invite(session)
+          r = session.create_response(200)
+          r.contact = '<sip:alice@sipper.com>'
+          session.send(r)
+        end 
+        
+        def on_ack(session)
+          session.do_record(session.remote_target)
+          session.invalidate(true)
+          session.flow_completed_for("TestSimpleReInvite")  
+        end
+        
+      end
+    end
+    EOF
+    define_controller_from(str)
+    set_controller("SipInline::UacReInviteController")
+  end
+  
+  
+  def test_reinvite
+    self.expected_flow = ["> INVITE", "< 100", "< 200", "! sip:nk@sipper.com","> ACK", "< INVITE", "> 100", "> 200", "< ACK", "! sip:nk@goblet.com"]
+    start_controller
+    verify_call_flow(:out)
+    self.expected_flow = ["< INVITE", "> 100", "> 200", "< ACK", "> INVITE", "< 100", "< 200", "! sip:alice@sipper.com", "> ACK"]
+    verify_call_flow(:in)
+  end
+  
+end
+