rutema 1.1.3 → 1.2.0

data/lib/rutema/models/base.rb

@@ -0,0 +1,5 @@
+module Rutema
+  #Exception occuring when connecting to a database
+  class ConnectionError<RuntimeError
+  end
+end

data/lib/rutema/{specification.rb → objectmodel.rb}

@@ -1,6 +1,5 @@
 #  Copyright (c) 2007-2010 Vassilis Rizopoulos. All rights reserved.
 $:.unshift File.join(File.dirname(__FILE__),"..")
-require 'rutema/reporters/standard_reporters'
 require 'patir/command'
 
 module Rutema
@@ -37,8 +36,6 @@ module Rutema
       end
     end
   end
-
-  
   #A TestSpecification encompasses all elements required to run a test, the builds used, the scenario to run,
   #together with a textual description and information that aids in tracing the test back to the requirements.
   class TestSpecification
@@ -74,12 +71,10 @@ module Rutema
       @scenario=TestScenario.new(@attributes[:version])
       @requirements||=Array.new
     end
-    
-    def to_s
+    def to_s#:nodoc: 
       return "#{@attributes[:name]} - #{@attributes[:title]}"
     end
   end
-    
   #A TestScenario is a sequence of TestStep instances.
   #
   #TestStep instances are run in the definition sequence and the scenario
@@ -121,7 +116,6 @@ module Rutema
       end
     end
   end
-  
   #Represents a step in a TestScenario.
   #
   #Each TestStep can have text and a command associated with it. 
@@ -210,7 +204,7 @@ module Rutema
       param=" - #{self.cmd.to_s}" if self.has_cmd?
       return "#{@attributes[:step_type]}#{param}"
     end
-    def to_s
+    def to_s#:nodoc:
       param=""
       param=" - #{self.cmd.to_s}" if self.has_cmd?
       msg="#{self.number} - #{self.step_type}#{param} - #{self.status}"
@@ -222,13 +216,13 @@ module Rutema
 end
 
 class Patir::ShellCommand
-  def to_s
+  def to_s#:nodoc:
     return @command
   end
 end
 
 class Patir::RubyCommand
-  def to_s
+  def to_s#:nodoc:
     return @name
   end
 end

data/lib/rutema/parsers/base.rb

@@ -0,0 +1,29 @@
+#  Copyright (c) 2007-2011 Vassilis Rizopoulos. All rights reserved.
+$:.unshift File.join(File.dirname(__FILE__),'..','..')
+
+module Rutema
+  #Is raised when an error is found in a specification
+  class ParserError<RuntimeError
+  end
+  #Base class that bombs out when used.
+  #
+  #Initialze expects a hash and as a base implementation assigns :logger as the internal logger.
+  #
+  #By default the internal logger will log to the console if no logger is provided.
+  class SpecificationParser
+    attr_reader :configuration
+    def initialize params
+      @configuration=params
+      @logger.warn("No system configuration provided to the parser") unless @configuration
+      @logger=@configuration[:logger]
+      unless @logger
+        @logger=Patir.setup_logger
+        @configuration[:logger]=@logger
+      end
+    end
+    
+    def parse_specification param
+      raise ParserError,"not implemented. You should derive a parser implementation from SpecificationParser!"
+    end
+  end
+end

data/lib/rutema/parsers/xml.rb

