patir 0.2 → 0.3

data/History.txt

@@ -1,3 +1,7 @@
+== 0.3.0 / 2007-05-20
+* Bugfix for the nesting of CommandSequenceStatus
+* PatirLoggerFormatter added and used in setup_logger
+
 == 0.2.0 / 2007-03-22
 * Added the Command library
  * Implementations: ShellCommand, RubyCommand

data/lib/patir/base.rb

@@ -5,7 +5,7 @@ module Patir
   require 'logger'
   #Version information
   VERSION_MAJOR="0"
-  VERSION_MINOR="2"
+  VERSION_MINOR="3"
   VERSION="#{VERSION_MAJOR}.#{VERSION_MINOR}"
   #Error thrown usually in initialize methods when missing required parameters
   #from the initialization hash.
@@ -15,6 +15,18 @@ module Patir
   def self.drb_service ip,port
     return "druby://#{ip}:#{port}"
   end
+  
+  class PatirLoggerFormatter<Logger::Formatter
+    Format="[%s] %5s: %s\n"
+    def initialize
+      @datetime_format="%Y%m%d %H:%M:%S"
+    end
+    
+    def call severity, time, progname, msg
+      Format % [format_datetime(time), severity,
+        msg2str(msg)]
+    end
+  end
   #Just making Logger usage easier
   #
   #This is for use on top level scripts.
@@ -40,7 +52,8 @@ module Patir
     logger.level=Logger::FATAL if mode==:mute
     logger.level=Logger::WARN if mode==:silent
     logger.level=Logger::DEBUG if mode==:debug || $DEBUG
-    logger.datetime_format="%Y%m%d %H:%M:%S"
+    logger.formatter=PatirLoggerFormatter.new
+    #logger.datetime_format="%Y%m%d %H:%M:%S"
     return logger
   end
 end

data/lib/patir/command.rb

@@ -97,7 +97,7 @@ module Patir
       return @status
     end
   end
-  
+
   #This class wraps the http://codeforpeople.com/lib/ruby/systemu/ as a Command duck.
   #
   #It allows for execution of any shell command.
@@ -125,7 +125,7 @@ module Patir
       @command=params[:cmd]
       @status=:not_executed
     end
-    
+
     #Executes the shell command and returns the status
     def run
       start_time=Time.now
@@ -148,12 +148,12 @@ module Patir
       @exec_time=Time.now-start_time
       return @status
     end
-    
+
     def to_s
       return "#{@name}: #{@command} in #{File.expand_path(@working_directory)}"
     end
   end
-  
+
   #CommandSequence describes a set of commands to be executed in sequence.
   #
   #Each instance of CommandSequence contains a set of Patir::Command instances, which are the steps to perform.
@@ -173,7 +173,7 @@ module Patir
     attr_reader :name,:state,:steps
     attr_reader :sequence_runner
     attr_reader :sequence_id
-    
+
     def initialize name,sequence_runner=""
       @name=name
       @steps||=Array.new
@@ -181,13 +181,13 @@ module Patir
       #intialize the status for the currently active build (not executed)
       reset
     end
-    
+
     #sets the sequence runner attribute updating status
     def sequence_runner=name
       @sequence_runner=name
       @state.sequence_runner=name
     end
-    
+
     #sets the sequence id attribute updating status
     def sequence_id=name
       @sequence_id=name
@@ -221,26 +221,26 @@ module Patir
         notify(:sequence_status=>@state)
         #evaluate the results' effect on execution status at the end
         case result
-          when :success
-            #everything is fine, continue
-          when :error
-            #this will be the final status
-            running_status=:error
-            #stop if we fail on error
-            if :fail_on_error==step.strategy
-              @state.status=:error
-              break 
-            end
-          when :warning
-            #a previous failure overrides a warning
-            running_status=:warning unless :error==running_status
-            #escalate this to a failure if the strategy says so
-            running_status=:error if :flunk_on_warning==step.strategy
-            #stop if we fail on warning
-            if :fail_on_warning==step.strategy
-              @state.status=:error
-              break 
-            end
+        when :success
+          #everything is fine, continue
+        when :error
+          #this will be the final status
+          running_status=:error
+          #stop if we fail on error
+          if :fail_on_error==step.strategy
+            @state.status=:error
+            break 
+          end
+        when :warning
+          #a previous failure overrides a warning
+          running_status=:warning unless :error==running_status
+          #escalate this to a failure if the strategy says so
+          running_status=:error if :flunk_on_warning==step.strategy
+          #stop if we fail on warning
+          if :fail_on_warning==step.strategy
+            @state.status=:error
+            break 
+          end
         end
       end
       #we finished
@@ -271,7 +271,7 @@ module Patir
       @state.step=bstep
       notify(:sequence_status=>@state)
     end
-    
+
     #Resets the status. This will set :not_executed status, 
     #and set the start and end times to nil.
     def reset
@@ -286,12 +286,12 @@ module Patir
       #tell the world
       notify(:sequence_status=>@state)
     end
-    
+
     #Returns true if the sequence has finished executing
     def completed?  
       return @state.completed? 
     end
-    
+
     def to_s
       "#{sequence_id}:#{:name} on #{@sequence_runner}, #{@steps.size} steps"
     end
@@ -321,7 +321,7 @@ module Patir
   #
   #:error is set when after execution at least one step has the :error status
   class CommandSequenceStatus
-    attr_accessor :start_time,:stop_time,:sequence_runner,:sequence_name,:status,:step_states,:sequence_id
+    attr_accessor :start_time,:stop_time,:sequence_runner,:sequence_name,:status,:step_states,:sequence_id,:strategy
     #You can pass an array of Commands to initialize CommandSequenceStatus
     def initialize sequence_name,steps=nil
       @sequence_name=sequence_name
@@ -343,7 +343,7 @@ module Patir
       return true if :success==@status
       return false
     end
-    
+
     #A sequence is considered completed when:
     #
     #a step has errors and the :fail_on_error strategy is used
@@ -369,118 +369,116 @@ module Patir
     #Adds a step to the state. The step state is inferred from the Command instance __step__
     def step=step
       @step_states[step.number]={:name=>step.name,
-                      :status=>step.status,
-                      :output=>step.output,
-                      :duration=>step.exec_time,
-                      :error=>step.error,
-                      :strategy=>step.strategy}
-      #this way we don't have to compare all the step states we always get the worst last stable state
-      #:not_executed<:success<:warning<:success
-      @previous_status=@status unless @status==:running
-      case step.status
-      when :running
-        @status=:running
-      when :warning
-        @status=:warning unless @status==:error
-        @status=:error if @previous_status==:error
-      when :error
-        @status=:error
-      when :success
-        @status=:success unless @status==:error || @status==:warning
-        @status=:warning if @previous_status==:warning
-        @status=:error if @previous_status==:error
-      when :not_executed
-        @status=@previous_status
+        :status=>step.status,
+        :output=>step.output,
+        :duration=>step.exec_time,
+        :error=>step.error,
+        :strategy=>step.strategy}
+        #this way we don't have to compare all the step states we always get the worst last stable state
+        #:not_executed<:success<:warning<:success
+        @previous_status=@status unless @status==:running
+        case step.status
+        when :running
+          @status=:running
+        when :warning
+          @status=:warning unless @status==:error
+          @status=:error if @previous_status==:error
+        when :error
+          @status=:error
+        when :success
+          @status=:success unless @status==:error || @status==:warning
+          @status=:warning if @previous_status==:warning
+          @status=:error if @previous_status==:error
+        when :not_executed
+          @status=@previous_status
+        end
       end
-    end
-    #produces a brief text summary for this status
-    def summary
-      sum=""
-      sum<<"#{@sequence_id}:" if @sequence_id
-      sum<<"#{@sequence_name}. " unless @sequence_name.empty?
-      sum<<"Status - #{@status}" 
-      if !@step_states.empty?
-        sum<<".States #{@step_states.size}\nStep status summary:"
-        if :not_executed!=@status
+      #produces a brief text summary for this status
+      def summary
+        sum=""
+        sum<<"#{@sequence_id}:" if @sequence_id
+        sum<<"#{@sequence_name}. " unless @sequence_name.empty?
+        sum<<"Status - #{@status}" 
+        if !@step_states.empty? && @status!=:not_executed
+          sum<<". States #{@step_states.size}\nStep status summary:"
           @step_states.each do |number,state|
             sum<<"\n\t#{number}:'#{state[:name]}' - #{state[:status]}"
           end
-        end
-      end 
-      return sum
-    end
-    def to_s
-      "'#{sequence_id}':'#{@sequence_name}' on '#{@sequence_runner}' started at #{@start_time}.#{@step_states.size} steps"
-    end
-    def exec_time
-      return @stop_time-@start_time if @stop_time
-      return 0
-    end
-    def name
-      return @sequence_name
-    end  
-    def number
-      return @sequence_id
-    end
-    def output
-      return self.summary
-    end
-    def error
-      return ""
-    end
-    def executed?
-      return true unless @status==:not_executed
-      return false
-    end
-  end
-  
-  #This class allows you to wrap Ruby blocks and handle them like Command
-  #
-  #Provide a block to RubyCommand#new and you can execute the block using
-  #RubyCommand#run
-  #
-  #The block receives the instance of RubyCommand so you can set the output and error output.
-  #
-  #The return value of the block is assigned as the command status.
-  #
-  #== Examples
-  #An example (using the excellent HighLine lib) of a CLI prompt as a RubyCommand
-  # RubyCommand.new("prompt") do |cmd|  
-  #     cmd.output=""
-  #     cmd.error=""
-  #     if HighLine.agree("#{step.text}?")
-  #       :success
-  #     else
-  #       :error
-  #     end
-  #   end
-  class RubyCommand
-    include Patir::Command
-    def initialize name,working_directory=nil,&block
-      @name=name
-      @working_directory=working_directory
-      if block_given?
-        @cmd=block 
-      else
-        raise "You need to provide a block"
+        end 
+        return sum
+      end
+      def to_s
+        "'#{sequence_id}':'#{@sequence_name}' on '#{@sequence_runner}' started at #{@start_time}.#{@step_states.size} steps"
+      end
+      def exec_time
+        return @stop_time-@start_time if @stop_time
+        return 0
+      end
+      def name
+        return @sequence_name
+      end  
+      def number
+        return @sequence_id
+      end
+      def output
+        return self.summary
+      end
+      def error
+        return ""
+      end
+      def executed?
+        return true unless @status==:not_executed
+        return false
       end
     end
-    #Runs the associated block
-    def run
-      @run=true
-      prev_dir=Dir.pwd
-      begin
-        Dir.chdir(@working_directory) if @working_directory
-        t1=Time.now
-        @status=@cmd.call(self)
-        @exec_time=Time.now-t1
-      rescue SystemCallError
-        @output="#{$!}"
-        @success=false
-      ensure
-        Dir.chdir(prev_dir)
+
+    #This class allows you to wrap Ruby blocks and handle them like Command
+    #
+    #Provide a block to RubyCommand#new and you can execute the block using
+    #RubyCommand#run
+    #
+    #The block receives the instance of RubyCommand so you can set the output and error output.
+    #
+    #The return value of the block is assigned as the command status.
+    #
+    #== Examples
+    #An example (using the excellent HighLine lib) of a CLI prompt as a RubyCommand
+    # RubyCommand.new("prompt") do |cmd|  
+    #     cmd.output=""
+    #     cmd.error=""
+    #     if HighLine.agree("#{step.text}?")
+    #       :success
+    #     else
+    #       :error
+    #     end
+    #   end
+    class RubyCommand
+      include Patir::Command
+      def initialize name,working_directory=nil,&block
+        @name=name
+        @working_directory=working_directory
+        if block_given?
+          @cmd=block 
+        else
+          raise "You need to provide a block"
+        end
+      end
+      #Runs the associated block
+      def run
+        @run=true
+        prev_dir=Dir.pwd
+        begin
+          Dir.chdir(@working_directory) if @working_directory
+          t1=Time.now
+          @status=@cmd.call(self)
+          @exec_time=Time.now-t1
+        rescue SystemCallError
+          @output="#{$!}"
+          @success=false
+        ensure
+          Dir.chdir(prev_dir)
+        end
+        return @success
       end
-      return @success
     end
-  end
-end
+  end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.1
 specification_version: 1
 name: patir
 version: !ruby/object:Gem::Version 
-  version: "0.2"
-date: 2007-05-17 00:00:00 +02:00
+  version: "0.3"
+date: 2007-05-21 00:00:00 +02:00
 summary: patir (Project Automation Tools in Ruby) provides libraries for use in automation tools
 require_paths: 
 - lib