rutema 0.4 → 0.4.1

data/History.txt

@@ -1,7 +1,16 @@
+== 0.4.1 / 2007-12-04
+* Documented MinimalXMLParser
+* More debug logs
+* Fixed bug in attribute checking for command steps in the minimal parser
+* Fixed bug in specification parsing in the Coordinator (no specs were returned)
+* Fixed bug in the implementation of <prompt> in the minimal parser (attended was not set)
+* Fixed bug in evaluation of attended status for steps
+* Fixed bug where runner would complain that attened scenarios cannot be run in unattended mode when choosing to run only attended tests
+* Added Version module to better handle versioning
 == 0.4 / 2007-07-05
 * rutemaweb, a web interface for the db contents added
 	* uses WEBRick, Camping and Ruport
-	* offers views on all runs in the System, detailed scenario views and ccenario-over-time views
+	* offers views on all runs in the System, detailed scenario views and scenario-over-time views
 * Runner now rescues all failures in scenarios
 * Bugfix in setting status of attended scenario in unattended mode
 * Better ruport usage in the historian

data/Manifest.txt

@@ -23,7 +23,6 @@ lib/rutemaweb/htdocs/step_ok.png
 lib/rutemaweb/htdocs/step_warn.png
 lib/rutemaweb/htdocs/style.css
 lib/rutemaweb/htdocs/tie_logo.gif
-lib/rutemaweb/htdocs/index.html
 lib/rutemaweb/rutemaweb.rb
 test/test_configuration.rb
 test/test_specification.rb

data/Rakefile

@@ -6,7 +6,7 @@ require 'rubygems'
 require 'hoe'
 require 'rutema/system'
 
-Hoe.new('rutema', "#{Rutema::VERSION_MAJOR}.#{Rutema::VERSION_MINOR}") do |p|
+Hoe.new('rutema', "#{Rutema::Version::STRING}") do |p|
   p.rubyforge_name = 'patir'
   p.author = "Vassilis Rizopoulos"
   p.email = "riva@braveworld.net"

data/lib/rutema/model.rb

@@ -1,3 +1,4 @@
+#  Copyright (c) 2007 Vassilis Rizopoulos. All rights reserved.
 require 'rubygems'
 require 'active_record'
 require 'ruport/acts_as_reportable'

data/lib/rutema/reporter.rb

@@ -79,7 +79,7 @@ module Rutema
           #~ if @password
           #~ #if a password is defined, use cram_md5 authentication
           #~ else
-          Net::SMTP.start(@server, @port, @domain) {|smtp| smtp.sendmail(@mail.to_s(),@mail.from,mail_to)} unless @dummy
+          Net::SMTP.start(@server, @port, @domain) {|smtp| smtp.sendmail(@mail.to_s(),@mail.from,@mail.to)} unless @dummy
           #~ end
         end#recipients empty
       rescue

data/lib/rutema/specification.rb

@@ -89,13 +89,15 @@ module Rutema
     attr_reader :steps
     
     def initialize version=nil
+      @attributes=Hash.new
+      #attended is off by default
+      @attributes[:attended]=false
       @version=version
-      @attended=false
       @steps=Array.new
     end
     
     def attended?
-      return @attended
+      return @attributes[:attended]
     end
     
     def add_step step
@@ -143,6 +145,7 @@ module Rutema
       @attributes[:cmd]=cmd if cmd
       @attributes[:text]=txt
       @attributes[:number]=0
+      @attributes[:step_type]="step"
     end
     
     def output
@@ -168,6 +171,9 @@ module Rutema
     def reset
       @attributes[:cmd].reset if @attributes[:cmd]
     end
+    def to_s
+      "#{self.number} - #{self.step_type} - #{self.status}"
+    end
   end
   
 end

data/lib/rutema/system.rb

@@ -12,8 +12,13 @@ require 'highline'
 require 'patir/command'
 
 module Rutema
-  VERSION_MAJOR=0
-  VERSION_MINOR=4
+  #This module defines the version numbers for the library
+  module Version
+    MAJOR=0
+    MINOR=4
+    TINY=1
+    STRING=[ MAJOR, MINOR, TINY ].join( "." )
+  end
   #Is raised when an error is found in a specification
   class ParserError<RuntimeError
   end
