solutious-stella 0.7.0.003 → 0.7.0.004

data/README.rdoc

@@ -1,8 +1,9 @@
 = Stella - 0.7 PREVIEW
 
-Perform load tests on your web applications with beauty and brute strength.
+<b>Perform load tests on your web applications with beauty and brute strength.</b>
+
+
 
-<i>NOTE: 0.7 release is not compatible with previous releases!</i>
 
 == Features
 
@@ -10,13 +11,14 @@ Perform load tests on your web applications with beauty and brute strength.
 * Sophisticated response handling (with automatic HTML document parsing)
 * Dynamic variable replacement 
 
+
 == PREVIEW NOTICE
 
-This is an early preview of Stella. It's still missing the following features (as of 2009-09-15):
+This is an early preview of Stella. The following features are still under development (as of 2009-09-15):
 
 * Reporting of any kind. 
-* Documentation.
 * File uploads.
+* Documentation.
 
 == Usage Example
 
@@ -28,9 +30,6 @@ This is an early preview of Stella. It's still missing the following features (a
     # using the same test plan. 
     $ stella load -p examples/basic/plan.rb http://stellaaahhhh.com/
     
-    # Preview a test plan
-    $ stella preview -p examples/basic/plan.rb
-    
     
 == Test Plan Example
 