@@ -0,0 +1,186 @@
+#  Copyright (c) 2007-2011 Vassilis Rizopoulos. All rights reserved.
+$:.unshift File.join(File.dirname(__FILE__),'..','..')
+require 'rexml/document'
+require 'patir/command'
+require 'rutema/objectmodel'
+require 'rutema/parsers/base'
+require 'rutema/elements/minimal'
+
+module Rutema
+  #BaseXMLParser encapsulates all the XML parsing code
+  class BaseXMLParser<SpecificationParser
+    ELEM_SPEC="specification"
+    ELEM_DESC="specification/description"
+    ELEM_TITLE="specification/title"
+    ELEM_SCENARIO="specification/scenario"
+    ELEM_REQ="requirement"
+    #Parses __param__ and returns the Rutema::TestSpecification instance
+    #
+    #param can be the filename of the specification or the contents of that file.
+    #
+    #Will throw ParserError if something goes wrong
+    def parse_specification param
+      @logger.debug("Loading #{param}")
+      begin
+        if File.exists?(param)
+          #read the file
+          txt=File.read(param)
+          filename=File.expand_path(param)
+        else
+          filename=Dir.pwd
+          #try to parse the parameter
+          txt=param
+        end
+        spec=parse_case(txt,filename)
+        raise "Missing required attribute 'name' in specification element" unless spec.has_name? && !spec.name.empty?
+        return spec
+      rescue
+        @logger.debug($!)
+        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,filename
+      #the testspec to return
+      spec=TestSpecification.new
+      #read the test spec
+      xmldoc=REXML::Document.new( xmltxt )
+      #validate it
+      validate_case(xmldoc)
+      #parse it
+      el=xmldoc.elements[ELEM_SPEC]
+      xmldoc.root.attributes.each do |attr,value|
+        add_attribute(spec,attr,value)
+      end
+      #get the title
+      spec.title=xmldoc.elements[ELEM_TITLE].text
+      spec.title||=""
+      spec.title.strip!
+      #get the description
+      #strip line feeds, cariage returns and remove all tabs
+      spec.description=xmldoc.elements[ELEM_DESC].text
+      spec.description||=""
+      begin
+        spec.description.strip!
+        spec.description.gsub!(/\t/,'')  
+      end unless spec.description.empty?
+      #get the requirements
+      reqs=el.elements.select{|e| e.name==ELEM_REQ}
+      reqs.collect!{|r| r.attributes["name"]}
+      spec.requirements=reqs
+      #Get the 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.
+    #
+    #Checks for the existence of ELEM_SPEC, ELEM_DESC and ELEM_TITLE and raises ParserError if they're missing.
+    def validate_case xmldoc
+      raise ParserError,"missing #{ELEM_SPEC} element" unless xmldoc.elements[ELEM_SPEC]
+      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|
+        add_attribute(scenario,attr,value)
+      end
+      number=0
+      xmldoc.root.elements.each do |el| 
+        step=parse_step(el.to_s)
+        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 )
+      #any step element
+      step=Rutema::TestStep.new()
+      step.ignore=false
+      xmldoc.root.attributes.each do |attr,value|
+        add_attribute(step,attr,value)
+      end
+      step.text=xmldoc.root.text.strip if xmldoc.root.text
+      step.step_type=xmldoc.root.name
+      return step
+    end
+
+    def add_attribute element,attr,value
+      if boolean?(value)
+        element.attribute(attr,eval(value))
+      else
+        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.
+  #
+  #A method element_foo(step) allows you to add behaviour for foo scenario elements.
+  #
+  #The method will receive a Rutema::TestStep instance. 
+  class ExtensibleXMLParser<BaseXMLParser
+    def parse_specification param
+      spec = super(param)
+      #change into the directory the spec is in to handle relative paths correctly
+      Dir.chdir(File.dirname(File.expand_path(spec.filename))) do |path|
+        #iterate through the steps
+        spec.scenario.steps.each do |step|
+          #do we have a method to handle the element?
+          if respond_to?(:"element_#{step.step_type}")
+            begin
+              self.send(:"element_#{step.step_type}",step)
+            rescue
+              raise ParserError, $!.message
+            end
+          end
+        end
+      end
+      return spec
+    end
+  end
+  #MinimalXMLParser offers three runnable steps in the scenarios as defined in Rutema::Elements::Minimal
+  class MinimalXMLParser<ExtensibleXMLParser
+    include Rutema::Elements::Minimal
+  end
+end

data/lib/rutema/reporters/activerecord.rb

@@ -1,15 +1,11 @@
 #  Copyright (c) 2007-2010 Vassilis Rizopoulos. All rights reserved.
 $:.unshift File.join(File.dirname(__FILE__),"..","..")
 require 'yaml'
-require 'rutema/reporter'
-require 'rutema/model'
+require 'rutema/models/activerecord'
 
 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
-    include ActiveRecord
     #The required keys in this reporter's configuration are:
     # :db - the database configuration. A Hash with the DB adapter information
     #  :db=>{:database=>"sample.rb"}
@@ -18,27 +14,26 @@ module Rutema
       @logger||=Patir.setup_logger
       database_configuration = definition[:db]
       raise "No database configuration defined, missing :db configuration key." unless database_configuration
-      ActiveRecord.connect(database_configuration,@logger)
+      Rutema::ActiveRecord.connect(database_configuration,@logger)
       @logger.info("Reporter #{self.to_s} registered")
     end
-    
-    #We get all the data for a Rutema::ActiveRecord::Model::Run entry in here.
+    #We get all the data for a Rutema::ActiveRecord::Run entry in here.
     #
-    #If the configuration is given and there is a context defined, this will be YAML-dumped into Rutema::ActiveRecord::Model::Run#context
+    #If the configuration is given and there is a context defined, this will be YAML-dumped into Rutema::ActiveRecord::Run#context
     def report specifications,runner_states,parse_errors,configuration
