dbrady-tourbus 0.0.7 → 0.0.8

data/{README.txt → README.rdoc}

@@ -6,6 +6,7 @@ Flexible and scalable website testing tool.
 
 * David Brady -- david.brady@leadmediapartners.com
 * Tim Harper -- tim.harper@leadmediapartners.com
+* James Britt -- http://github.com/jamesbritt
 
 == General Info
 
@@ -54,22 +55,48 @@ better name, these are called Tours.
 
 === Example TourBus Run
 
-tourbus -c 2 -n 3 simple
+You want to invoke +tourbus+ from the parent directory of the @tours/@ folder.
 
-This will create 2 concurrent Tour runners, each of which will run all
+For example, if you have this project  tree ...
+
+    `-- contact_app
+        |-- README.rdoc
+        |-- contact_app.rb
+        `-- tours
+            |-- simple.rb
+            `-- tourbus.yml
+
+... then you execute  +tourbus+ from the +contact_app/+ directory.
+
+    tourbus -c 2 -n 3 simple
+
+That will run the +simple.rb+ tour file.
+
+It will create 2 concurrent Tour runners, each of which will run all
 of the methods in Simple three times.
 
 * You can specify multiple tours.
 
+  tourbus -c 2 -n 3 simple1 simple2 simple3
+
 * If you don't specify a tour, all tours in ./tours will be run.
 
 * tourbus --help will give you more information.
 
+* You can run tours and filter given tests.
+
+  tourbus -c 2 -n 3 simple -t test_login,test_logout
+
+Note that if you specify multiple tours and filter tests, the filtered
+tests will be run on all tours specified. If you do not specify a
+tour, the filtered tests will be run on all tours found in the
++./tours+ folder.
+
 === Example TourWatch Run
 
 On the webserver, you can type 
 
-tourwatch -c 4
+    tourwatch -c 4
 
 To begin running tourwatch. It's basically a stripped-down version of
 top with cheesy text graphs. (TourWatch's development cycles were
@@ -82,7 +109,7 @@ included in the 2 days for TourBus.)
 
 * You can choose which processes to watch by passing a csv to -p:
   
-  tourwatch -p ruby,mongrel
+    tourwatch -p ruby,mongrel
 
   Each process name is a partial regexp, so the above would match
   mongrel AND mongrel_rails, etc.
@@ -110,7 +137,8 @@ duplications, oversights, and kludges.
   didn't put tests on it. I haven't put tests on it yet because I'm
   not sure how to go about it. Instead of exercising a web app with a
   test browser, we need to exercise a test browser with... um... a web
-  app?
+  app? (dbrady notes: Now that we have a contact_app, we could try
+  writing some specs and features to run tourbus against it.)
 
 * Web-Sickle is another internal app, written by Tim Harper, that
   works "well enough". Until I open-sourced this project, it was a
@@ -118,12 +146,31 @@ duplications, oversights, and kludges.
   from WebSickle itself, so there's a lot of code in Runner that
   really belongs in WebSickle.
 
-* Documentation is horrible.
+* Documentation is <strike>horrible</strike> merely quite bad.
 
 * There's not much in the way of examples, either. When I removed all
   the LMP-specific code, all of the examples went with it. Sorry about
   that. Coming soon.
 
+== Feature Requests (How You Can Help!)
+
+* I'd like to beef up the example contact app to show more of TourBus
+  than the simplest possible path. Adding in another page or two, and
+  then adding an additional tour or two would make it more apparent to
+  new users that you can do things like run multiple tours at once.
+  Also, having more than one test_ method in simple.rb would let us
+  demonstrate test filtering as well. (Be aware that at present
+  [2009-04-17], webrat still does not play well with Sinatra sessions
+  so there would be complications. dbrady's fork of webrat combines
+  jferris' fix with the latest webrat, and will be maintained until
+  main webrat includes the feature. That fork is at
+  http://github.com/dbrady/webrat)
+
+* I'd like to remove WebSickle and replace it with Webrat. There is a
+  webrat branch on the main fork (http://github.com/dbrady/tourbus)
+  that is 90% complete. Once that's done we can start massaging the
+  API to be a little more friendly.
+
 == Credits
 
 * Tim Harper camped at my place for a day fixing bugs in WebSickle as
@@ -133,6 +180,9 @@ duplications, oversights, and kludges.
   source it. How much do they rock? All the way to 11, that's how much
   they rock.
 
+* James Britt jumped on this and revived it as it was gathering dust.
+  Thanks!
+
 == License
 
 MIT. See the license file.

data/bin/tourbus

@@ -7,7 +7,7 @@ require_all_files_in_folder 'tours'
 config_file = ["./tourbus.yml", "./tours/tourbus.yml", "./config/tourbus.yml", "~/tourbus.yml"].map {|p| File.expand_path(p)}.find {|p| File.exists? p}
 config = config_file ? YAML::load_file(config_file).symbolize_keys : {}
 
-config_map = { :host => :to_s, :concurrency => :to_i, :number => :to_i, :rand => :to_i }
+config_map = { :host => :to_s, :concurrency => :to_i, :number => :to_i, :rand => :to_i, :tests => :to_s }
 config_map.each {|key,conv| config[key] = config[key].send(conv) if config.key? key }
 
 # defaults
@@ -22,10 +22,11 @@ opts = Trollop.options do
   opt :number, "Number of times to run the tour (in each concurrent step, so -c 10 -n 10 will run the tour 100 times)", :type => :integer, :default => config[:number]
   opt :list, "List tours and runs available. If tours or runs are included, filters the list", :type => :boolean, :default => nil
   opt :rand, "Random seed", :type => :integer, :default => config[:rand]
+  opt :tests, "Test name(s) filter. The name of the test to run (use --list to see the test names). Use commas, no spaces, for mulitple names",  :type => :string, :default => nil
 end
 
 tours = if ARGV.empty?
-           Dir[File.join('.', 'tours', '*.rb')].map {|f| File.basename(f, ".rb")}
+          Tour.tours
          else
            ARGV
          end
@@ -38,6 +39,8 @@ if opts[:list]
     puts Tour.tests(tour).map {|test| "  #{test}"}
   end
 else
-  TourBus.new(opts[:host], opts[:concurrency], opts[:number], tours).run
+  opts[:tests] = opts[:tests].split(',')
+  
+  TourBus.new(opts[:host], opts[:concurrency], opts[:number], tours, opts[:tests]).run
 end
 

data/lib/runner.rb

@@ -4,23 +4,31 @@ require 'common'
 class Runner
   attr_reader :host, :tours, :number, :runner_type, :runner_id
   
-  def initialize(host, tours, number, runner_id)
-    @host, @tours, @number, @runner_id = host, tours, number, runner_id
+  def initialize(host, tours, number, runner_id, test_list)
+    @host, @tours, @number, @runner_id, @test_list = host, tours, number, runner_id, test_list
     @runner_type = self.send(:class).to_s
     log("Ready to run #{@runner_type}")
   end
   
   # Dispatches to subclass run method
-  def run_tours
-    runs,passes,fails,errors = 0,0,0,0
+  def run_tours test_list = []
+    log "Filtering on tests #{test_list.join(', ')}" unless test_list.to_a.empty?
+    tours,tests,passes,fails,errors = 0,0,0,0,0
     1.upto(number) do |num|
       log("Starting #{@runner_type} run #{num}/#{number}")
-      @tours.each do |tour|
-        runs += 1
-        tour = Tour.make_tour(tour,@host,@tours,@number,@runner_id)
+      @tours.each do |tour_name|
+        
+        log("Starting run #{number} of Tour #{tour_name}")
+        tours += 1
+        tour = Tour.make_tour(tour_name,@host,@tours,@number,@runner_id)
         tour.tests.each do |test|
+
+          next if !test_list.empty? && !test_list.include?(test.to_s) 
+
           begin
+            tests += 1
             tour.run_test test
+            passes += 1
           rescue TourBusException, WebsickleException => e
             log("********** FAILURE IN RUN! **********")
             log e.message
@@ -38,14 +46,13 @@ class Runner
             end
             errors += 1
           end 
-
+          log("Finished run #{number} of Tour #{tour_name}")
         end
       end
-      passes += 1
       log("Finished #{@runner_type} run #{num}/#{number}")
     end
-    log("Finished all #{@runner_type} runs.")
-    [runs,passes,fails,errors]
+    log("Finished all #{@runner_type} tours.")
+    [tours,tests,passes,fails,errors]
   end
   
   protected

data/lib/tour.rb

@@ -117,5 +117,22 @@ class Tour
     end
     log "Page body ok (matches #{pattern})"
   end
+
+
+
+  # True if page does not contain (or match) the given string (or regexp)
+  # 
+  # TODO: Refactor me--these were separated out back when Websickle
+  # was a shared submodule and we couldn't pollute it. Now that it's
+  # frozen these probably belong there.
+  def assert_page_body_does_not_contain(pattern)
+    case pattern
+    when String:
+        raise WebsickleException, "Expected page body to not contain String '#{pattern}' but it did. It was #{page.body}" if page.body.to_s.index(pattern)
+    when Regexp:
+        raise WebsickleException, "Expected page body to not match Regexp '#{pattern}' but it did. It was #{page.body}" if  page.body.to_s =~ pattern
+    end
+    log "Page body ok (does not match #{pattern})"
+  end
 end
 

data/lib/tour_bus.rb

@@ -1,12 +1,12 @@
 require 'benchmark'
 
 class TourBus < Monitor
-  attr_reader :host, :concurrency, :number, :tours, :runs, :passes, :fails, :errors, :benchmarks
+  attr_reader :host, :concurrency, :number, :tours, :runs, :tests, :passes, :fails, :errors, :benchmarks
   
-  def initialize(host="localhost", concurrency=1, number=1, tours=[])
-    @host, @concurrency, @number, @tours = host, concurrency, number, tours
+  def initialize(host="localhost", concurrency=1, number=1, tours=[], test_list=nil)
+    @host, @concurrency, @number, @tours, @test_list = host, concurrency, number, tours, test_list
     @runner_id = 0
-    @runs, @passes, @fails, @errors = 0,0,0,0
+    @runs, @tests, @passes, @fails, @errors = 0,0,0,0,0
     super()
   end
   
@@ -16,9 +16,10 @@ class TourBus < Monitor
     end 
   end
   
-  def update_stats(runs,passes,fails,errors)
+  def update_stats(runs,tests,passes,fails,errors)
     synchronize do
       @runs += runs
+      @tests += tests
       @passes += passes
       @fails += fails
       @errors += errors
@@ -48,11 +49,11 @@ class TourBus < Monitor
       log "Starting #{tour_name}"
       threads << Thread.new do
         runner_id = next_runner_id
-        runs,passes,fails,errors,start = 0,0,0,0,Time.now.to_f
+        runs,tests,passes,fails,errors,start = 0,0,0,0,0,Time.now.to_f
         bm = Benchmark.measure do
-          runner = Runner.new(@host, @tours, @number, runner_id)
-          runs,passes,fails,errors = runner.run_tours
-          update_stats runs, passes, fails, errors
+          runner = Runner.new(@host, @tours, @number, runner_id, @test_list)
+          runs,tests,passes,fails,errors = runner.run_tours(@test_list)
+          update_stats runs, tests, passes, fails, errors
         end
         log "Runner Finished!"
         log "Runner finished in %0.3f seconds" % (Time.now.to_f - start)
@@ -66,12 +67,13 @@ class TourBus < Monitor
     log '-' * 80
     log tour_name
     log "All Runners finished."
-    log "Total Runs: #{@runs}"
+    log "Total Tours: #{@runs}"
+    log "Total Tests: #{@tests}"
     log "Total Passes: #{@passes}"
     log "Total Fails: #{@fails}"
     log "Total Errors: #{@errors}"
     log "Elapsed Time: #{finished - started}"
-    log "Speed: %5.3f v/s" % (@runs / (finished-started))
+    log "Speed: %5.3f tours/sec" % (@runs / (finished-started))
     log '-' * 80
     if @fails > 0 || @errors > 0
       log '********************************************************************************'

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification 
 name: dbrady-tourbus
 version: !ruby/object:Gem::Version 
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors: 
 - David Brady
+- James Britt
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-01-10 00:00:00 -08:00
+date: 2009-04-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: TourBus web stress-testing tool
+description: TourBus, a web stress-testing tool that combines complex 'tour' definitions with scalable concurrent testing
 email: github@shinybit.com
 executables: 
 - tourbus
@@ -60,7 +61,7 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- README.txt
+- README.rdoc
 - MIT-LICENSE
 - examples/contact_app/README.rdoc
 files: 
@@ -86,16 +87,16 @@ files:
 - lib/web-sickle/spec/spec_helper.rb
 - lib/web-sickle/spec/spec_helpers/mechanize_mock_helper.rb
 - lib/web-sickle/spec/web_sickle_spec.rb
-- README.txt
+- README.rdoc
 - MIT-LICENSE
 has_rdoc: true
-homepage: http://github.com/dbrady/tourbus
+homepage: http://github.com/jamesbritt/tourbus/
 post_install_message: 
 rdoc_options: 
 - --line-numbers
 - --inline-source
 - --main
-- README.txt
+- README.rdoc
 - --title
 - Tourbus - Web Stress Testing in Ruby
 require_paths: