Sipper 1.1.3

data/sipper/bin/common.rb

@@ -0,0 +1,42 @@
+require 'fileutils'
+require 'sipper_configurator'
+
+module SipperUtil
+  class Common
+    @@project_dir = nil
+    # Returns base proj dir if called from within a project directory. 
+    def self.in_project_dir
+      unless @@project_dir 
+        dir = FileUtils.pwd
+        try_files = [File.join(dir,".sipper.proj"), File.join(dir,"..",".sipper.proj"), File.join(dir,"..","..",".sipper.proj")]
+        try_files.each_with_index do |f,i|  
+          if File.exist? f 
+            pd = case i
+            when 0
+              dir
+            when 1
+              File.join(dir,"..")
+            when 2
+              File.join(dir,"..","..")
+            end
+            @@project_dir =  pd
+          end
+        end
+      end
+      return @@project_dir
+    end
+    
+    def self.set_environment
+      dir = SipperUtil::Common.in_project_dir()
+      if dir
+        cf = File.join(dir, "config", "sipper.cfg")
+        SipperConfigurator.load_yaml_file(cf) if File.exist? cf
+      end
+      dir
+    end
+    
+  end  # class
+  
+  
+  
+end # module

data/sipper/bin/generate.rb

@@ -0,0 +1,70 @@
+# todo let gems create an executable that can run this from anywhere. 
+
+$:.unshift File.join(File.dirname(__FILE__),"..")
+
+require 'sipper_configurator'
+require 'bin/common'
+
+dir = SipperUtil::Common.set_environment()
+
+require "generators/gen_controller"
+require "generators/gen_test"
+
+Signal.trap("INT") { puts; exit }
+
+
+require File.dirname(__FILE__) + '/../version'
+
+
+def __print_usage
+  puts "Options:   --version | -v  => print version information"
+  puts "           --help | -h  => print this message"
+  puts "           -c|-t [-r] <class_name> <flow_str>"
+  puts "         => -c for controller and -t for test generation"
+  puts "         => -r to optionally generate the reverse or opposite"
+  puts "            flow from flow_str."
+  puts "            i.e if flow indicates UAS then generate a UAC etc."
+  puts "         => <class_name> is the name of class to be generated, "
+  puts "            controller or test."
+  puts "         => <flow_str> is the actual call flow." 
+  puts "            e.g. '< INVITE, > 100, > 200 {2,7}, < ACK'" 
+  exit(0)
+end
+
+if %w(--version -v).include? ARGV.first
+  puts "generate #{SIP::VERSION::STRING}"
+  exit(0)
+end
+
+if ((ARGV.length < 3) || %w(--help -h).include?(ARGV.first) || !(%w(-t -c).include?(ARGV.first)))
+  __print_usage
+end
+
+
+type = ARGV.shift
+reverse = false
+if ARGV.first == "-r"
+  reverse = true
+  ARGV.shift  
+end
+
+gcls = ARGV.shift # class name
+flow = ARGV.shift.dup
+
+unless gcls && flow 
+  __print_usage
+end
+
+if reverse
+  flow.gsub!("<", "~").gsub!(">", "<").gsub!("~", ">")
+end
+
+if type == "-c"
+  g = SIP::Generators::GenController.new(gcls, flow)
+  g.generate_controller(true, dir.nil? ? nil : File.join(dir, "controllers") )
+elsif type == "-t"
+  g = SIP::Generators::GenTest.new(gcls, flow)
+  g.generate_test(true, dir.nil? ? nil : File.join(dir, "tests"))
+else
+  __print_usage
+end

data/sipper/bin/project.rb

