testability-driver 1.2.1 → 1.3.0

data/lib/tdriver/report/report_graph_generator.rb

@@ -0,0 +1,59 @@
+############################################################################
+##
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+## All rights reserved.
+## Contact: Nokia Corporation (testabilitydriver@nokia.com)
+##
+## This file is part of Testability Driver.
+##
+## If you have questions regarding the use of this file, please contact
+## Nokia at testabilitydriver@nokia.com .
+##
+## This library is free software; you can redistribute it and/or
+## modify it under the terms of the GNU Lesser General Public
+## License version 2.1 as published by the Free Software Foundation
+## and appearing in the file LICENSE.LGPL included in the packaging
+## of this file.
+##
+############################################################################
+
+class ReportGraphGenerator
+  def initialize(columns,data)
+    @columns=columns
+    @data=data
+  end
+
+  def generate_graph(file_name)
+
+    begin
+      require 'gruff'
+    rescue LoadError
+      $stderr.puts "Can't load the Gruff gem. If its missing from your system please run 'gem install gruff' to install it."
+    end
+
+    begin
+      g = Gruff::Line.new()
+                  
+      data_rows = Hash.new #Create hash for data
+      @columns.each do |title|        
+        data_rows[title] = Array.new #Create array for data
+      end
+                        
+      @data.each do |value|        
+        value.each_key do |key|
+          data_rows[key].push(value[key].to_f) #Put values in the row data
+        end
+      end
+      
+      data_rows.each_key do |key|
+        g.data(key, data_rows[key])
+      end
+      
+      g.write(file_name)
+
+    rescue Exception => e
+      puts "Graph creation failed #{e.message} from data: "
+      p data_rows
+    end
+  end
+end

data/lib/tdriver/report/report_test_case_run.rb

@@ -324,7 +324,31 @@ module TDriverReportCreator
     def set_test_case_behaviour_log(value,test_case)
       @test_case_behaviour_log << [value.to_s,test_case]
     end
-    #Thid methods sets video recording of the test case
+
+    #This methods checks the available video devices
+    #
+    # === params
+    # 
+    # === returns
+    # nil
+    def each_video_device
+
+      if $parameters[:report_video, nil] != nil
+
+        device_index = 0
+        $parameters[:report_video].split("|").each do | video_device |
+          if !video_device.strip.empty?
+            yield video_device.strip, device_index.to_s
+            device_index += 1
+          end
+        end
+
+      end
+
+    end
+
+
+    #This methods sets video recording of the test case
     #
     # === params
     # rec_name: String, name of video file to create
@@ -338,6 +362,7 @@ module TDriverReportCreator
       tc_video_width = 640
       tc_video_height = 480
       tc_video_fps = 30
+      tc_max_time = '99:00:00'
 
       begin
         tc_video_width =  $parameters[ :report_video_width ].to_i
@@ -354,6 +379,11 @@ module TDriverReportCreator
       rescue
         # parameter not loaded, do nothing
       end
+      begin 
+        tc_max_time =  $parameters[ :report_video_max_time ].to_i
+      rescue
+        # parameter not loaded, do nothing
+      end
 
 
       @tc_video_recorders = []
@@ -549,7 +579,9 @@ module TDriverReportCreator
             begin
               sut_attributes[:sut].capture_screen( :Filename => dump_folder+'/'+time_stamp+'_'+sut_id.to_s+'_state.png', :Redraw => true ) if sut_attributes[:is_connected]
               if arguments[:file]
-                sut_attributes[:sut].capture_screen( :Filename => arguments[:file], :Redraw => true ) if sut_attributes[:is_connected]
+                base_name=File.basename(arguments[:file])
+                base_folder=File.dirname(arguments[:file])
+                sut_attributes[:sut].capture_screen( :Filename => "#{base_folder}/#{sut_id.to_s}_#{base_name}", :Redraw => true ) if sut_attributes[:is_connected]
               end
               image_html='<div class="img"><a href="state_xml/'<<
                 time_stamp+'_'+sut_id.to_s+'_state.png'<<

data/lib/tdriver/report/report_writer.rb

@@ -890,6 +890,7 @@ display: block;
         format_behaviour_log(@test_case_behaviour_log)<<
         '</dd>'<<
         '</dl>'
+
     end
     if @test_case_user_data!=nil && !@test_case_user_data.empty?
       html_body=html_body<<
@@ -899,6 +900,17 @@ display: block;
         format_user_log_table( @test_case_user_data,@test_case_user_data_columns)<<
         '</dd>'<<
         '</dl>'
