rutema 0.8.0 → 0.9.0

data/History.txt

@@ -1,7 +1,11 @@
+== 0.9.0 / 2008-09-08
+* Ability to nest scenarios added to the base parser
+* Documentation at 
+
 == 0.8.0 / 2008-07-03
 * Split rutemaweb into own gem
 * Refactored reporters
-* Re-enabled the --step commandline facility of rutemax alowing step-by-step execution and fixed the StepRunner implementation
+* Re-enabled the --step commandline facility of rutemax allowing step-by-step execution and fixed the StepRunner implementation
 
 == 0.7.1 / 2008-06-12
 * Added the ruport_formatter.rb file to the manifest (and consequently to the gem)

data/Manifest.txt

@@ -28,14 +28,12 @@ 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/include.scenario
+test/distro_test/specs/no_title.spec
+test/distro_test/specs/sample.spec
 test/rutema.rutema
 test/rutema.spec
-test/samples/check.spec
-test/samples/setup.spec
-test/samples/teardown.spec
-test/samples/test.spec
-test/samples/tests/no_title.spec
-test/samples/tests/sample.spec
 test/test_configuration.rb
 test/test_historian.rb
 test/test_model.rb

data/README.txt

@@ -6,6 +6,7 @@ It allows you to combine test tools while it takes care of logging, reporting, a
 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.)
@@ -14,7 +15,6 @@ For more information look at http://patir.rubyforge.org/rutema
 * 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:

data/lib/rutema/configuration.rb

@@ -44,7 +44,7 @@ module Rutema
     def setup= path
       @setup=check_path(path)
     end
-
+    
     #Path to the teardown specification. (optional)
     #
     #The teardown test runs after every test.    
@@ -54,7 +54,8 @@ module Rutema
     
     #Path to the check specification. (optional)
     #
-    #The check test runs once in the beginning.
+    #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)

data/lib/rutema/db.rb

@@ -1,3 +1,4 @@
+#  Copyright (c) 2008 Vassilis Rizopoulos, Markus Barchfeld. All rights reserved.
 $:.unshift File.join(File.dirname(__FILE__),"..")
 require 'rutema/gems'
 

data/lib/rutema/historian.rb

@@ -1,3 +1,4 @@
+#  Copyright (c) 2007 Vassilis Rizopoulos. All rights reserved.
 $:.unshift File.join(File.dirname(__FILE__),"..")
 require 'rutema/model'
 require 'rutema/system'

data/lib/rutema/specification.rb

@@ -149,7 +149,7 @@ module Rutema
       #assign
       @attributes[:cmd]=cmd if cmd
       @attributes[:text]=txt
-      @attributes[:number]=0
+      @number=0
       @attributes[:step_type]="step"
     end
     
@@ -180,7 +180,9 @@ module Rutema
       @attributes[:cmd].reset if @attributes[:cmd]
     end
     def to_s
-      "#{self.number} - #{self.step_type} - #{self.status}"
+      msg="#{self.number} - #{self.step_type} - #{self.status}"
+      msg<<" in #{self.included_in}" if self.has_included_in?
+      return msg
     end
   end
   

data/lib/rutema/system.rb

@@ -10,7 +10,7 @@ module Rutema
   #This module defines the version numbers for the library
   module Version
     MAJOR=0
-    MINOR=8
+    MINOR=9
     TINY=0
     STRING=[ MAJOR, MINOR, TINY ].join( "." )
   end
@@ -47,18 +47,16 @@ module Rutema
     def parse_specification param
       @logger.debug("Loading #{param}")
       begin
-        file=false
         if File.exists?(param)
           #read the file
           txt=File.read(param)
-          file=true
+          filename=File.expand_path(param)
         else
+          filename=Dir.pwd
           #try to parse the parameter
           txt=param
         end
-        spec=parse_case(txt)
-        spec.filename=""
-        spec.filename=param if file
+        spec=parse_case(txt,filename)
         raise "Missing required attribute 'name' in specification element" unless spec.has_name? && !spec.name.empty?
         return spec
       rescue
@@ -66,10 +64,10 @@ module Rutema
         raise ParserError,"Error loading #{param}: #{$!.message}"
       end
     end
-
+    
     private
     #Parses the XML specification of a testcase and creates the corresponding TestSpecification instance
-    def parse_case xmltxt
+    def parse_case xmltxt,filename
       #the testspec to return
       spec=TestSpecification.new
       #read the test spec
@@ -99,7 +97,10 @@ module Rutema
       spec.requirements=reqs
       #Get the scenario
       @logger.debug("Parsing scenario element")
