sippy_cup 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec38982988f13808a01d0edb5d995d05235d5000
-  data.tar.gz: 18b80cca252826d0790c2152b0e72b507610a804
+  metadata.gz: cec1cec887891ded08da44c8bf7e35d533923924
+  data.tar.gz: 3f79938ed6a455dd62b883f4db39ddd6273876a2
 SHA512:
-  metadata.gz: ed52b5856e8df516dbeaf1da79ca86ece5f83f76b8e414cce292bc09b3c77fca976150b1980486460562f3166125f38f0bee8a23eaf694cde97a0959dd48c702
-  data.tar.gz: be9366e3fe1c86649c361c79bd265a0608ad8195843bce5d9dbc1797fff60f69419b3dfcea2aaab02cdfcdf52f1124ddab63cf5584925cb3a0c1484c5531e1ac
+  metadata.gz: 63276337ff8887505d17e00dc3e26ff1ae4670b6f905d432bc911c082f7dc740c23acdcd8e7f17466fdf0746d2756e67fad1f4ebeae3cd37acf43e9884c92852
+  data.tar.gz: 3bce73eada59e55f0610a8667441712c3b3b3f93d36ec7311f38b4f63569440998972c94a21eafd5064c703a7dbf0b60413aef2a132dbdfde77d72d8c57b252b

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # develop
 
+# [0.7.0](https://github.com/mojolingo/sippy_cup/compare/v0.6.0...v0.7.0)
+  * Feature: Permit `To` domain to be different from the destination. This permits testing multi-tenant systems more easily.
+
 # [0.6.0](https://github.com/mojolingo/sippy_cup/compare/v0.5.0...v0.6.0)
   * Change: Call limits (`number_of_calls`, `concurrent_max` and `calls_per_second`) no longer have default values for simplicity of UAS scenarios. The value of `to_user` now defaults to the SIPp default of `s`.
   * Feature: Support for setting rate scaling independently of reporting frequency via the new `calls_per_second_interval` option. See also https://github.com/SIPp/sipp/pull/107 and https://github.com/SIPp/sipp/pull/126.

data/README.markdown

@@ -201,8 +201,8 @@ Each parameter has an impact on the test, and may either be changed once the XML
   <dt>from_user</dt>
   <dd>SIP user from which traffic should appear. Default: sipp</dd>
 
-  <dt>to_user</dt>
-  <dd>SIP user to send requests to. Defaults to SIPp's default: `s` (as in `s@127.0.0.1`)</dd>
+  <dt>to</dt>
+  <dd>SIP user / address to send requests to. Defaults to SIPp's default: `s@[destination]` (as in `s@127.0.0.1`). Can specify either a user (`foouser`) or a full address (`foouser@there.com`), the latter being useful for testing multi-tenant systems where the `To` domain is not the same as the hostname of the system.</dd>
 
   <dt>transport</dt>
   <dd>Specify the SIP transport. Valid options are `udp` (default) or `tcp`. Default: `udp`</dd>

data/lib/sippy_cup/runner.rb

@@ -105,7 +105,7 @@ module SippyCup
       options[:l] = max_concurrent if max_concurrent
       options[:m] = @scenario_options[:number_of_calls] if @scenario_options[:number_of_calls]
       options[:r] = @scenario_options[:calls_per_second] if @scenario_options[:calls_per_second]
-      options[:s] = @scenario_options[:to_user] if @scenario_options[:to_user]
+      options[:s] = @scenario_options[:to] if @scenario_options[:to]
 
       options[:i] = @scenario_options[:source] if @scenario_options[:source]
       options[:mp] = @scenario_options[:media_port] if @scenario_options[:media_port]

data/lib/sippy_cup/scenario.rb

@@ -83,7 +83,8 @@ module SippyCup
     # @option options [String] :destination The target system at which to direct traffic.
     # @option options [String] :advertise_address The IP address to advertise in SIP and SDP if different from the bind IP (defaults to the bind IP).
     # @option options [String] :from_user The SIP user from which traffic should appear.
