rutema 1.3.0 → 2.0.0.pre

data/README.txt

@@ -1,44 +0,0 @@
-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/examples.html for an introductory example.
-
-== INSTALL:
-* gem install rutema
-
-== LICENSE:
-(The MIT License)
-
-Copyright (c) 2007-2012 Vassilis Rizopoulos
-
-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/Rakefile

@@ -1,30 +0,0 @@
-#  Copyright (c) 2007-2010 Vassilis Rizopoulos. All rights reserved.
-# -*- ruby -*-
-$:.unshift File.join(File.dirname(__FILE__),"lib")
-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 = "vassilisrizopoulos@gmail.com"
-  p.summary = 'rutema is a test execution and management framework for heterogeneous testing environments'
-  p.description = p.paragraphs_of('README.md', 1..4).join("\n\n")
-  p.urls= ["http://github.com/damphyr/rutema"]
-  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
-  p.extra_deps<<["patir", "~>0.8.0"]
-  p.extra_deps<<["highline","~>1.6.15"]
-  p.extra_deps<<["mailfactory","~>1.4.0"]
-  p.spec_extras={:executables=>["rutema"]}
-end
-
-task :default =>[:test,:system_tests]
-
-task :system_tests do 
-  Dir.chdir(File.join(File.dirname(__FILE__),'examples')) do 
-    sh('./system_test.sh')
-  end
-end
-# vim: syntax=Ruby
-

data/examples/README.md