@@ -0,0 +1,44 @@
+ 
+require File.join(File.dirname(__FILE__), "..", "generators", "gen_project")
+
+Signal.trap("INT") { puts; exit }
+
+require File.dirname(__FILE__) + '/../version'
+
+
+def __print_usage
+  usage = <<-EOF
+  Usage : sproj [-f] <name_of_project> 
+    This command creates a new directory by the name 'name_of_project'
+    and creates a directory structure under it for the project. 
+    The only optional argument is -f to force create the project directory.  
+    Please see user manual for details of the directory structure. 
+  EOF
+  puts usage
+  exit(0)
+end
+
+if %w(--version -v).include? ARGV.first
+  puts "generate #{SIP::VERSION::STRING}"
+  exit(0)
+end
+
+if ((ARGV.length > 2) || (ARGV.length == 0) || %w(--help -h).include?(ARGV.first) )
+  __print_usage
+end
+
+if "-f".include?(ARGV.first)
+  ARGV.shift
+  flag = true
+else
+  flag = false
+end
+
+name = ARGV.shift
+
+begin
+  SIP::Generators::GenProject.new(name, flag)
+#rescue
+#  __print_usage
+#  raise
+end

data/sipper/bin/run.rb

@@ -0,0 +1,85 @@
+# todo let gems create an executable that can run this from anywhere. 
+require 'fileutils'
+
+$:.unshift File.join(File.dirname(__FILE__),"..")
+
+require 'sipper_configurator'
+
+#Signal.trap("INT") { puts; exit }
+
+require File.dirname(__FILE__) + '/../version'
+def __print_usage
+  puts " --version | -v  => print version information"
+  puts " --help | -h  => print this message"
+  puts ""
+  puts " [-i <local_ip>] [-p <local_port>] [-r <remote_ip>] [-o remote_port>]  [-c|-t <file_name>]"
+  puts "  => -c for controller and -t for test generation"
+  puts "  => <file_name> is the name of test or controller class to be run."
+  puts " The default local port while running the controller is 5060 and the default remote port is "
+  puts " also 5060. While running the test the default local port is 5066, remote is 5060"
+  puts " In its simplest usage, you can just start sipper by running it "
+  puts " without arguments. The controllers in this case are loaded from "
+  puts " the default controller path location. "
+  exit(0)
+end
+
+if %w(--help -h).include?(ARGV.first)
+  __print_usage
+end
+
+if %w(--version -v).include? ARGV.first
+  puts "sipper #{SIP::VERSION::STRING}"
+  exit(0)
+end
+
+
+
+
+
+if ARGV.length == 0
+  require 'bin/common'
+  require File.join(File.dirname(__FILE__), "..", "run", "run_sipper1")
+  RunSipper1.new.run
+else
+  # [-i <local_ip>] [-p <local_port>] [-r <remote_ip>] [-o remote_port>]  [-c|-t <file_name>]"
+  # Adding a bitwise mask to remember what was sent by commandline
+  # lip lp rip rp (8 4 2 1)
+  p = nil
+  ARGV.each_with_index do |arg, i|  
+    if arg == "-m" 
+      SipperConfigurator[:SipperMediaDefaultControlPort] = Integer(ARGV[i+1])
+    elsif arg == "-i" 
+      SipperConfigurator[:LocalSipperIP] = ARGV[i+1]
+      SipperConfigurator[:CommandlineBitmask] |= 8
+    elsif arg == "-p" 
+      p = SipperConfigurator[:LocalSipperPort] = Integer(ARGV[i+1])
+      SipperConfigurator[:CommandlineBitmask] |= 4
+    elsif arg == "-r" 
+      SipperConfigurator[:DefaultRIP] = ARGV[i+1]
+      SipperConfigurator[:CommandlineBitmask] |= 2
+    elsif arg == "-o"
+      SipperConfigurator[:DefaultRP] = Integer(ARGV[i+1])
+      SipperConfigurator[:CommandlineBitmask] |= 1
+    elsif arg == "-rf"
+      SipperConfigurator[:SipperRunFor] = Integer(ARGV[i+1])
+    elsif arg == "-t"
+      SipperConfigurator[:LocalTestPort] = p if p
+      f = ARGV[i+1]
+      unless $ULOGNAME
+        $ULOGNAME = '_'+File.basename(f)[0...-3]
+      end
+      ARGV.clear # clear the args
+      require 'bin/common'
+      load f
+    elsif arg == "-c"
+      unless $ULOGNAME
+        $ULOGNAME = '_' + File.basename(ARGV[i+1])[0...-3]
+      end
+      require 'bin/common'
+      require File.join(File.dirname(__FILE__), "..", "run", "run_sipper1")
+      r = RunSipper1.new(ARGV[i+1])
+      r.run
+    end  
+  end
+end
+