-    # @option options [String] :to_user The SIP user to send requests to.
+    # @option options [String] :to_user The SIP user to send requests to. Alias for `:to` and deprecated in favour of the same.
+    # @option options [String] :to The SIP user / address to send requests to.
     # @option options [Integer] :media_port The RTCP (media) port to bind to locally.
     # @option options [String, Numeric] :max_concurrent The maximum number of concurrent calls to execute.
     # @option options [String, Numeric] :number_of_calls The maximum number of calls to execute in the test run.
@@ -155,10 +156,9 @@ module SippyCup
       # FIXME: The DTMF mapping (101) is hard-coded. It would be better if we could
       # get this from the DTMF payload generator
       from_addr = "#{@from_user}@#{@adv_ip}:[local_port]"
-      to_addr   = "[service]@[remote_ip]:[remote_port]"
       msg = <<-MSG
 
-INVITE sip:#{to_addr} SIP/2.0
+INVITE sip:[service]@[remote_ip]:[remote_port] SIP/2.0
 Via: SIP/2.0/[transport] #{@adv_ip}:[local_port];branch=[branch]
 From: "#{@from_user}" <sip:#{from_addr}>;tag=[call_number]
 To: <sip:#{to_addr}>
@@ -325,7 +325,7 @@ Content-Type: application/sdp
 Content-Length: [len]
 
 v=0
-o=user1 53655765 2353687637 IN IP[local_ip_type] #{@adv_ip} 
+o=user1 53655765 2353687637 IN IP[local_ip_type] #{@adv_ip}
 s=-
 c=IN IP[media_ip_type] [media_ip]
 t=0 0
@@ -448,7 +448,7 @@ a=rtpmap:0 PCMU/8000
 ACK [next_url] SIP/2.0
 Via: SIP/2.0/[transport] #{@adv_ip}:[local_port];branch=[branch]
 From: "#{@from_user}" <sip:#{@from_user}@#{@adv_ip}:[local_port]>;tag=[call_number]
-To: <sip:[service]@[remote_ip]:[remote_port]>[peer_tag_param]
+To: <sip:#{to_addr}>[peer_tag_param]
 Call-ID: [call_id]
 CSeq: [cseq] ACK
 Contact: <sip:[$local_addr];transport=[transport]>
@@ -499,7 +499,7 @@ Content-Length: 0
 INFO [next_url] SIP/2.0
 Via: SIP/2.0/[transport] #{@adv_ip}:[local_port];branch=[branch]
 From: "#{@from_user}" <sip:#{@from_user}@#{@adv_ip}:[local_port]>;tag=[call_number]
-To: <sip:[service]@[remote_ip]:[remote_port]>[peer_tag_param]
+To: <sip:#{to_addr}>[peer_tag_param]
 Call-ID: [call_id]
 CSeq: [cseq] INFO
 Contact: <sip:[$local_addr];transport=[transport]>
@@ -736,6 +736,10 @@ Content-Length: 0
 
   private
 
+    def to_addr
+      @to_addr ||= "[service]@#{@to_domain}:[remote_port]"
+    end
+
     #TODO: SIPS support?
     def parse_user(user)
       user.slice! 0, 4 if user =~ /sip:/
@@ -774,9 +778,13 @@ Content-Length: 0
         @dtmf_mode = :rfc2833
       end
 
-      @from_addr, @from_port = args[:source].split ':' if args[:source]
-      @to_addr, @to_port = args[:destination].split ':' if args[:destination]
       @from_user = args[:from_user] || "sipp"
+
+      args[:to] ||= args[:to_user] if args.has_key?(:to_user)
+      if args[:to]
+        @to_user, @to_domain = args[:to].to_s.split('@')
+      end
+      @to_domain ||= "[remote_ip]"
     end
 
     def compile_media

data/lib/sippy_cup/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module SippyCup
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/sippy_cup.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'packetfu'
   s.add_runtime_dependency 'nokogiri', ["~> 1.6.0"]