@@ -94,6 +99,7 @@ module Rutema
       reqs.collect!{|r| r.attributes["name"]}
       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]
       return spec
     end
@@ -130,11 +136,12 @@ module Rutema
         add_attribute(step,attr,value)
       end
       step.text=xmldoc.root.text.strip if xmldoc.root.text
-      step.step_type=xmldoc.root.name 
+      step.step_type=xmldoc.root.name
       return step
     end
 
     def add_attribute element,attr,value
+      @logger.debug("Adding attribute #{attr} with value #{value}")
       if boolean?(value)
         element.attribute(attr,eval(value))
       else
@@ -147,25 +154,33 @@ module Rutema
     end
   end
 
+  #MinimalXMLParser offers three runnable steps in the scenarios:
+  #
+  #echo prints a message on the screen:
+  # <echo text="A meaningful message"/>
+  # <echo>A meaningful message</echo>
+  #command executes a shell command
+  # <command cmd="useful_command.exe with parameters", working_directory="some/directory"/>
+  #prompt asks the user a yes/no question. Anwerings yes means the step is succesfull.
+  # <prompt text="Do you want fries with that?"/> 
   class MinimalXMLParser<BaseXMLParser
     def parse_specification param
-      handle_specification(super(param))
-    end
-    private
-    def handle_specification spec
+      spec = super(param)
       spec.scenario.steps.each do |step|
         case step.step_type
         when "echo"
           step.cmd=Patir::RubyCommand.new("echo"){|cmd| cmd.output="#{step.text}";$stdout.puts(cmd.output) ;:success}
         when "command"
-          raise ParserError,"missing required attribute cmd in #{step}"
+          raise ParserError,"missing required attribute cmd in #{step}" unless step.has_cmd?
           wd=step.working_directory if step.has_working_directory?
           step.cmd=Patir::ShellCommand.new(:cmd=>step.cmd,:working_directory=>wd)
         when "prompt"
+          step.attended=true
+          spec.scenario.attended=true
           step.cmd=Patir::RubyCommand.new("prompt") do |cmd|  
             cmd.output=""
             cmd.error=""
-            if HighLine.agree("#{step.text}?")
+            if HighLine.new.agree("#{step.text}?")
               :success
             else
               :error
@@ -200,13 +215,16 @@ module Rutema
     #mode can be :all, :attended, :unattended or a test filename
     def run mode
       @configuration.context.start_time=Time.now
-      @logger.info("Run started")
+      @logger.info("Run started in mode '#{mode}'")
       begin
         case mode
         when :all
+          @runner.attended=true
           specs=parse_all_specifications
+          @logger.debug(specs)
           run_scenarios(specs)
         when :attended
+          @runner.attended=true
           specs=parse_all_specifications
           @logger.debug(specs)
           run_scenarios(specs.select{|s| s.scenario && s.scenario.attended?})
@@ -216,13 +234,14 @@ module Rutema
           run_scenarios(specs.select{|s| s.scenario && !s.scenario.attended?})
         when String
           spec=parse_specification(mode)
+          @logger.debug("Running #{spec}")
           run_test(spec) if spec
         else
           @logger.error("Don't know how to run '#{mode}'")
         end
       rescue
-        @logger.error("Runner error: #{$!.message}")
         @logger.debug($!)
+        @logger.error("Runner error: #{$!.message}")
       end
       @configuration.context.end_time=Time.now
       @logger.info("Run completed in #{@configuration.context.end_time-@configuration.context.start_time}s")
@@ -295,10 +314,17 @@ module Rutema
         @logger.error(msg)
         @parse_errors<<{:filename=>filename,:error=>msg}
       end
-      return nil
+      return spec
     end
     def parse_all_specifications
-      @configuration.tests.collect{|t| parse_specification(t)}.compact
+      @configuration.tests.collect do |t| 
+        begin
+          parse_specification(t)
+        rescue
+          @logger.debug($!)
+          @logger.error($!.message)
+        end
+      end.compact
     end
 
     def run_scenarios specs
@@ -394,7 +420,7 @@ module Rutema
           @logger.warn("Attended scenario cannot be run in unattended mode")
           state.status=:warning
         else
