testability-driver 0.9.2 → 1.0.0

data/lib/tdriver/util/parameter/parameter_hash.rb

@@ -23,7 +23,8 @@ module MobyUtil
 
     def initialize( hash = {} )
 
-      Kernel::raise ArgumentError.new( "Unexpected argument type %s, expecting Hash or ParameterHash" % [ hash.class ] ) unless [ Hash, ParameterHash ].include?( hash.class )
+      #Kernel::raise ArgumentError.new( "Unexpected argument type %s, expecting Hash or ParameterHash" % [ hash.class ] ) unless [ Hash, ParameterHash ].include?( hash.class )
+      hash.check_type( [ Hash, ParameterHash ], "Wrong argument type $1 for hash (expected $2)" )
 
       merge!( 
 
@@ -72,13 +73,15 @@ module MobyUtil
     end
 
     # Merge this Hash with another, primary Hash. Any values found in the other hash will overwrite local values and any Hash values will be recursively merged.
-    def merge_with_hash!( primary_hash )
+    def merge_with_hash!( other_hash )
 
-      raise ArgumentError.new( "Unable to merge, the other Hash was not a Hash, it was of type \"" + primary_hash.class.to_s + "\"." ) unless primary_hash.kind_of?( Hash )
+      #raise ArgumentError.new( "Unable to merge, the other Hash was not a Hash, it was of type \"" + other_hash.class.to_s + "\"." ) unless other_hash.kind_of?( Hash )
 
-      primary_hash.each_pair do | key, value |
+      other_hash.check_type( Hash, "Wrong argument type $1 for hash (expected $2)" )
 
-        if ( self.has_key?( key ) && self[ key ].kind_of?( Hash ) ) and primary_hash[ key ].kind_of?( Hash )
+      other_hash.each_pair do | key, value |
+
+        if ( self.has_key?( key ) && self[ key ].kind_of?( Hash ) ) and other_hash[ key ].kind_of?( Hash )
 
           self[ key ].merge_with_hash!( value )
 

data/lib/tdriver/util/parameter/parameter_xml.rb

@@ -61,13 +61,20 @@ module MobyUtil
       # default results 
       results = ParameterHash.new()
 
+      # retrieve platform name
+      platform = MobyUtil::EnvironmentHelper.platform
+
+      # detect is posix platform
+      is_posix = MobyUtil::EnvironmentHelper.posix?
+
       begin
+
         # create new xml document
         document = MobyUtil::XML::parse_string( xml )
 
       rescue Exception => exception
 
-        Kernel::raise ParameterFileParseError.new( "Error occured while parsing XML. Reason %s (%s)" % [ exception.message, exception.class ] )
+        Kernel::raise ParameterFileParseError.new( "Error occured while parsing XML. Reason: %s (%s)" % [ exception.message, exception.class ] )
 
       end
 
@@ -77,18 +84,27 @@ module MobyUtil
         attribute = element.attributes.to_hash
 
         name = attribute[ "name" ].to_s
+
+        # default value
         value = attribute[ "value" ].to_s
 
+        # generic posix value - overwrites attribute["value"] if found
+        value = attribute["posix"].to_s unless attribute[ "posix" ].nil? if is_posix
+
+        # platform specific value - overwrites existing value
+        value = attribute[ platform.to_s ].to_s unless attribute[ platform.to_s ].nil?
+
         case element.name
             
           when 'fixture'
 
             plugin = attribute[ "plugin" ].to_s
+		    env = attribute[ "env" ].to_s unless attribute[ "env" ].nil?
 
             Kernel::raise SyntaxError.new( "No name defined for fixture with value %s" % name ) if name.empty?
             Kernel::raise SyntaxError.new( "No plugin defined for fixture with name %s" % name ) if plugin.empty?
 
-            value = plugin
+   		    value = {:plugin => plugin, :env => env}
 
           when 'parameter'
 

data/lib/tdriver/util/recorder.rb

@@ -16,8 +16,6 @@
 ## of this file. 
 ## 
 ############################################################################
-
-
  
 # Class for recording scripts from qt applications.
 # Complete test script recording not supported. 
@@ -29,26 +27,33 @@ module MobyUtil
 	class Recorder
 
 		#TODO detect app start for later versions...
-		def self.start_rec(app)
+		def self.start_rec( app )
+
+			#Kernel::raise ArgumentError.new("Application must be defined.") unless app
+			app.check_type( MobyBase::TestObject, "Wrong argument type $1 for application object (expected $2)" )
 
-			Kernel::raise ArgumentError.new("Application must be defined.") unless app
 			app.start_recording
 
 		end
 
 		# Prints the recorded events as an tdriver script fragment.
-		def self.print_script(sut, app, object_identificators = ['text','icontext','label'])
+		def self.print_script( sut, app, object_identificators = ['text','icontext','label'] )
+
+      # verify that sut type is type of MobyBase::SUT
+			#Kernel::raise ArgumentError.new("Sut must be defined.") unless sut
+      sut.check_type( MobyBase::SUT, "Wrong argument type $1 for SUT (expected $2)" )
 
-			Kernel::raise ArgumentError.new("Sut must be defined.") unless sut
-			Kernel::raise ArgumentError.new("Application must be defined.") unless app
-			Kernel::raise ArgumentError.new("Object identificators must be set, use defaults if not sure what the use.") unless object_identificators
+			#Kernel::raise ArgumentError.new("Application must be defined.") unless app
+      app.check_type( MobyBase::TestObject, "Wrong argument type $1 for application object (expected $2)" )
 
+			#Kernel::raise ArgumentError.new("Object identificators must be set, use defaults if not sure what the use.") unless object_identificators
+      object_identificators.check_type( Array, "Wrong argument type $1 for object identificators (expected $2)" )
+      
 			xml_source = app.print_recordings
-			app.stop_recording
-			xml_as_object = MobyBase::StateObject.new( xml_source )
-			scripter = Scripter.new(sut.id, object_identificators)
 
-			scripter.write_fragment(xml_as_object, app.name)
+			app.stop_recording
+			
+			Scripter.new( sut.id, object_identificators ).write_fragment( MobyBase::StateObject.new( xml_source ), app.name )
 
 		end
 

data/lib/tdriver/util/user_data/user_data.rb

@@ -39,7 +39,7 @@ module MobyUtil
 		#
 		# table_name
 		#  String
-		#   description: String containing the name of table to be used when user information
+		#   description: Optional string containing the name of table to be used when user information, if empty the parameter user_data_server_database_tablename will be used
 		#   example: "user_data_week201042"
 		#
 		# == returns
@@ -59,7 +59,7 @@ module MobyUtil
 		# SqlError
 		#  description: If there is and sql error while executing the query
 		#
-		def self.retrieve( user_data_lname, language, table_name )
+		def self.retrieve( user_data_lname, language, table_name = nil )
 			
 			Kernel::raise UserDataNotFoundError.new( "User data logical name can't be empty" ) if user_data_lname == nil
 
@@ -69,6 +69,7 @@ module MobyUtil
 			username = MobyUtil::Parameter[ :user_data_server_username ]
 			password = MobyUtil::Parameter[ :user_data_server_password ]
 			database_name = MobyUtil::Parameter[ :user_data_server_database_name ]
+      table_name = MobyUtil::Parameter[:user_data_server_database_tablename] if table_name.nil? or table_name.empty?
 			
 			db_connection = DBConnection.new(  db_type, host, database_name, username, password )
 

data/lib/tdriver/util/{video_rec.rb → video_utils.rb}

@@ -69,23 +69,35 @@ module MobyUtil
 		# Creates a new recroding object witdh the given recording options		
 		# === params
 		# video_file: String, path and name of file where the recorded video is stored
-        # user_options: (optional) Hash, keys :fps, :width, :height can be used to overwrite defaults
+    # user_options: (optional) Hash, keys :fps, :width, :height can be used to overwrite defaults
 		def initialize( video_file, user_options = {} )
 		    
-		    begin
-		      require 'Win32API'			
-              #OSCARWEBCAMCONTROL_API long OscarWebCamControlStartEx(char* captureFile, double compQuality, DWORD dwBitsPerSec, long lFramesPerSec, long lCapWidth, long lCapHeight, bool bFlipV, bool bFlipH)
-              @_owcc_startex = Win32API.new( 'OscarWebCamControl', 'OscarWebCamControlStartEx', [ 'P', 'N', 'N', 'N', 'L', 'L', 'L', 'I', 'I'  ], 'L' )
-			  #OSCARWEBCAMCONTROL_API void OscarWebCamControlStop(long pTargetMediaControl)
-              @_owcc_stop = Win32API.new( 'OscarWebCamControl', 'OscarWebCamControlStop', [ 'L' ], 'V' )
-            rescue Exception => e
-              raise RuntimeError.new( "Failed to connect to video recording DLL file (OscarWebCamControl.dll). Details:\n" + e.message )
-            end
-		    
-            if user_options.has_key? :device
-              puts "WARNING: TDriverWinCam does not support the :device option. This setting is ignored."
-            end
-			
+      require 'Win32API'			
+
+      begin     
+      
+        @_owcc_startex = Win32API.new( 'TDriverWebCamControl', 'OscarWebCamControlStartEx', [ 'P', 'N', 'N', 'N', 'L', 'L', 'L', 'I', 'I'  ], 'L' )
+        @_owcc_stop = Win32API.new( 'TDriverWebCamControl', 'OscarWebCamControlStop', [ 'L' ], 'V' )
+   
+      rescue Exception => e
+      
+        begin 
+            
+          #OSCARWEBCAMCONTROL_API long OscarWebCamControlStartEx(char* captureFile, double compQuality, DWORD dwBitsPerSec, long lFramesPerSec, long lCapWidth, long lCapHeight, bool bFlipV, bool bFlipH)
+          @_owcc_startex = Win32API.new( 'OscarWebCamControl', 'OscarWebCamControlStartEx', [ 'P', 'N', 'N', 'N', 'L', 'L', 'L', 'I', 'I'  ], 'L' )
+          #OSCARWEBCAMCONTROL_API void OscarWebCamControlStop(long pTargetMediaControl)
+          @_owcc_stop = Win32API.new( 'OscarWebCamControl', 'OscarWebCamControlStop', [ 'L' ], 'V' )
+          
+        rescue Exception => ee
+          raise RuntimeError.new( "Failed to connect to video recording DLL file (TDriverWebCamControl.dll or OscarWebCamControl.dll). Details:\n" + ee.message )
+        end
+        
+      end
+
+      if user_options.has_key? :device
+        puts "WARNING: TDriverWinCam does not support the :device option. This setting is ignored."
+      end
+  
 		    @_control_id = nil
 			@_video_file = video_file
 		    @_rec_options = DEFAULT_OPTIONS.merge user_options
@@ -183,7 +195,7 @@ module MobyUtil
 		# Creates a new recroding object witdh the given recording options		
 		# === params
 		# video_file: String, path and name of file where the recorded video is stored
-        # user_options: (optional) Hash, keys :fps, :width, :height can be used to overwrite defaults
+    # user_options: (optional) Hash, keys :fps, :width, :height can be used to overwrite defaults
 		def initialize( video_file, user_options = {} )	    
 			
 		    @_control_id = nil
@@ -261,4 +273,112 @@ module MobyUtil
 		end		
 		
 	end #TDriverLinuxCam
+  
+  
+  # Checks if the target video contains enough activity to be considered active or static.
+  #
+	# === params
+	# in_target_video: String, Name and path of video file to analyze
+  # in_fps: (optional) Numeric, frames to be analyzed per second
+  # in_image_treshold: (optional) Numeric, minimum change between two frames for them to be considered different
+  # in_video_treshold: (optional) Numeric, Minimum percentage of frames with changes for the video to be considered alive.
+  # in_verbose: (optional) Boolean, True for verbose output including target video statistics
+  def self.video_alive?( in_target_video, in_fps = 1, in_image_treshold = 4, in_video_treshold = 35, in_verbose = false )
+  
+    puts "Arguments fps: " << in_fps.inspect << " frame: " << in_image_treshold.inspect << " video: "  << in_video_treshold.inspect if in_verbose
+    in_change = in_image_treshold / 100.0
+    
+    alive_temp_folder = "temp_target_alive"
+    
+    require 'rmagick'
+    
+    raise ArgumentError.new( "The FPS argument must be an Interger or a Float, it was a #{ in_fps.class }." ) unless in_fps.kind_of? Numeric
+    raise ArgumentError.new( "The frame treshold argument must be an Interger or a Float, it was a #{ in_image_treshold.class }." ) unless in_image_treshold.kind_of? Numeric
+    raise ArgumentError.new( "The video treshold argument must be an Interger or a Float, it was a #{ in_video_treshold.class }." ) unless in_video_treshold.kind_of? Numeric
+     
+    ts = Time.now if in_verbose
+
+    begin
+      FileUtils.remove_dir alive_temp_folder
+    rescue 
+      # failed to remove dir, do nothing
+    end
+    
+    begin
+      FileUtils.mkdir_p alive_temp_folder  
+    rescue
+    
+    end
+    
+    begin
+      File.delete 'video_split.log' if File.exist? 'video_split.log'
+    rescue
+    end
+        
+    if in_verbose
+      system('ffmpeg.exe -v 0 -i '+in_target_video.to_s+' -y -f image2 -r '+in_fps.to_s+' '+alive_temp_folder+'/frame-%05d.png')
+    else
+      system('ffmpeg.exe 2>video_split.log -v 0 -i '+in_target_video.to_s+' -y -f image2 -r '+in_fps.to_s+' '+alive_temp_folder+'/frame-%05d.png')
+    end
+
+    puts "Video processing duration: " << (Time.now - ts).to_s if in_verbose
+
+    t_start = Time.now
+    
+    im_files = Dir.glob( alive_temp_folder + '/frame-*.png' )
+
+    raise RuntimeError.new( "No video frames found for analysis." ) if im_files.size == 0
+    
+    d_max = 0.0
+    d_min = 1.0
+
+    d_sum = 0.0
+    
+    dif_count = 0
+
+    pre_obj = Magick::ImageList.new(im_files[0])
+
+    (im_files.size-1).times do | im_index |
+
+      im_file = Magick::ImageList.new(im_files[ im_index ])
+      pre_file = pre_obj
+       
+      dif = pre_file.compare_channel(im_file, Magick::RootMeanSquaredErrorMetric)[1]
+       if in_verbose
+        d_min = dif unless dif >= d_min
+        d_max = dif unless dif <= d_max
+        d_sum += dif
+      end
+      dif_count += 1 if dif > in_change
+      puts "Processing image: " << im_file.to_s << " I: " << (im_index+1).to_s  << " C: " << dif.to_s if in_verbose
+      
+      pre_obj = im_file
+           
+    end
+        
+    if in_verbose
+      puts "Max difference: " << d_max.to_s << "\nMin difference: " << d_min.to_s << "\n"
+      puts "Mean difference: " << (d_sum/im_files.size).to_s unless im_files.size == 0
+      puts "Count of images exceeding difference tolerance: " << dif_count.to_s
+
+      puts "Fraction of images exceeding difference tolerance: " << (dif_count.to_f/im_files.size).to_s unless im_files.size == 0
+      puts "Analysis duration: " << (Time.now - t_start).to_s
+      puts "Total duration: " << (Time.now - ts).to_s
+    end
+
+    begin
+      FileUtils.remove_dir alive_temp_folder
+    rescue 
+    end
+    
+    begin
+      File.delete 'video_split.log' if File.exist? 'video_split.log'
+    rescue
+    end
+    
+    # Check if enough frames had changes
+    return (dif_count.to_f/im_files.size)*100 >= in_video_treshold
+      
+  end  
+  
 end

data/lib/tdriver/util/xml/abstraction.rb

@@ -37,6 +37,13 @@ module MobyUtil
 
       end      
 
+      # print only object type and id hex
+      def inspect
+      
+        "#<#{ self.class }:0x#{ ( "%x" % ( self.object_id.to_i << 1 ) )[ 3 .. -1 ] }>"
+            
+      end
+
       # enable hooking for performance measurement & debug logging
       MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
 

data/lib/tdriver/util/xml/attribute.rb

@@ -0,0 +1,32 @@
+############################################################################
+## 
+## 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 MobyUtil
+
+  module XML
+
+    class Attribute
+
+      include Abstraction
+
+    end # Attribute
+
+  end # XML
+
+end # MobyUtil

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

@@ -32,8 +32,14 @@ require File.expand_path( File.join( File.dirname( __FILE__ ), 'document.rb' ) )
 # element object
 require File.expand_path( File.join( File.dirname( __FILE__ ), 'element.rb' ) )
 
-# element object
-require File.expand_path( File.join( File.dirname( __FILE__ ), 'nil_element.rb' ) )
+# text object
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'text.rb' ) )
+
+# attribute object
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'attribute.rb' ) )
+
+# nil element object
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'nil_node.rb' ) )
 
 # nodeset object
 require File.expand_path( File.join( File.dirname( __FILE__ ), 'nodeset.rb' ) )

data/lib/tdriver/util/xml/nil_node.rb

@@ -0,0 +1,95 @@
+############################################################################
+## 
+## 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 MobyUtil
+
+  module XML
+
+    class NilNode
+
+      include Abstraction
+
+      def method_missing( method, *method_arguments )
+
+        raise RuntimeError.new( "Method '%s' is not supported by %s (%s)" % [ method, self.class, @parser ] )
+
+      end
+
+      def xml=( value )
+
+        @xml = nil
+
+      end
+
+      def name
+
+        nil
+
+      end
+
+      def size
+
+        0
+
+      end
+
+      def nil?
+
+        true
+
+      end
+
+      def eql?( object )
+
+        nil == object.xml.content
+
+      end
+
+      def empty?
+
+        true
+
+      end
+
+      def content
+      
+        nil
+      
+      end
+
+      def to_s
+
+        ""
+
+      end
+
+      def inner_xml
+
+        ""
+
+      end
+
+      # enable hooking for performance measurement & debug logging
+      MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+    end # NilElement
+
+  end # XML
+
+end # MobyUtil