sippy_cup 0.2.3 → 0.3.0

data/lib/sippy_cup/tasks.rb

@@ -7,9 +7,9 @@ namespace :sippy_cup do
     require File.expand_path(args[:scenario])
   end
 
-  desc "Run the scenario described by the given YAML file"
+  desc "Run the scenario described by the given manifest file"
   task :run, :options_file do |t, args|
-  	options = YAML.load_file args[:options_file]
-    SippyCup::Runner.new(options).run
+  	scenario = SippyCup::Scenario.from_manifest File.read(args[:options_file])
+    SippyCup::Runner.new(scenario).run
   end
 end

data/lib/sippy_cup/version.rb

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

data/lib/sippy_cup/xml_scenario.rb

@@ -0,0 +1,57 @@
+require 'tempfile'
+
+module SippyCup
+  #
+  # A representation of a SIPp XML scenario
+  #
+  class XMLScenario
+    # @return [Hash] The options the scenario was created with, either from a manifest or passed as overrides
+    attr_reader :scenario_options
+
+    #
+    # Create a scenario instance
+    #
+    # @param [String] name The scenario's name
+    # @param [String] xml The XML document representing the scenario
+    # @param [String] media The media to be invoked by the scenario in PCAP format
+    # @param [Hash] args options to customise the scenario. @see Scenario#initialize.
+    #
+    def initialize(name, xml, media, args = {})
+      @xml, @media = xml, media
+      @scenario_options = args.merge name: name
+    end
+
+    #
+    # Write compiled Scenario XML and PCAP media 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.
+    #
+    # @return [Hash<Symbol => Tempfile>] handles to created Tempfiles at :scenario and :media
+    #
+    # @see http://www.ruby-doc.org/stdlib-1.9.3/libdoc/tempfile/rdoc/Tempfile.html
+    #
+    def to_tmpfiles
+      scenario_file = Tempfile.new 'scenario'
+      scenario_file.write @xml
+      scenario_file.rewind
+
+      if @media
+        media_file = Tempfile.new 'media'
+        media_file.write @media
+        media_file.rewind
+      else
+        media_file = nil
+      end
+
+      {scenario: scenario_file, media: media_file}
+    end
+
+    #
+    # Dump the scenario to a SIPp XML string
+    #
+    # @return [String] the SIPp XML scenario
+    def to_xml
+      @xml
+    end
+  end
+end

data/lib/sippy_cup.rb

@@ -1,5 +1,6 @@
 %w{
   scenario
+  xml_scenario
   media
   runner
 }.each {|r| require "sippy_cup/#{r}"}

data/sippy_cup.gemspec

@@ -21,10 +21,11 @@ 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_development_dependency 'guard-rspec'
   s.add_development_dependency 'rspec', ["~> 2.11"]
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'simplecov-rcov'
-  s.add_development_dependency 'ci_reporter'
+  s.add_development_dependency 'fakefs'
 end

data/spec/fixtures/scenario.xml

@@ -0,0 +1,73 @@
+<?xml version="1.0"?>
+<scenario name="spec scenario">
+  <send retrans="500">
+<![CDATA[
+INVITE sip:[service]@[remote_ip]:[remote_port] 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]
+To: <sip:[service]@[remote_ip]:[remote_port]>
+Call-ID: [call_id]
+CSeq: [cseq] INVITE
+Contact: <sip:#{specs_from}@[local_ip]:[local_port];transport=[transport]>
+Max-Forwards: 100
+User-Agent: SIPp/sippy_cup
+Content-Type: application/sdp
+Content-Length: [len]
+
+v=0
+o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+s=-
+c=IN IP[media_ip_type] [media_ip]
+t=0 0
+m=audio [media_port] RTP/AVPF 0 101
+a=rtcp:[media_port+1]
+a=rtpmap:0 PCMU/8000
+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="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:]
+Call-ID: [call_id]
+CSeq: [cseq] ACK
+Contact: <sip:#{specs_from}@[local_ip]:[local_port];transport=[transport]>
+Max-Forwards: 100
+User-Agent: SIPp/sippy_cup
+Content-Length: 0
+[routes]
+]]>
+</send>
+  <nop>
+    <action>
+      <exec play_pcap_audio="/tmp/spec_scenario.pcap"/>
+    </action>
+  </nop>
+  <pause milliseconds="3000"/>
+  <pause milliseconds="5000"/>
+  <pause milliseconds="5000"/>
+  <pause milliseconds="500"/>
+  <recv request="BYE"/>
+  <send>
+<![CDATA[
+SIP/2.0 200 OK
+[last_Via:]
+[last_From:]
+[last_To:]
+[last_Call-ID:]
+[last_CSeq:]
+Contact: <sip:#{specs_from}@[local_ip]:[local_port];transport=[transport]>
+Max-Forwards: 100
+User-Agent: SIPp/sippy_cup
+Content-Length: 0
+[routes]
+]]>
+</send>
+</scenario>

data/spec/sippy_cup/fixtures/test.yml

@@ -0,0 +1,16 @@
+---
+name: My test scenario
+source: 192.0.2.15
+destination: 192.0.2.200
+max_concurrent: 10
+calls_per_second: 5
+number_of_calls: 20
+steps:
+  - invite
+  - wait_for_answer
+  - ack_answer
+  - sleep 3
+  - send_digits '3125551234'
+  - sleep 5
+  - send_digits '#'
+  - wait_for_hangup