rutema 1.0.4 → 1.0.5

data/History.txt

@@ -1,3 +1,10 @@
+== 1.0.5 / 2009-07-16
+* Updated gem dependencies to use activerecord 2.3.2
+* A failure of the check test now passes all test stati (as not_executed). This will not skew statistics that show the trends on test numbers
+* Setup and teardown are no longer executed for check tests
+* fixed bug in element_prompt where a negative answer would not set an error
+* TextReporter now shows the failed tests first, followed by tests with warnings, not executed tests and finally the successes. This gives a better overview of the important bits
+* removed require "rubygems" from library code
 == 1.0.4 / 2008-11-7
 * Added functionality that allows ignoring the result of a step. The step is considered always successful
 == 1.0.3 / 2008-10-28

data/README.txt

@@ -32,7 +32,7 @@ See http://patir.rubyforge.org/rutema/distro_test.html for an introductory examp
 == LICENSE:
 (The Ruby License)
 
-rutema is copyright (c) 2007 Vassilis Rizopoulos
+rutema is copyright (c) 2007 - 2009 Vassilis Rizopoulos
 
 You can redistribute it and/or modify it under either the terms of the GPL
 (see COPYING.txt file), or the conditions below:

data/Rakefile

@@ -6,7 +6,8 @@ require 'rubygems'
 require 'hoe'
 require 'rutema/system'
 
-Hoe.new('rutema', "#{Rutema::Version::STRING}") do |p|
+Hoe.spec('rutema') do |p|
+  p.version=Rutema::Version::STRING
   p.rubyforge_name = 'patir'
   p.author = "Vassilis Rizopoulos"
   p.email = "riva@braveworld.net"
@@ -17,9 +18,9 @@ Hoe.new('rutema', "#{Rutema::Version::STRING}") do |p|
   p.extra_deps<<['patir',">=0.6.0"]
   p.extra_deps<<['highline']
   p.extra_deps<<['mailfactory']
-  p.extra_deps<<['activerecord','=2.1.1']
-  p.extra_deps<<['ruport','>=1.6.1']
-  p.extra_deps<<['acts_as_reportable','>=1.1.1']
+  p.extra_deps<<['activerecord','=2.3.2']
+  p.extra_deps<<['ruport','=1.6.1']
+  p.extra_deps<<['acts_as_reportable','=1.1.1']
   p.spec_extras={:executables=>["rutemax","rutema_upgrader"],
     :default_executable=>"rutemax"}
 end

data/bin/rutema_upgrader

@@ -1,5 +1,4 @@
 #  Copyright (c) 2008 Vassilis Rizopoulos. All rights reserved.
-require 'rubygems'
 require 'rutema/system'
 require 'patir/base'
 

data/bin/rutemax

@@ -1,9 +1,4 @@
 #  Copyright (c) 2007 Vassilis Rizopoulos. All rights reserved.
-begin
-  require 'rutema/system'
-rescue LoadError
-  require 'rubygems'
-  require 'rutema/system'
-end
-
+require 'rutema/gems'
+require 'rutema/system'
 Rutema::RutemaX.new(ARGV)

data/distro_test.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
-rutemax -c test/distro_test/config/minimal.rutema
-rutemax -c test/distro_test/config/database.rutema
-rutemax -c test/distro_test/config/full.rutema --check
-rutemax -c test/distro_test/config/full.rutema 
+ruby -rubygems -I lib/ bin/rutemax -c test/distro_test/config/minimal.rutema
+ruby -rubygems -I lib/ bin/rutemax -c test/distro_test/config/database.rutema
+ruby -rubygems -I lib/ bin/rutemax -c test/distro_test/config/full.rutema --check
+ruby -rubygems -I lib/ bin/rutemax -c test/distro_test/config/full.rutema 
 #rutemax -c test/distro_test/config/minimal.rutema --step

data/lib/rutema/gems.rb

@@ -1,11 +1,3 @@
-require 'rubygems'
-gem 'activerecord','=2.1.1'
-require 'active_record'
-gem 'patir','>=0.5.8'
-require 'patir/configuration'
-require 'patir/command'
-require 'patir/base'
-
-require 'ruport/acts_as_reportable'
-require 'mailfactory'
-require 'highline'
+gem 'activerecord','=2.3.2'
+gem 'patir',">=0.6.1"
+gem 'acts_as_reportable','=1.1.1'

data/lib/rutema/model.rb

@@ -1,6 +1,7 @@
 #  Copyright (c) 2007 Vassilis Rizopoulos. All rights reserved.
 $:.unshift File.join(File.dirname(__FILE__),"..")
-require 'rutema/gems'
+require 'active_record'
+require 'ruport/acts_as_reportable'
 #this fixes the AR Logger hack that annoys me sooooo much
 class Logger
   private

