solutious-stella 0.6.0 → 0.7.0.001

data/CHANGES.txt

@@ -1,21 +1,9 @@
 STELLA, CHANGES
 
-#### TODO
-
-* TODO: prepend instance variables with "stella_"
-* TODO: implement session handling
-* BUG: http://jira.codehaus.org/browse/JRUBY-2992
-* TODO: variable interpolation that happens at test time so instance variables can be grabbed from the calling space. 
-#
-#  get "/product/${token}" do
-#    ## TODO: Override environment settings. 
-#    #protocol :https
-#    response 200 do |headers, body|
-#      data = YAML.load(body)
-#      puts "ID: #{data[:id]}"
-#    end
-#  end
 
+#### 0.7.0 (2009-09-05) ###############################
+
+NOTE: Complete rewrite
 
 
 #### 0.6.0 (2009-03-15) ###############################

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Delano Mandelbaum
+Copyright (c) 2009 Solutious Inc, Delano Mandelbaum
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.rdoc

@@ -1,64 +1,91 @@
-= Stella - 0.6.0 ALPHA
-
-Stella is a Ruby library for writing functional tests in a sexy DSL (domain specific language).
-
-==== NOTE: The 0.6 release was a complete rewrite from previous versions. All commands, APIs, and documentation have changed!*
-
-== Example 1
-
-     testplan :maintain_value do
-       desc "Maintain a value between requests"
-       auth :basic, "stella", "stella"
-       protocol :http
-     
-       post "/upload" do
-         name "Add Product"
-         body "bill", "/path/2/file.txt"
-         header "X-Stella" => "Version #{Stella::VERSION}"
-         param :convert => true
-         param :rand => rand
-         
-         response 200, 201 do |headers, body, objid|
-           data = YAML.load(body)
-           @product_id = data[:id]                   # Save a response value
-         end
-       end
-       
-       get "/product" do
-         name "View Product"
-         param 'id' => @product_id                   # Use the saved value
-         
-         response 200 do |header, body, objid|
-           data = YAML.load(body)
-           repeat :times => 2, :wait => 1.second     # Repeat this request twice
-         end
-       end
-     end
-     
-     functest :quick_test do
-		   plan :product_api
-		   clients 2
-		   duration 5.minutes 
-		   verbose
-		 end
-		 
-		 environment :development do
-		   machines "localhost:3114"  
-		   # machine "localhost:3115"
-		   # ...
-		 end
-		 
-		 run :development, :quick_test 
-
-
-See bin/example_test.rb for a running example. 
-
-
+= Stella - 0.7 PREVIEW
+
+Perform load tests on your web applications with beauty and brute strength.
+
+<i>NOTE: 0.7 release is not compatible with previous releases!</i>
+
+== Features
+
+* Realistic load simulation
+* 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):
+
+* Reporting of any kind. 
+* Documentation.
+* File uploads.
+
+== Usage Example
+
+    # Verify a test plan is defined correctly
+    # by running a single user functional test.
+    $ stella verify -p examples/basic/plan.rb http://stellaaahhhh.com/
+    
+    # Perform a load test  
+    # 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
+
+Test plans are defined in the Ruby programming language. This makes it possible to define sophisticated logic to handle responses. They also typically contain more than one usecase which is important when simulating realistic load. In this example, 65% of virtual users will execute the first usecase and 35% will execute the second.
+
+    usecase 65, "Simple search" do
+  
+      get "/", "Homepage" do
+        wait 1..5
+        response 200 do
+          status                       # => 200
+          headers['Content-Type']      # => ['text/html']
+          body                         # => <html>...
+          doc                          # => Nokigiri::HTML::Document
+        end
+      end
+  
+      get "/search", "Search Results" do
+        wait 2..5
+        param :what  => 'Big Al'
+        param :where => 'Toronto'
+        response 200 do
+          listing = doc.css('div.listing').first
+          set :lid, listing['id'].match(/(\d+)/)[0]
+        end
+      end
+      
+      get "/listing/:lid" do           # URIs can contain variables.
+        desc "Selected listing"        # This one will be replaced by
+        wait 1..8                      # the one stored in the previous
+      end                              # request.
+  
+    end
+
+    usecase 35, "YAML API" do
+    
+      resource :listing_ids, list('ids.csv')
+      
+      get "/listing/:lid.yaml" do
+        desc "Select listing"
+        param :lid => random(:listing_ids)
+        response 200 do
+          repeat 5
+        end
+      end
+
+    end
+    
+See examples/ for more. 
+
+    
 == Installation
 
 Get it in one of the following ways:
 
-* RubyForge: http://stella.rubyforge.org/
 * gem install stella 
 * git clone git://github.com/solutious/stella.git
 * gem install solutious-stella --source http://gems.github.com
@@ -66,13 +93,16 @@ Get it in one of the following ways:
 
 == More Information
 
-Stellaaahhhh[http://www.youtube.com/watch?v=wmq-JDonTpc]
+* Homepage[http://solutious.com/projects/stella]
+* Codes[http://github.com/solutious/stella]
+* RDocs[http://solutious.com/stella]
+* Stellaaahhhh[http://www.youtube.com/watch?v=jHHprvyl-Hc]
 
 
 == Credits
 
-* Delano Mandelbaum (delano@solutious.com)
-
+* Delano Mandelbaum (http://solutious.com)
+* Threadify (C) Ara T Howard (http://codeforpeople.com/)
 
 == Thanks 
 

data/Rakefile

@@ -1,83 +1,73 @@
-require 'rubygems'
+
 require 'rake/clean'
 require 'rake/gempackagetask'
 require 'hanna/rdoctask'
+require 'rake/testtask'
+require 'shoulda/tasks'
+require 'rake/runtest'
+require 'monkeyspecdoc'  # http://jgre.org/2008/09/03/monkeyspecdoc/
 require 'fileutils'
 include FileUtils
  
-task :default => :package
- 
-# CONFIG =============================================================
+task :default => :test
 
-# Change the following according to your needs
-README = "README.rdoc"
-CHANGES = "CHANGES.txt"
-LICENSE = "LICENSE.txt"
 
-# Files and directories to be deleted when you run "rake clean"
-CLEAN.include [ 'pkg', '*.gem', '.config', 'doc']
+# PACKAGE =============================================================
 
-# Virginia assumes your project and gemspec have the same name
-name = (Dir.glob('*.gemspec') || ['stella']).first.split('.').first
+name = "stella"
 load "#{name}.gemspec"
-version = @spec.version
-
-# That's it! The following defaults should allow you to get started
-# on other things. 
-
-
-# TESTS/SPECS =========================================================
-
-
 
-# INSTALL =============================================================
+version = @spec.version
 
 Rake::GemPackageTask.new(@spec) do |p|
   p.need_tar = true if RUBY_PLATFORM !~ /mswin/
 end
 
-task :release => [ :rdoc, :package ]
+task :release => [ "publish:gem", :clean, "publish:rdoc" ] do
+  $: << File.join(File.dirname(__FILE__), 'lib')
+  require "rudy"
+  abort if Drydock.debug?
+end
+
 task :install => [ :rdoc, :package ] do
 	sh %{sudo gem install pkg/#{name}-#{version}.gem}
 end
+
 task :uninstall => [ :clean ] do
 	sh %{sudo gem uninstall #{name}}
 end
 
 
-# RUBYFORGE RELEASE / PUBLISH TASKS ==================================
+# Rubyforge Release / Publish Tasks ==================================
 
-if @spec.rubyforge_project
-  desc 'Publish website to rubyforge'
-  task 'publish:rdoc' => 'doc/index.html' do
-    sh "scp -rp doc/* rubyforge.org:/var/www/gforge-projects/#{name}/"
-  end
+#about 'Publish website to rubyforge'
+task 'publish:rdoc' => 'doc/index.html' do
+  sh "scp -rp doc/* rubyforge.org:/var/www/gforge-projects/#{name}/"
+end
 
-  desc 'Public release to rubyforge'
-  task 'publish:gem' => [:package] do |t|
-    sh <<-end
-      rubyforge add_release -o Any -a #{CHANGES} -f -n #{README} #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.gem &&
-      rubyforge add_file -o Any -a #{CHANGES} -f -n #{README} #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.tgz 
-    end
+#about 'Public release to rubyforge'
+task 'publish:gem' => [:package] do |t|
+  sh <<-end
+    rubyforge add_release -o Any -a CHANGES.txt -f -n README.rdoc #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.gem &&
+    rubyforge add_file -o Any -a CHANGES.txt -f -n README.rdoc #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.tgz 
   end
 end
 
 
-
-# RUBY DOCS TASK ==================================
-
 Rake::RDocTask.new do |t|
 	t.rdoc_dir = 'doc'
 	t.title    = @spec.summary
-	t.options << '--line-numbers'
+	t.options << '--line-numbers' <<  '-A cattr_accessor=object'
 	t.options << '--charset' << 'utf-8'
-	t.rdoc_files.include(LICENSE)
-	t.rdoc_files.include(README)
-	t.rdoc_files.include(CHANGES)
+	t.rdoc_files.include('LICENSE.txt')
+	t.rdoc_files.include('README.rdoc')
+	t.rdoc_files.include('CHANGES.txt')
+	#t.rdoc_files.include('Rudyfile')  # why is the formatting f'd?
 	t.rdoc_files.include('bin/*')
 	t.rdoc_files.include('lib/**/*.rb')
 end
 
+CLEAN.include [ 'pkg', '*.gem', '.config', 'doc', 'coverage*' ]
 
 
 

data/bin/stella

@@ -0,0 +1,138 @@
+#!/usr/bin/ruby
+
+# = Stella
+# 
+# === Your friend in web app performance testing
+#
+# Config (default paths):
+# 
+#     ./.stella/config   (current directory)
+#     ~/.stella/config   (your home directory)
+#
+# Usage:
+# 
+#     $ stella -h
+#     $ stella verify 
+#     $ stella load -u 10 -t 60 http://test.example.com/
+#     $ stella load -u 10 -r 40 -p plans/basic.rb http://test.example.com/
+
+STELLA_LIB_HOME = File.expand_path File.join(File.dirname(__FILE__), '..', 'lib')
+
+$:.unshift STELLA_LIB_HOME  # Put our local lib in first place
+
+require 'drydock'
+require 'stella'
+require 'stella/cli'
+
+# Command-line interface for bin/stella
+class Stella::CLI::Definition
+  extend Drydock
+  
+  debug :off
+  default :verify    # when no command is provided
+  
+  # ----------------------------------------  STELLA GLOBALS  --------
+  # ------------------------------------------------------------------
+  
+  global :A, :apikey, String, "API Key"
+  global :S, :secret, String, "Secret Key"
+  global :q, :quiet, "Be quiet!" do
+    Stella.enable_quiet
+  end
+  global :D, :debug, "Enable debug mode" do
+    Drydock.debug true
+    Stella.enable_debug
+  end
+  global :v, :verbose, "Increase verbosity of output (e.g. -v or -vv or -vvv)" do
+    Stella.loglev += 1
+  end
+  global :V, :version, "Display version number" do
+    puts "Stella version: #{Stella::VERSION} (#{Stella::VERSION::PATCH})"
+    exit 0
+  end
+
+  
+  # ------------------------------------------------  STELLA  --------
+  # ------------------------------------------------------------------
+
+  about "Run a functional test"
+  usage "stella verify http://stellaaahhhh.com/"
+  usage "stella verify -p path/2/testplan.rb http://stellaaahhhh.com/"
+  option :b, :benchmark, "Benchmark mode (ignore wait times)"
+  option :p, :testplan, String, "Path to testplan" do |v|
+    raise Stella::InvalidOption, "Bad path: #{v}" unless File.exists?(v)
+    v
+  end
+  command :verify => Stella::CLI
+  
+  about "Run a load test"
+  usage "stella load http://stellaaahhhh.com/"
+  usage "stella load -p path/2/testplan.rb http://stellaaahhhh.com/"
+  option :b, :benchmark, "Benchmark mode (ignore wait times)"
+  option :u, :users, Integer, "Number of virtual users"
+  option :r, :repetitions, Integer, "Number of times to repeat the testplan (per vuser)"
+  option :t, :time, String, "Max duration to run test"
+  option :d, :delay, Float, "Delay between client requests (s)"
+  option :p, :testplan, String, "Path to testplan" do |v|
+    raise Stella::InvalidOption, "Bad path: #{v}" unless File.exists?(v)
+    v
+  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
+  end
+  
+  if Drydock.debug?
+    about "Blast away all Stella config assets"
+    command :blast do
+      Stella::Config.blast
+    end
+  end
+  
+  
+  # ----------------------------------  STELLA MISCELLANEOUS  --------
+  # ------------------------------------------------------------------
+
+  before do |obj|
+    @start = Time.now
+    Stella.enable_debug if Drydock.debug?
+  end
+
+  after do |obj|  
+    Drydock::Screen.flush
+    @elapsed = Time.now - @start
+    if Stella.loglev > 1 && @elapsed > 0.1
+      puts
+      puts "Elapsed: %.2f seconds" % @elapsed.to_f
+    end
+  end
+  
+end
+
+begin
+  Drydock.run!(ARGV, STDIN) if Drydock.run? && !Drydock.has_run?
+rescue Drydock::ArgError, Drydock::OptError => ex
+  STDERR.puts ex.message
+  STDERR.puts ex.usage
+rescue Drydock::InvalidArgument => ex
+  STDERR.puts ex.message
+rescue Stella::Error => ex
+  STDERR.puts ex.message
+  STDERR.puts ex.backtrace if Drydock.debug?
+rescue Interrupt
+  puts "#{$/}Exiting... "
+  exit 1
+rescue => ex
+  STDERR.puts "ERROR (#{ex.class.to_s}): #{ex.message}"
+  STDERR.puts ex.backtrace if Drydock.debug?
+end