rutema 1.1.3 → 1.2.0

data/History.txt

@@ -1,3 +1,8 @@
+== 1.2.0 /2011-04-01
+* refactored library structure
+* More unit tests. We're now over the magical 80% coverage point
+* Updated gem dependencies for activerecord to the newest version
+* Deprecated rutemax. The command now is simply rutema (avoids observed confusion). Will remove in 1.3.0
 == 1.1.3 /2010-12-23
 * fixed dependency handling of Rutema::RakeTask within the block.
 == 1.1.2 /2010-12-22

data/Manifest.txt

@@ -1,46 +1,51 @@
+bin/rutema
+bin/rutemax
 COPYING.txt
 History.txt
-Manifest.txt
-README.txt
-Rakefile
-bin/rutemax
-bin/rutema_upgrader
-distro_test.sh
 lib/rutema/configuration.rb
+lib/rutema/elements/minimal.rb
 lib/rutema/gems.rb
-lib/rutema/model.rb
+lib/rutema/models/activerecord.rb
+lib/rutema/models/base.rb
+lib/rutema/objectmodel.rb
+lib/rutema/parsers/base.rb
+lib/rutema/parsers/xml.rb
 lib/rutema/rake.rb
-lib/rutema/reporter.rb
 lib/rutema/reporters/activerecord.rb
+lib/rutema/reporters/base.rb
 lib/rutema/reporters/email.rb
-lib/rutema/reporters/standard_reporters.rb
 lib/rutema/reporters/text.rb
 lib/rutema/reporters/yaml.rb
-lib/rutema/reporters/couchdb.rb
-lib/rutema/specification.rb
+lib/rutema/runners/default.rb
+lib/rutema/runners/step.rb
 lib/rutema/system.rb
-selftest.sh
-test/data/sample09.db
+Manifest.txt
+Rakefile
+README.md
+README.txt
 test/distro_test/config/database.rutema
 test/distro_test/config/full.rutema
 test/distro_test/config/minimal.rutema
+test/distro_test/specs/check.spec
+test/distro_test/specs/duplicate_name.spec
+test/distro_test/specs/fail.spec
+test/distro_test/specs/include.scenario
+test/distro_test/specs/no_title.spec
+test/distro_test/specs/sample.spec
+test/distro_test/specs/setup.spec
 test/distro_test/specs/T001.spec
 test/distro_test/specs/T002.spec
 test/distro_test/specs/T003.spec
 test/distro_test/specs/T004.spec
 test/distro_test/specs/T005.spec
 test/distro_test/specs/T006.spec
-test/distro_test/specs/include.scenario
-test/distro_test/specs/no_title.spec
-test/distro_test/specs/sample.spec
+test/distro_test/specs/teardown.spec
 test/rutema.rutema
 test/rutema.spec
-test/migration.spec
+test/test_activerecord.rb
 test/test_configuration.rb
-test/test_model.rb
-test/test_reporter.rb
-test/test_specification.rb
+test/test_objectmodel.rb
+test/test_parsers.rb
+test/test_reporters.rb
+test/test_runners.rb
 test/test_system.rb
-test/test_couchdb.rb
-test/test_rake.rb
-

data/README.md

