rutema 0.9.0 → 0.9.1

data/History.txt

@@ -1,6 +1,12 @@
+== 0.9.1 / 2008-09-09
+* Modularisation of element parsing methods introduced. 
+* MinimalXMLParser refactored as example.
+* Extra element parser modules available in the rutema_elements gem
+* Cleaned up EmailReporter. Unit tests with Mocha, text report has a better layout
+
 == 0.9.0 / 2008-09-08
 * Ability to nest scenarios added to the base parser
-* Documentation at 
+* Documentation at http://patir.rubyforge.org/rutema/tool_configuration.html
 
 == 0.8.0 / 2008-07-03
 * Split rutemaweb into own gem

data/lib/rutema/reporter.rb

@@ -12,7 +12,7 @@ module Rutema
 
     #Coordinator will pass the Rutema __configuration__ giving you access to the context which can contain data like headings and build numbers to use in the report. It will also pass the specifications used in the last run so that data like the title and the specification version can be used.
     #
-    #runner_states is an Hash of Patir::CommandSeqeunceStatus indexed by the specification name containing the stati of the last run (so it contains all the Scenario stati for the loaded tests)
+    #runner_states is a Hash of Patir::CommandSeqeunceStatus indexed by the specification name containing the stati of the last run (so it contains all the Scenario stati for the loaded tests)
     #
     #parse_errors is an Array of {:filename,:error} hashes containing the errors encountered by the parser when loading the specifications
     def report specifications,runner_states,parse_errors,configuration
@@ -21,11 +21,5 @@ module Rutema
   end
 
   private
-  def self.text_report runner_states,parse_errors
-    msg="Parse errors: #{parse_errors.size}"
-    parse_errors.each{|e| msg<<"\n\t#{e[:filename]}"}
-    msg<<"\nCurrent run:\nScenarios: #{runner_states.size}"
-    # msg<<"\n#{runner_status.summary}"
-    return msg
-  end
+  
 end

data/lib/rutema/reporters/activerecord.rb

@@ -10,12 +10,10 @@ module Rutema
   #The ActiveRecordReporter will store the results of a test run in a database using ActiveRecord.
   #
   #The DBMSs supported are dependent on the platform: either SQLite3 (MRI) or h2 (jruby)
-  class ActiveRecordReporter<Reporter
+  class ActiveRecordReporter
     #The required keys in this reporter's configuration are:
     # :db - the database configuration. A Hash with the DB adapter information
     #  :db=>{:database=>"sample.rb"}
-    #
-    #Optionally you can pass a Logger instance with the :logger key
     def initialize definition
       @logger=definition[:logger]
       @logger||=Patir.setup_logger

data/lib/rutema/reporters/email.rb

@@ -42,8 +42,6 @@ module Rutema
       #customize
       @subject=definition[:subject]
       @subject||=""
-      #this is a way to test without sending
-      @dummy=true if definition[:dummy]
       @logger.info("Reporter '#{self.to_s}' registered")
     end
 
@@ -54,7 +52,7 @@ module Rutema
     
     def report specifications,runner_states,parse_errors,configuration
       @mail.subject = "#{@subject}"
-      @mail.text = Rutema.text_report(runner_states,parse_errors)
+      @mail.text = text_report(runner_states,parse_errors)
       begin
         if @mail.to.empty?
           @logger.error("No recipients for the report mail")
@@ -63,7 +61,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)}
           #~ end
         end#recipients empty
       rescue
@@ -71,5 +69,25 @@ module Rutema
       end
       @mail.to_s
     end
+    private
+    def text_report runner_states,parse_errors
+      msg=""
+      #Report on parse errors
+      msg<<"No parse errors" if parse_errors.empty?
+      msg<<"One parse error:" if parse_errors.size==1
+      msg<<"#{parse_errors.size} parse errors:" if parse_errors.size>1
+      parse_errors.each do |er|
+        msg<<"\n\tin #{er[:filename]} : #{er[:error]}"
+      end
+      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
+      runner_states.each do |state|
+        msg<<"\n#{state.summary}\n---"
+      end
+      return msg
+    end
   end
 end

data/lib/rutema/system.rb

@@ -11,9 +11,52 @@ module Rutema
   module Version
     MAJOR=0
     MINOR=9