+      if $parameters[ :report_generate_duration_graph, false]=='true'
+        graph=ReportGraphGenerator.new(@test_case_user_data_columns,@test_case_user_data)        
+        graph.generate_graph("#{folder}/graph.png")
+         html_body=html_body<<
+        '<dl class="togList">'<<
+        '<dt onclick="tog(this)" style="background-color: #CCCCCC;"><b style="font-size: large"><span><input id="Button1" type="button" value="Close" class="btn" /></span> Graph</b></dt>'<<
+        '<dd style="font-size: small">'<<
+        '<img border="0" src="graph.png"/>'<<
+        '</dd>'<<
+        '</dl>'
+      end
     end
     html_body=html_body<<
       '</div>'

data/lib/tdriver/tdriver.rb

@@ -86,7 +86,7 @@ module TDriver
     # ArgumentError:: Not connected to device 'id' if not connected at all / device already disconnected
     # ArgumentError:: Sut id not given
     # === example
-    #  @sut = TDriver.reboot_sut(:Id =>'sut_qt') # for Qt, should be connected already   
+    #  @sut = TDriver.reboot_sut(:Id => 'sut_qt') # for Qt, should be connected already   
     def reboot_sut( sut_attributes = {} )
 
       MobyBase::SUTFactory.instance.reboot_sut( sut_attributes )
@@ -167,6 +167,14 @@ module TDriver
       File.expand_path( File.dirname( __FILE__ ) )
     
     end
+
+    # == nodoc
+    # TODO: document me
+    def version
+
+      ENV['TDRIVER_VERSION'] || "unknown"
+
+    end
   
   private
 
@@ -182,6 +190,9 @@ module TDriver
       # set xml cache buffer size 
       MobyUtil::XML.buffer_size = $parameters[ :xml_cache_buffer_size, 10 ].to_i
 
+      # load behaviours
+      TDriver::BehaviourFactory.init( :path => File.join( config_dir, 'behaviours' ) )
+
       # initialization done, everything is ready
       $TDRIVER_INITIALIZED = true
 

data/lib/tdriver/util/agent/loader.rb

@@ -0,0 +1,22 @@
+############################################################################
+## 
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). 
+## All rights reserved. 
+## Contact: Nokia Corporation (testabilitydriver@nokia.com) 
+## 
+## This file is part of Testability Driver. 
+## 
+## If you have questions regarding the use of this file, please contact 
+## Nokia at testabilitydriver@nokia.com . 
+## 
+## This library is free software; you can redistribute it and/or 
+## modify it under the terms of the GNU Lesser General Public 
+## License version 2.1 as published by the Free Software Foundation 
+## and appearing in the file LICENSE.LGPL included in the packaging 
+## of this file. 
+## 
+############################################################################
+
+# agent command services module
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'service.rb' ) )
+

data/lib/tdriver/util/agent/service.rb

@@ -0,0 +1,107 @@
+############################################################################
+##
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+## All rights reserved.
+## Contact: Nokia Corporation (testabilitydriver@nokia.com)
+##
+## This file is part of Testability Driver.
+##
+## If you have questions regarding the use of this file, please contact
+## Nokia at testabilitydriver@nokia.com .
+##
+## This library is free software; you can redistribute it and/or
+## modify it under the terms of the GNU Lesser General Public
+## License version 2.1 as published by the Free Software Foundation
+## and appearing in the file LICENSE.LGPL included in the packaging
+## of this file.
+##
+############################################################################
+
+module TDriver
+
+  class AgentService
+
+=begin
+    # remove all public methods
+    instance_methods.each{ | method | 
+      undef_method( method ) unless method =~ /^__|^(methods|inspect|to_s|class|nil?|extend)/ 
+    }
+    
+    # required by commands method to list available services
+    private :methods
+=end
+    
+    # TODO: document me
+    def initialize( options = {} )
+
+      # verify that options is type of hash
+      options.check_type Hash, 'wrong argument type $1 for AgentCommandService options (expected $2)'
+
+      # verify that sut is defined in options hash
+      options.require_key :sut
+
+      sut = options[ :sut ]
+
+      TDriver::BehaviourFactory.apply_behaviour( 
+        :object       => self,
+        :object_type  => [ 'AgentCommandService'                  ],
+        :env          => [ '*', *sut.environment.to_s.split(";")  ],
+        :input_type   => [ '*', *sut.input.to_s.split(";")        ],
+        :version      => [ '*', *sut.ui_version.to_s.split(";")   ]
+      )
+    
+      # store given options
+      @options = options
+
+      # store sut variable
+      @sut = sut
+      
+      # store caller backtrace
+      @caller = caller
+
+    end
+    
+    # TODO: document me
+    def commands
+      
+      class << self
+
+        # retrieve all public methods
+        instance_methods( false ).select{ | name | true unless name =~ /^__|^commands$/ }      
+
+      end
+    
+    end
+
+  private
+
+    # TODO: document me
+    def execute_command( command_data_object )
+
+      begin
+
+        # execute command
+        @sut.__send__( :execute_command, command_data_object )
+
+      rescue MobyBase::ControllerNotFoundError
+
+        # raise exception if sut doesn't have controller for the command data object 
+        raise NotImplementedError, "Agent command #{ command_data_object.parameters[ :command ].inspect } is not supported on #{ @sut.id.inspect }", @caller
+
+      end
+      
+    end
+
+  private
+
+    # TODO: document me      
+    def method_missing( id, *args )
+    
+      # raise exception if unknown command or not supported by sut 
+      raise RuntimeError, "agent command #{ id.inspect } not supported by #{ @options[ :sut ].id }", caller
+    
+    end
+                    
+  end # AgentCommandService
+
+end # TDriver

