sippy_cup 0.3.0 → 0.4.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZTYzYWNiZmNmOTU4NjU5MzBhOTRhZGI4M2ZlZjg5YzBiOWEyZmIzNw==
-  data.tar.gz: !binary |-
-    NTU0NDIwOWUyZjc5MTRjMzkzOTQwZTNhZWZjNjhlNTMwZmM0N2NhYQ==
+SHA1:
+  metadata.gz: 12ebcabfa7aeab3fd07ebd8ccf1a0f4cfb88b859
+  data.tar.gz: 917066d6774889765f8c19d40d694d85dc02c19a
 SHA512:
-  metadata.gz: !binary |-
-    ZWE1NDM0Nzg5OTU0NDAzMDA0MmI3Mjk0YjY1MWFkOTMzZDQ4YmU0ZTI0ZDk0
-    N2ViNjlhYWVlOGQ4YTQxOGUxYTQ5NzE0ZjY4Y2ZlNjVlMjBhMTczZmMxZmFh
-    YzAxMzU4MTk4YzYyZWZmN2EyZDRlYjMyYmZlNGYxMGY1NzdlYzg=
-  data.tar.gz: !binary |-
-    MmRiYTBlMjc4MzUxMjAwZjdmZGJjYWY1MDNjNGM2MTU5ZTEyNjk2MWE2ZTgy
-    NWE1ZDM2YTQzNmYyZDg0NDUwNTk0NDEzZWZhYTg0OWIxNGY4NzIwMTQxNWM0
-    MDk0MTEyZDhhYzIzNjU1YjIwMDMyYjU4ODJlNTkxMDI5YjZmZDk=
+  metadata.gz: 3cd3fab1459b55ccadc61c1d74a58c304aaf91c9ff27f406bd189b30dbcef88216caf78c73fce48a5317db64e6e1ed9cbeec4525dd15a0a3de86105ec914a87e
+  data.tar.gz: d712da0444fbc5774db1f983cb0277f14950971742f6fe5a09c61c9ee1ec5c1a9017de923b0951e3cd63a0b9ecbfd7f152bb9386171acfd1b7a95e1fdaa7a47a

data/.travis.yml

@@ -2,12 +2,14 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0
   - jruby-19mode
   - rbx-19mode
   - ruby-head
 matrix:
   allow_failures:
     - rvm: 2.0.0
+    - rvm: 2.1.0
     - rvm: jruby-19mode
     - rvm: rbx-19mode
     - rvm: ruby-head

data/CHANGELOG.md

