testability-driver 0.9.2

data/lib/tdriver/util/stats.rb

@@ -0,0 +1,90 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+
+require 'rubygems'
+require 'net/http'
+require 'socket'
+require 'uri'
+require 'date'
+
+# Utility for storing statistics regarding TDriver usage
+#
+#
+# Usage:
+# 
+# 1. report installation
+# MobyUtil::Stats.report('install', 'message')
+# will report installation event, message is optional
+#
+# 2. report activation of TDriver
+# MobyUtil::Stats.report('install', 'message')
+# will report TDriver activation event, message is optional
+#
+# 3. report exception raised by TDriver
+# MobyUtil::Stats.report('exception', 'message describing the exception')
+# will report exception thrown by TDriver, message describes the the exception
+#
+
+module MobyUtil  
+
+	class Stats
+
+		def self.report( action, message )
+
+			return nil if defined?( $_TDRIVER_DISABLE_STATS_REPORTING )
+
+			report_thread = Thread.new{
+
+				begin
+					# TODO: override possibility for the url using parameters?
+					url = URI.parse('http://127.0.0.1/tdriver/stats/create/new_stat')
+					
+					resp, data = Net::HTTP.new( url.host, url.port ).post( 
+						url.path, 
+						"stat[action]=#{ action }" <<
+						"&stat[host]=#{ Socket.gethostname }" <<
+						"&stat[time_stamp]=#{ DateTime.now.strftime( "%Y%m%d%H%M%S" ) }" <<
+						"&stat[message]=#{ message }" <<
+						"&stat[user]=#{ 'NO' }" << 
+						"&stat[ip]=#{ 'NO' }" << 
+						"&stat[mac]=#{ 'NO' }" << 
+						"&stat[platform]=#{ RUBY_PLATFORM.to_s }" <<
+						"&stat[version]=#{ ENV['TDRIVER_VERSION'] }" <<
+						"&commit=#{ 'Create' }",
+						{ 'Content-Type' => 'application/x-www-form-urlencoded' }
+					)
+
+				rescue Exception => e
+
+					#puts "Exception:#{e.message} trace:#{e.backtrace.inspect}"             
+
+				end
+
+			}
+
+			report_thread
+
+		end	    
+
+		MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+	end # Stats
+
+end # MobyUtil

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

@@ -0,0 +1,29 @@
+############################################################################
+## 
+## 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
+	
+	# This error should be raised when the desired user data is not found
+	class UserDataNotFoundError < StandardError; def initialize ( msg = nil ); super( msg ); end; end # class
+	
+	# This error should be raised when the desired data column name to be used for the output is not found
+	class UserDataColumnNotFoundError < StandardError; def initialize ( msg = nil ); super( msg ); end; end # class
+	
+end

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

@@ -0,0 +1,26 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+
+# user data inputs related errors
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'error.rb' ) )
+
+# 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

@@ -0,0 +1,103 @@
+############################################################################
+##
+## 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.
+##
+############################################################################
+
+# Utility for handling user data database
+
+module MobyUtil
+
+	class UserData
+
+		# == description
+		# Function for fetching user data from the user data DB
+		#
+		# == arguments
+		# user_data_lname
+		#  String
+		#   description: String containing user_data_lname to be used in fetching the translation
+		#   example: "uif_first_name"
+		#
+		# language
+		#  String
+		#   description: Scring containing language to be used in fetching user information
+		#   example: "en"
+		#
+		# table_name
+		#  String
+		#   description: String containing the name of table to be used when user information
+		#   example: "user_data_week201042"
+		#
+		# == returns
+		# String
+		#  description: User data string
+		#
+		# Array
+		#  description: Array of values when multiple user data strings found
+		#
+		# == throws
+		# UserDataNotFoundError
+		#  description: If the desired user data is not found
+		#
+		# UserDataColumnNotFoundError
+		#  description: If the desired data column name to be used for the output is not found
+		#
+		# SqlError
+		#  description: If there is and sql error while executing the query
+		#
+		def self.retrieve( user_data_lname, language, table_name )
+			
+			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 ]
+			
+			db_connection = DBConnection.new(  db_type, host, database_name, username, password )
+
+			query_string = "select `#{ language }` from #{ table_name } where lname = \'#{ user_data_lname }' and `#{ language }` <>\'#MISSING\'"
+
+			begin
+				result = MobyUtil::DBAccess.query( db_connection, query_string )
+			rescue
+				# if column referring to language is not found then Kernel::raise error for language not found
+				Kernel::raise UserDataColumnNotFoundError.new( "User data language column '#{ language }' was not found" ) unless $!.message.index( "Unknown column" ) == nil
+				Kernel::raise SqlError.new( $!.message )
+			end
+
+			# Return only the first column of the row or and array of the values of the first column if multiple rows have been found
+			Kernel::raise UserDataNotFoundError.new( "No user data for '#{ user_data_lname }' found for language '#{ language }'" ) if ( result.empty?)
+			if result.length > 1
+				result_array = Array.new # array of rows! We want the first column of the first row
+				result.each do |row|
+					result_array << row[0]
+				end
+				return result_array
+			else
+				# Result is an Array of rows (Array<String>)! We want the first column of the first row.
+				return result[0][0]
+			end
+
+		end
+
+	end # class
+
+end # module
+

data/lib/tdriver/util/video_rec.rb

@@ -0,0 +1,264 @@
+############################################################################
+## 
+## 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?
+		  
+		    return TDriverWinCam.new( *args )
+		  
+		  elsif EnvironmentHelper.linux?
+		  
+		    return 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
+
+	end # TDriverCam
+
+	# Windows DirectShow webcam implementation
+	class TDriverWinCam < TDriverCam
+
+		@_device = nil
+		@_video_file = nil
+		@_recording = false
+		@_rec_options = nil
+		@_owcc_startex = nil
+		@_owcc_stop = nil
+		STARTUP_TIMEOUT = 60
+		DEFAULT_OPTIONS = { :device => nil, :width => 640, :height => 480, :fps => 30 }
+		
+		# 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 = {} )
+		    
+		    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
+			
+		    @_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.") unless !@_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
+		  
+		  return nil
+		  
+		end
+				
+		# Stops ongoing recording		
+		def stop_recording 
+          if @_recording		  
+            @_recording = false						
+			@_owcc_stop.call( @_control_id )
+		  end
+		  return nil
+		end		
+		
+	end #TDriverWinCam
+	
+	
+	# Linux streamer webcam implementation
+	# Requires that the streamer application is installed
+	class TDriverLinuxCam < TDriverCam
+
+		@_device = nil
+		@_video_file = nil
+		@_recording = false
+		@_rec_options = nil
+		@_owcc_startex = nil
+		@_owcc_stop = nil
+		STARTUP_TIMEOUT = 60
+		DEFAULT_OPTIONS = { :device => '/dev/video0', :width => 320, :height => 240, :fps => 5 }
+		
+		# 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 = {} )	    
+			
+		    @_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." ) unless !@_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
+		
+            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
+			  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
+		  
+		  return nil
+		  
+		end
+				
+		# Stops ongoing recording		
+		def stop_recording 
+          if @_recording		  
+            @_recording = false						
+            Process.kill( 9, @_streamer_pid.to_i )
+		  end
+		  return nil
+		end		
+		
+	end #TDriverLinuxCam
+end