sippy_cup 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6dd7d94d947152635902fedf054429f24ffa2de8
-  data.tar.gz: 621cb762e6bbef801190e0aeb855c82eeb9ed064
+  metadata.gz: ec38982988f13808a01d0edb5d995d05235d5000
+  data.tar.gz: 18b80cca252826d0790c2152b0e72b507610a804
 SHA512:
-  metadata.gz: 2423aa6cff4c235c5416b3f3fdbea27a973a79eff72fee91a56862386827eaa0a3d04bc260515d4031331623abbc2da0271589d7cb505380eb89c499434d2f34
-  data.tar.gz: a45bac4f0fbb3a98c5e40dcc8aa4761a49bf6b4d8f3452f8fed86f141456cc200148ab2c2739681a81abe53e07510259837f5f9a3dd23f5dd7fd74b15f061543
+  metadata.gz: ed52b5856e8df516dbeaf1da79ca86ece5f83f76b8e414cce292bc09b3c77fca976150b1980486460562f3166125f38f0bee8a23eaf694cde97a0959dd48c702
+  data.tar.gz: be9366e3fe1c86649c361c79bd265a0608ad8195843bce5d9dbc1797fff60f69419b3dfcea2aaab02cdfcdf52f1124ddab63cf5584925cb3a0c1484c5531e1ac

data/.travis.yml

@@ -13,3 +13,4 @@ matrix:
     - rvm: ruby-head
 notifications:
   irc: "irc.freenode.org#adhearsion"
+sudo: false

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # develop
 