@@ -1,4 +1,13 @@
-# develop
+# [0.4.0](https://github.com/bklang/sippy_cup/compare/v0.3.0...v0.4.0)
+  * Feature: receive_message for incoming SIP MESSAGEs.
+  * Feature: SIP INFO DTMF.
+  * Feature: Don't write unnecessary PCAP files.
+  * Feature: Execute sipp via which, allowing sudo rule to be more restrictive.
+  * Change: Split `#receive_200` into its own method ([#61](https://github.com/mojolingo/sippy_cup/pull/61))
+  * Allow passing arbitrary SIPp options from the YAML manifest
+  * Bugfix: Fix ACK/BYE being sent to self.
+  * Bugfix: Require Psych 2.0.1 to fix `safe_load` NoMethodError (#63)
+  * Bugfix: Ensure the correct XML serializer is used (#66)
 
 # [0.3.0](https://github.com/bklang/sippy_cup/compare/v0.2.3...v0.3.0)
 * Feature: A whole lot more documentation, test coverage and cleaner internals.
@@ -8,7 +17,6 @@
 * Feature: API for validation of scenarios in manifests.
 * Feature: Handle SIPp exit codes with clean exceptions.
 * Feature: Allow passing arbitary headers in an INVITE
-* Change: AVP is now AVPF in SDP.
 * Change: Rake tasks for executing scenarios are removed.
 * Change: Running and compiling scenarios are now separate concepts.
   * `-c` on the CLI writes a YAML manifest to disk as SIPp XML and PCAP media. `-r` executes a YAML manifest and does not write to disk.

data/README.markdown

@@ -33,13 +33,13 @@ 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 (2.0.0 NOT YET SUPPORTED; see [PacketFu Issue #28](https://github.com/todb/packetfu/issues/28))
+* Ruby 1.9.3 or later (2.1.2 recommended)
 * [SIPp](http://sipp.sourceforge.net/) - Download from http://sourceforge.net/projects/sipp/files/
 * "root" user access via sudo: needed to run SIPp so it can bind to raw network sockets
 
 ## Installation
 
-If you do not have Ruby 1.9.3 available (check using `ruby --version`), we recommend installing Ruby with [RVM](http://rvm.io)
+If you do not have Ruby 2.1.2 available (check using `ruby --version`), we recommend installing Ruby with [RVM](http://rvm.io)
 
 ### Install via gem (production)
 
@@ -147,6 +147,8 @@ Each command below can take [SIPp attributes](http://sipp.sourceforge.net/doc/re
 * `wait_for_answer` Convenient shortcut for `receive_trying; receive_ringing; receive_progress; receive_answer`, with all but the `answer` marked as optional
 * `ack_answer` Send an `ACK` in response to a `200 OK`
 * `send_digits <string>` Send a DTMF string. May send one or many digits, including `0-9`, `*`, `#`, and `A-D`
+* `receive_ok` Expect to receive a `200 OK`
+* `receive_message [regex]` Expect to receive a SIP MESSAGE, optionally matching a regex
 * `send_bye` Send a `BYE` (hangup request)
 * `receive_bye` Expect to receive a `BYE` from the target
 * `ack_bye` Send a `200 OK` response to a `BYE`
@@ -184,15 +186,27 @@ Each parameter has an impact on the test, and may either be changed once the XML
   <dt>stats_interval</dt>
   <dd>Frequency (in seconds) of statistics collections. Defaults to 10. Has no effect unless :stats_file is also specified</dd>
 
-  <dt>sip_user</dt>
-  <dd>SIP username to use. Defaults to "1" (as in 1@127.0.0.1)</dd>
+  <dt>from_user</dt>
+  <dd>SIP user from which traffic should appear. Defaults to "sipp".</dd>
+
+  <dt>to_user</dt>
+  <dd>SIP user to send requests to. Defaults to "1" (as in 1@127.0.0.1).</dd>
+
+  <dt>transport</dt>
+  <dd>Specify the SIP transport. Valid options are `udp` (default) or `tcp`.</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>
 
+  <dt>options</dt>
+  <dd>A string of SIPp command line options included with the SIPp run.</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>
 
+  <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.</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>
 </dl>
@@ -217,7 +231,7 @@ For more information on possible attributes, visit the [SIPp Documentation](http
 
 ## Credits
 
-Copyright (C) 2013 [Mojo Lingo LLC](https://mojolingo.com)
+Copyright (C) 2013-2014 [Mojo Lingo LLC](https://mojolingo.com)
 
 Sippy Cup is released under the [MIT license](http://opensource.org/licenses/MIT). Please see the [LICENSE](https://github.com/bklang/sippy_cup/blob/master/LICENSE) file for details.
 

data/lib/sippy_cup/media.rb

@@ -8,7 +8,6 @@ module SippyCup
     USEC = 1_000_000
     MSEC = 1_000
     attr_accessor :sequence
-    attr_reader :packets
 
     def initialize(from_addr, from_port, to_addr, to_port, generator = PCMUPayload)
       @from_addr, @to_addr = IPAddr.new(from_addr), IPAddr.new(to_addr)
@@ -18,7 +17,6 @@ module SippyCup
 
     def reset!
       @sequence = []
-      @packets = []
     end
 
     def <<(input)
@@ -26,6 +24,10 @@ module SippyCup
       @sequence << input
     end
 
+    def empty?
+      @sequence.empty?
+    end
+
     def compile!
       sequence_number = 0
       start_time = Time.now

data/lib/sippy_cup/runner.rb

@@ -27,8 +27,34 @@ module SippyCup
       @logger = @options[:logger] || Logger.new(STDOUT)
     end
 
+    #
     # Runs the loaded scenario using SIPp
     #
+    def run
+      @input_files = @scenario.to_tmpfiles
+
+      @logger.info "Preparing to run SIPp command: #{command}"
+
+      execute_with_redirected_streams
+
+      wait unless @options[:async]
+    ensure
+      cleanup_input_files unless @options[:async]
+    end
+
+    #
+    # Tries to stop SIPp by killing the target PID
+    #
+    # @raises Errno::ESRCH when the PID does not correspond to a known process
+    # @raises Errno::EPERM when the process referenced by the PID cannot be killed
+    #
+    def stop
+      Process.kill "KILL", @sipp_pid if @sipp_pid
+    end
+
+    #
+    # Waits for the runner to finish execution
+    #
     # @raises Errno::ENOENT when the SIPp executable cannot be found
     # @raises SippyCup::ExitOnInternalCommand when SIPp exits on an internal command. Calls may have been processed
     # @raises SippyCup::NoCallsProcessed when SIPp exit normally, but has processed no calls
@@ -38,15 +64,10 @@ module SippyCup
     #
     # @return Boolean true if execution succeeded without any failed calls, false otherwise
     #
-    def run
-      @input_files = @scenario.to_tmpfiles
-
-      @logger.info "Preparing to run SIPp command: #{command}"
-
-      exit_status, stderr_buffer = execute_with_redirected_streams
-
-      final_result = process_exit_status exit_status, stderr_buffer
-
+    def wait
+      exit_status = Process.wait2 @sipp_pid.to_i
+      @rd.close if @rd
+      final_result = process_exit_status exit_status, @stderr_buffer
       if final_result
         @logger.info "Test completed successfully!"
       else
@@ -59,21 +80,11 @@ module SippyCup
       cleanup_input_files
     end
 
-    #
-    # Tries to stop SIPp by killing the target PID
-    #
-    # @raises Errno::ESRCH when the PID does not correspond to a known process
-    # @raises Errno::EPERM when the process referenced by the PID cannot be killed
-    #
-    def stop
-      Process.kill "KILL", @sipp_pid if @sipp_pid
-    end
-
   private
 
     def command
       @command ||= begin
-        command = "sudo sipp"
+        command = "sudo $(which sipp)"
         command_options.each_pair do |key, value|
           command << (value ? " -#{key} #{value}" : " -#{key}")
         end
@@ -86,10 +97,10 @@ module SippyCup
         i: @scenario_options[:source],
         p: @scenario_options[:source_port] || '8836',
         sf: @input_files[:scenario].path,
-        l: @scenario_options[:max_concurrent],
-        m: @scenario_options[:number_of_calls],
-        r: @scenario_options[:calls_per_second],
-        s: @scenario_options[:from_user] || '1'
+        l: @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'
       }
 
       options[:mp] = @scenario_options[:media_port] if @scenario_options[:media_port]
@@ -108,31 +119,27 @@ module SippyCup
         options[:inf] = @scenario_options[:scenario_variables]
       end
 
+      options.merge! @scenario_options[:options] if @scenario_options[:options]
+
       options
     end
 
     def execute_with_redirected_streams
-      rd, wr = IO.pipe
+      @rd, wr = IO.pipe
       stdout_target = @options[:full_sipp_output] ? $stdout : '/dev/null'
 
       @sipp_pid = spawn command, err: wr, out: stdout_target
 
-      stderr_buffer = String.new
+      @stderr_buffer = String.new
 
       Thread.new do
         wr.close
-        until rd.eof?
-          buffer = rd.readpartial(1024).strip
-          stderr_buffer += buffer
+        until @rd.eof?
+          buffer = @rd.readpartial(1024).strip
+          @stderr_buffer += buffer
           $stderr << buffer if @options[:full_sipp_output]
         end
       end
-
-      exit_status = Process.wait2 @sipp_pid.to_i
-
-      rd.close
-
-      [exit_status, stderr_buffer]
     end
 
     def process_exit_status(process_status, error_message = nil)
@@ -156,7 +163,7 @@ module SippyCup
     end
 
     def cleanup_input_files
-      @input_files.each_pair do |key, value|
+      @input_files.values.compact.each do |value|
         value.close
         value.unlink
       end

data/lib/sippy_cup/scenario.rb

@@ -79,6 +79,7 @@ module SippyCup
     # @option options [String, Numeric] :source_port The source port to bind SIPp to (defaults to 8836).
     # @option options [String] :destination The target system at which to direct traffic.
     # @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 [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.
@@ -86,7 +87,9 @@ module SippyCup
     # @option options [String] :stats_file The path at which to dump statistics.
     # @option options [String, Numeric] :stats_interval The interval (in seconds) at which to dump statistics (defaults to 1s).
     # @option options [String] :transport_mode The transport mode over which to direct SIP traffic.
+    # @option options [String] :dtmf_mode The output DTMF mode, either rfc2833 (default) or info.
     # @option options [String] :scenario_variables A path to a CSV file of variables to be interpolated with the scenario at runtime.
+    # @option options [Hash] :options A collection of options to pass through to SIPp, as key-value pairs. In cases of value-less options (eg -trace_err), specify a nil value.
     # @option options [Array<String>] :steps A collection of steps
     #
     # @yield [scenario] Builder block to construct scenario
@@ -99,6 +102,8 @@ module SippyCup
       @filename = args[:filename] || name.downcase.gsub(/\W+/, '_')
       @filename = File.expand_path @filename, Dir.pwd
       @media = Media.new '127.0.0.255', 55555, '127.255.255.255', 5060
+      @message_variables = 0
+      @media_nodes = []
       @errors = []
 
       instance_eval &block if block_given?
@@ -198,7 +203,7 @@ a=fmtp:101 0-15
     # Sets an expectation for a SIP 100 message from the remote party
     #
     # @param [Hash] opts A set of options to modify the expectation
-    # @option opts [true, false] :optional Wether or not receipt of the message is optional. Defaults to true.
+    # @option opts [true, false] :optional Whether or not receipt of the message is optional. Defaults to true.
     #
     def receive_trying(opts = {})
       handle_response 100, opts
@@ -209,7 +214,7 @@ a=fmtp:101 0-15
     # Sets an expectation for a SIP 180 message from the remote party
     #
     # @param [Hash] opts A set of options to modify the expectation
-    # @option opts [true, false] :optional Wether or not receipt of the message is optional. Defaults to true.
+    # @option opts [true, false] :optional Whether or not receipt of the message is optional. Defaults to true.
     #
     def receive_ringing(opts = {})
       handle_response 180, opts
@@ -220,7 +225,7 @@ a=fmtp:101 0-15
     # Sets an expectation for a SIP 183 message from the remote party
     #
     # @param [Hash] opts A set of options to modify the expectation
-    # @option opts [true, false] :optional Wether or not receipt of the message is optional. Defaults to true.
+    # @option opts [true, false] :optional Whether or not receipt of the message is optional. Defaults to true.
     #
     def receive_progress(opts = {})
       handle_response 183, opts
@@ -229,20 +234,30 @@ a=fmtp:101 0-15
 
     #
     # Sets an expectation for a SIP 200 message from the remote party
+    # as well as storing the record set and the response time duration
     #
     # @param [Hash] opts A set of options to modify the expectation
-    # @option opts [true, false] :optional Wether or not receipt of the message is optional. Defaults to true.
+    # @option opts [true, false] :optional Whether or not receipt of the message is optional. Defaults to false.
     #
     def receive_answer(opts = {})
       options = {
-        response: 200,
         rrs: true, # Record Record Set: Make the Route headers available via [route] later
         rtd: true # Response Time Duration: Record the response time
       }
 
-      recv options.merge(opts)
+      receive_200 options.merge(opts)
     end
-    alias :receive_200 :receive_answer
+
+    #
+    # Sets an expectation for a SIP 200 message from the remote party
+    #
+    # @param [Hash] opts A set of options to modify the expectation
+    # @option opts [true, false] :optional Whether or not receipt of the message is optional. Defaults to false.
+    #
+    def receive_200(opts = {})
+      recv({ response: 200 }.merge(opts))
+    end
+    alias :receive_200 :receive_ok
 
     #
     # Shortcut that sets expectations for optional SIP 100, 180 and 183, followed by a required 200.
@@ -250,9 +265,9 @@ a=fmtp:101 0-15
     # @param [Hash] opts A set of options to modify the expectations
     #
     def wait_for_answer(opts = {})
-      receive_trying({optional: true}.merge opts)
-      receive_ringing({optional: true}.merge opts)
-      receive_progress({optional: true}.merge opts)
+      receive_trying opts
+      receive_ringing opts
+      receive_progress opts
       receive_answer opts
     end
 
@@ -267,7 +282,7 @@ a=fmtp:101 0-15
 ACK [next_url] SIP/2.0
 Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
 From: "#{@from_user}" <sip:#{@from_user}@[local_ip]>;tag=[call_number]
-[last_To:]
+To: <sip:[service]@[remote_ip]:[remote_port]>[peer_tag_param]
 Call-ID: [call_id]
 CSeq: [cseq] ACK
 Contact: <sip:#{@from_user}@[local_ip]:[local_port];transport=[transport]>
@@ -307,10 +322,68 @@ Content-Length: 0
       digits.split('').each do |digit|
         raise ArgumentError, "Invalid DTMF digit requested: #{digit}" unless VALID_DTMF.include? digit
 
-        @media << "dtmf:#{digit}"
-        @media << "silence:#{delay}"
+        case @dtmf_mode
+        when :rfc2833
+          @media << "dtmf:#{digit}"
+          @media << "silence:#{delay}"
+        when :info
+          info = <<-INFO
+
+INFO [next_url] SIP/2.0
+Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+From: "#{@from_user}" <sip:#{@from_user}@[local_ip]>;tag=[call_number]
+To: <sip:[service]@[remote_ip]:[remote_port]>[peer_tag_param]
+Call-ID: [call_id]
+CSeq: [cseq] INFO
+Contact: <sip:#{@from_user}@[local_ip]:[local_port];transport=[transport]>
+Max-Forwards: 100
+User-Agent: #{USER_AGENT}
+[routes]
+Content-Length: [len]
+Content-Type: application/dtmf-relay
+
+Signal=#{digit}
+Duration=#{delay}
+          INFO
+          send info
+          recv response: 200
+          pause delay
+        end
+      end
+
+      if @dtmf_mode == :rfc2833
+        pause delay * 2 * digits.size
       end
-      pause delay * 2 * digits.size
+    end
+
+    #
+    # Expect to receive a MESSAGE message
+    #
+    # @param [String] regexp A regular expression (as a String) to match the message body against
+    #
+    def receive_message(regexp = nil)
+      recv = Nokogiri::XML::Node.new 'recv', doc
+      recv['request'] = 'MESSAGE'
+      scenario_node << recv
+
+      if regexp
+        action = Nokogiri::XML::Node.new 'action', doc
+        ereg = Nokogiri::XML::Node.new 'ereg', doc
+        ref = Nokogiri::XML::Node.new 'Reference', doc
+
+        ereg['regexp'] = regexp
+        ereg['search_in'] = 'body'
+        ereg['check_it'] = true
+
+        var = "message_#{@message_variables += 1}"
+        ereg['assign_to'] = ref['variables'] = var
+
+        action << ereg
+        recv << action
+        scenario_node << ref
+      end
+
+      okay
     end
 
     #
@@ -322,10 +395,10 @@ Content-Length: 0
       msg = <<-MSG
 
 BYE [next_url] SIP/2.0
-[last_Via:]
+Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
 From: "#{@from_user}" <sip:#{@from_user}@[local_ip]>;tag=[call_number]
-[last_To:]
-[last_Call-ID]
+To: <sip:[service]@[remote_ip]:[remote_port]>[peer_tag_param]
+Call-ID: [call_id]
 CSeq: [cseq] BYE
 Contact: <sip:#{@from_user}@[local_ip]:[local_port];transport=[transport]>
 Max-Forwards: 100
@@ -346,11 +419,11 @@ Content-Length: 0
     end
 
     #
-    # Acknowledge a received BYE message
+    # Acknowledge the last request
     #
     # @param [Hash] opts A set of options to modify the message parameters
     #
-    def ack_bye(opts = {})
+    def okay(opts = {})
       msg = <<-ACK
 
 SIP/2.0 200 OK
@@ -367,6 +440,7 @@ Content-Length: 0
       ACK
       send msg, opts
     end
+    alias :ack_bye :okay
 
     #
     # Shortcut to set an expectation for a BYE and acknowledge it when received
@@ -382,14 +456,30 @@ Content-Length: 0
     # Dump the scenario to a SIPp XML string
     #
     # @return [String] the SIPp XML scenario
-    def to_xml
-      doc.to_xml
+    def to_xml(options = {})
+      pcap_path = options[:pcap_path]
+      docdup = doc.dup
+
+      # Not removing in reverse would most likely remove the wrong
+      # nodes because of changing indices.
+      @media_nodes.reverse.each do |nop|
+        nopdup = docdup.xpath(nop.path)
+
+        if pcap_path.nil? or @media.empty?
+          nopdup.remove
+        else
+          exec = nopdup.xpath("./action/exec").first
+          exec['play_pcap_audio'] = pcap_path
+        end
+      end
+
+      docdup.to_xml
     end
 
     #
     # Compile the scenario and its media to disk
     #
-    # Writes the SIPp scenario file to disk at {filename}.xml, and the PCAP media to {filename}.pcap.
+    # Writes the SIPp scenario file to disk at {filename}.xml, and the PCAP media to {filename}.pcap if applicable.
     # {filename} is taken from the :filename option when creating the scenario, or falls back to a down-snake-cased version of the scenario name.
     #
     # @return [String] the path to the resulting scenario file
@@ -403,22 +493,24 @@ Content-Length: 0
     #   scenario.compile! # Leaves files at test_scenario.xml and test_scenario.pcap
     #
     def compile!
+      unless @media.empty?
+        print "Compiling media to #{@filename}.pcap..."
+        compile_media.to_file filename: "#{@filename}.pcap"
+        puts "done."
+      end
+
       scenario_filename = "#{@filename}.xml"
       print "Compiling scenario to #{scenario_filename}..."
       File.open scenario_filename, 'w' do |file|
-        file.write doc.to_xml
+        file.write to_xml(:pcap_path => "#{@filename}.pcap")
       end
       puts "done."
 
-      print "Compiling media to #{@filename}.pcap..."
-      compile_media.to_file filename: "#{@filename}.pcap"
-      puts "done."
-
       scenario_filename
     end
 
     #
-    # Write compiled Scenario XML and PCAP media to tempfiles.
+    # Write compiled Scenario XML and PCAP media (if applicable) to tempfiles.
     #
     # These will automatically be closed and deleted once they have gone out of scope, and can be used to execute the scenario without leaving stuff behind.
     #
@@ -427,14 +519,16 @@ Content-Length: 0
     # @see http://www.ruby-doc.org/stdlib-1.9.3/libdoc/tempfile/rdoc/Tempfile.html
     #
     def to_tmpfiles
+      unless @media.empty?
+        media_file = Tempfile.new 'media'
+        media_file.write compile_media.to_s
+        media_file.rewind
+      end
+
       scenario_file = Tempfile.new 'scenario'
-      scenario_file.write to_xml
+      scenario_file.write to_xml(:pcap_path => media_file.try(:path))
       scenario_file.rewind
 
-      media_file = Tempfile.new 'media'
-      media_file.write compile_media.to_s
-      media_file.rewind
-
       {scenario: scenario_file, media: media_file}
     end
 
@@ -452,19 +546,29 @@ Content-Length: 0
     def doc
       @doc ||= begin
         Nokogiri::XML::Builder.new do |xml|
-          xml.scenario name: @scenario_options[:name]
+          xml.scenario name: @scenario_options[:name] do
+            @scenario_node = xml.parent
+          end
         end.doc
       end
     end
 
     def scenario_node
-      @scenario_node = doc.xpath('//scenario').first
+      doc
+      @scenario_node
     end
 
     def parse_args(args)
       raise ArgumentError, "Must include source IP:PORT" unless args.has_key? :source
       raise ArgumentError, "Must include destination IP:PORT" unless args.has_key? :destination
 
+      if args[:dtmf_mode]
+        @dtmf_mode = args[:dtmf_mode].to_sym
+        raise ArgumentError, "dtmf_mode must be rfc2833 or info" unless [:rfc2833, :info].include?(@dtmf_mode)
+      else
+        @dtmf_mode = :rfc2833
+      end
+
       @from_addr, @from_port = args[:source].split ':'
       @to_addr, @to_port = args[:destination].split ':'
       @from_user = args[:from_user] || "sipp"
@@ -511,12 +615,13 @@ Content-Length: 0
     end
 
     def start_media
-      nop = Nokogiri::XML::Node.new 'nop', doc
-      action = Nokogiri::XML::Node.new 'action', doc
-      nop << action
-      exec = Nokogiri::XML::Node.new 'exec', doc
-      exec['play_pcap_audio'] = "#{@filename}.pcap"
-      action << exec
+      nop = doc.create_element('nop') { |nop|
+        nop << doc.create_element('action') { |action|
+          action << doc.create_element('exec')
+        }
+      }
+
+      @media_nodes << nop
       scenario_node << nop
     end
 

data/lib/sippy_cup/version.rb

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

data/sippy_cup.gemspec

@@ -21,7 +21,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 'psych', ["~> 2.0.0"] unless RUBY_PLATFORM == 'java'
+  s.add_runtime_dependency 'psych', ["~> 2.0.1"] unless RUBY_PLATFORM == 'java'
 
   s.add_development_dependency 'guard-rspec'
   s.add_development_dependency 'rspec', ["~> 2.11"]

data/spec/sippy_cup/media_spec.rb

@@ -13,6 +13,15 @@ describe SippyCup::Media do
     @media.sequence.should be_empty
   end
 
+  it 'should correctly report itself as empty' do
+    expect(@media.empty?).to be true
+  end
+
+  it 'should correctly report itself as non-empty' do
+    @media << 'silence:1000'
+    expect(@media.empty?).to be false
+  end
+
   it 'should append a valid action to the sequence list' do
     @media << 'silence:1000'
     @media.sequence.include?('silence:1000').should be true