data/lib/rutema/reporter.rb

@@ -1,7 +1,6 @@
 #  Copyright (c) 2007 Vassilis Rizopoulos. All rights reserved.
 $:.unshift File.join(File.dirname(__FILE__),"..")
 require 'rutema/specification'
-require 'rutema/gems'
 
 module Rutema
   #Reporter is meant as a base class for reporter classes.

data/lib/rutema/reporters/activerecord.rb

@@ -4,7 +4,6 @@ require 'yaml'
 require 'rutema/reporter'
 require 'rutema/model'
 require 'rutema/db'
-require 'rutema/gems'
 
 module Rutema
   #The ActiveRecordReporter will store the results of a test run in a database using ActiveRecord.

data/lib/rutema/reporters/email.rb

@@ -4,7 +4,7 @@ require 'net/smtp'
 require 'rutema/reporter'
 require 'rutema/specification'
 require 'rutema/reporters/text'
-require 'rutema/gems'
+require 'mailfactory'
 
 module Rutema
   #The following configuration keys are used by EmailReporter:
@@ -13,6 +13,8 @@ module Rutema
   #
   #:port - the port to use (defaults to 25)
   #
+  #:domain - the domain the mail is coming from
+  #
   #:sender - the sender of the email (defaults to rutema@domain)
   #
   #:recipients - an array of strings with the recipients of the report emails

data/lib/rutema/reporters/text.rb

@@ -25,17 +25,36 @@ module Rutema
       msg<<"\n---"
       #Report on scenarios
       msg<<"\nNo scenarios in this run" if runner_states.empty?
-      msg<<"\nOne scenario in the current run:" if runner_states.size==1
-      msg<<"\n#{runner_states.size} scenarios in the current run:" if runner_states.size>1
-      rstates=runner_states.sort_by do |state| 
-        state.sequence_id.to_i
-      end
-      rstates.each do |state|
+      msg<<"\nOne scenario in the current run" if runner_states.size==1
+      msg<<"\n#{runner_states.size} scenarios in the current run" if runner_states.size>1
+      not_run = runner_states.select{|state| state.status == :not_executed }.sort_by {|state| state.sequence_id.to_i}
+      errors = runner_states.select{|state| state.status == :error }.sort_by {|state| state.sequence_id.to_i}
+      warnings = runner_states.select{|state| state.status == :warning }.sort_by {|state| state.sequence_id.to_i}
+      successes = runner_states.select{|state| state.status == :success }.sort_by {|state| state.sequence_id.to_i}
+      msg<<"\n#{errors.size} errors, #{warnings.size} warnings, #{successes.size} successes"
+      msg<<"\nErrors:" unless errors.empty?
+      msg<<scenario_summaries(errors,specifications)
+      msg<<"\nWarnings:" unless warnings.empty?
+      msg<<scenario_summaries(warnings,specifications)
+      msg<<"\nNot executed:" unless not_run.empty?
+      not_run.each do |state|
         msg<<"\n#{specifications[state.sequence_name].title}" if specifications[state.sequence_name]
-        msg<<"\n#{state.summary}\n---"
+      end
+      msg<<"\nSuccesses:" unless successes.empty?
+      msg<<scenario_summaries(successes,specifications)
+      
+      return msg
+    end
+    
+    def scenario_summaries scenarios,specifications
+      msg=""
+      unless scenarios.empty?
+        scenarios.each do |state|
+          msg<<"\n#{specifications[state.sequence_name].title}" if specifications[state.sequence_name]
+          msg<<"\n#{state.summary}\n---"
+        end
       end
       return msg
     end
   end
-  
 end

data/lib/rutema/specification.rb

@@ -1,7 +1,6 @@
 #  Copyright (c) 2007 Vassilis Rizopoulos. All rights reserved.
 $:.unshift File.join(File.dirname(__FILE__),"..")
 require 'rutema/reporters/standard_reporters'
-require 'rutema/gems'
 
 module Rutema
   #This module adds functionality that allows us to 

data/lib/rutema/system.rb

@@ -1,17 +1,19 @@
 #  Copyright (c) 2007 Vassilis Rizopoulos. All rights reserved.
 $:.unshift File.join(File.dirname(__FILE__),"..")
 require 'rexml/document'
+require 'patir/configuration'
+require 'patir/command'
+require 'patir/base'
 require 'rutema/specification'
 require 'rutema/configuration'
 require 'rutema/reporters/standard_reporters'
-require 'rutema/gems'
 
 module Rutema
   #This module defines the version numbers for the library
   module Version
     MAJOR=1
     MINOR=0
