testability-driver 1.0.3 → 1.0.4

data/lib/tdriver/util/{stats.rb → statistics/statistics.rb}

@@ -17,13 +17,6 @@
 ## 
 ############################################################################
 
-
-require 'rubygems'
-require 'net/http'
-require 'socket'
-require 'uri'
-require 'date'
-
 # Utility for storing statistics regarding TDriver usage
 #
 #
@@ -50,6 +43,12 @@ module MobyUtil
 
 			return nil if defined?( $_TDRIVER_DISABLE_STATS_REPORTING )
 
+      require 'rubygems'
+      require 'uri'
+      require 'socket'
+      require 'net/http'
+      require 'date'
+
 			report_thread = Thread.new{
 
 				begin
@@ -83,7 +82,7 @@ module MobyUtil
 
 		end	    
 
-		MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+		TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
 
 	end # Stats
 

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

@@ -17,7 +17,6 @@
 ## 
 ############################################################################
 
-
 module MobyUtil
 	
 	# This error should be raised when the desired user data is not found

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

@@ -17,10 +17,9 @@
 ## 
 ############################################################################
 
-
 # user data inputs related errors
 require File.expand_path( File.join( File.dirname( __FILE__ ), 'error.rb' ) )
 
-# user data inputs  module implementation 
+# user data inputs module implementation
 require File.expand_path( File.join( File.dirname( __FILE__ ), 'user_data.rb' ) )
 

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

@@ -64,12 +64,12 @@ module MobyUtil
 			Kernel::raise UserDataNotFoundError.new( "User data logical name can't be empty" ) if user_data_lname == nil
 
 			# Get Localization parameters for DB Connection
-			db_type =  MobyUtil::Parameter[ :user_data_db_type, nil ].to_s.downcase
-			host =  MobyUtil::Parameter[ :user_data_server_ip ]
-			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_type =  $parameters[ :user_data_db_type, nil ].to_s.downcase
+			host =  $parameters[ :user_data_server_ip ]
+			username = $parameters[ :user_data_server_username ]
+			password = $parameters[ :user_data_server_password ]
+			database_name = $parameters[ :user_data_server_database_name ]
+      table_name = $parameters[: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/camera.rb

@@ -0,0 +1,67 @@
+############################################################################
+## 
+## 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
+
+  # Base class and interface for camera recorders in TDriver
+  class TDriverCam
+
+    # Automatically select the right kind of camera implementation for the detected platform.
+    def self.new_cam( *args )
+
+      if EnvironmentHelper.windows?
+
+        MobyUtil::TDriverWinCam.new( *args )
+
+      elsif EnvironmentHelper.linux?
+
+        MobyUtil::TDriverLinuxCam.new( *args )
+
+      else
+
+        raise RuntimeError.new("Unidentified platform type, unable to select platform specific camera. Supported platform types: Linux, Windows.")
+
+      end
+
+    end
+
+    def initialize
+
+      raise RuntimeError.new("TDriverCam abstract class")
+
+    end
+
+    def start_recording
+
+      raise RuntimeError.new("TDriverCam abstract class")
+
+    end
+
+    def stop_recording
+
+      raise RuntimeError.new("TDriverCam abstract class")
+
+    end
+
+    # enable hooking for performance measurement & debug logging
+    TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
+
+  end # TDriverCam
+
+end # MobyUtil

data/lib/tdriver/util/video/camera_linux.rb

@@ -0,0 +1,139 @@
+############################################################################
+## 
+## 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
+  
+  # Linux streamer webcam implementation
+  # Requires that the streamer application is installed
+  class TDriverLinuxCam
+
+    STARTUP_TIMEOUT = 60
+
+    DEFAULT_OPTIONS = { :device => '/dev/video0', :width => 320, :height => 240, :fps => 5 }
+
+    # TODO: document me
+    def self.new_cam( *args )
+
+      MobyUtil::TDriverLinuxCam.new( *args )
+
+    end
+
+    # 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
+    def initialize( video_file, user_options = {} )      
+
+      @_device = nil
+      @_video_file = nil
+      @_recording = false
+      @_rec_options = nil
+      @_owcc_startex = nil
+      @_owcc_stop = nil
+      
+      @_control_id = nil
+      @_video_file = video_file
+      @_rec_options = DEFAULT_OPTIONS.merge user_options
+          
+    end
+    
+    # Starts recording based on options given during initialization
+    # === raises
+    # RuntimeError: No filename has been defined or recording initialization failed due to timeout.
+    def start_recording
+
+      raise RuntimeError.new( "No video file defined, unable to start recording." ) if @_video_file.nil?
+
+      if File.exists?( @_video_file )        
+        begin
+          File.delete( @_video_file )
+            rescue
+          # no reaction to failed file ops, unless recording fails
+        end
+      end  
+
+      rec_command = 'streamer -q -c ' + @_rec_options[ :device ].to_s + ' -f rgb24 -r ' + @_rec_options[ :fps ].to_s + ' -t 99:00:00 -o ' +  @_video_file.to_s + ' -s ' + @_rec_options[ :width ].to_s + 'x' + @_rec_options[ :height ].to_s
+
+      @_streamer_pid = fork do
+        begin
+          Kernel::exec( rec_command )
+        rescue Exception => e
+          raise RuntimeError.new( "An error was encountered while launching streamer:\n" << e.inspect )
+        end
+      end
+
+      file_timed_out = false
+
+      file_timeout = Time.now + STARTUP_TIMEOUT
+
+      while File.size?( @_video_file ).nil? && !file_timed_out do
+
+        #wait for recording to start, ie. filesize > 0
+        sleep 0.1
+
+        file_timed_out = true if Time.now > file_timeout
+
+      end
+      
+      if file_timed_out
+
+        # make sure recording is not initializing, clean up any failed file        
+        begin
+          Process.kill( 9, @_streamer_pid.to_i )
+        rescue
+        end
+        
+        if File.exists?( @_video_file )
+          begin
+            File.delete( @_video_file )
+          rescue
+          end
+        end
+
+        raise RuntimeError.new( "Failed to start recording. Timeout: #{STARTUP_TIMEOUT} second(s). File: \"#{@_video_file}\" " )
+
+      end
+    
+      @_recording = true
+      
+      nil
+      
+    end
+        
+    # Stops ongoing recording    
+    def stop_recording 
+
+      if @_recording      
+
+        @_recording = false            
+
+        Process.kill( 9, @_streamer_pid.to_i )
+
+      end
+
+      nil
+
+    end    
+    
+    # enable hooking for performance measurement & debug logging
+    TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
+
+  end #TDriverLinuxCam
+    
+end # MobyUtil

data/lib/tdriver/util/video/camera_windows.rb

@@ -0,0 +1,174 @@
+############################################################################
+## 
+## 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
+
+  # Windows DirectShow webcam implementation
+  class TDriverWinCam
+
+    STARTUP_TIMEOUT = 60
+
+    DEFAULT_OPTIONS = { :device => nil, :width => 640, :height => 480, :fps => 30 }
+    
+    # TODO: document me
+    def self.new_cam( *args )
+
+      MobyUtil::TDriverWinCam.new( *args )
+
+    end
+
+    # 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
+    def initialize( video_file, user_options = {} )
+
+      @_device = nil
+      @_video_file = nil
+      @_recording = false
+      @_rec_options = nil
+      @_owcc_startex = nil
+      @_owcc_stop = nil
+        
+      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
+          
+    end
+    
+    # Starts recording based on options given during initialization
+    # === raises
+    # RuntimeError: No filename has been defined or recording initialization failed due to timeout.
+    def start_recording
+
+      raise RuntimeError.new("No video file defined, unable to start recording.") if @_video_file.nil?
+
+      if File.exists?( @_video_file )        
+        begin
+          File.delete( @_video_file )
+        rescue
+          # no reaction to failed file ops, unless recording fails
+        end
+      end
+    
+      @_control_id = @_owcc_startex.call( @_video_file, 0, 0, 0, @_rec_options[ :fps ].to_i, @_rec_options[ :width ].to_i, @_rec_options[ :height ].to_i, 0, 0 )
+      
+      if @_control_id == 0
+
+        Kernel::raise RuntimeError.new( "Failed to start video recording.\nFile: " + @_video_file + "\nFPS: " + @_rec_options[ :fps ].to_s + "\nWidth: " + @_rec_options[ :width ].to_s + "\nHeight: " + @_rec_options[ :height ].to_s )
+
+      end
+
+      file_timed_out = false
+
+      file_timeout = Time.now + STARTUP_TIMEOUT
+
+      while File.size?( @_video_file ).nil? && !file_timed_out do
+
+        #wait for recording to start, ie. filesize > 0
+        sleep 1
+
+        # force refresh file size
+        begin
+
+          if File.exists?( @_video_file ) 
+            File.open( @_video_file, 'r' ) do 
+            end      
+          end
+
+        rescue
+
+        end      
+        
+        if Time.now > file_timeout
+          file_timed_out = true
+        end
+
+      end
+      
+      if file_timed_out
+
+        # make sure recording is not initializing, clean up any failed file        
+        begin
+          @_owcc_stop.call( @_control_id )
+        rescue
+        end
+        
+        if File.exists?( @_video_file )
+          begin
+            File.delete( @_video_file )
+          rescue
+          end
+        end      
+
+        raise RuntimeError.new( "Failed to start recording. Timeout: #{STARTUP_TIMEOUT} File: \"#{@_video_file}\" " )
+      end
+      
+      @_recording = true
+      
+      nil
+      
+    end
+        
+    # Stops ongoing recording    
+    def stop_recording 
+
+      if @_recording      
+        @_recording = false            
+        @_owcc_stop.call( @_control_id )
+      end
+
+      nil
+
+    end
+
+    # enable hooking for performance measurement & debug logging
+    TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
+    
+  end #TDriverWinCam
+    
+end # MobyUtil