-      spec.scenario=parse_scenario(xmldoc.elements[ELEM_SCENARIO].to_s) if xmldoc.elements[ELEM_SCENARIO]
+      Dir.chdir(File.dirname(filename)) do
+        spec.scenario=parse_scenario(xmldoc.elements[ELEM_SCENARIO].to_s) if xmldoc.elements[ELEM_SCENARIO]
+      end
+      spec.filename=filename
       return spec
     end
     #Validates the XML file from our point of view.
@@ -110,8 +111,10 @@ module Rutema
       raise ParserError,"missing #{ELEM_DESC} element" unless xmldoc.elements[ELEM_DESC]
       raise ParserError,"missing #{ELEM_TITLE} element" unless xmldoc.elements[ELEM_TITLE]
     end
+    
     #Parses the scenario XML element and returns the Rutema::TestScenario instance
     def parse_scenario xmltxt
+      @logger.debug("Parsing scenario from #{xmltxt}")
       scenario=Rutema::TestScenario.new
       xmldoc=REXML::Document.new( xmltxt )
       xmldoc.root.attributes.each do |attr,value|
@@ -119,13 +122,25 @@ module Rutema
       end
       number=0
       xmldoc.root.elements.each do |el| 
-        number+=1
         step=parse_step(el.to_s)
-        step.number=number
-        scenario.add_step(step)
+        if step.step_type=="include_scenario"
+          included_scenario=include_scenario(step)
+          included_scenario.steps.each do |st|
+            @logger.debug("Adding included step #{st}")
+            number+=1
+            st.number=number
+            st.included_in=step.file
+            scenario.add_step(st)
+          end
+        else
+          number+=1
+          step.number=number
+          scenario.add_step(step)
+        end
       end
       return scenario
     end
+    
     #Parses xml and returns the Rutema::TestStep instance
     def parse_step xmltxt
       xmldoc=REXML::Document.new( xmltxt )
@@ -147,10 +162,23 @@ module Rutema
         element.attribute(attr,value)
       end
     end
+   
     def boolean? attribute_value
       return true if attribute_value=="true" || attribute_value=="false"
       return false
     end
+    
+    #handles <include_scenario> elements, adding the steps to the current scenario
+    def include_scenario step
+      @logger.debug("Including file from #{step}")
+      raise ParserError,"missing required attribute file in #{step}" unless step.has_file?
+      raise ParserError,"Cannot find #{File.expand_path(step.file)}" unless File.exists?(File.expand_path(step.file))
+      #Load the scenario
+      step.file=File.expand_path(step.file)
+      include_content=File.read(step.file)
+      @logger.debug(include_content)
+      return parse_scenario(include_content)
+    end
   end
   #The ExtensibleXMLParser allows you to easily add methods to handle specification elements.
   #

data/test/distro_test/config/database.rutema

@@ -8,5 +8,6 @@ configuration.tests=[
 "../specs/T001.spec",
 "../specs/T002.spec",
 "../specs/T003.spec",
-"../specs/T004.spec"
+"../specs/T004.spec",
+"../specs/T005.spec"
 ]

data/test/distro_test/config/full.rutema

@@ -1,10 +1,11 @@
 configuration.parser={:class=>Rutema::MinimalXMLParser}
-configuration.reporter={:class=>Rutema::ActiveRecordReporter, :database=>"sample.db"}
+configuration.reporter={:class=>Rutema::ActiveRecordReporter, :db=>{:database=>"sample.db"}}
 configuration.tests=[
 "../specs/T001.spec",
 "../specs/T002.spec",
 "../specs/T003.spec",
-"../specs/T004.spec"
+"../specs/T004.spec",
+"../specs/T005.spec"
 ]
 configuration.tool={:name=>"test",:path=>".",:configuration=>{:key=>"value"}}
 configuration.path={:name=>"test",:path=>"."}

data/test/distro_test/config/jruby.rutema

@@ -4,5 +4,6 @@ configuration.tests=[
 "../specs/T001.spec",
 "../specs/T002.spec",
 "../specs/T003.spec",
-"../specs/T004.spec"
+"../specs/T004.spec",
+"../specs/T005.spec"
 ]

data/test/distro_test/config/minimal.rutema

@@ -3,5 +3,6 @@ configuration.tests=[
 "../specs/T001.spec",
 "../specs/T002.spec",
 "../specs/T003.spec",
-"../specs/T004.spec"
+"../specs/T004.spec",
+"../specs/T005.spec"
 ]

data/test/distro_test/specs/T001.spec

@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
 <specification name="T001">
 <title>T001</title>
 <description>An echo test</description>

data/test/distro_test/specs/T002.spec

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

data/test/distro_test/specs/T003.spec

@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
 <specification name="T003">
 <title>T003</title>
 <description>A prompt</description>

data/test/distro_test/specs/T004.spec

