rutema 0.1

data/lib/rutema/specification.rb

@@ -0,0 +1,170 @@
+#  Copyright (c) 2007 Vassilis Rizopoulos. All rights reserved.
+require 'rubygems'
+require 'patir/command'
+
+module Rutema
+  #This module adds functionality that allows us to 
+  #arbitrarily add attributes to a class and then have 
+  #the accessor methods for these attributes appear automagically.
+  #
+  #It will also add a has_attribute? method to query if an attribute is part of the object or not.
+  module SpecificationElement
+    #adds an attribute to the class with the given __value__. __symbol__ can be a Symbol or a String, the rest are silently ignored
+    def attribute symbol,value
+      @attributes||=Hash.new
+      case symbol
+        when String : @attributes[:"#{symbol}"]=value
+        when Symbol : @attributes[symbol]=value
+      end
+    end
+    #allows us to call object.attribute, object.attribute=, object.attribute? and object.has_attribute?
+    #
+    #object.attribute and object.attribute? will throw NoMethodError if no attribute is set.
+    #
+    #object.attribute= will set the attribute to the right operand and
+    #object.has_attribute? returns false or true according to the existence of the attribute.
+    def method_missing symbol,*args
+      @attributes||=Hash.new
+      key=symbol.id2name.chomp('?').chomp('=').sub(/^has_/,"")
+      @attributes[:"#{key}"]=args[0] if key+"="==symbol.id2name
+      if @attributes.has_key?(:"#{key}")
+          return true if "has_"+key+"?"==symbol.id2name
+          return @attributes[:"#{key}"]
+      else
+        return false if "has_"+key+"?"==symbol.id2name
+        super(symbol,*args)
+      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
+    include SpecificationElement
+    attr_accessor :scenario,:requirements
+    #Following keys have meaning in initialization:
+    #
+    #:name - the name of the testcase. Should uniquely identify the testcase
+    #
+    #:title - a one liner describing what the testcase does
+    #
+    #:filename - the filename describing the testcase
+    #
+    #:description - a full textual description for the testcase. To be used in reports and documents
+    #
+    #:scenario - An instance of TestScenario
+    #
+    #:requirements - An Array of String. The idea is that the strings can lead you back to the requirements specification that is tested here.
+    #
+    #Default values are empty strings and arrays. (scenario is nil)
+    def initialize *args
+      params=args[0] if args
+      begin
+        @attributes=params
+      end if params
+      @attributes||=Hash.new
+      @attributes[:name]||=""
+      @attributes[:title]||=""
+      @attributes[:filename]||=""
+      @attributes[:description]||=""
+      @scenario=TestScenario.new
+      @requirements||=Array.new
+    end
+  end
+    
+  #A TestScenario is a sequence of TestStep instances.
+  #
+  #TestStep instances are run in the definition sequence and the scenario
+  #is succesfull when all steps are succesfull. 
+  #
+  #From the execution point of view each step is either succesfull or failed and it depends on 
+  #the exit code of the step's command. 
+  #
+  #Failure in a step results in the interruption of execution and the report of the errors.
+  class TestScenario
+    include SpecificationElement
+    attr_reader :steps
+    
+    def initialize
+      @attended=false
+      @steps=Array.new
+    end
+    
+    def attended?
+      return @attended
+    end
+    
+    def add_step step
+      @steps<<step
+      @attended=true if step.attended?
+    end
+    
+    def steps= array_of_steps
+      @steps=array_of_steps
+      @steps.each do |step|
+        @attended=true if step.attended?
+      end
+    end
+  end
+  
+  #Represents a step in a TestScenario.
+  #
+  #Each TestStep can have text and a command associated with it. 
+  #
+  #TestStep standard attributes are.
+  #
+  #attended - the step can only run in attended mode, it requires user input.
+  #
+  #step_type - a string identifying the type of the step. It is "step" by default.
+  #
+  #ignore - set to true if the step's success or failure is to be ignored. It essentially means that the step is always considered succesfull
+  #
+  #number - this is set when the step is assigned to a Scenario and is the sequence number
+  #
+  #cmd - the command associated with this step. This should quack like Patir::Command.
+  #
+  #status - one of :not_executed, :success, :warning, :error. Encapsulates the underlying command's status
+  class TestStep
+    include SpecificationElement
+    include Patir::Command
+    
+    #_txt_ describes the step, _cmd_ is the command to run
+    def initialize txt="",cmd=nil
+      @attributes=Hash.new
+      #ignore is off by default
+      @attributes[:ignore]=false
+      #attended is off by default
+      @attributes[:attended]=false
+      #assign
+      @attributes[:cmd]=cmd if cmd
+      @attributes[:text]=txt
+      @attributes[:number]=0
+    end
+    
+    def output
+      return "" unless @attributes[:cmd]
+      return @attributes[:cmd].output
+    end
+    def error
+      return "no command associated" unless @attributes[:cmd]
+      return @attributes[:cmd].error
+    end
+    def exec_time
+      return 0 unless @attributes[:cmd]
+      return @attributes[:cmd].exec_time
+    end
+    def status
+      return :warning unless @attributes[:cmd]
+      return @attributes[:cmd].status
+    end
+    def run
+      return not_executed unless @attributes[:cmd]
+      return @attributes[:cmd].run
+    end
+    def reset
+      @attributes[:cmd].reset if @attributes[:cmd]
+    end
+  end
+  
+end