cutedriver-driver 2.0.0.20210120164037

data/lib/tdriver/util/recorder/scripter.rb

@@ -0,0 +1,294 @@
+############################################################################
+## 
+## 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
+
+  class Scripter
+
+    def initialize(sut_id, object_identificators)
+
+      @_object_identificators = object_identificators
+
+      @_tap_max_time = $parameters[sut_id][:record_tap_time_treshold].to_i
+      @_tap_min_distance = $parameters[sut_id][:record_move_treshold].to_i
+
+    end
+
+    def write_fragment(xml_as_object, app_name)
+    
+      script =  "# Insert the script fragment below into your test \n"
+      script << "# Add verification points if needed. \n \n"
+      script << "# For testing the script! Do not include in your own test scripts. \n"
+      script << "@app = sut.application(:name =>'" << app_name << "') \n"  
+      script << "# To test the script make sure the application is in the same state as it was when recording was started. \n\n"
+      script << "#################################### \n"
+      script << "# Begin recorded script              \n"
+      script << "#################################### \n \n"
+
+      event_list = xml_as_object.events
+      event_count = event_list.attribute('eventCount').to_i
+
+      mouse_down = false
+      points = Array.new
+      active_target = nil
+      scripting = false;
+      mouse_status = 0
+      previous_time = nil
+      event = nil
+      
+      # mouse_status: 
+      # 0 = no press or release
+      # 1 = press, no release     [ will only happen if recording stoped before mouse release]
+      # 2 = release, no press     [ will only happen if recording started after mouse press]
+      # 3 = press and release
+      
+      # COLLECT ALL MOUSE EVENTS
+      mouse_moves = []
+      mouse_press_events = []
+      mouse_release_events = []
+      
+      begin
+        mouse_moves = xml_as_object.children(:type =>'event', :name=>'MouseMove')
+      rescue MobyBase::TestObjectNotFoundError
+      end
+      
+      begin
+        mouse_press_events = xml_as_object.children(:type =>'event', :name=>'MouseButtonPress')
+      rescue MobyBase::TestObjectNotFoundError
+      end
+      
+      begin 
+        mouse_release_events = xml_as_object.children(:type =>'event', :name=>'MouseButtonRelease')
+      rescue MobyBase::TestObjectNotFoundError
+      end
+      
+      # STORE MOVE POINTS
+      move_points = []
+      mouse_moves.each do |point|
+        timestamp = point.attribute('timeStamp').to_i
+        previous_timestamp = ( move_points[-1].nil? ) ? timestamp : move_points[-1]['timestamp'].to_i
+        interval = get_duration(previous_timestamp, timestamp)
+        move_points.push({'x' => point.attribute('windowX'), 'y' => point.attribute('windowY'), 'interval' => interval, 'timestamp' => timestamp, 'id' => point.id} )
+      end
+      
+      # STORE RELEASE EVENTS
+      release_events = []
+      mouse_release_events.each do |event|
+        release_events.push({'id' => event.id})
+      end
+
+      # FOREACH MouseButtonPress
+      mouse_press_events.each_index do |index|
+        active_target = get_target_details( mouse_press_events[index].child(:id => mouse_press_events[index].id) )  
+
+        # COLLECT MouseMove points until MouseButtonRelease
+        # If no more MouseButtonRelease or MouseButtonPress then last MoveMouse point id
+        first_point_index = mouse_press_events[index].id.to_i
+        if ( !move_points.empty? )
+          next_mouse_press_index =  ( mouse_press_events[ index + 1 ].nil? ) ?  move_points.last['id'].to_i : mouse_press_events[ index + 1 ].id.to_i
+          next_mouse_release = release_events.select{ |event| event['id'].to_i < next_mouse_press_index }
+          next_mouse_release_index = next_mouse_release.first['id'].to_i unless next_mouse_release.empty?
+          last_point_index = ( next_mouse_release_index.nil? ) ? next_mouse_press_index : next_mouse_release_index
+        else
+          if ( !release_events.empty? )
+            next_mouse_press_index =  ( mouse_press_events[ index + 1 ].nil? ) ?  0 : mouse_press_events[ index + 1 ].id.to_i
+            next_mouse_release = ( next_mouse_press_index == 0 ) ? [ release_events.last ] : release_events.select{ |event| event['id'].to_i < next_mouse_press_index }
+            last_point_index =  next_mouse_release.first['id'].to_i unless ( next_mouse_release.nil? or next_mouse_release.empty? )
+          else
+            last_point_index = 0
+          end
+        end
+        
+        
+        points = move_points.select{ |point| point['id'].to_i > first_point_index and point['id'].to_i <= last_point_index }
+        points.first['interval'] = 0.to_f unless points.empty? # set first interval to 0
+        
+        # PROCESS gesture at MouseButtonRelease unless we hit last point and there is no release
+        last_processed_event_id = ( move_points.empty? ) ? 0 : move_points.last['id'].to_i
+        if ( last_point_index != last_processed_event_id )
+          script << generate_command(active_target, points, mouse_status = 3 ) << "\n"   
+          
+        # END EVENTS, MouseButtonRelease truncated or second press without release witch would not make sense
+        else
+          script << generate_command(active_target, points, mouse_status = 1 ) << "\n"  
+        end
+        
+      end
+
+      script << "\n"
+      script << "#################################### \n"
+      script << "# End recorded script                \n"
+      script << "#################################### \n"
+      script     
+
+    end
+
+  private
+
+    def add_command( mouse_status, active_target, points, duration )
+
+      fragment << fragment
+
+    end
+
+    def get_target_details(test_object)
+
+      target = test_object.type
+      params = Array.new
+
+      params.push(":name=>'#{ test_object.name }'") 
+
+      if test_object.name.empty?
+
+        params.clear
+
+        @_object_identificators.each do |attribute|
+
+          begin
+
+            value = test_object.attribute(attribute)
+            params.push(":#{ attribute } => '#{ value }'") unless value == "" 
+
+          rescue MobyBase::AttributeNotFoundError
+
+          end
+
+        end
+
+      end
+
+      if params.size > 0
+
+        target << "( "
+
+        until params.size == 0
+
+          target << params.pop
+          target << ", " if params.size > 0
+
+        end
+
+        target << " )"
+
+      end
+
+      target
+    end
+
+
+    def generate_command(target_details, points, mouse_status)
+
+      command = "@app." 
+
+      if valid_gesture?(points)
+
+        command << target_details << ".gesture_points(\n\t[\n"
+        duration = 0 
+
+        for i in 0...points.size  
+
+          value =  points[ i ]
+          command << "\t\t{'x' => " << value[ "x" ].to_s << ", 'y' => " << value[ "y" ].to_s << ", 'interval' => " << value[ "interval" ].to_s << " }"
+          command << ", \n" unless i == points.size - 1
+          duration = duration + value[ 'interval' ]
+
+        end
+
+        command << "\n\t], \n\t" << duration.to_s << ", \n\t"
+
+        case mouse_status
+          when 0
+            command << "{ :press => false, :release => false }"
+          when 1
+            command << "{ :press => true, :release => false }"
+          when 2
+            command << "{ :press => false, :release => true }"
+          when 3
+            command << "{ :press => true, :release => true }"
+        end
+
+        command << "\n)"
+
+        command
+
+      elsif mouse_status > 0
+
+        duration = 0
+
+        points.each{|value| duration = duration + value['interval']}
+
+        if mouse_status == 1
+
+          command << target_details << ".tap_down" 
+
+        elsif duration < @_tap_max_time
+
+          command << target_details << ".tap" 
+
+        else
+
+          command << target_details << ".long_tap( " << duration.to_s << " )" 
+
+        end
+
+      end
+    end
+
+    def valid_gesture?(points)
+
+      return false if points.size < 2
+
+      min_x = -1
+      max_x = -1
+      min_y = -1
+      max_y = -1
+
+      for i in 0...points.size  
+
+        value =  points[i]
+
+        x = value['x'].to_i
+        y = value['y'].to_i
+
+        min_x = x if x < min_x or min_x == -1
+        max_x = x if x > max_x or max_x == -1
+        min_y = y if y < min_y or min_y == -1
+        max_y = y if y > max_y or max_y == -1
+
+      end
+
+      return false if (max_x - min_x).abs < @_tap_min_distance and (max_y - min_y).abs < @_tap_min_distance
+      
+      true
+    end
+
+    def get_duration(start_time, end_time)
+      duration_millis = end_time - start_time
+      #we want this in second
+      duration_millis = duration_millis.to_f
+      duration_secs = duration_millis / 1000
+      duration_secs
+    end
+
+    # enable hooking for performance measurement & debug logging
+    TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
+
+  end # Scripter
+
+end # MobyUtil

data/lib/tdriver/util/statistics/statistics.rb

@@ -0,0 +1,89 @@
+############################################################################
+## 
+## 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 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 )
+
+      require 'rubygems'
+      require 'uri'
+      require 'socket'
+      require 'net/http'
+      require 'date'
+
+			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	    
+
+		TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
+
+	end # Stats
+
+end # MobyUtil

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

@@ -0,0 +1,28 @@
+############################################################################
+## 
+## 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,25 @@
+############################################################################
+## 
+## 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,104 @@
+############################################################################
+##
+## 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: 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
+		# 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 = nil )
+			
+			raise UserDataNotFoundError.new( "User data logical name can't be empty" ) if user_data_lname == nil
+
+			# Get Localization parameters for DB Connection
+			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 )
+
+			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 raise error for language not found
+				raise UserDataColumnNotFoundError.new( "User data language column '#{ language }' was not found" ) unless $!.message.index( "Unknown column" ) == nil
+				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
+			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
+