-          if scenario.attended?a
+          if scenario.attended?
             state.strategy=:attended
           else
             state.strategy=:unattended
@@ -420,13 +446,13 @@ module Rutema
       return state
     end
     def run_step step
-      @logger.info("#{step.to_s}")
+      @logger.info(step.to_s)
       if step.has_cmd? && step.cmd.respond_to?(:run)
         step.cmd.run
       else
         @logger.warn("No command associated with step '#{step.step_type}'")
       end
-      msg="#{step.number} - #{step.step_type} - #{step.status}"
+      msg=step.to_s
       # we might not have a command object
       if step.has_cmd? && step.cmd.executed? && !step.cmd.success?
         msg<<"\n#{step.cmd.output}" unless step.cmd.output.empty?
@@ -483,7 +509,7 @@ module Rutema
         opt.on("--config FILE", "-c FILE",String,"Loads the configuration from FILE") { |@config_file|}
         opt.on("--log FILE", "-l FILE",String,"Redirects the log output to FILE") { |@log_file|}
         opt.on("--check","Runs just the check test"){@check=true}
-        opt.on("-V", "--version","Displays the version") { $stdout.puts("v#{VERSION_MAJOR}.#{VERSION_MINOR}");exit 0 }
+        opt.on("-v", "--version","Displays the version") { $stdout.puts("v#{Version::STRING}");exit 0 }
         opt.on("--help", "-h", "-?", "This text") { $stdout.puts opt; exit 0 }
         opt.on("The commands are:")
       	opt.on("\tall - Runs all tests")
@@ -507,7 +533,7 @@ module Rutema
             if File.exists?(command)
               @mode=command
             else
-              $stderr.puts "Can't find '#{command}'. Don't know what to do with it."
+              $stderr.puts "Can't find '#{command}' and it does not match any known commands. Don't know what to do with it."
               exit 1
             end
           end

data/lib/rutemaweb/rutemaweb.rb

@@ -12,6 +12,7 @@ Camping.goes :RutemaWeb
 
 #This is the module containing the Camping views and controllers for the web interface to rutema
 module RutemaWeb
+  HTDOCS=File.expand_path(File.join(File.dirname(__FILE__),"htdocs"))
   #The rutema web interface controllers
   module RutemaWeb::Controllers
     #This is the main controller
@@ -56,6 +57,16 @@ module RutemaWeb
         end
       end
     end
+    
+    class StyleSheetsAndImages < R '/(.*[css|jpg|png|gif])'
+      def get name
+        @headers['Content-Type'] = "image/jpg" if name=~/$jpg/
+        @headers['Content-Type'] = "image/png" if name=~/$png/
+        @headers['Content-Type'] = "image/gif" if name=~/$gif/
+        @headers['Content-Type'] = "text/css" if name=~/$css/
+        @headers['X-Sendfile'] = File.join(RutemaWeb::HTDOCS,name)
+      end
+    end
   end
   module RutemaWeb::Views
     #Time format to use for the start and stop times
@@ -96,7 +107,7 @@ module RutemaWeb
                 div.bodytext(:style=>"padding:12px;", :align=>"justify"){self<<yield}
               end
               leftpanel
-              footer
+              div.footer!(:class=>"smallgraytext") {"&copy; 2007 Vassilis Rizopoulos"}
             end
           end 
         end
@@ -105,7 +116,8 @@ module RutemaWeb
     
     #Start point: No rendering content
     def start
-
+      	p{"This is the rutema web interface.<br/>It allows you to browse the contents of the test results database."}
+				p{"Currently you can view the results for each separate run, the results for a specific scenario (a complete list of all steps executed in the scenario with standard and error output logs) or the complete execution history of a scenario."}
     end
     
     #Renders the information for a specific executed scenario
@@ -199,13 +211,6 @@ module RutemaWeb
       end
     end
     
-    #Just a bit of copyright info as a footer
-    def footer
-      div.footer!(:class=>"smallgraytext") do
-        "&copy; 2007 Vassilis Rizopoulos"
-      end
-    end
-    
     #will render a hash in a table of key||value rows 
     def context_table context
        table do
@@ -220,8 +225,8 @@ module RutemaWeb
   end
 end
 