data/sipper/bin/run_smoke.rb

@@ -0,0 +1,8 @@
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "..","sipper_test")
+
+Signal.trap("INT") { puts; exit }
+
+require File.dirname(__FILE__) + '/../version'
+
+require File.join(File.dirname(__FILE__), "..", "..","sipper_test", "ts_smoke.rb")

data/sipper/config/log4r.xml

@@ -0,0 +1,71 @@
+<log4r_config>
+  <pre_config>
+    <global level="DEBUG"/>
+  </pre_config>
+
+  <!-- Outputters -->
+
+  <outputter name="sipout" type="FileOutputter" level="DEBUG">
+    <filename>#{logpath}/#{pid}_sipper.log</filename>
+    <formatter name="aformat" type="PatternFormatter" pattern="[%l]:[%d]:[%h]:%C :: %m">
+      <date_method>to_f</date_method>
+    </formatter>
+  </outputter>
+  
+  <outputter name="sipmsgtrace" type="FileOutputter" level="DEBUG">
+    <filename>#{logpath}/#{pid}#{udfname}_sipmsgtrace.log</filename>
+    <formatter name="aformat" type="PatternFormatter" pattern="[%d]:[%h]:: %m">
+      <date_method>to_f</date_method>
+    </formatter>
+  </outputter>
+  
+  
+  <!-- Spit any errors to the console. They merit special attention -->
+  <outputter name="console" type="StderrOutputter" level="FATAL"/>
+  
+  
+
+  <!-- Loggers -->
+
+  <logger name="siplog" level="DEBUG" additive="false" trace="true">
+    <outputters>sipout, console</outputters>
+  </logger>
+
+  <logger name="siplog::transport_udptransport" level="DEBUG" additive="true" trace="true"/>
+  <logger name="siplog::request" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::message" level="DEBUG" additive="true" trace="true"/>
+  <logger name="siplog::response" level="DEBUG" additive="true" trace="true"/>
+  <logger name="siplog::session" level="DEBUG" additive="true" trace="true"/>
+  <logger name="siplog::messagefill" level="DEBUG" additive="true" trace="true"/>
+  <logger name="siplog::sipmessagerouter" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::sessionmanager" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::sip_sipper" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::udpsession" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::detachedsession" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::udpsessionwrapper" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::sip_basecontroller" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::sip_controllerselector" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::sessionrecorder" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::sipperconfigurator" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::sip_controllerclassloader" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::sip_testcompletionsignalinghelper" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::sip_timermanager" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::sip_transaction_inviteclienttransaction" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::sip_transaction_inviteservertransaction" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::sip_transaction_noninviteservertransaction" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::sip_transaction_noninviteclienttransaction" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::sipperutil_expectationelement" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::sipperutil_commandelement" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::sipheaders_header" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::media_sippermediaproxy" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::media_sippermediamanager" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::media_sippermediaclient" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::media_sipperofferanswer" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::media_sipperdummymediaclient" level="DEBUG" additive="true" trace="false"/>
+  <logger name="siplog::sipperhttprequestdispatcher" level="DEBUG" additive="true" trace="false"/>
+  
+  <logger name="sipmsgtracelog" level="DEBUG" additive="false" trace="true">
+    <outputters>sipmsgtrace</outputters>
+  </logger>
+ 
+</log4r_config>

data/sipper/controller_class_loader.rb

@@ -0,0 +1,29 @@
+require 'sip_logger'
+require 'ruby_ext/string'
+
+module SIP
+  class ControllerClassLoader
+    
+    @@class_constants = []
+    
+    def self.clear_all
+      @@class_constants = []
+    end
+    
+    def self.load fpath
+      str = IO.read(fpath)
+      load_from_string(str)
+    end
+    
+    def self.load_from_string(str)
+      @@class_constants += str.all_class_names.select {|x| x=~ /Controller/}  # re-opened string in ruby_ext
+      Object.module_eval(str)  # load it in top level too. (could also be Kernel.load(path)
+    end
+    
+    def self.controllers 
+      SipLogger['siplog::sip_controllerclassloader'].debug("Controllers now are #{@@class_constants.uniq.join(',')} ") 
+      @@class_constants.uniq
+    end
+    
+  end
+end