-    TINY=4
+    TINY=5
     STRING=[ MAJOR, MINOR, TINY ].join( "." )
   end
   #The Elements module provides the namespace for the various modules adding parser functionality
@@ -29,8 +31,10 @@ module Rutema
       def element_echo step
         step.cmd=Patir::RubyCommand.new("echo"){|cmd| cmd.error="";cmd.output="#{step.text}";$stdout.puts(cmd.output) ;:success}
       end
-      #command executes a shell command
-      # <command cmd="useful_command.exe with parameters", working_directory="some/directory"/>
+      #prompt asks the user a yes/no question. Answering yes means the step is succesful.
+      # <prompt text="Do you want fries with that?"/>
+      #
+      #A prompt element automatically makes a specification "attended"
       def element_prompt step
          step.attended=true
          step.cmd=Patir::RubyCommand.new("prompt") do |cmd|  
@@ -38,17 +42,13 @@ module Rutema
           cmd.error=""
           if HighLine.new.agree("#{step.text}")
             step.output="y"
-            :success
           else
-            step.error="n"
-            :error
+            raise "n"
           end#if
         end#do rubycommand
       end
-      #prompt asks the user a yes/no question. Answering yes means the step is succesful.
-      # <prompt text="Do you want fries with that?"/>
-      #
-      #A prompt element automatically makes a specification "attended"
+      #command executes a shell command
+      # <command cmd="useful_command.exe with parameters", working_directory="some/directory"/>
       def element_command step
         raise ParserError,"missing required attribute cmd in #{step}" unless step.has_cmd?
         wd=Dir.pwd
@@ -264,6 +264,7 @@ module Rutema
   #This class coordinates parsing, execution and reporting of test specifications
   class Coordinator
     attr_accessor :configuration,:parse_errors,:parsed_files
+    attr_reader :test_states
     def initialize configuration,logger=nil
       @logger=logger
       @logger||=Patir.setup_logger
@@ -277,6 +278,7 @@ module Rutema
       #this will hold any specifications that are succesfully parsed.
       @specifications=Hash.new
       @parsed_files=Array.new
+      @test_states=Hash.new
     end
     #Runs a set of tests
     #
@@ -323,7 +325,7 @@ module Rutema
     def parse_all_specifications
       @configuration.tests.collect do |t| 
         begin
-          parse_specification(t)
+          spec=parse_specification(t)
         rescue
           @logger.debug($!)
           @logger.error($!.message)
@@ -334,10 +336,14 @@ module Rutema
     #
     #It then joins the threads and returns when all of them are finished.
     def report
+      #get the states from the runner
+      @runner.states.each do |k,v|
+        @test_states[k]=v
+      end
       threads=Array.new
       #get the runner stati and the configuration and give it to the reporters
       @reporters.each do |reporter|
-        threads<<Thread.new(reporter,@specifications,@runner.states.values,@parse_errors,@configuration) do |reporter,specs,status,perrors,configuration|
+        threads<<Thread.new(reporter,@specifications,@test_states.values,@parse_errors,@configuration) do |reporter,specs,status,perrors,configuration|
           @logger.debug(reporter.report(specs,status,perrors,configuration))
         end
       end
@@ -397,8 +403,10 @@ module Rutema
             msg="Duplicate specification name '#{spec.name}' in '#{spec_file}'"
             @logger.error(msg)
             @parse_errors<<{:filename=>spec_file,:error=>msg}
+            @test_states[spec.name]=Patir::CommandSequenceStatus.new(spec.name,[])
           else
             @specifications[spec.name]=spec
+            @test_states[spec.name]=Patir::CommandSequenceStatus.new(spec.name,spec.scenario.steps)
           end
         rescue ParserError
           @logger.error("Error parsing '#{spec_file}': #{$!.message}")
@@ -422,7 +430,7 @@ module Rutema
           spec=parse_specification(@configuration.check)
           if spec
             @logger.info("Running check test '#{spec}'")
-            if run_test(spec).success?
+            if run_test(spec,false).success?
               specs.each{|s| run_test(s)}
             else
               @logger.error("Check test failed")
@@ -436,14 +444,15 @@ module Rutema
       end
     end
     
-    def run_test specification
+    def run_test specification,run_setup=true
       @logger.info("Running #{specification.name} -  #{specification.title}")
       if specification.scenario
-        status=@runner.run(specification.name,specification.scenario)
+        status=@runner.run(specification.name,specification.scenario,run_setup)
       else
         @logger.warn("#{specification.name} has no scenario")
         status=:not_executed
       end
+      @test_states[specification.name]=status
       return status
     end
   end
@@ -472,10 +481,10 @@ module Rutema
     #Runs a scenario and stores the result internally
     #
     #Returns the result of the run as a Patir::CommandSequenceStatus