@@ -105,12 +104,14 @@ Get it in one of the following ways:
 * Delano Mandelbaum (http://solutious.com)
 * Threadify (C) Ara T Howard (http://codeforpeople.com/)
 
+
 == Thanks 
 
 * Harm Aarts for the great test case and feedback!
 * Kalin Harvey for keeping me on track.
 * Dave L, the best intern money can't buy. 
 
+
 == License
 
 See LICENSE.txt

data/bin/stella

@@ -81,14 +81,6 @@ class Stella::CLI::Definition
   end
   command :load => Stella::CLI
   
-  about "Preview a testplan"
-  usage "stella preview -p path/2/testplan.rb http://stellaaahhhh.com/"
-  option :p, :testplan, String, "Path to testplan" do |v|
-    raise Stella::InvalidOption, "Bad path: #{v}" unless File.exists?(v)
-    v
-  end
-  command :preview => Stella::CLI
-  
   about "Initialize Stella"
   command :init do
     Stella::Config.init
@@ -117,6 +109,7 @@ class Stella::CLI::Definition
       puts
       puts "Elapsed: %.2f seconds" % @elapsed.to_f
     end
+    exit obj.exit_code || 0
   end
   
 end

data/examples/basic/plan.rb

@@ -3,6 +3,7 @@
 desc "Business Finder Testplan"
 
 usecase 65, "Simple search" do
+  resource :search_terms, list('search_terms.csv')
   
   get "/", "Homepage" do
     wait 1..5
@@ -16,8 +17,8 @@ usecase 65, "Simple search" do
   
   get "/search", "Search Results" do
     wait 2..5
-    param :what  => 'Big'
-    param :where => ''
+    param :what  => random(:search_terms)
+    param :where => random(['Toronto', 'Montreal'])
     response 200 do
       listing = doc.css('div.listing').first
       set :lid, listing['id'].match(/(\d+)/)[0]
@@ -31,15 +32,18 @@ usecase 65, "Simple search" do
   
 end
 
-usecase "YAML API" do
-  resource :preset_listing_ids, list('listing_ids.csv')
-  
-  get "/listing/:lid.yaml", "Select listing" do
-    param :lid => random(:preset_listing_ids)
-    response 200 do
-      repeat 5
+usecase 10, "Self-serve" do
+  post "/listing/add", "Add a listing" do
+    wait 1..4 
+    param :name => random(8)
+    param :city => "Vancouver"
+    response 302 do
+      repeat 3
     end
   end
+end
+
+usecase "Listing API" do
   
   get '/listings.yaml', "View All" do
     response 200 do
@@ -49,7 +53,7 @@ usecase "YAML API" do
     end
   end
   
-  get "/listing/:lid.yaml", "Select listing" do
+  get "/listing/:lid.yaml", "Select (sequential)" do
     param :lid => rsequential(:current_listing_ids)
     response 200 do
       repeat 7
@@ -58,14 +62,3 @@ usecase "YAML API" do
   
 end
 
-usecase 10, "Self-serve" do
-  post "/listing/add" do
-    desc "Add a business"
-    wait 1..4 
-    param :name => random(8)
-    param :city => "Vancouver"
-    response 302 do
-      repeat 3
-    end
-  end
-end

data/examples/basic/search_terms.csv

@@ -0,0 +1,19 @@
+west
+smoked
+pen
+fire
+ink
+town
+big
+ti
+al
+furniture
+keyboard
+rods
+beads
+fu
+w
+pe
+op
+on
+k

data/{support → examples}/example_webapp.rb

@@ -15,6 +15,19 @@ set :port => 3114
 set :reload => true
 set :max_listings => 1000
 
+LISTINGS = [
+  { :id => 1000, :name => 'John West Smoked Oysters', :city => 'Toronto'  },
+  { :id => 1001, :name => 'Fire Town Lightning Rods', :city => 'Toronto'  },
+  { :id => 1002, :name => 'Oversized Pen and Ink Co', :city => 'Toronto'  },
+  { :id => 1003, :name => 'The Rathzenburg Brothers', :city => 'Toronto'  },
+  { :id => 1004, :name => 'Forever and Always Beads', :city => 'Montreal' },
+  { :id => 1005, :name => "Big Al's Flavour Country", :city => 'Montreal' },
+  { :id => 1006, :name => 'Big Time Furniture World', :city => 'Montreal' },
+  { :id => 1007, :name => 'High-End Keyboard Makers', :city => 'Montreal' }
+]
+
+set :listings => LISTINGS.clone
+
 #log = File.new("/dev/null", "a")
 #STDOUT.reopen(log)
 #STDERR.reopen(log)
@@ -100,16 +113,6 @@ get '/listings.yaml' do
   @listings.to_yaml
 end
 
-set :listings => [
-  { :id => 1000, :name => 'John West Smoked Oysters', :city => 'Toronto'  },
-  { :id => 1001, :name => 'Fire Town Lightning Rods', :city => 'Toronto'  },
-  { :id => 1002, :name => 'Oversized Pen and Ink Co', :city => 'Toronto'  },
-  { :id => 1003, :name => 'The Rathzenburg Brothers', :city => 'Toronto'  },
-  { :id => 1004, :name => 'Forever and Always Beads', :city => 'Montreal' },
-  { :id => 1005, :name => "Big Al's Flavour Country", :city => 'Montreal' },
-  { :id => 1006, :name => 'Big Time Furniture World', :city => 'Montreal' },
-  { :id => 1007, :name => 'High-End Keyboard Makers', :city => 'Montreal' }
-]
 
 before do
   @cookie = request.cookies["bff-history"]
@@ -118,6 +121,7 @@ before do
   if params[:clear] == 'true'
     @cookie[:history] = []
     @cookie[:location] = ''
+    set :listings => LISTINGS.clone
   end
   @cookie[:history].delete params[:what]
   @cookie[:history].unshift params[:what] unless blank?(params[:what])

data/examples/exceptions/plan.rb

@@ -0,0 +1,19 @@
+
+
+usecase "Exception Handling" do
+  
+  get "/search", "Search Results" do
+    wait 2..5
+    param :what  => random()
+    param :where => random('Toronto', 'Montreal', 'Vancouver')
+    response 200 do
+      listing = doc.css('div.listing').first
+      set :lid, listing['id'].match(/(\d+)/)[0]
+      raise NoListingResultFound if listing.nil?
+    end
+    response 404 do
+      raise NoSearchResults 
+    end
+  end
+  
+end

data/lib/stella.rb

@@ -35,6 +35,7 @@ module Stella
     
   @@logger = Drydock::Screen
   @@loglev = 1
+  @@debug  = false
   
   # Puts +msg+ to +@@logger+
   def li(*msg); msg.each { |m| @@logger.puts m } if !quiet? end
@@ -58,9 +59,9 @@ module Stella
   def enable_quiet; @@loglev = 0; end
   def disable_quiet; @@loglev = 1; end
 
-  def debug?; @@loglev > 3; end
-  def enable_debug; @@loglev = 4; end
-  def disable_debug; @@loglev = 1; end
+  def debug?; @@debug == true; end
+  def enable_debug; @@debug = true; end
+  def disable_debug; @@debug = false; end
   
   def rescue(&blk)
     blk.call

data/lib/stella/cli.rb

@@ -1,9 +1,11 @@
 
 
 class Stella::CLI < Drydock::Command
+  attr_accessor :exit_code
   
   def init
     @conf = Stella::Config.refresh
+    @exit_code = 0
   end
   
   def verify_valid?
@@ -14,7 +16,8 @@ class Stella::CLI < Drydock::Command
     opts = {}
     opts[:hosts] = @hosts
     opts[:benchmark] = true if @option.benchmark
-    Stella::Engine::Functional.run @testplan, opts
+    ret = Stella::Engine::Functional.run @testplan, opts
+    @exit_code = (ret ? 0 : 1)
   end
   
   def load_valid?
@@ -27,18 +30,9 @@ class Stella::CLI < Drydock::Command
     [:benchmark, :users, :repetitions, :delay, :time].each do |opt|
       opts[opt] = @option.send(opt) unless @option.send(opt).nil?
     end
-    Stella::Engine::Load.run @testplan, opts
+    ret = Stella::Engine::Load.run @testplan, opts
+    @exit_code = (ret ? 0 : 1)
   end
-  
-  def preview_valid?
-    create_testplan
-  end
-  
-  def preview
-    Stella.li2 "file: #{@option.testplan} (#{@testplan.digest})"
-    Stella.li @testplan.pretty
-  end
-
 
   private
   def create_testplan
@@ -46,18 +40,12 @@ class Stella::CLI < Drydock::Command
     if @option.testplan
       @testplan = Stella::Testplan.load_file @option.testplan
     else
-      @testplan = Stella::Testplan.new
-      usecase = Stella::Testplan::Usecase.new
-      @argv.each do |uri|
-        uri = URI.parse uri
-        uri.path = '/' if uri.path.empty?
-        req = usecase.add_request :get, uri.path
-        req.wait = @option.delay if @option.delay
-      end
-      @testplan.add_usecase usecase
+      opts = {}
+      opts[:delay] = @option.delay if @option.delay
+      @testplan = Stella::Testplan.new(@argv, opts)
     end
     @testplan.check!  # raise errors, update usecase ratios
-    Stella.ld "PLANHASH: #{@testplan.digest}"
+    Stella.li3 " File: #{@option.testplan} (#{@testplan.digest})", $/
     true
   end
   

data/lib/stella/client.rb

@@ -163,6 +163,17 @@ module Stella
       ret
     end
     
+    class ResponseError < Stella::Error
+      def initialize(k, m=nil)
+        @kind, @msg = k, m
+      end
+      def message
+        msg = "#{@kind}"
+        msg << ": #{@msg}" unless @msg.nil?
+        msg
+      end
+    end
+    
     class Container
       attr_accessor :usecase
       attr_accessor :response
@@ -170,6 +181,10 @@ module Stella
         @usecase = usecase
       end
       
+      def self.const_missing(const, *args)
+        ResponseError.new(const)
+      end
+      
       def doc
         # NOTE: It's important to parse the document on every 
         # request because this container is available for the

data/lib/stella/data.rb

@@ -1,11 +1,10 @@
 
 module Stella::Data
-  
-  module Helpers
     
+  module Helpers
     
-    def random(input=nil)
-      
+    def random(*args)
+      input = args.size > 1 ? args : args.first
       Proc.new do
         value = case input.class.to_s
         when "Symbol"
@@ -19,6 +18,7 @@ module Stella::Data
         when "NilClass"
           Stella::Utils.strand( rand(100) )
         end
+        raise Stella::Testplan::Usecase::UnknownResource, input if value.nil?
         Stella.ld "RANDVALUES: #{input} #{value.inspect}"
         value = value[ rand(value.size) ] if value.is_a?(Array)
         Stella.ld "SELECTED: #{value}"
@@ -26,7 +26,8 @@ module Stella::Data
       end
     end
     
-    def sequential(input=nil)
+    def sequential(*args)
+      input = args.size > 1 ? args : args.first
       digest = input.gibbler
       Proc.new do
         value = case input.class.to_s
@@ -52,7 +53,8 @@ module Stella::Data
       end
     end
     
-    def rsequential(input=nil)
+    def rsequential(*args)
+      input = args.size > 1 ? args : args.first
       digest = input.gibbler
       Proc.new do
         value = case input.class.to_s

data/lib/stella/engine.rb

@@ -32,8 +32,8 @@ module Stella::Engine
       container.headers.all.each do |pair|
         Stella.li3 "    %s: %s" % pair
       end
-      Stella.li3 $/, "  Content:"
-      Stella.li3 container.body.empty? ? '    [empty]' : container.body
+      Stella.li4 $/, "  Content:"
+      Stella.li4 container.body.empty? ? '    [empty]' : container.body
       Stella.li2 $/
     end
     

data/lib/stella/engine/functional.rb

@@ -12,11 +12,16 @@ module Stella::Engine
       }.merge! opts
       Stella.ld "OPTIONS: #{opts.inspect}"
       Stella.li2 "Hosts: " << opts[:hosts].join(', ') if !opts[:hosts].empty?
+      Stella.li plan.pretty
       
       client = Stella::Client.new opts[:hosts].first
       client.add_observer(self)
       client.enable_benchmark_mode if opts[:benchmark]
       
+      Stella.li $/, "Starting test...", $/
+      Drydock::Screen.flush
+      sleep 0.2
+      
       plan.usecases.each_with_index do |uc,i|
         desc = (uc.desc || "Usecase ##{i+1}")
         Stella.li ' %-65s '.att(:reverse).bright % [desc]
@@ -24,6 +29,8 @@ module Stella::Engine
       end
       
       Drydock::Screen.flush
+      
+      !plan.errors?
     end
     
   end

data/lib/stella/engine/load.rb

@@ -16,12 +16,21 @@ module Stella::Engine
       opts[:users] = 1000 if opts[:users] > 1000
       
       Stella.ld "OPTIONS: #{opts.inspect}"
-      Stella.li2 "Hosts: " << opts[:hosts].join(', ')
+      Stella.li3 "Hosts: " << opts[:hosts].join(', ')
+      Stella.li2 plan.pretty
       
       packages = build_thread_package plan, opts
+      Stella.li $/, "Prepared #{packages.size} virtual users..."
       Drydock::Screen.flush
       
+      
+      Stella.li $/, "Starting test...", $/
+      Drydock::Screen.flush
+      sleep 0.2
+      
       Thread.ify packages, :threads => opts[:users] do |package|
+        # TEMPFIX. The fill in build_thread_package is creating nil elements
+        next if package.nil? 
         (1..opts[:repetitions]).to_a.each do |rep|
           # We store client specific data in the usecase
           # so we clone it here so each thread is unique.
@@ -31,6 +40,8 @@ module Stella::Engine
       end
       
       Drydock::Screen.flush
+      
+      !plan.errors?
     end
     
   protected
@@ -42,7 +53,7 @@ module Stella::Engine
         @index, @client, @usecase = i, c, u
       end
     end
-  
+    
     def build_thread_package(plan, opts)
       packages, pointer = Array.new(opts[:users]), 0
       plan.usecases.each_with_index do |usecase,i|
@@ -78,7 +89,7 @@ module Stella::Engine
     
     def update_receive_response(client_id, usecase, meth, uri, req, params, container)
       desc = "#{usecase.desc} > #{req.desc}"
-      Stella.li '  Client%-3s %3d %-6s %-45s %s' % [client_id, container.status, req.http_method, desc, uri]
+      Stella.li2 '  Client%-3s %3d %-6s %-45s %s' % [client_id, container.status, req.http_method, desc, uri]
     end
     
     def update_execute_response_handler(client_id, req, container)

data/lib/stella/testplan.rb

@@ -7,17 +7,28 @@ class Testplan
   
   class WackyRatio < Stella::Error
   end
-
   
   attr_accessor :usecases
   attr_accessor :base_path
   attr_accessor :desc
   attr_reader :stats
   
-  def initialize
+  def initialize(uris=[], opts={})
     @desc, @usecases = "Stella's plan", []
     @testplan_current_ratio = 0
     @stats = Stella::Testplan::Stats.new
+    
+    unless uris.empty?
+      usecase = Stella::Testplan::Usecase.new
+      usecase.ratio = 1.0
+      uris.each do |uri|
+        uri = URI.parse uri
+        uri.path = '/' if uri.path.empty?
+        req = usecase.add_request :get, uri.path
+        req.wait = opts[:delay] if opts[:delay]
+      end
+      self.add_usecase usecase
+    end
   end
   
   def self.load_file(path)
@@ -29,6 +40,12 @@ class Testplan
     plan
   end
   
+  # Were there any errors in any of the usecases?
+  def errors?
+    Stella.ld "TODO: tally use case errors"
+    false
+  end
+  
   def check!
     # Adjust ratios if necessary
     needy = @usecases.select { |u| u.ratio == -1 }
@@ -74,7 +91,7 @@ class Testplan
     str << " %-50s ".att(:reverse) % [@desc]
     @usecases.each_with_index do |uc,i| 
       description = uc.desc || "Usecase ##{i+1}"
-      str << "  %s (%s)".bright % [description, uc.ratio]
+      str << "  %s (%s%%)".bright % [description, uc.ratio_pretty]
       requests = uc.requests.each do |r| 
         str << "    %-35s %s" % ["#{r.desc}:", r]
         if Stella.loglev > 2

data/lib/stella/testplan/usecase.rb

@@ -3,14 +3,34 @@
 module Stella
 class Testplan
   
+  #
+  # Any valid Ruby syntax will do the trick:
+  #
+  #     usecase(10, "Self-serve") {
+  #       post("/listing/add", "Add a listing") {
+  #         wait 1..4 
+  #         param :name => random(8)
+  #         param :city => "Vancouver"
+  #         response(302) {
+  #           repeat 3
+  #         }
+  #       }
+  #     }
+  #
   class Usecase
     include Gibbler::Complex
+    
     attr_accessor :desc
-    attr_accessor :requests
     attr_writer :ratio
+    
+    attr_accessor :requests
     attr_accessor :resources
     attr_accessor :base_path
     
+    class UnknownResource < Stella::Error
+      def message; "UnknownResource: #{@obj}"; end
+    end
+    
     def initialize(&blk)
       @requests, @resources = [], {}
       instance_eval &blk unless blk.nil?
@@ -32,6 +52,11 @@ class Testplan
       r
     end
     
+    def ratio_pretty
+      r = (@ratio || 0).to_f
+      r > 1.0 ? r.to_i : (r * 100).to_i
+    end
+    
     # Reads the contents of the file <tt>path</tt> (the current working
     # directory is assumed to be the same directory containing the test plan).
     def file(path)
@@ -64,4 +89,4 @@ class Testplan
     
   end
 end
-end
+end

data/lib/stella/version.rb

@@ -6,7 +6,7 @@ module Stella
       MAJOR = 0.freeze
       MINOR = 7.freeze
       TINY  = 0.freeze
-      PATCH = '003'.freeze
+      PATCH = '004'.freeze
     end
     def self.to_s; [MAJOR, MINOR, TINY].join('.'); end
     def self.to_f; self.to_s.to_f; end

data/stella.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
   s.name = "stella"
   s.rubyforge_project = 'stella'
-  s.version = "0.7.0.003"
+  s.version = "0.7.0.004"
   s.summary = "Stella: Your friend in performance testing."
   s.description = s.summary
   s.author = "Delano Mandelbaum"
@@ -29,8 +29,10 @@
   README.rdoc
   Rakefile
   bin/stella
-  examples/basic/listing_ids.csv
   examples/basic/plan.rb
+  examples/basic/search_terms.csv
+  examples/example_webapp.rb
+  examples/exceptions/plan.rb
   lib/stella.rb
   lib/stella/cli.rb
   lib/stella/client.rb
@@ -56,7 +58,6 @@
   lib/stella/version.rb
   lib/threadify.rb
   stella.gemspec
-  support/example_webapp.rb
   support/useragents.txt
   )
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: solutious-stella
 version: !ruby/object:Gem::Version 
-  version: 0.7.0.003
+  version: 0.7.0.004
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -78,8 +78,10 @@ files:
 - README.rdoc
 - Rakefile
 - bin/stella
-- examples/basic/listing_ids.csv
 - examples/basic/plan.rb
+- examples/basic/search_terms.csv
+- examples/example_webapp.rb
+- examples/exceptions/plan.rb
 - lib/stella.rb
 - lib/stella/cli.rb
 - lib/stella/client.rb
@@ -105,7 +107,6 @@ files:
 - lib/stella/version.rb
 - lib/threadify.rb
 - stella.gemspec
-- support/example_webapp.rb
 - support/useragents.txt
 has_rdoc: true
 homepage: http://solutious.com/projects/stella/

data/examples/basic/listing_ids.csv

@@ -1,7 +0,0 @@
-1000
-1001
-1002
-1003
-1004
-1005
-1006