-  s.add_runtime_dependency 'activesupport', ["~> 3.0"]
+  s.add_runtime_dependency 'activesupport', [">= 3.0"]
   s.add_runtime_dependency 'psych', ["~> 2.0.1"] unless RUBY_PLATFORM == 'java'
 
   s.add_development_dependency 'guard-rspec'

data/spec/sippy_cup/runner_spec.rb

@@ -86,7 +86,7 @@ steps:
 name: foobar
 source: 'dah.com'
 destination: 'bar.com'
-to_user: 1
+to: 1
 concurrent_max: 5
 calls_per_second: 2
 number_of_calls: 10
@@ -166,7 +166,7 @@ steps:
       end
     end
 
-    context "specifying a to_user in the Scenario" do
+    context "specifying a to in the Scenario" do
       let(:manifest) do
         <<-MANIFEST
 name: foobar
@@ -176,7 +176,7 @@ concurrent_max: 5
 calls_per_second: 2
 number_of_calls: 10
 from_user: pat
-to_user: frank
+to: frank@there.com
 steps:
   - invite
   - wait_for_answer
@@ -450,9 +450,7 @@ steps:
         let(:exit_code) { 0 }
 
         it "doesn't raise anything if SIPp returns 0" do
-          quietly do
-            subject.run.should be true
-          end
+          subject.run.should be true
         end
       end
 
@@ -460,10 +458,8 @@ steps:
         let(:exit_code) { 1 }
 
         it "returns false if SIPp returns 1" do
-          quietly do
-            logger.should_receive(:info).ordered.with(/Test completed successfully but some calls failed./)
-            subject.run.should be false
-          end
+          logger.should_receive(:info).ordered.with(/Test completed successfully but some calls failed./)
+          subject.run.should be false
         end
       end
 
@@ -471,9 +467,7 @@ steps:
         let(:exit_code) { 97 }
 
         it "raises a ExitOnInternalCommand error if SIPp returns 97" do
-          quietly do
-            expect { subject.run }.to raise_error SippyCup::ExitOnInternalCommand, error_string
-          end
+          expect { subject.run }.to raise_error SippyCup::ExitOnInternalCommand, error_string
         end
       end
 
@@ -481,9 +475,7 @@ steps:
         let(:exit_code) { 99 }
 
         it "raises a NoCallsProcessed error if SIPp returns 99" do
-          quietly do
-            expect { subject.run }.to raise_error SippyCup::NoCallsProcessed, error_string
-          end
+          expect { subject.run }.to raise_error SippyCup::NoCallsProcessed, error_string
         end
       end
 
@@ -491,9 +483,7 @@ steps:
         let(:exit_code) { 255 }
 
         it "raises a FatalError error if SIPp returns 255" do
-          quietly do
-            expect { subject.run }.to raise_error SippyCup::FatalError, error_string
-          end
+          expect { subject.run }.to raise_error SippyCup::FatalError, error_string
         end
       end
 
@@ -501,9 +491,7 @@ steps:
         let(:exit_code) { 254 }
 
         it "raises a FatalSocketBindingError error if SIPp returns 254" do
-          quietly do
-            expect { subject.run }.to raise_error SippyCup::FatalSocketBindingError, error_string
-          end
+          expect { subject.run }.to raise_error SippyCup::FatalSocketBindingError, error_string
         end
       end
 
@@ -511,15 +499,11 @@ steps:
         let(:exit_code) { 128 }
 
         it "raises a SippGenericError error if SIPp returns 255" do
-          quietly do
-            expect { subject.run }.to raise_error SippyCup::SippGenericError, error_string
-          end
+          expect { subject.run }.to raise_error SippyCup::SippGenericError, error_string
         end
 
         it "raises a SippGenericError error with the appropriate message" do
-          quietly do
-            expect { subject.run }.to raise_error SippyCup::SippGenericError, error_string
-          end
+          expect { subject.run }.to raise_error SippyCup::SippGenericError, error_string
         end
       end
     end
@@ -537,24 +521,18 @@ steps:
 
       context "by default" do
         it "proxies stdout to the terminal" do