@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
 <specification name="T004">
 <title>T004</title>
 <description>An implicitly attended test</description>

data/test/distro_test/specs/T005.spec

@@ -0,0 +1,10 @@
+<?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 5th step</echo>
+</scenario>
+</specification>

data/test/distro_test/specs/include.scenario

@@ -0,0 +1,5 @@
+<?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/test/{samples/tests → distro_test/specs}/no_title.spec

@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
 <specification name="no_title">
 <description>Expect a parser error</description>
 <scenario></scenario>

data/test/{samples/tests → distro_test/specs}/sample.spec

@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
 <specification name="sample">
 <title>Sample specification</title>
 <description>Something to play with</description>

data/test/test_system.rb

@@ -18,6 +18,34 @@ module TestRutema
     </scenario>
     </specification>
 EOT
+    INCLUDE_SPEC=<<EOT
+    <specification name="include">
+    <title>Title</title>
+    <description>Description</description>
+    <scenario>
+    <step/>
+    <include_scenario file="#{File.expand_path(File.dirname(__FILE__))}/distro_test/specs/include.scenario"/>
+    </scenario>
+    </specification>
+EOT
+    BAD_INCLUDE_SPEC=<<EOT
+    <specification name="bad_include">
+    <title>Title</title>
+    <description>Description</description>
+    <scenario>
+    <include_scenario file=unknown.scenario"/>
+    </scenario>
+    </specification>
+EOT
+    MISSING_INCLUDE_SPEC=<<EOT
+    <specification name="bad_include">
+    <title>Title</title>
+    <description>Description</description>
+    <scenario>
+    <include_scenario/>
+    </scenario>
+    </specification>
+EOT
     
     def test_parse_specification
       parser=Rutema::BaseXMLParser.new({})
@@ -34,6 +62,16 @@ EOT
       assert_raise(Rutema::ParserError) { parser.parse_specification("") }
       assert_raise(Rutema::ParserError) { parser.parse_specification("missing.spec") }
     end
+    
+    def test_include
+      parser=Rutema::BaseXMLParser.new({})
+      specification=parser.parse_specification(INCLUDE_SPEC)
+      assert_equal(3, specification.scenario.steps.size)
+      assert(specification.scenario.steps[2].has_included_in?)
+      assert_raise(Rutema::ParserError) {  parser.parse_specification(BAD_INCLUDE_SPEC) }
+      assert_raise(Rutema::ParserError) {  parser.parse_specification(MISSING_INCLUDE_SPEC) }
+    end
+    
   end
   
   class TestExtensibleXMlParser<Test::Unit::TestCase
@@ -91,8 +129,8 @@ EOT
         coord.run(:all)
         coord.run(:attended)
         coord.run(:unattended)
-        coord.run("samples/tests/sample.spec")
-        coord.run("samples/tests/no_title.spec")
+        coord.run("distro_test/specs/sample.spec")
+        coord.run("distro_test/specs/no_title.spec")
       end
       assert_equal(1,coord.parse_errors.size)
       puts coord.to_s if $DEBUG

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rutema
 version: !ruby/object:Gem::Version 
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Vassilis Rizopoulos
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-03 00:00:00 +02:00
+date: 2008-09-08 00:00:00 +02:00
 default_executable: rutemax
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -82,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.7.0
     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
@@ -125,14 +125,12 @@ files:
 - 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/include.scenario
+- test/distro_test/specs/no_title.spec
+- test/distro_test/specs/sample.spec
 - test/rutema.rutema
 - test/rutema.spec
-- test/samples/check.spec
-- test/samples/setup.spec
-- test/samples/teardown.spec
-- test/samples/test.spec
-- test/samples/tests/no_title.spec
-- test/samples/tests/sample.spec
 - test/test_configuration.rb
 - test/test_historian.rb
 - test/test_model.rb

data/test/samples/check.spec

@@ -1,5 +0,0 @@
-<specification name="check">
-	<title></title>
-	<description></description>
-	<scenario></scenario>
-</specification>

data/test/samples/setup.spec

@@ -1,7 +0,0 @@
-<specification name="setup">
-	<title></title>
-	<description></description>
-	<scenario>
-		<echo>Hello Testing World</echo>
-	</scenario>
-</specification>

data/test/samples/teardown.spec

@@ -1,7 +0,0 @@
-<specification name="teardown">
-	<title></title>
-	<description></description>
-	<scenario>
-		<echo>Hello Testing World</echo>
-	</scenario>
-</specification>

data/test/samples/test.spec

@@ -1,7 +0,0 @@
-<specification name="sample">
-<title>Sample specification</title>
-<description>Something to play with</description>
-<scenario>
-	<echo>Hello Testing World</echo>
-</scenario>
-</specification>