data/sipper/controller_selector.rb

@@ -0,0 +1,119 @@
+# If the order.yaml does not have any controller then 
+# the cotrollers defined in the controllers directory are taken
+# in the alphabetical order, otherwise the order defined in 
+# the yaml is taken for the ones present, the rest are arranged alphabetically. 
+# There can be an optional block in the yaml file which is invoked to see 
+# if the controller should be invoked or not. Much like a rules engine.
+# If the controller doesnt want to handle a request, it returns false, true otherwise.
+# Data structure to check for on request 
+#  - [[fname, <controller_instance>, <block/proc>],..] ordered by order in yaml and then alphabetical
+#  Iteration-1 only ordered instance array, later add block
+
+require 'request'
+require 'yaml'
+require 'sip_logger'
+require 'util/sipper_util'
+require 'controller_class_loader'
+
+module SIP
+  class ControllerSelector
+    include SipLogger
+    include SipperUtil
+    
+    # this goes off and creates the controlllers and maintain
+    # the order map 
+    def initialize dir
+      @controllers = {} #  fqname=> instance 
+      @load_dir = dir
+      load_controllers dir  if @load_dir
+    end
+    
+    # Load all or a defined controller
+    # todo code to load a named controller
+    def load_controllers(dir=@load_dir, controller=nil)
+      dir = Dir.new(dir) unless dir.class <= Dir
+      order_arr = nil
+      dir.each do |f|
+        next if File.directory?(f)
+        path = File.join(dir.path, f)
+        logd("Path is #{path}")
+        if f=~/order.yaml/
+          @order_arr = SipperUtil.load_yaml(path)
+        elsif f=~/controller.rb$/
+          SIP::ControllerClassLoader.load( path )
+        end
+      end
+      create_controllers
+      logd("There are a total of #{@controllers.size} controllers, they are #{@controllers.keys.join(',')}")
+    end
+    
+   
+    def load_controller_from_string(str)
+      existing_controllers = SIP::ControllerClassLoader.controllers
+      SIP::ControllerClassLoader.load_from_string(str)
+      new_controllers = SIP::ControllerClassLoader.controllers - existing_controllers
+      name = nil
+      new_controllers.each do |fqcname|
+        create_controller( fqcname )
+        name = fqcname
+      end
+      name
+    end
+   
+    def get_controllers(request=nil)
+      if @order_arr
+        logd("order_arr present with #{@order_arr.join(',')}")
+        control_order = @controllers.sort do |x,y|
+          # todo DRY it when you have tests
+          (@order_arr.index(x[0])?@order_arr.index(x[0]):@order_arr.length) <=> (@order_arr.index(y[0])?@order_arr.index(y[0]):@order_arr.length)
+        end 
+      else
+        control_order = @controllers.sort
+      end
+      control_order.map {|x| x[1]}
+    end
+      
+    def get_controller(name)
+      @controllers[name]
+    end
+  
+  
+    def clear_all
+      @controllers = {}
+      @order_arr = nil
+      SIP::ControllerClassLoader.clear_all 
+    end
+  
+   
+    
+    def create_controllers
+      logd("Loading controller from ControllerClassFinder")
+      SIP::ControllerClassLoader.controllers.each do |fqcname|
+        create_controller(fqcname)  
+      end
+    end
+    
+    def create_controller(fqcname)
+      m = SipperUtil.constantize(fqcname)       
+      if m.class == Class
+        @controllers[fqcname] = inst = m.new  
+        if inst.order >= 0
+          if @order_arr
+            @order_arr.insert([inst.order, @order_arr.length].min, fqcname) 
+          else
+            @order_arr = [fqcname]
+          end
+        end
+      end
+    end
+    
+    private  :create_controllers 
+    
+  end
+end
+
+if $PROGRAM_NAME == __FILE__
+  cs = SIP::ControllerSelector.new(Dir.new(File.join(SipperConfigurator[:SipperBasePath], "sipper", "controllers")))
+  ctr = cs.get_controllers(nil)
+  ctr.each {|x| p x.name}  
+end