-    def run name,scenario
+    def run name,scenario, run_setup=true
       @logger.debug("Starting run for #{name} with #{scenario.inspect}")
       #if setup /teardown is defined we need to execute them before and after
-      if @setup
+      if @setup && run_setup
         @logger.info("Setup for #{name}")
         @states["#{name}_setup"]=run_scenario("#{name}_setup",@setup)
         @states["#{name}_setup"].sequence_id="s#{@number_of_runs}"
@@ -492,7 +501,8 @@ module Rutema
         @states[name]=run_scenario(name,scenario)
         @states[name].sequence_id="#{@number_of_runs}"
       end
-      if @teardown
+      #no setup means no teardown
+      if @teardown && run_setup
         #always execute teardown
         @logger.warn("Teardown for #{name}")
         @states["#{name}_teardown"]=run_scenario("#{name}_teardown",@teardown)
@@ -501,7 +511,7 @@ module Rutema
       @number_of_runs+=1
       return @states[name]
     end
-
+    
     #Returns the state of the scenario with the given name.
     #
     #Will return nil if no scenario is found under that name.
@@ -575,7 +585,6 @@ module Rutema
           @logger.warn("Step failed but result is being ignored!")
           @logger.warn(msg)
           step.status=:success
-          
         else
           @logger.error(msg) 
         end

data/selftest.sh

@@ -1,2 +1,2 @@
 #!/bin/sh
-rutemax -c test/rutema.rutema all
+ruby -rubygems -I lib/ bin/rutemax -c test/rutema.rutema all

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rutema
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors: 
 - Vassilis Rizopoulos
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-07 00:00:00 +01:00
+date: 2009-07-16 00:00:00 +02:00
 default_executable: rutemax
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,7 +50,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 2.1.1
+        version: 2.3.2
     version: 
 - !ruby/object:Gem::Dependency 
   name: ruport
@@ -58,7 +58,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         version: 1.6.1
     version: 
@@ -68,7 +68,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         version: 1.1.1
     version: 
@@ -80,9 +80,34 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: 2.3.2
     version: 
-description: "== DESCRIPTION: rutema is a test execution tool with a twist. It allows you to combine test tools while it takes care of logging, reporting, archiving of results and formalizes execution of automated and manual tests. It's purpose is to make testing in heterogeneous environments easier.   For more information look at http://patir.rubyforge.org/rutema  == FEATURES/PROBLEMS: * Unified test execution environment for automated and manual tests * Extensible reports and notifications in various formats (email, rss, pdf, html etc.) * Web frontend and command line report generation tools for browsing the test results database (with rutemaweb) * Comprehensive history of test execution * A well defined way to create a project specific test specification format  == SYNOPSIS: See http://patir.rubyforge.org/rutema/distro_test.html for an introductory example.  == REQUIREMENTS: * patir (http://patir.rubyforge.org) * mailfactory (http://rubyforge.org/projects/mailfactory/) * activerecord (http://ar.rubyonrails.com/) * sqlite3 (http://rubyforge.org/projects/sqlite-ruby/) * ruport (http://rubyreports.org/) * acts_as_reportable * highline"
+description: |-
+  == DESCRIPTION:
+  rutema is a test execution tool with a twist.
+  It allows you to combine test tools while it takes care of logging, reporting, archiving of results and formalizes execution of automated and manual tests.
+  It's purpose is to make testing in heterogeneous environments easier. 
+  
+  For more information look at http://patir.rubyforge.org/rutema
+  
+  == FEATURES/PROBLEMS:
+  * Unified test execution environment for automated and manual tests
+  * Extensible reports and notifications in various formats (email, rss, pdf, html etc.)
+  * Web frontend and command line report generation tools for browsing the test results database (with rutemaweb)
+  * Comprehensive history of test execution
+  * A well defined way to create a project specific test specification format
+  
+  == SYNOPSIS:
+  See http://patir.rubyforge.org/rutema/distro_test.html for an introductory example.
+  
+  == REQUIREMENTS:
+  * patir (http://patir.rubyforge.org)
+  * mailfactory (http://rubyforge.org/projects/mailfactory/)
+  * activerecord (http://ar.rubyonrails.com/)
+  * sqlite3 (http://rubyforge.org/projects/sqlite-ruby/)
+  * ruport (http://rubyreports.org/)
+  * acts_as_reportable
+  * highline
 email: riva@braveworld.net
 executables: 
 - rutemax
@@ -139,6 +164,8 @@ files:
 - test/test_system.rb
 has_rdoc: true
 homepage: 
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -160,9 +187,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: patir
-rubygems_version: 1.3.1
+rubygems_version: 1.3.4
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: rutema is a test execution and management framework for heterogeneous testing environments
 test_files: 
 - test/test_configuration.rb