+# [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.
+
 # [0.5.0](https://github.com/mojolingo/sippy_cup/compare/v0.4.1...v0.5.0)
 SYNTAX CHANGES!
 This is a backward incompatible change. If upgrading from Sippy Cup 0.4.x please see the [documentation](http://mojolingo.github.io/sippy_cup/#available-scenario-steps) and the `Change` items below.

data/README.markdown

@@ -34,7 +34,7 @@ Sippy Cup is a tool to generate [SIPp](http://sipp.sourceforge.net/) load test p
 SippyCup relies on the following to generate scenarios and the associated media PCAP files:
 
 * Ruby 1.9.3 or later (2.1.2 recommended)
-* [SIPp](http://sipp.sourceforge.net/) - Download from http://sourceforge.net/projects/sipp/files/
+* [SIPp](http://sipp.sourceforge.net/) latest master branch - Download from https://github.com/sipp/sipp - NOTE: Version SIPp version 3.4 may work, but will be missing certain new Sippy Cup features, such as rate scaling
 * "root" user access via sudo: needed to run SIPp so it can bind to raw network sockets
 
 ## Installation
@@ -199,49 +199,58 @@ Each parameter has an impact on the test, and may either be changed once the XML
   <dd>Frequency (in seconds) of statistics collections. Defaults to 10. Has no effect unless :stats_file is also specified</dd>
 
   <dt>from_user</dt>
-  <dd>SIP user from which traffic should appear. Defaults to "sipp".</dd>
+  <dd>SIP user from which traffic should appear. Default: sipp</dd>
 
   <dt>to_user</dt>
-  <dd>SIP user to send requests to. Defaults to "1" (as in 1@127.0.0.1).</dd>
+  <dd>SIP user to send requests to. Defaults to SIPp's default: `s` (as in `s@127.0.0.1`)</dd>
 
   <dt>transport</dt>
-  <dd>Specify the SIP transport. Valid options are `udp` (default) or `tcp`.</dd>
+  <dd>Specify the SIP transport. Valid options are `udp` (default) or `tcp`. Default: `udp`</dd>
 
   <dt>full_sipp_output</dt>
-  <dd>By default, SippyCup will show SIPp's command line output while running a scenario. Set this parameter to `false` to hide full command line output</dd>
+  <dd>By default, SippyCup will show SIPp's command line output while running a scenario. Set this parameter to `false` to hide full command line output. Default: `true`</dd>
 
   <dt>summary_report_file</dt>
-  <dd>Write a summary of the SIPp run to the specified file. This summary is the output from the SIPp `-trace_screen` command. Requires a development build of SIPp; see https://github.com/SIPp/sipp/pull/106.</dd>
+  <dd>Write a summary of the SIPp run to the specified file. This summary is the output from the SIPp `-trace_screen` command. Default: unused</dd>
 
   <dt>errors_report_file</dt>
-  <dd>Record SIPp's errors to the specified file. This report is the output from the SIPp `-trace_err` command.</dd>
+  <dd>Record SIPp's errors to the specified file. This report is the output from the SIPp `-trace_err` command. Default: unused</dd>
 
   <dt>options</dt>
-  <dd>A string of SIPp command line options included with the SIPp run.</dd>
+  <dd>A string of SIPp command line options included with the SIPp run. Default: none</dd>
 
   <dt>media_port</dt>
-  <dd>By default, SIPp assigns RTP ports dynamically. However, if there is a need for a static RTP port (say, for data collection purposes), it can be done by supplying a port number here.</dd>
+  <dd>By default, SIPp assigns RTP ports dynamically. However, if there is a need for a static RTP port (say, for data collection purposes), it can be done by supplying a port number here. Default: SIPp's default of 6000</dd>
 
   <dt>dtmf_mode</dt>
   <dd>Specify the mechanism by which DTMF is signaled. Valid options are `rfc2833` for within the RTP media, or `info` for SIP INFO. Default: rfc2833</dd>
 
   <dt>scenario_variables</dt>
-  <dd>If you're using sippy_cup to run a SIPp XML file, there may be CSV fields in the scenario ([field0], [field1], etc.). Specify a path to a CSV file containing the required information using this option. (File is semicolon delimeted, information can be found [here](http://sipp.sourceforge.net/doc/reference.html#inffile).)</dd>
+  <dd>If you're using sippy_cup to run a SIPp XML file, there may be CSV fields in the scenario ([field0], [field1], etc.). Specify a path to a CSV file containing the required information using this option. (File is semicolon delimeted, information can be found [here](http://sipp.sourceforge.net/doc/reference.html#inffile).) Default: unused</dd>
+
+  <dt>number_of_calls</dt>
+  <dd>The total number of calls permitted for the entire test. When this limit is reached, the test is over. Defaults to none - test will run forever until manually stopped</dd>
+
+  <dt>number_of_calls</dt>
+  <dd>The total number of calls permitted for the entire test. When this limit is reached, the test is over. Defaults to nil.</dd>
 
   <dt>concurrent_max</dt>
-  <dd>The maximum number of calls permitted to be active at any given time. When this limit is reached, SIPp will slow down or stop sending new calls until there it falls below the limit. Default: 5</dd>
+  <dd>The maximum number of calls permitted to be active at any given time. When this limit is reached, SIPp will slow down or stop sending new calls until there it falls below the limit. Defaults to SIPp's default: (3 * call_duration (seconds) * calls_per_second)</dd>
 
   <dt>calls_per_second</dt>
-  <dd>The rate at which new calls should be created. Note that SIPp will automatically adjust this downward to stay at or beneath the maximum number of concurrent calls (`concurrent_max`). Default: 10</dt>
+  <dd>The rate at which new calls should be created. Note that SIPp will automatically adjust this downward to stay at or beneath the maximum number of concurrent calls (`concurrent_max`). Defaults to SIP's default of 10</dt>
 
   <dt>calls_per_second_incr</dt>
-  <dd>When used with `calls_per_second_max`, tells SIPp the amount by which calls-per-second should be incremented. CPS rate is adjusted each `stats_interval`. Default: 1.</dd>
+  <dd>When used with `calls_per_second_max`, tells SIPp the amount by which `calls_per_second` should be incremented. CPS rate is adjusted each `calls_per_second_interval`. Default: 1.</dd>
+
+  <dt>calls_per_second_interval</dt>
+  <dd>When used with `calls_per_second_max`, tells SIPp the time interval (in seconds) by which calls-per-second should be incremented. Default: Unset; SIPp's default (60s). NOTE: Requires a development build of SIPp; see https://github.com/SIPp/sipp/pull/107</dd>
 
   <dt>calls_per_second_max</dt>
-  <dd>The maximum rate of calls-per-second. If unset, the CPS rate will remain at the level set by `calls_per_second`.</dd>
+  <dd>The maximum rate of calls-per-second. Default: unused (`calls_per_second` will not change)</dd>
 
   <dt>advertise_address</dt>
-  <dd>The IP address to advertise in SIP and SDP if different from the bind IP (defaults to the bind IP).</dd>
+  <dd>The IP address to advertise in SIP and SDP if different from the bind IP. Default: `source` IP address</dd>
 </dl>
 
 ### Additional SIPp Scenario Attributes

data/Rakefile

@@ -1,3 +1,5 @@
+require 'bundler/gem_tasks'
+
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)

data/lib/sippy_cup/runner.rb

@@ -99,12 +99,14 @@ module SippyCup
       options = {
         p: @scenario_options[:source_port] || '8836',
         sf: @input_files[:scenario].path,
-        l: @scenario_options[:concurrent_max] || @scenario_options[:max_concurrent] || 5,
-        m: @scenario_options[:number_of_calls] || 10,
-        r: @scenario_options[:calls_per_second] || 10,
-        s: @scenario_options[:to_user] || '1'
       }
 
+      max_concurrent = @scenario_options[:concurrent_max] || @scenario_options[:max_concurrent]
+      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[:i] = @scenario_options[:source] if @scenario_options[:source]
       options[:mp] = @scenario_options[:media_port] if @scenario_options[:media_port]
 
@@ -112,6 +114,7 @@ module SippyCup
         options[:no_rate_quit] = nil
         options[:rate_max] = @scenario_options[:calls_per_second_max]
         options[:rate_increase] = @scenario_options[:calls_per_second_incr] || 1
+        options[:rate_interval] = @scenario_options[:calls_per_second_interval] if @scenario_options[:calls_per_second_interval]
       end
 
       if @scenario_options[:stats_file]

data/lib/sippy_cup/version.rb

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

data/spec/sippy_cup/runner_spec.rb

@@ -20,9 +20,6 @@ describe SippyCup::Runner do
 name: foobar
 source: 'dah.com'
 destination: 'bar.com'
-concurrent_max: 5
-calls_per_second: 2
-number_of_calls: 10
 steps:
   - invite
   - wait_for_answer
@@ -48,7 +45,7 @@ steps:
   describe '#run' do
     it "executes the correct command to invoke SIPp" do
       full_scenario_path = File.join(Dir.tmpdir, '/scenario.*')
-      expect_command_execution %r{sudo \$\(which sipp\) -p 8836 -sf #{full_scenario_path} -l 5 -m 10 -r 2 -s 1 -i dah.com bar.com}
+      expect_command_execution %r{sudo \$\(which sipp\) -p 8836 -sf #{full_scenario_path} -i dah.com bar.com}
       subject.run
     end
 
@@ -83,6 +80,34 @@ steps:
       end
     end
 
+    context "specifying outbound options in the manifest" do
+      let(:manifest) do
+        <<-MANIFEST
+name: foobar
+source: 'dah.com'
+destination: 'bar.com'
+to_user: 1
+concurrent_max: 5
+calls_per_second: 2
+number_of_calls: 10
+steps:
+  - invite
+  - wait_for_answer
+  - ack_answer
+  - sleep 3
+  - send_digits 'abc'
+  - sleep 5
+  - send_digits '#'
+  - wait_for_hangup
+        MANIFEST
+      end
+
+      it 'should pass the appropriate options to sipp' do
+        expect_command_execution(/-l 5 -m 10 -r 2 -s 1/)
+        subject.run
+      end
+    end
+
     context "specifying arbitrary options in the manifest" do
       let(:manifest) do
         <<-MANIFEST
@@ -335,6 +360,7 @@ concurrent_max: 5
 calls_per_second: 2
 calls_per_second_max: 5
 calls_per_second_incr: 2
+calls_per_second_interval: 20
 number_of_calls: 10
 errors_report_file: errors.txt
 steps:
@@ -350,7 +376,7 @@ steps:
       end
 
       it 'should not terminate the test when reaching the rate limit and set the rate limit and increase appropriately' do
-        expect_command_execution(/-no_rate_quit -rate_max 5 -rate_increase 2/)
+        expect_command_execution(/-no_rate_quit -rate_max 5 -rate_increase 2 -rate_interval 20/)
         subject.run
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sippy_cup
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ben Klang
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-23 00:00:00.000000000 Z
+date: 2015-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: packetfu