-    TINY=0
+    TINY=1
     STRING=[ MAJOR, MINOR, TINY ].join( "." )
   end
+  #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
+      #command executes a shell command
+      # <command cmd="useful_command.exe with parameters", working_directory="some/directory"/>
+      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"
+            :success
+          else
+            step.error="n"
+            :error
+          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"
+      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
   #Is raised when an error is found in a specification
   class ParserError<RuntimeError
   end
@@ -32,7 +75,8 @@ module Rutema
       raise ParserError,"not implemented. You should derive a parser implementation from SpecificationParser!"
     end
   end
-
+  
+  #BaseXMLParser encapsulates all the XML parsing code
   class BaseXMLParser<SpecificationParser
     ELEM_SPEC="specification"
     ELEM_DESC="specification/description"
@@ -205,39 +249,11 @@ module Rutema
       return spec
     end
   end
-  #MinimalXMLParser offers three runnable steps in the scenarios:
+  #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 succesful.
-  # <prompt text="Do you want fries with that?"/> 
   class MinimalXMLParser<ExtensibleXMLParser
-    def element_echo step
-      step.cmd=Patir::RubyCommand.new("echo"){|cmd| cmd.error="";cmd.output="#{step.text}";$stdout.puts(cmd.output) ;:success}
-    end
-    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"
-          :success
-        else
-          step.error="n"
-          :error
-        end#if
-      end#do rubycommand
-    end
-    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
+    include Rutema::Elements::Minimal
   end
 
   #This class coordinates parsing, execution and reporting of test specifications
@@ -552,6 +568,8 @@ module Rutema
   end
 
   #The "executioner" application class
+  #
+  #Parses the commandline, sets up the configuration and launches Cordinator
   class RutemaX
     require  'optparse'
     def initialize command_line_args
@@ -640,4 +658,5 @@ module Rutema
       end
     end
   end
+  
 end

data/test/test_reporter.rb

@@ -1,10 +1,11 @@
 $:.unshift File.join(File.dirname(__FILE__),"..","lib")
-$:.unshift File.join(File.dirname(__FILE__),"..","ext")
 require 'test/unit'
 require 'ostruct'
 require 'fileutils'
-require 'rutema/reporter'
 require 'rutema/reporters/standard_reporters'
+require 'rubygems'
+require 'mocha'
+require 'net/smtp'
 #$DEBUG=true
 module TestRutema
   class MockCommand
@@ -69,8 +70,22 @@ module TestRutema
       @status=[st]
     end
     def test_new
-      definition={:server=>"localhost",:port=>25,:recipients=>["test"],:sender=>"rutema",:subject=>"test",:dummy=>true}
+      definition={:server=>"localhost",:port=>25,:recipients=>["test"],:sender=>"rutema",:subject=>"test"}
       r=Rutema::EmailReporter.new(definition)
+      Net::SMTP.expects(:start).times(2)
+      assert_nothing_raised() { puts r.report(nil,@status,@parse_errors,nil) }
+      assert_nothing_raised() { puts r.report(nil,[],[],nil) }
+    end
+    
+    def test_multiple_scenarios
+      status1=mock()
+      status1.expects(:summary).returns("test1. Status - error. States 3\nStep status summary:\n\t1:'echo' - success\n\t2:'check' - warning\n\t3:'try' - error")
+      status2=mock()
+      status2.expects(:summary).returns("test2. Status - error. States 3\nStep status summary:\n\t1:'echo' - success\n\t2:'check' - success\n\t3:'try' - success")
+      @status=[status1,status2]
+      definition={:server=>"localhost",:port=>25,:recipients=>["test"],:sender=>"rutema",:subject=>"test"}
+      r=Rutema::EmailReporter.new(definition)
+      Net::SMTP.expects(:start)
       assert_nothing_raised() { puts r.report(nil,@status,@parse_errors,nil) }
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rutema
 version: !ruby/object:Gem::Version 
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors: 
 - Vassilis Rizopoulos
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-08 00:00:00 +02:00
+date: 2008-09-09 00:00:00 +02:00
 default_executable: rutemax
 dependencies: 
 - !ruby/object:Gem::Dependency