sippy_cup 0.3.0 → 0.4.0

data/spec/sippy_cup/runner_spec.rb

@@ -7,7 +7,7 @@ describe SippyCup::Runner do
 
   let(:settings) { {} }
   let(:default_settings) { { logger: logger } }
-  let(:command) { "sudo sipp -i 127.0.0.1" }
+  let(:command) { "sudo $(which sipp) -i 127.0.0.1" }
   let(:pid) { '1234' }
 
   let(:logger) { double }
@@ -17,8 +17,8 @@ describe SippyCup::Runner do
   let(:manifest) do
     <<-MANIFEST
 name: foobar
-source: 'doo@dah.com'
-destination: 'foo@bar.com'
+source: 'dah.com'
+destination: 'bar.com'
 max_concurrent: 5
 calls_per_second: 2
 number_of_calls: 10
@@ -47,7 +47,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 sipp -i doo@dah.com -p 8836 -sf #{full_scenario_path} -l 5 -m 10 -r 2 -s 1 foo@bar.com}
+      expect_command_execution %r{sudo \$\(which sipp\) -i dah.com -p 8836 -sf #{full_scenario_path} -l 5 -m 10 -r 2 -s 1 bar.com}
       subject.run
     end
 
@@ -72,12 +72,52 @@ steps:
       end
     end
 
+    context "async" do
+      let(:settings) { {async: true} }
+      it 'should not wait for SIPp to terminate' do
+        subject.stub :process_exit_status
+        subject.should_receive :spawn
+        Process.should_not_receive :wait2
+        subject.run
+      end
+    end
+
+    context "specifying arbitrary options in the manifest" do
+      let(:manifest) do
+        <<-MANIFEST
+name: foobar
+source: 'dah.com'
+destination: 'bar.com'
+max_concurrent: 5
+calls_per_second: 2
+number_of_calls: 10
+options:
+  trace_err: ~
+  foo: bar
+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 options to sipp' do
+        expect_command_execution(/-trace_err -foo bar/)
+        subject.run
+      end
+    end
+
     context "specifying a source port in the manifest" do
       let(:manifest) do
         <<-MANIFEST
 name: foobar
-source: 'doo@dah.com'
-destination: 'foo@bar.com'
+source: 'dah.com'
+destination: 'bar.com'
 max_concurrent: 5
 calls_per_second: 2
 number_of_calls: 10
@@ -100,16 +140,17 @@ steps:
       end
     end
 
-    context "specifying a from_user in the Scenario" do
+    context "specifying a to_user in the Scenario" do
       let(:manifest) do
         <<-MANIFEST
 name: foobar
-source: 'doo@dah.com'
-destination: 'foo@bar.com'
+source: 'dah.com'
+destination: 'bar.com'
 max_concurrent: 5
 calls_per_second: 2
 number_of_calls: 10
-from_user: frank
+from_user: pat
+to_user: frank
 steps:
   - invite
   - wait_for_answer
@@ -132,8 +173,8 @@ steps:
       let(:manifest) do
         <<-MANIFEST
 name: foobar
-source: 'doo@dah.com'
-destination: 'foo@bar.com'
+source: 'dah.com'
+destination: 'bar.com'
 max_concurrent: 5
 calls_per_second: 2
 number_of_calls: 10
@@ -160,8 +201,8 @@ steps:
       let(:manifest) do
         <<-MANIFEST
 name: foobar
-source: 'doo@dah.com'
-destination: 'foo@bar.com'
+source: 'dah.com'
+destination: 'bar.com'
 max_concurrent: 5
 calls_per_second: 2
 number_of_calls: 10
@@ -187,8 +228,8 @@ steps:
         let(:manifest) do
           <<-MANIFEST
 name: foobar
-source: 'doo@dah.com'
-destination: 'foo@bar.com'
+source: 'dah.com'
+destination: 'bar.com'
 max_concurrent: 5
 calls_per_second: 2
 number_of_calls: 10
@@ -231,8 +272,8 @@ steps:
       let(:manifest) do
         <<-MANIFEST
 name: foobar
-source: 'doo@dah.com'
-destination: 'foo@bar.com'
+source: 'dah.com'
+destination: 'bar.com'
 max_concurrent: 5
 calls_per_second: 2
 number_of_calls: 10
@@ -261,8 +302,8 @@ steps:
       let(:manifest) do
         <<-MANIFEST
 name: foobar
-source: 'doo@dah.com'
-destination: 'foo@bar.com'
+source: 'dah.com'
+destination: 'bar.com'
 max_concurrent: 5
 calls_per_second: 2
 number_of_calls: 10
@@ -427,6 +468,26 @@ steps:
     end
   end
 
+  describe '#wait' do
+    before { subject.sipp_pid = pid }
+    it "waits for the SIPp process" do
+      Process.should_receive(:wait2).with pid.to_i
+      subject.should_receive(:process_exit_status)
+      subject.should_receive(:cleanup_input_files)
+      subject.wait
+    end
+
+    context "async" do
+      subject { SippyCup::Runner.new scenario, logger: logger, async: true }
+      it "waits for the SIPp process and cleans up input files" do
+        Process.should_receive(:wait2).with pid.to_i
+        subject.should_receive(:process_exit_status)
+        subject.should_receive(:cleanup_input_files)
+        subject.wait
+      end
+    end
+  end
+
   describe '#stop' do
     before { subject.sipp_pid = pid }
 

data/spec/sippy_cup/scenario_spec.rb

@@ -233,6 +233,26 @@ describe SippyCup::Scenario do
     end
   end
 
+  describe '#receive_200' do
+    it "expects a 200" do
+      subject.receive_200
+
+      scenario.to_xml.should match(%q{<recv response="200"/>})
+    end
+
+    it "allows passing options to the recv expectation" do
+      subject.receive_200 foo: 'bar'
+
+      scenario.to_xml.should match(%q{<recv response="200" foo="bar"/>})
+    end
+
+    it "allows overriding options" do
+      subject.receive_200 response: 999 # Silly but still...
+
+      scenario.to_xml.should match(%q{<recv response="999"/>})
+    end
+  end
+
   describe '#ack_answer' do
     it "sends an ACK message" do
       subject.ack_answer
@@ -246,10 +266,20 @@ describe SippyCup::Scenario do
       subject.to_xml.should match(%r{<send foo="bar".*>})
     end
 
-    it "starts the PCAP media" do
-      subject.ack_answer
+    context "when media is present" do
+      before { subject.sleep 1 }
+
+      it "starts the PCAP media" do
+        subject.ack_answer
+        subject.to_xml(:pcap_path => "/dev/null").should match(%r{<nop>\n.*<action>\n.*<exec play_pcap_audio="/dev/null"/>\n.*</action>\n.*</nop>})
+      end
+    end
 
-      subject.to_xml.should match(%r{<nop>\n.*<action>\n.*<exec play_pcap_audio="/tmp/test.pcap"/>\n.*</action>\n.*</nop>})
+    context "when media is not present" do
+      it "does not start the PCAP media" do
+        subject.ack_answer
+        subject.to_xml(:pcap_path => "/dev/null").should_not match(%r{<nop>\n.*<action>\n.*<exec play_pcap_audio="/dev/null"/>\n.*</action>\n.*</nop>})
+      end
     end
 
     context "when a from user is specified" do
@@ -276,11 +306,11 @@ describe SippyCup::Scenario do
       scenario.wait_for_answer
 
       xml = scenario.to_xml
-      xml.should =~ /recv optional="true".*response="100"/
-      xml.should =~ /recv optional="true".*response="180"/
-      xml.should =~ /recv optional="true".*response="183"/
+      xml.should =~ /recv response="100".*optional="true"/
+      xml.should =~ /recv response="180".*optional="true"/
+      xml.should =~ /recv response="183".*optional="true"/
       xml.should =~ /recv response="200"/
-      xml.should_not =~ /recv optional="true".*response="200"/
+      xml.should_not =~ /recv response="200".*optional="true"/
     end
 
     it "passes through additional options" do
@@ -294,6 +324,30 @@ describe SippyCup::Scenario do
     end
   end
 
+  describe '#receive_message' do
+    it "expects a MESSAGE and acks it" do
+      subject.receive_message
+      subject.to_xml.should match(%r{<recv request="MESSAGE"/>.*SIP/2\.0 200 OK}m)
+    end
+
+    it "allows a string to be given as a regexp for matching" do
+      subject.receive_message "Hello World!"
+      subject.to_xml.should match(%r{<action>\s*<ereg regexp="Hello World!" search_in="body" check_it="true" assign_to="[^"]+"/>\s*</action>}m)
+    end
+
+    it "increments the variable name used for regexp matching because SIPp requires it to be unique" do
+      subject.receive_message "Hello World!"
+      subject.receive_message "Hello Again World!"
+      subject.receive_message "Goodbye World!"
+      subject.to_xml.should match(%r{<ereg [^>]* assign_to="([^"]+)_1"/>.*<ereg [^>]* assign_to="\1_2"/>.*<ereg [^>]* assign_to="\1_3"/>}m)
+    end
+
+    it "declares the variable used for regexp matching so that SIPp doesn't complain that it's unused" do
+      subject.receive_message "Hello World!"
+      subject.to_xml.should match(%r{<ereg [^>]* assign_to="([^"]+)"/>.*<Reference variables="\1"/>}m)
+    end
+  end
+
   describe '#send_bye' do
     it "sends a BYE message" do
       subject.send_bye
@@ -340,16 +394,16 @@ describe SippyCup::Scenario do
     end
   end
 
-  describe '#ack_bye' do
+  describe '#okay' do
     it "sends a 200 OK" do
-      subject.ack_bye
+      subject.okay
 
       subject.to_xml.should match(%r{<send>})
       subject.to_xml.should match(%r{SIP/2.0 200 OK})
     end
 
     it "allows setting options on the send instruction" do
-      subject.ack_bye foo: 'bar'
+      subject.okay foo: 'bar'
       subject.to_xml.should match(%r{<send foo="bar".*>})
     end
 
@@ -357,14 +411,14 @@ describe SippyCup::Scenario do
       let(:args) { {from_user: 'frank'} }
 
       it "includes the specified user in the Contact header" do
-        subject.ack_bye
+        subject.okay
         subject.to_xml.should match(%r{Contact: <sip:frank@})
       end
     end
 
     context "when no from user is specified" do
       it "uses a default of 'sipp' in the Contact header" do
-        subject.ack_bye
+        subject.okay
         subject.to_xml.should match(%r{Contact: <sip:sipp@})
       end
     end
@@ -379,15 +433,6 @@ describe SippyCup::Scenario do
     end
   end
 
-  describe '#ack_bye' do
-    it "sends a 200 OK" do
-      subject.ack_bye
-
-      subject.to_xml.should match(%r{<send>})
-      subject.to_xml.should match(%r{SIP/2.0 200 OK})
-    end
-  end
-
   describe 'media-dependent operations' do
     let(:media) { double :media }
     before do
@@ -437,6 +482,28 @@ describe SippyCup::Scenario do
     end
   end
 
+  describe "#send_digits with a SIP INFO DTMF mode" do
+    let(:args) { {dtmf_mode: 'info'} }
+
+    it "creates the requested DTMF string as SIP INFO messages" do
+      scenario.send_digits '136'
+
+      xml = scenario.to_xml
+      scenario.to_xml.should match(%r{(<send>.*INFO \[next_url\] SIP/2\.0.*</send>.*){3}}m)
+      scenario.to_xml.should match(%r{Signal=1(\nDuration=250\n).*Signal=3\1.*Signal=6\1}m)
+    end
+
+    it "expects a response for each digit sent" do
+      scenario.send_digits '123'
+      scenario.to_xml.should match(%r{(<send>.*INFO.*</send>.*<recv response="200"/>.*){3}}m)
+    end
+
+    it "inserts 250ms pauses between each digit" do
+      scenario.send_digits '321'
+      scenario.to_xml.should match(%r{(<send>.*INFO.*</send>.*<pause milliseconds="250"/>.*){3}}m)
+    end
+  end
+
   describe "#compile!" do
     context "when a filename is not provided" do
       it "writes the scenario XML to disk at name.xml" do
@@ -499,15 +566,32 @@ describe SippyCup::Scenario do
       File.read(files[:scenario].path).should eql(scenario.to_xml)
     end
 
-    it "writes the PCAP media to a Tempfile and returns it" do
-      files = scenario.to_tmpfiles
-      files[:media].should be_a(Tempfile)
-      files[:media].read.should_not be_empty
+    context "without media" do
+      it "does not write a PCAP media file" do
+        files = scenario.to_tmpfiles
+        files[:media].should be_nil
+      end
     end
 
-    it "allows the PCAP media to be read from disk independently" do
-      files = scenario.to_tmpfiles
-      File.read(files[:media].path).should_not be_empty
+    context "with media" do
+      before { scenario.sleep 1 }
+
+      it "writes the PCAP media to a Tempfile and returns it" do
+        files = scenario.to_tmpfiles
+        files[:media].should be_a(Tempfile)
+        files[:media].read.should_not be_empty
+      end
+
+      it "allows the PCAP media to be read from disk independently" do
+        files = scenario.to_tmpfiles
+        File.read(files[:media].path).should_not be_empty
+      end
+
+      it "puts the PCAP file path into the scenario XML" do
+        scenario.ack_answer
+        files = scenario.to_tmpfiles
+        files[:scenario].read.should match(%r{play_pcap_audio="#{files[:media].path}"})
+      end
     end
   end
 
@@ -540,16 +624,16 @@ a=rtpmap:101 telephone-event/8000
 a=fmtp:101 0-15
 ]]>
 </send>