-#Starts a WEBRick server with the RutemaWeb controller in /rutema
-def start_server (port=3301,docroot=File.join(File.dirname(__FILE__),"htdocs"),mountpoint="/rutema")
+#Starts a WEBRick server with the RutemaWeb controller in /
+def start_server (port=3301,docroot=RutemaWeb::HTDOCS,mountpoint="/")
   include WEBrick 
   dbfile=ARGV.shift
   if !dbfile

metadata

@@ -1,102 +1,21 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.1
-specification_version: 1
 name: rutema
 version: !ruby/object:Gem::Version 
-  version: "0.4"
-date: 2007-07-05 00:00:00 +02:00
-summary: rutema is a test execution and management framework for heterogeneous testing environments
-require_paths: 
-- lib
-email: riva@braveworld.net
-homepage: 
-rubyforge_project: patir
-description: "== DESCRIPTION:  Rutema provides the basis for building tools that can manage the execution of tests as well as an example implementation as proof-of-concept for the ideas behind it.  It's purpose is to provide a set of classes and a framework that will allow testers to specify and execute tests in heterogeneous testing environments.   A heterogeneous testing environment would be one where several testing tools are put to use, each with it's own scripts and ways to define tests. Rutema will allow you to combine tools, take care of logging, reporting, archiving of results and formalize execution of automated and manual tests.   For more information look at http://patir.rubyforge.org/rutema  == FEATURES/PROBLEMS:  *"
-autorequire: 
-default_executable: rutemax
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
-platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
+  version: 0.4.1
+platform: ""
 authors: 
 - Vassilis Rizopoulos
-files: 
-- History.txt
-- Manifest.txt
-- README.txt
-- COPYING.txt
-- Rakefile
-- bin/rutemax
-- bin/rutemah
-- bin/rutemaweb
-- lib/rutema/configuration.rb
-- lib/rutema/specification.rb
-- lib/rutema/system.rb
-- lib/rutema/reporter.rb
-- lib/rutema/reporter_ar.rb
-- lib/rutema/historian.rb
-- lib/rutema/model.rb
-- lib/rutemaweb/htdocs/bg_menu.gif
-- lib/rutemaweb/htdocs/bg_submenu.gif
-- lib/rutemaweb/htdocs/run_error.png
-- lib/rutemaweb/htdocs/run_ok.png
-- lib/rutemaweb/htdocs/run_warn.png
-- lib/rutemaweb/htdocs/step_error.png
-- lib/rutemaweb/htdocs/step_ok.png
-- lib/rutemaweb/htdocs/step_warn.png
-- lib/rutemaweb/htdocs/style.css
-- lib/rutemaweb/htdocs/tie_logo.gif
-- lib/rutemaweb/htdocs/index.html
-- lib/rutemaweb/rutemaweb.rb
-- test/test_configuration.rb
-- test/test_specification.rb
-- test/test_system.rb
-- test/test_historian.rb
-- test/test_reporter.rb
-- 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/samples/valid_config.rb
-- test/samples/rutemah_config.rb
-test_files: 
-- test/test_configuration.rb
-- test/test_historian.rb
-- test/test_model.rb
-- test/test_reporter.rb
-- test/test_specification.rb
-- test/test_system.rb
-rdoc_options: 
-- --main
-- README.txt
-extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.txt
-- COPYING.txt
-executables: 
-- rutemax
-- rutemah
-- rutemaweb
-extensions: []
-
-requirements: []
+autorequire: 
+bindir: bin
+cert_chain: []
 
+date: 2007-12-04 00:00:00 +01:00
+default_executable: rutemax
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: patir
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -105,54 +24,141 @@ dependencies:
 - !ruby/object:Gem::Dependency 
   name: highline
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.0
+        version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
   name: mailfactory
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.0
+        version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.0
+        version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
   name: ruport
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.0
+        version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
   name: camping
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.0
+        version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.1
+        version: 1.3.0
     version: 