@@ -0,0 +1,91 @@
+rutema [http://patir.rubyforge.org/rutema](http://patir.rubyforge.org/rutema)
+
+## 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.)
+* 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
+
+## INSTALL:
+* gem install rutema
+
+## LICENSE:
+(The Ruby License)
+
+rutema is copyright (c) 2007 - 2011 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:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/README.txt

@@ -10,7 +10,6 @@ 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
 
@@ -32,7 +31,7 @@ See http://patir.rubyforge.org/rutema/distro_test.html for an introductory examp
 == LICENSE:
 (The Ruby License)
 
-rutema is copyright (c) 2007 - 2009 Vassilis Rizopoulos
+rutema is copyright (c) 2007 - 2011 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:
@@ -89,11 +88,4 @@ You can redistribute it and/or modify it under either the terms of the GPL
   6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
      IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-     PURPOSE.
-
-== CREDITS
-	RutemaWeb uses icons from
-	Fast Icon (Dirceu Veiga)
-	Homepage:	http://www.fasticon.com
-	The page design used is an adaptation of RedTie, a design found in www.oswd.org
-	Homepage: http://www.oswd.org/design/preview/id/3699
+     PURPOSE.

data/Rakefile

@@ -2,29 +2,26 @@
 # -*- ruby -*-
 $:.unshift File.join(File.dirname(__FILE__),"lib")
 $:.unshift File.join(File.dirname(__FILE__),"ext")
+require 'rutema/system'
 require 'rubygems'
-require 'rutema/gems'
 require 'hoe'
-require 'rutema/system'
-
 Hoe.spec('rutema') do |p|
   p.version=Rutema::Version::STRING
   p.rubyforge_name = 'patir'
   p.author = "Vassilis Rizopoulos"
   p.email = "riva@braveworld.net"
   p.summary = 'rutema is a test execution and management framework for heterogeneous testing environments'
-  p.description = p.paragraphs_of('README.txt', 1..5).join("\n\n")
-  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.description = p.paragraphs_of('README.md', 1..5).join("\n\n")
+  p.url = "http://patir.rubyforge.org/rutema"
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
   p.extra_deps<<['patir',">=0.6.4"]
   p.extra_deps<<['highline','1.5.2']
   p.extra_deps<<['mailfactory','1.4.0']
-  p.extra_deps<<['activerecord','2.3.8']
+  p.extra_deps<<['activerecord','3.0.5']
   p.extra_deps<<['ruport','1.6.3']
   p.extra_deps<<['acts_as_reportable','1.1.1']
-  p.extra_deps<<['couchrest','=0.37']
-  p.spec_extras={:executables=>["rutemax","rutema_upgrader"],
-    :default_executable=>"rutemax"}
+  #p.extra_deps<<['couchrest','=1.0.1']
+  p.spec_extras={:executables=>["rutemax","rutema"],:default_executable=>"rutema"}
 end
 
 # vim: syntax=Ruby

data/bin/rutema

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

data/bin/rutemax

@@ -1,7 +1,9 @@
 #  Copyright (c) 2007-2010 Vassilis Rizopoulos. All rights reserved.
+require 'rubygems'
 require 'rutema/gems'
 require 'rutema/system'
 begin
+	puts "rutemax is deprecated and will be removed in the near future, use rutema instead"
 	Rutema::RutemaX.new(ARGV)
 rescue
 	exit 1

data/lib/rutema/configuration.rb

@@ -2,18 +2,17 @@
 $:.unshift File.join(File.dirname(__FILE__),"..")
 
 module Rutema
-  #This module defines the "configuration directives" used in the configuration of RutemaX
+  #This module defines the "configuration directives" used in the configuration of Rutema
   #
   #Example
   #A configuration file needs as a minimum to define which parser to use and which tests to run.
   #
   #Since rutema configuration files are valid Ruby code, you can use the full power of the Ruby language including require directives
   #
-  # require 'rubygems'
   # require 'rake'
   # configuration.parser={:class=>Rutema::MinimalXMLParser}
   # configuration.tests=FileList['all/of/the/tests/**/*.*']
-  module RutemaXConfiguration
+  module RutemaConfiguration
     #Adds a hash of values to the tools hash of the configuration
     #
     #This hash is then accessible in the parser and reporters as a property of the configuration instance
@@ -79,7 +78,7 @@ module Rutema
       end
     end
     
-    #Adds the files to the specifications available to RutemaX.
+    #Adds the files to the specifications available to Rutema.
     def tests= array_of_files
       @tests||=Array.new
       @tests+=array_of_files
@@ -124,11 +123,11 @@ module Rutema
     end
   end
   
-  #This class reads a RutemaX configuration file
+  #This class reads a Rutema configuration file
   #
-  #See Rutema::RutemaXConfiguration for configuration examples and directives
-  class RutemaXConfigurator<Patir::Configurator
-    include RutemaXConfiguration
+  #See Rutema::RutemaConfiguration for configuration examples and directives
+  class RutemaConfigurator<Patir::Configurator
+    include RutemaConfiguration
     def initialize config_file,logger=nil
       @reporters=Array.new
       @context=Hash.new

data/lib/rutema/elements/minimal.rb

@@ -0,0 +1,45 @@
+#  Copyright (c) 2007-2011 Vassilis Rizopoulos. All rights reserved.
+$:.unshift File.join(File.dirname(__FILE__),'..','..')
+module Rutema
+  #The Elements module provides the namespace for the various modules adding parser functionality
+  module Elements
+    #Minimal offers a minimal(chic) set of elements for use in specifications
+    #
+    #These are:
+    # echo
+    # command
+    # prompt
+    module Minimal
+      #echo prints a message on the screen:
+      # <echo text="A meaningful message"/>
+      # <echo>A meaningful message</echo>
+      def element_echo step
+        step.cmd=Patir::RubyCommand.new("echo"){|cmd| cmd.error="";cmd.output="#{step.text}";$stdout.puts(cmd.output) ;:success}
+      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"
+      def element_prompt step
+         step.attended=true
+         step.cmd=Patir::RubyCommand.new("prompt") do |cmd|  
+          cmd.output=""
+          cmd.error=""
+          if HighLine.new.agree("#{step.text}")
+            step.output="y"
+          else
+            raise "n"
+          end#if
+        end#do rubycommand
+      end
+      #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
+        wd=step.working_directory if step.has_working_directory?
+        step.cmd=Patir::ShellCommand.new(:cmd=>step.cmd,:working_directory=>File.expand_path(wd))      
+      end
+    end
+  end
+end

data/lib/rutema/gems.rb

@@ -1,4 +1,4 @@
-gem 'activerecord','2.3.8'
+gem 'activerecord','3.0.5'
 gem 'patir',">=0.6.4"
-gem 'acts_as_reportable','=1.1.1'
-gem 'couchrest','=0.37'
+gem 'ruport','=1.6.3'
+gem 'acts_as_reportable','>=1.1.1'

data/lib/rutema/models/activerecord.rb

@@ -0,0 +1,164 @@
+#  Copyright (c) 2007-2010 Vassilis Rizopoulos. All rights reserved.
+$:.unshift File.join(File.dirname(__FILE__),'..','..')
+require 'rutema/models/base'
+require 'active_record'
+require 'ruport/acts_as_reportable'
+
+#this fixes the AR Logger hack that annoys me sooooo much
+class Logger
+  private
+  def format_message(severity, datetime, progname, msg)
+    (@formatter || @default_formatter).call(severity, datetime, progname, msg)
+  end
+end
+module Rutema
+  module ActiveRecord
+    #This is the schema for the AR database used to store test results
+    #
+    #We store the RutemaConfiguration#context for every run so that reports for past runs can be recreated without running the actual tests again.
+    class Schema< ::ActiveRecord::Migration
+      def self.up
+        create_table :runs do |t|
+          t.column :context, :string
+        end
+
+        create_table :scenarios do |t|
+          t.column :name, :string, :null=>false
+          t.column :run_id,:integer, :null=>false
+          t.column :attended,:bool, :null=>false
+          t.column :status, :string,:null=>false
+          t.column :number,:integer
+          t.column :start_time, :datetime,:null=>false
+          t.column :stop_time, :datetime
+          t.column :version, :string
+          t.column :title, :string
+          t.column :description, :string
+        end
+
+        create_table :steps do |t|
+          t.column :scenario_id,:integer, :null=>false
+          t.column :name, :string
+          t.column :number, :integer,:null=>false
+          t.column :status, :string,:null=>false
+          t.column :output, :text
+          t.column :error, :text
+          t.column :duration, :decimal
+        end
+
+        create_table :parse_errors do |t|
+          t.column :filename, :string,:null=>false
+          t.column :error, :string
+          t.column :run_id,:integer, :null=>false
+        end
+      end
+    end
+    class Run< ::ActiveRecord::Base
+      has_many :scenarios
+      has_many :parse_errors
+      serialize :context
+      acts_as_reportable      
+    end
+    class Scenario< ::ActiveRecord::Base
+      belongs_to :run
+      has_many :steps
+      acts_as_reportable
+    end
+    class Step< ::ActiveRecord::Base
+      belongs_to :scenario
+      acts_as_reportable
+    end
+    class ParseError< ::ActiveRecord::Base
+      belongs_to :run
+      acts_as_reportable
+    end
+    #Exports the contents of the database/model as a yaml dump
+    class Export
+      def initialize params
+        @logger = params[:logger]
+        @logger ||= Patir.setup_logger
+        @result_set_size = params[:result_set_size]
+        @result_set_size ||= 1000
+        @currently_on_no=0
+        database_configuration = params[:db]
+        raise "No database configuration defined, missing :db configuration key." unless database_configuration
+        ActiveRecord.connect(database_configuration,@logger)
+      end
+      def next
+        @logger.info("Found #{Run.count} runs") if @currently_on_no==0
+        @logger.info("Exporting from #{@currently_on_no} to #{@currently_on_no+@result_set_size}")
+        export(@result_set_size)
+      end
+      def all
+        @logger.info("Found #{Run.count} runs")
+        export(nil)
+      end
+      private 
+      def export offset=nil
+        if offset
+          runs=Run.find(:all,:order=>"id ASC",:limit=>@result_set_size,:offset=>@currently_on_no)
+          @currently_on_no+=offset
+        else
+          runs=Run.find(:all)
+        end
+        return nil if runs.empty?
+        export=[]
+        runs.each do |run|
+          e={:parse_errors=>[],:scenarios=>[],:context=>run.context}
+          run.parse_errors.each { |pe| e[:parse_errors]<<{:filename=>pe.filename, :error=>pe.error} }
+          run.scenarios.each { |sc| e[:scenarios]<<export_scenario(sc)  }
+          export<<e
+          @logger.debug("Exported #{run.id}")
+        end
+        return export
+      end
+      def export_scenario sc
+        scenario={:name=>sc[:name],
+          :attended=>sc[:attended],
+          :status=>sc[:status],
+          :number=>sc[:number],
+          :start_time=>sc[:start_time], 
+          :stop_time=>sc[:stop_time],
+          :version=>sc[:version],
+          :title=>sc[:title], 
+          :description=>sc[:description],
+          :steps=>[]
+        }
+        sc.steps.each do |step|
+          st={:name=>step[:name],
+            :number=>step[:number], 
+            :status=>step[:status], 
+            :output=>step[:output], 
+            :error=>step[:error],
+            :duration=>step[:duration]
+          }
+          scenario[:steps]<<st
+        end
+        return scenario
+      end
+    end  
+    #Establishes an ActiveRecord connection
+    def self.connect cfg,logger
+      conn=cnct(cfg,logger)
+      Schema.migrate(:up) if perform_migration?(cfg)
+    end
+    private
+    #Establishes an active record connection using the cfg hash
+    #There is only a rudimentary check to ensure the integrity of cfg
+    def self.cnct cfg,logger
+      if cfg[:adapter] && cfg[:database]
+        logger.debug("Connecting to #{cfg[:database]}")
+        return ::ActiveRecord::Base.establish_connection(cfg)
+      else
+        raise Rutema::ConnectionError,"Erroneous database configuration. Missing :adapter and/or :database"
+      end
+    end
+    def self.perform_migration? cfg
+      return true if cfg[:migrate]
+      #special case for sqlite3
+      if cfg[:adapter]=="sqlite3" && !File.exists?(cfg[:database])
+        return true
+      end
+      return false
+    end
+  end
+end