-  <recv optional="true" response="100"/>
-  <recv optional="true" response="180"/>
-  <recv optional="true" response="183"/>
+  <recv response="100" optional="true"/>
+  <recv response="180" optional="true"/>
+  <recv response="183" optional="true"/>
   <recv response="200" rrs="true" rtd="true"/>
   <send>
 <![CDATA[
 ACK [next_url] SIP/2.0
 Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
 From: "sipp" <sip:sipp@[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:sipp@[local_ip]:[local_port];transport=[transport]>
@@ -559,11 +643,6 @@ Content-Length: 0
 [routes]
 ]]>
 </send>
-  <nop>
-    <action>
-      <exec play_pcap_audio="/tmp/test.pcap"/>
-    </action>
-  </nop>
   <recv request="BYE"/>
   <send>
 <![CDATA[
@@ -589,7 +668,7 @@ Content-Length: 0
 
       it "runs each step" do
         subject.build(steps)
-        subject.to_xml.should == scenario_xml
+        subject.to_xml(:pcap_path => "/dev/null").should == scenario_xml
       end
     end
 
@@ -653,16 +732,16 @@ a=rtpmap:101 telephone-event/8000
 a=fmtp:101 0-15
 ]]>
 </send>
-  <recv optional="true" response="100"/>
-  <recv optional="true" response="180"/>
-  <recv optional="true" response="183"/>
+  <recv response="100" optional="true"/>
+  <recv response="180" optional="true"/>
+  <recv response="183" optional="true"/>
   <recv response="200" rrs="true" rtd="true"/>
   <send>
 <![CDATA[
 ACK [next_url] SIP/2.0
 Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
 From: "#{specs_from}" <sip:#{specs_from}@[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:#{specs_from}@[local_ip]:[local_port];transport=[transport]>
@@ -674,7 +753,7 @@ Content-Length: 0
 </send>
   <nop>
     <action>
-      <exec play_pcap_audio="/tmp/spec_scenario.pcap"/>
+      <exec play_pcap_audio="/dev/null"/>
     </action>
   </nop>
   <pause milliseconds="3000"/>
@@ -705,7 +784,7 @@ Content-Length: 0
 
     it "generates the correct XML" do
       scenario = described_class.from_manifest(scenario_yaml)
-      scenario.to_xml.should == scenario_xml
+      scenario.to_xml(:pcap_path => "/dev/null").should == scenario_xml
     end
 
     it "sets the proper options" do
@@ -835,7 +914,7 @@ steps:
 
       it "overrides keys with values from the options hash" do
         scenario = described_class.from_manifest(scenario_yaml, override_options)
-        scenario.to_xml.should == scenario_xml
+        scenario.to_xml(:pcap_path => "/dev/null").should == scenario_xml
       end
 
       it "sets the proper options" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sippy_cup
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ben Klang
@@ -9,132 +9,132 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-20 00:00:00.000000000 Z
+date: 2014-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: packetfu
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.0
 - !ruby/object:Gem::Dependency
   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
   name: psych
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.11'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov-rcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: This tool makes it easier to generate SIPp load tests with DTMF interactions.
@@ -146,10 +146,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -163,7 +163,6 @@ files:
 - lib/sippy_cup/media/pcmu_payload.rb
 - lib/sippy_cup/media/rtp_header.rb
 - lib/sippy_cup/media/rtp_payload.rb
-- lib/sippy_cup/rtp_generator.rb
 - lib/sippy_cup/runner.rb
 - lib/sippy_cup/scenario.rb
 - lib/sippy_cup/tasks.rb
@@ -188,17 +187,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: SIPp profile and RTP stream generator