@@ -1,17 +0,0 @@
-## rutema examples
-The examples included herein are also used to test the rutema functionality, so you know they work.
-
-## Structure
-The basic structure we follow in rutema usage (and this has been "in production" for a good 5 years now) is a config/ directory where each suite is configured, a specs/ directory to store the test specifications and a scritps/ directory for any scripts and data files used by the steps in the scripts directory. 
-
-We also usually add any custom code used in the configuration files in config/lib so that it can be required in the configuration files without much trouble.
-
-##Rutema configuration
-rutema is a modular system made up of two types of modules: parser and reporter.
-
-Customizing the behaviour of rutema involves specifying a parser to use for parsing test specifications and one or more reporters to handle the test results.
-
-Some examples:
- * [The absolute minimum](https://github.com/damphyr/rutema/blob/master/examples/config/minimal.rutema)
- * [Storing results in an active record database](https://github.com/damphyr/rutema/blob/master/examples/config/database.rutema)
- * [Specify setup, teardown and check scripts](https://github.com/damphyr/rutema/blob/master/examples/config/full.rutema)

data/examples/config/database.rutema

@@ -1,17 +0,0 @@
-require 'rutema/parsers/xml'
-require 'rutema/reporters/activerecord'
-#The parser to use
-configuration.parser={:class=>Rutema::MinimalXMLParser}
-#Use the AR-Reporter. 
-#In case of reporters the whole Hash is passed to the reporter initializer, so any keys are dependent on the reporter to use
-#Check the appropriate RDoc entries
-#Also note that any relative paths are relative to __the location of the configuration file__
-configuration.reporter={:class=>Rutema::ActiveRecordReporter, :db=>{:adapter=>"sqlite3",:database=>"../example.db"}}
-configuration.tests=[
-"../specs/T001.spec",
-"../specs/T002.spec",
-"../specs/T003.spec",
-"../specs/T004.spec",
-"../specs/T005.spec",
-"../specs/T006.spec"
-]

data/examples/config/full.rutema

@@ -1,27 +0,0 @@
-require 'rutema/parsers/xml'
-require 'rutema/reporters/activerecord'
-#Configures the parser to use. You can only use one parser and the last entry wins
-configuration.parser={:class=>Rutema::MinimalXMLParser}
-#Configures the reporters to use. You can define as many reporters as you wish (there are stdout, email, active record and couchdb reporters included). The Hash defined here is passed in it's entirety over to the reporter so each reporter defines different keys.
-#Check each reporter's RDoc entry for details
-configuration.reporter={:class=>Rutema::ActiveRecordReporter, :db=>{:adapter=>"sqlite3",:database=>"sample.db"}}
-configuration.tests=[
-"../specs/T001.spec",
-"../specs/T002.spec",
-"../specs/T003.spec",
-"../specs/T004.spec",
-"../specs/T005.spec",
-"../specs/T006.spec"
-]
-#This is a way to centrally configure tools and commands used to implement test steps.
-#When building command lines for test steps in the parser it is a good idea to have things like paths, IP addresses and other environment specific parameters in a single place. Using tool= and path= entries you can then access this information in the parser i.e. configuration.tool.test[:path]
-configuration.tool={:name=>"test",:path=>".",:configuration=>{:key=>"value"}}
-configuration.path={:name=>"test",:path=>"."}
-#The context Hash is used to pass general information to the rutema components (parser, runner, reporters). It's the easiest way to pass versioning information etc. Since the configuration file is Ruby code nothing prevents you from programmatically generating the context content here.
-configuration.context={:key=>"value"}
-#The test specification that runs as a sanity check before the entire suite. If it fails then the rest of the tests are not executed
-configuration.check="../specs/check.spec"
-#Teardown script
-configuration.teardown="../specs/teardown.spec"
-#Setup script
-configuration.setup="../specs/setup.spec"

data/examples/config/minimal.rutema

@@ -1,10 +0,0 @@
-require 'rutema/parsers/xml'
-configuration.parser={:class=>Rutema::MinimalXMLParser}
-configuration.tests=[
-"../specs/T001.spec",
-"../specs/T002.spec",
-"../specs/T003.spec",
-"../specs/T004.spec",
-"../specs/T005.spec",
-"../specs/T006.spec"
-]

data/examples/specs/T001.spec

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<specification name="T001">
-<title>T001</title>
-<description>An echo test</description>
-<scenario>
-	<echo>Hello Testing World</echo>
-</scenario>
-</specification>

data/examples/specs/T002.spec

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<specification name="T002">
-<title>T002</title>
-<description>A command test</description>
-<scenario>
-	<command cmd="ls"/>
-</scenario>
-</specification>

data/examples/specs/T003.spec

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<specification name="T003">
-<title>T003</title>
-<description>A prompt</description>
-<scenario attended="true">
-	<prompt>Are you there?</prompt>
-</scenario>
-</specification>

data/examples/specs/T004.spec

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<specification name="T004">
-<title>T004</title>
-<description>An implicitly attended test</description>
-<scenario>
-	<prompt>Are you (implicitly) there?</prompt>
-</scenario>
-</specification>

data/examples/specs/T005.spec

@@ -1,10 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<specification name="T005">
-<title>T005</title>
-<description>Test the include_scenario element</description>
-<scenario>
-	<echo>We can now include scenarios in standalone files</echo>
-	<include_scenario file="include.scenario"/>
-	<echo>This is the 4th step</echo>
-</scenario>
-</specification>

data/examples/specs/T006.spec

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<specification name="T006">
-<title>T006</title>
-<description>A command test</description>
-<scenario>
-	<command cmd="surely_it_will_fail" ignore="true"/>
-	<echo text="cool"/>
-</scenario>
-</specification>

data/examples/specs/check.spec

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<specification name="check">
-<title>Check specification</title>
-<description>Runs once at the beginning</description>
-<scenario>
-	<echo text="Just checking"/>
-</scenario>
-</specification>

data/examples/specs/fail.spec

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<specification name="fail">
-<title>Failing specification</title>
-<description>This will fail</description>
-<scenario>
-	<echo text="About to fail"/>
-	<command cmd="cd blibliki"/>
-</scenario>
-</specification>

data/examples/specs/include.scenario

@@ -1,5 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<scenario>
-	<echo>This is a step from an included scenario</echo>
-	<echo>And another step from the included scenario</echo>
-</scenario>

data/examples/specs/rutema.spec

@@ -1,10 +0,0 @@
-<specification name="TR001">
-<title>Rutema self hosting test</title>
-<description>Test that rutema is usable as a step in a specification using the distro test example</description>
-<scenario>
-	<command cmd="bundle exec ruby -I../../lib ../../bin/rutema -c ../config/minimal.rutema"/>
-	<command cmd="bundle exec ruby -I../../lib ../../bin/rutema -c ../config/database.rutema"/>
-	<command cmd="bundle exec ruby -I../../lib ../../bin/rutema -c ../config/database.rutema ../specs/T001.spec"/>
-	<command cmd="bundle exec ruby -I../../lib ../../bin/rutema -c ../config/full.rutema"/>
-</scenario>
-</specification>

data/examples/specs/setup.spec

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<specification name="setup">
-<title>Setup specification</title>
-<description>Runs before every test</description>
-<scenario>
-	<echo text="Setting up"/>
-</scenario>
-</specification>

data/examples/specs/teardown.spec

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<specification name="teardown">
-<title>Teardown specification</title>
-<description>Runs after every test</description>
-<scenario>
-	<echo text="Tearing down"/>
-</scenario>
-</specification>

data/lib/rutema/configuration.rb

@@ -1,173 +0,0 @@
-#  Copyright (c) 2007-2010 Vassilis Rizopoulos. All rights reserved.
-$:.unshift File.join(File.dirname(__FILE__),"..")
-require 'ostruct'
-require 'patir/configuration'
-module Rutema
-  #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 'rake'
-  # configuration.parser={:class=>Rutema::MinimalXMLParser}
-  # configuration.tests=FileList['all/of/the/tests/**/*.*']
-  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
-    #
-    #Required keys:
-    # :name - the name to use for accessing the path in code
-    #Example:
-    # configuration.tool={:name=>"nunit",:path=>"/bin/nunit",:configuration=>{:important=>"info"}}
-    #
-    #The path to make can be accessed in the parser as
-    # @configuration.tools.nunit[:path]
-    #
-    #This way you can pass configuration information for the tools you use
-    def tool= definition
-      @tools||=Hash.new
-      raise Patir::ConfigurationException,"required key :name is missing from #{definition}" unless definition[:name]
-      @tools[definition[:name]]=definition
-    end
-    #Adds a path to the paths hash of the configuration
-    #
-    #Required keys:
-    # :name - the name to use for accessing the path in code
-    # :path - the path
-    #Example:
-    # configuration.path={:name=>"sources",:path=>"/src"}
-    def path= definition
-      @paths||=Hash.new
-      raise Patir::ConfigurationException,"required key :name is missing from #{definition}" unless definition[:name]
-      raise Patir::ConfigurationException,"required key :path is missing from #{definition}" unless definition[:path]
-      @paths[definition[:name]]=definition[:path]
-    end
-    
-    #Path to the setup specification. (optional)
-    #
-    #The setup test runs before every test.
-    def setup= path
-      @setup=check_path(path)
-    end
-    
-    #Path to the teardown specification. (optional)
-    #
-    #The teardown test runs after every test.    
-    def teardown= path
-      @teardown=check_path(path)
-    end
-    
-    #Path to the check specification. (optional)
-    #
-    #The check test runs once in the beginning before all the tests.
-    #
-    #If it fails no tests are run.
-    def check= path
-      @check=check_path(path)
-    end
-    
-    #Hash values for passing data to the system. It's supposed to be used in the reporters and contain 
-    #values such as version numbers, tester names etc.
-    def context= definition
-      @context||=Hash.new
-      raise Patir::ConfigurationException,"Only accepting hash values as context_data" unless definition.kind_of?(Hash)
-      definition.each do |k,v|
-        @context[k]=v
-      end
-    end
-    
-    #Adds the specification identifiers available to this instance of Rutema
-    #
-    #These will usually be files, but they can be anything.
-    #Essentially this is an Array of strings that mean something to your parser
-    def tests= array_of_identifiers
-      @tests||=Array.new
-      @tests+=array_of_identifiers
-    end
-    
-    #A hash defining the parser to use.
-    #
-    #The hash is passed as is to the parser constructor and each parser should define the necessary configuration keys.
-    #
-    #The only required key from the configurator's point fo view is :class which should be set to the fully qualified name of the class to use.
-    #
-    #Example:
-    # configuration.parser={:class=>Rutema::MinimalXMLParser}
-    def parser= definition
-      raise Patir::ConfigurationException,"required key :class is missing from #{definition}" unless definition[:class]
-      @parser=definition
-    end
-    
-    #Adds a reporter to the configuration.
-    #
-    #As with the parser, the only required configuration key is :class and the definition hash is passed to the class' constructor.
-    # 
-    #Unlike the parser, you can define multiple reporters.
-    def reporter= definition
-      @reporters||=Array.new
-      raise Patir::ConfigurationException,"required key :class is missing from #{definition}" unless definition[:class]
-      @reporters<<definition
-    end
-
-    private 
-    #Checks if a path exists and raises a Patir::ConfigurationException if not
-    def check_path path
-      path=File.expand_path(path)
-      raise Patir::ConfigurationException,"#{path} does not exist" unless File.exists?(path)
-      return path
-    end
-    #Gives back a string of key=value,key=value for a hash
-    def definition_string definition
-      msg=Array.new
-      definition.each{|k,v| msg<<"#{k}=#{v}"}
-      return msg.join(",")
-    end
-  end
-  
-  #This class reads a Rutema configuration file
-  #
-  #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
-      @paths=Hash.new
-      @tools=Hash.new
-      @tests=Array.new
-      @setup=nil
-      @teardown=nil
-      @check=nil
-      super(config_file,logger)
-    end
-    
-    def configuration
-      @configuration=OpenStruct.new
-      Dir.chdir(File.dirname(config_file)) do |path|
-        @configuration.tools=OpenStruct.new(@tools)
-        @configuration.paths=OpenStruct.new(@paths)
-        @configuration.setup=@setup
-        @configuration.teardown=@teardown
-        @configuration.check=@check
-        @configuration.context=@context
-        @configuration.parser=@parser
-        raise Patir::ConfigurationException,"No parser defined" unless @configuration.parser
-        raise Patir::ConfigurationException,"Syntax error in parser definition - missing :class" unless @configuration.parser[:class]
-        @configuration.reporters=@reporters
-        @configuration.tests=@tests.collect do |t|  
-          if File.exists?(t) 
-            File.expand_path(t)
-          else
-            t
-          end
-        end
-        @configuration.filename=@config_file
-      end
-      return @configuration
-    end
-  end
-  
-end