data/lib/tdriver/util/common/crc16.rb

@@ -73,20 +73,27 @@ module TDriver
 
     public
 
-      # CRC-16-CCITT    
-      def crc16( buf, crc = 0 )
+      # check if implementation is already loaded from TDriver native Ruby C Extension; native crc routines are ~10% faster
+      unless instance_methods.include?( 'native_extension' )
+  
+        # CRC-16-CCITT    
+        def crc16( buf, crc = 0 )
 
-        # calculate the checksum
-        buf.each_byte{ | x | crc = ( ( crc << 8 ) ^ @CCITT_16[ ( crc >> 8 ) ^ x ] ) & 0xffff }
+          # calculate the checksum
+          buf.each_byte{ | x | crc = ( ( crc << 8 ) ^ @CCITT_16[ ( crc >> 8 ) ^ x ] ) & 0xffff }
 
-        # result
-        crc
+          # result
+          crc
 
-      end # crc16
+        end # crc16
+
+        # determines that native extension is not in use    
+        def native_extension
+
+          false
+
+        end 
 
-      # check if implementation is already loaded from TDriver native Ruby C Extension; native crc routines are ~10% faster
-      unless instance_methods.include?( 'crc16_ibm' )
-      
         # IBM-CRC-16: fallback when native extensions are not supported (e.g. jruby)
         def crc16_ibm( buf, crc = 0xffff )
 

data/lib/tdriver/util/common/hash.rb

@@ -66,9 +66,12 @@ class Hash
   # verify that receiver object contains all of given keys. Raises exception is key not found.
   def require_key( key, message = 'required key $1 not found from hash' )
   
+    # store caller backtrace before calling fetch
+    backtrace = caller
+  
     fetch( key ){
     
-      raise ArgumentError, message.gsub!( "$1", key.inspect ), caller
+      raise ArgumentError, message.gsub( "$1", key.inspect ), backtrace
     
     }
   

data/lib/tdriver/util/common/kernel.rb

@@ -27,6 +27,17 @@ module Kernel
 
   end
 
+  # TODO: document me
+  def __method_path__
+
+    # retrieve filename, line number and method name
+    /^(.+?):(\d+)(?::in `(.*)')?/.match( caller.reverse[ -2 ].to_s )
+
+    # construct string with module/class and method name
+    "#{ ( [ Class, Module ].include?( self.class ) ? self.name : self.class.name ).to_s }##{ caller.first.to_s.scan(/`(.+)'$/).to_s }"
+
+  end
+
   # TODO: document me
   def warn_caller( message, remove_eval = true )
 

data/lib/tdriver/util/common/numeric.rb

@@ -48,6 +48,54 @@ class Numeric
 
   end
 
+  # TODO: document me
+  def not_negative( message = 'Given value ($1) must not be negative', exception = ArgumentError )
+
+    if negative?
+
+      # replace macros
+      message.gsub!( '$1', self.inspect )
+
+      raise exception, message, caller
+
+    end
+  
+    self
+    
+  end
+
+  # TODO: document me
+  def not_zero( message = 'Given value must not be zero', exception = ArgumentError )
+
+    if zero?
+
+      # replace macros
+      message.gsub!( '$1', self.inspect )
+
+      raise exception, message, caller
+
+    end
+      
+    self
+  
+  end
+
+  # TODO: document me
+  def not_positive( message = 'Given value ($1) must not be positive', exception = ArgumentError )
+
+    if positive?
+
+      # replace macros
+      message.gsub!( '$1', self.inspect )
+
+      raise exception, message, caller
+
+    end
+  
+    self
+  
+  end
+
   # TODO: document me
   def check_range( range, message = "value $1 is out of range ($2)"  )
 

data/lib/tdriver/util/common/object.rb

@@ -27,26 +27,29 @@ class Object
   
   end
 
+  # TODO: document me
   def true?
 
     false
   
   end
   
+  # TODO: document me
   def false?
   
     false
   
   end
 
-  def not_blank( message = "Object must not be blank", exception = ArgumentError )
+  # TODO: document me
+  def not_blank( message = "object must not be blank", exception = ArgumentError )
 
     raise exception, message, caller if blank? 
 
     self
 
   end
-
+  
   # define method to class instance
   def meta_def( method_name, &block )