-          quietly do
-            capture(:stdout) { subject.run }.strip.should == output_string
-          end
+          capture(:stdout) { subject.run }.strip.should == output_string
         end
 
         it "proxies stderr to the terminal" do
-          quietly do
-            capture(:stderr) { subject.run }.strip.should == error_string
-          end
+          capture(:stderr) { subject.run }.strip.should == error_string
         end
 
         it "does not leak threads" do
           Thread.list.each { |t| t.kill unless t = Thread.main }
           sleep 0.1
           original_thread_count = active_thread_count
-          quietly do
-            subject.run
-          end
+          subject.run
           sleep 0.1
           active_thread_count.should == original_thread_count
         end
@@ -572,14 +550,12 @@ steps:
         end
 
         it "does not leak threads" do
-          quietly do
-            Thread.list.each { |t| t.kill unless t = Thread.main }
-            sleep 0.1
-            original_thread_count = active_thread_count
-            subject.run
-            sleep 0.1
-            active_thread_count.should == original_thread_count
-          end
+          Thread.list.each { |t| t.kill unless t = Thread.main }
+          sleep 0.1
+          original_thread_count = active_thread_count
+          subject.run
+          sleep 0.1
+          active_thread_count.should == original_thread_count
         end
       end
     end

data/spec/sippy_cup/scenario_spec.rb

@@ -91,6 +91,34 @@ describe SippyCup::Scenario do
         subject.to_xml.should match(%r{Contact: <sip:sipp@})
       end
     end
+
+    context "when a to user is specified" do
+      let(:args) { {to: 'usera'} }
+
+      it "includes the specified user in the To header and URI line" do
+        subject.invite
+        subject.to_xml.should match(%r{To: <sip:\[service\]@\[remote_ip\]})
+        subject.to_xml.should match(%r{INVITE sip:\[service\]@\[remote_ip\]})
+      end
+    end
+
+    context "when a to address is specified" do
+      let(:args) { {to: 'usera@foo.bar'} }
+
+      it "includes the specified address in the To header, but not the URI line" do
+        subject.invite
+        subject.to_xml.should match(%r{To: <sip:\[service\]@foo.bar})
+        subject.to_xml.should match(%r{INVITE sip:\[service\]@\[remote_ip\]})
+      end
+    end
+
+    context "when no to is specified" do
+      it "uses a default of '[remote_ip]' in the To header and URI line" do
+        subject.invite
+        subject.to_xml.should match(%r{To: <sip:\[service\]@\[remote_ip\]})
+        subject.to_xml.should match(%r{INVITE sip:\[service\]@\[remote_ip\]})
+      end
+    end
   end
 
   describe "#register" do

data/spec/spec_helper.rb

@@ -3,15 +3,52 @@
 %w{
   sippy_cup
   fakefs/spec_helpers
+  tempfile
 }.each { |f| require f }
 
+module SippyCup
+  module SpecHelpers
+    def capture(stream)
+      stream = stream.to_s
+      captured_stream = Tempfile.new(stream)
+      stream_io = eval("$#{stream}")
+      origin_stream = stream_io.dup
+      stream_io.reopen(captured_stream)
+
+      yield
+
+      stream_io.rewind
+      return captured_stream.read
+    ensure
+      captured_stream.close
+      captured_stream.unlink
+      stream_io.reopen(origin_stream)
+    end
+
+    def silence_stream(stream)
+      old_stream = stream.dup
+      stream.reopen(RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ ? 'NUL:' : '/dev/null')
+      stream.sync = true
+      yield
+    ensure
+      stream.reopen(old_stream)
+      old_stream.close
+    end
+  end
+end
+
 RSpec.configure do |config|
+  config.include SippyCup::SpecHelpers
   config.mock_framework = :rspec
   config.filter_run :focus => true
   config.run_all_when_everything_filtered = true
   config.color = true
 
   config.around(:each) do |example|
-    quietly { example.run }
+    silence_stream(STDOUT) do
+      silence_stream(STDERR) do
+        example.run
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sippy_cup
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ben Klang
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2015-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: packetfu
@@ -43,14 +43,14 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency