solutious-stella 0.5.5 → 0.6.0

data/CHANGES.txt

@@ -1,9 +1,46 @@
 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.6.0 (2009-03-15) ###############################
+
+http://github.com/solutious/stella/tree/0.6
+
+* COMPLETE REWRITE!
+  * The commands and API from 0.5.x are no longer supported. This ain't your grandmother's Stella.
+* NEW: Tests are now defined using a DSL. See tryouts/dsl_tryout.rb for an example. 
+* NEW: Tests are run with Ruby directly: ruby testplan.rb (for now)
+
+
+#### 0.5.6 (2009-02-04) ###############################
+
+* API Change: watch is replaced by pcap and proxy. 
+  * "stella watch -C" is now "stella pcap"
+  * "stella watch -P" is now "stella proxy"
+* Fixed body printing bug for stella -v watch -C
+* Added adapter tests 
+* Improved RDocs
+
 
 #### 0.5.5 (2009-01-14) ###############################
 
-http://github.com/solutious/stella/tree/0.5.5
+http://github.com/solutious/stella/tree/stella-0.5.5
 
 * Now has specs (33 specifications, 303 requirements)
 * New dependency: test-spec (development copy only)
@@ -18,7 +55,7 @@ http://github.com/solutious/stella/tree/0.5.5
 
 #### 0.5.4-alpha (2009-01-07) #########################
 
-http://github.com/solutious/stella/tree/0.5.4-alpha
+http://github.com/solutious/stella/tree/stella-0.5.4-alpha
 
 * New command: watch. Monitor HTTP traffic with Ruby-Pcap (unix only) or proxy. Pcap also supports DNS sniffing.
 * Improved error handling for stats output

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2008 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,85 @@
+= 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. 
+
+
+== 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
+
+
+== More Information
+
+Stellaaahhhh[http://www.youtube.com/watch?v=wmq-JDonTpc]
+
+
+== Credits
+
+* Delano Mandelbaum (delano@solutious.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/Rakefile

@@ -1,88 +1,83 @@
-
 require 'rubygems'
 require 'rake/clean'
 require 'rake/gempackagetask'
-require 'rake/rdoctask'
+require 'hanna/rdoctask'
 require 'fileutils'
 include FileUtils
  
-task :default => :test
- 
-# SPECS ===============================================================
+task :default => :package
  
-desc 'Run specs with unit test style output'
-task :test do |t|
-#  sh "specrb -s tests/*_test.rb"
-  sh "specrb -s tests/*_test.rb"
-end
+# CONFIG =============================================================
 
-# PACKAGE =============================================================
-
-
-STELLA_HOME = File.expand_path(File.join(File.dirname(__FILE__)))
-$: << File.join(STELLA_HOME, 'lib')
-
-require 'stella'
-version = Stella::VERSION.to_s
-name = "stella"
-
-spec = Gem::Specification.new do |s|
-	s.name = name
-	s.version = version
-	s.summary = "Your friend in performance testing."
-	s.description = "Run Apache Bench, Siege, or httperf tests in batches and aggregate results."
-	s.author = "Delano Mandelbaum"
-	s.email = "delano@solutious.com"
-	s.homepage = "http://stella.solutious.com/"
-	s.executables = [ "stella", "stella.bat" ]
-	s.rubyforge_project = "stella"
-  s.extra_rdoc_files  = ['README.textile']
-  
-  # NOTE: how to make optional dependencies?
-	s.add_dependency 'mongrel'
-	s.add_dependency 'rspec'
-	s.add_dependency 'net-dns'
-
-	s.platform = Gem::Platform::RUBY
-	s.has_rdoc = true
-	
-	s.files = %w(Rakefile) + Dir.glob("{bin,doc,lib,tests,support,vendor}/**/**/*")
-	
-	s.require_path = "lib"
-	s.bindir = "bin"
-end
+# 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']
+
+# Virginia assumes your project and gemspec have the same name
+name = (Dir.glob('*.gemspec') || ['stella']).first.split('.').first
+load "#{name}.gemspec"
+version = @spec.version
+
+# That's it! The following defaults should allow you to get started
+# on other things. 
+
+
+# TESTS/SPECS =========================================================
 
-Rake::GemPackageTask.new(spec) do |p|
-	p.need_tar = true if RUBY_PLATFORM !~ /mswin/
-end
 
 
+# INSTALL =============================================================
 
+Rake::GemPackageTask.new(@spec) do |p|
+  p.need_tar = true if RUBY_PLATFORM !~ /mswin/
+end
+
+task :release => [ :rdoc, :package ]
 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 ==================================
+
+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
+
+  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
+  end
+end
+
+
+
+# RUBY DOCS TASK ==================================
 
 Rake::RDocTask.new do |t|
 	t.rdoc_dir = 'doc'
-	t.title    = "stella, a friend in performance testing"
-	t.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+	t.title    = @spec.summary
+	t.options << '--line-numbers'
 	t.options << '--charset' << 'utf-8'
-	t.rdoc_files.include('LICENSE.txt')
-	t.rdoc_files.include('README.textile')
-	t.rdoc_files.include('CHANGES.txt')
-	t.rdoc_files.include('lib/utils/*.rb')
-	t.rdoc_files.include('lib/stella.rb')
-	t.rdoc_files.include('lib/stella/*.rb')
-	t.rdoc_files.include('lib/stella/**/*.rb')
+	t.rdoc_files.include(LICENSE)
+	t.rdoc_files.include(README)
+	t.rdoc_files.include(CHANGES)
+	t.rdoc_files.include('bin/*')
+	t.rdoc_files.include('lib/**/*.rb')
 end
 
-CLEAN.include [ 'pkg', '*.gem', '.config', 'doc' ]
 
 
 

data/bin/example_test.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/ruby
+
+# Stella Test DSL - Example 1: Multiple requests, with response data
+# 
+# To run the example test, do the following:
+# 
+# * run bin/example_webapp.rb in an other terminal window. This provides
+# an HTTP server for this script to run against. 
+# 
+# * run bin/example_test.rb and watch the output!
+#
+#
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib')) # Put the local lib first in line
+
+require 'stella'
+require 'yaml'
+
+include Stella::DSL
+
+testplan :dsl_example1 do
+  desc "A basic demonstration of the testplan DSL"
+  protocol :http
+#  auth :basic, "stella", "stella"
+  
+  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|
+      data = YAML.load(body)
+      @product_id = data[:id]             # Store the response value
+    end
+  end
+  
+  get "/product" do
+    name "View Product"
+    param 'id' => @product_id             # Use the value from the previous request
+    
+    response 200 do |header, body|
+      data = YAML.load(body)
+      #repeat :times => 2, :wait => 1      # Repeat this request
+    end
+  end
+
+  get "/product/22" do
+    name "Product 22"
+    response 200 do |header, body|
+      data = YAML.load(body)
+    end
+  end
+
+end
+
+# Environments 
+#
+# Stella can execute the same test plan on different environments.
+# You can specify several environment blocks by giving them unique
+# names. Each environment can contain any number of machines. 
+environment :development do
+  machines "localhost:3114"  
+  # machine "localhost:3115"
+  # ...
+end
+
+# Functional Test
+#
+# A functional test executes the test plan with a single client. It 
+# produces more output than a load test which can be used to verify 
+# both that the test plan was written correctly and that the server
+# is responding as expected for each request. 
+functest :integration do
+  plan :dsl_example1
+  verbose  2
+end
+
+
+run :development, :integration     # Run functional test
+

data/bin/example_webapp.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/ruby
+
+# Use Ruby 1.8
+
+require "rubygems"
+require "rack"
+require "sinatra"
+
+require 'yaml'
+
+set :run => true
+set :environment => :development
+set :raise_errors => true
+set :port => 3114
+
+#log = File.new("/dev/null", "a")
+#STDOUT.reopen(log)
+#STDERR.reopen(log)
+
+
+#use Rack::Auth::Basic do |username, password|
+#  username == 'stella' && password == 'stella'
+#end
+
+# 
+# Generates a string of random alphanumeric characters
+# These are used as IDs throughout the system
+def strand( len )
+   chars = ("a".."z").to_a + ("0".."9").to_a
+   newpass = ""
+   1.upto(len) { |i| newpass << chars[rand(chars.size-1)] }
+   return newpass
+end
+
+get '/' do
+  redirect '/product'
+end
+
+get '/product' do
+  content_type "text/plain"
+  product = {
+    :id => (params[:id] || 0).to_s,
+    :name => "John West Smoked Oysters"
+  }.to_yaml
+end
+
+get '/product/:id' do 
+  content_type "text/plain"
+  product = {
+    :id => params[:id].to_i,
+    :name => "John West Smoked Oysters"
+  }.to_yaml
+end
+
+post '/upload' do
+  content_type "text/plain"
+  product = {
+    :id => strand(3),
+    :name => "John West Smoked Oysters",
+    :convert => params[:convert] || false,
+    :rand => params[:rand]
+  }.to_yaml
+end