-      run_entry=ActiveRecord::Model::Run.new
+      run_entry=Rutema::ActiveRecord::Run.new
       if configuration && configuration.context
         run_entry.context=configuration.context
       end
       parse_errors.each do |pe|
-        er=ActiveRecord::Model::ParseError.new()
+        er=Rutema::ActiveRecord::ParseError.new()
         er.filename=pe[:filename]
         er.error=pe[:error]
         run_entry.parse_errors<<er
       end
       runner_states.compact!
       runner_states.each do |scenario|
-        sc=ActiveRecord::Model::Scenario.new
+        sc=Rutema::ActiveRecord::Scenario.new
         sc.name=scenario.sequence_name
         sc.number=scenario.sequence_id
         sc.start_time=scenario.start_time
@@ -61,7 +56,7 @@ module Rutema
           sc.attended=false
         end
         scenario.step_states.each do |number,step|
-          st=ActiveRecord::Model::Step.new
+          st=Rutema::ActiveRecord::Step.new
           st.name=step[:name]
           st.number=number
           st.status="#{step[:status]}"
@@ -75,17 +70,13 @@ module Rutema
       run_entry.save!
       "activerecord reporter done"
     end
-    
-    def to_s
+    def to_s#:nodoc:
       "ActiveRecordReporter"
     end
-    
     private
     def sanitize text
       return text.gsub("\000","") if text
       return ""
     end
-   
   end
-  
 end

data/lib/rutema/{reporter.rb → reporters/base.rb}

@@ -1,9 +1,9 @@
 #  Copyright (c) 2007-2010 Vassilis Rizopoulos. All rights reserved.
 $:.unshift File.join(File.dirname(__FILE__),"..")
-require 'rutema/specification'
-
 module Rutema
-  #Reporter is meant as a base class for reporter classes.
+  #Reporter is meant as a base class for reporter classes. Which means that it is here for ducumentation purposes.
+  #
+  #In order to create act as a Reporter for Rutema a class only need to implement the #report method
   class Reporter
     #params should be a Hash containing the parameters used to initialize the class
     def initialize params
@@ -15,10 +15,6 @@ module Rutema
     #
     #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
-
     end
   end
-
-  private
-  
 end

data/lib/rutema/reporters/email.rb

@@ -1,10 +1,8 @@
 #  Copyright (c) 2007-2010 Vassilis Rizopoulos. All rights reserved.
 $:.unshift File.join(File.dirname(__FILE__),"..","..")
 require 'net/smtp'
-require 'rutema/reporter'
-require 'rutema/specification'
-require 'rutema/reporters/text'
 require 'mailfactory'
+require 'rutema/reporters/text'
 
 module Rutema
   #The following configuration keys are used by EmailReporter:
@@ -53,8 +51,7 @@ module Rutema
       @verbose||=false
       @logger.info("Reporter '#{self.to_s}' registered")
     end
-
-    def to_s
+    def to_s#:nodoc:
       list=@recipients.join(', ')
       "EmailReporter - #{@server}:#{@port} from #{@mail.from} to #{list}"
     end

data/lib/rutema/reporters/text.rb

@@ -1,3 +1,5 @@
+#  Copyright (c) 2007-2010 Vassilis Rizopoulos. All rights reserved.
+
 module Rutema
   #This reporter creates a simple text summary of a test run
   #
@@ -9,7 +11,6 @@ module Rutema
       @verbose=params[:verbose] if params
       @verbose||=false 
     end
-    
     #Returns the text summary
     #
     #runner_states is an Array of Patir::CommandSequenceStatus containing the stati of the last run (so it contains all the Scenario stati for the loaded tests)
@@ -59,7 +60,6 @@ module Rutema
       end
       msg<<"\nSuccesses:" unless successes.empty?
       msg<<scenario_summaries(successes,specifications)
-      
       return msg
     end
     

data/lib/rutema/reporters/yaml.rb

@@ -1,7 +1,7 @@
+#  Copyright (c) 2007-2010 Vassilis Rizopoulos. All rights reserved.
 require 'yaml'
 
 module Rutema
-  
   module YAML
     #Experimental reporter used to dump the data of a run on disk
     #
@@ -18,7 +18,6 @@ module Rutema
         @filename||="rutema.yaml"
         @logger.info("Reporter #{self.to_s} registered")
       end
-      
       #We get all the data from a test run in here.
       def report specifications,runner_states,parse_errors,configuration
         run_entry={}