+description: "== DESCRIPTION:  Rutema provides the basis for building tools that can manage the execution of tests as well as an example implementation as proof-of-concept for the ideas behind it.  It's purpose is to provide a set of classes and a framework that will allow testers to specify and execute tests in heterogeneous testing environments.   A heterogeneous testing environment would be one where several testing tools are put to use, each with it's own scripts and ways to define tests. Rutema will allow you to combine tools, take care of logging, reporting, archiving of results and formalize execution of automated and manual tests.   For more information look at http://patir.rubyforge.org/rutema  == FEATURES/PROBLEMS:  *"
+email: riva@braveworld.net
+executables: 
+- rutemax
+- rutemah
+- rutemaweb
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- COPYING.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- COPYING.txt
+- Rakefile
+- bin/rutemax
+- bin/rutemah
+- bin/rutemaweb
+- lib/rutema/configuration.rb
+- lib/rutema/specification.rb
+- lib/rutema/system.rb
+- lib/rutema/reporter.rb
+- lib/rutema/reporter_ar.rb
+- lib/rutema/historian.rb
+- lib/rutema/model.rb
+- lib/rutemaweb/htdocs/bg_menu.gif
+- lib/rutemaweb/htdocs/bg_submenu.gif
+- lib/rutemaweb/htdocs/run_error.png
+- lib/rutemaweb/htdocs/run_ok.png
+- lib/rutemaweb/htdocs/run_warn.png
+- lib/rutemaweb/htdocs/step_error.png
+- lib/rutemaweb/htdocs/step_ok.png
+- lib/rutemaweb/htdocs/step_warn.png
+- lib/rutemaweb/htdocs/style.css
+- lib/rutemaweb/htdocs/tie_logo.gif
+- lib/rutemaweb/rutemaweb.rb
+- test/test_configuration.rb
+- test/test_specification.rb
+- test/test_system.rb
+- test/test_historian.rb
+- test/test_reporter.rb
+- 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/samples/valid_config.rb
+- test/samples/rutemah_config.rb
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: patir
+rubygems_version: 0.9.5
+signing_key: 
+specification_version: 2
+summary: rutema is a test execution and management framework for heterogeneous testing environments
+test_files: 
+- test/test_configuration.rb
+- test/test_historian.rb
+- test/test_model.rb
+- test/test_reporter.rb
+- test/test_specification.rb
+- test/test_system.rb

data/lib/rutemaweb/htdocs/index.html

@@ -1,50 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-	<meta name="author" content="Vassilis Rizopoulos" />
-	<meta http-equiv="Content-Type" content="text/html; charset=UTF8" />
-	<link rel="stylesheet" href="style.css" type="text/css" />
-	<title>Rutema Historian Web Interface</title>
-</head>
-<body>
-	<div id="page" align="center">
-		<div id="content" style="width:800px">
-			<div id="logo">
-				<div style="margin-top:70px" class="whitetitle">rutema</div>
-			</div>
-			<div id="topheader">
-				<div align="left" class="bodytext">
-					<br />
-				</div>
-			</div>
-			<div id="menu">
-			</div>
-			<div id="submenu">
-				<div align="right" class="smallgraytext" style="padding:9px;">
-				<!--	<a href="../index.html">patir</a> | <a href="index.html">rutema</a> | <a href="rdoc/index.html">rdoc</a> -->
-				</div>
-			</div>
-			<div id="contenttext">
-				<div style="padding:10px">
-					<span class="titletext">Intro</span>
-				</div>
-				<div class="bodytext" style="padding:12px;" align="justify">
-					<p>This is the rutema web interface.<br />
-					It allows you to browse the contents of the test results database.
-					</p>
-					<p>Currently you can view the results for each separate run, the results for a specific scenario (a complete list of all steps executed in the scenario with standard and error output logs) or the complete execution history of a scenario.</p>
-				</div>
-			</div>
-				<div id="leftpanel">
-					<div align="justify" class="graypanel">
-						<span class="bodytext"><a href="/rutema" class="smallgraytext">Run overview</a></span><br /><br />
-						<span class="bodytext"><a href="/rutema?scenarios=all" class="smallgraytext">Scenario overview</a></span><br /><br />
-					</div>
-				</div>
-			<div id="footer" class="smallgraytext">
-				<a href="/index.html">Home</a> |	&copy; 2007 Vassilis Rizopoulos</a> 
-			</div>
-		</div>
-	</div>
-</body>
-</html>