testability-driver-qt-sut-plugin 0.9.2

data/lib/testability-driver-plugins/testability-driver-qt-sut-plugin/behaviours/os.rb

@@ -0,0 +1,100 @@
+############################################################################
+## 
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). 
+## All rights reserved. 
+## Contact: Nokia Corporation (testabilitydriver@nokia.com) 
+## 
+## This file is part of TDriver. 
+## 
+## 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 MobyBehaviour
+
+	module QT
+
+    # == description
+    # OS specific behaviours
+    #
+    # == behaviour
+    # QtOs
+    #
+    # == requires
+    # testability-driver-qt-sut-plugin
+    #
+    # == input_type
+    # *
+    #
+    # == sut_type
+    # QT
+    #
+    # == sut_version
+    # *
+    #
+    # == objects
+    # sut
+    #
+		module Os
+
+			include MobyBehaviour::QT::Behaviour
+
+			# This method is now deprecated as the latest version of QTTas server never loards PlatformService
+			# Select and open a file from an active open file dialog
+			# == params
+			# == returns  
+			# == raises
+			# def open_file(path, dialog_name, button)
+      # begin
+      # command = command_params #in qt_behaviour           
+      # command.command_name('OpenFile')
+      # command.command_params('dialogName' => dialog_name, 'filePath' => path, 'dialogButton' => button)
+      # command.service('platformOperation')
+      ##open file is done without ui state update so wait for the dialog to open
+      # sleep 0.2
+      # @sut.execute_command(command)
+      # self.force_refresh
+      # rescue Exception => e
+      # MobyUtil::Logger.instance.log "behaviour" , "FAIL;Failed open_file with path \"#{path}\", dialog_name \"#{dialog_name}\", button \"#{button.to_s}\".;#{identity};open_file;"
+      # Kernel::raise e
+      # end
+      # MobyUtil::Logger.instance.log "behaviour" , "PASS;Operation file executed successfully with path \"#{path}\", dialog_name \"#{dialog_name}\", button \"#{button.to_s}\".;#{identity};open_file;"
+      # nil
+      # end			
+			# Press Enter on the keyboard. Useful to accept crash warnings on windows
+			# == params
+			# == returns  
+			# == raises
+
+      # == deprecated
+      # 0.x.x
+      # == description
+			# This method is now deprecated as recent version of Agent Qt server never loads PlatformService      
+			def press_enter(interval = nil)
+				begin   				  
+				  if interval
+					interval = (interval*1000).to_i
+					params = {:interval => interval}
+				  end
+				  self.execute_command( MobyCommand::WidgetCommand.new( nil, nil, nil, 'PressEnter', params, nil, 'uiCommand') )
+				rescue Exception => e
+					MobyUtil::Logger.instance.log "behaviour" , "FAIL;Failed to send an Enter keystroke request to the qttas server;press_enter;"
+					Kernel::raise e
+				end
+					MobyUtil::Logger.instance.log "behaviour" , "PASS;Successfuly sent an Enter keystroke request to the qttas server;press_enter;"
+				nil
+			end
+
+			# enable hooking for performance measurement & debug logging
+			MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+			
+		end
+	end
+end

data/lib/testability-driver-plugins/testability-driver-qt-sut-plugin/behaviours/qt_api_method.rb

@@ -0,0 +1,148 @@
+############################################################################
+## 
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). 
+## All rights reserved. 
+## Contact: Nokia Corporation (testabilitydriver@nokia.com) 
+## 
+## This file is part of TDriver. 
+## 
+## 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 MobyBehaviour
+
+	module QT
+
+		module ApiMethod
+
+			class MethodReturnValue
+
+				attr_reader :value, :type
+
+				def initialize( type, value )
+					Kernel::raise ArgumentError.new("Invalid argument type for type. (Actual: %s, Expected: String)" % [ type.class.to_s ] ) unless type.kind_of?( String )
+					Kernel::raise ArgumentError.new("Invalid argument type for value. (Actual: %s, Expected: String)" % [ value.class.to_s ] ) unless value.kind_of?( String )
+					@type, @value = type, value
+				end
+	
+				def to_s
+					@value
+				end
+
+				def ==( value )
+					value == @value
+				end
+
+				# enable hooking for performance measurement & debug logging
+				MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+			end
+
+			class Method
+
+				RETURN_RESULT_VALUE	= 0x01
+				RETURN_RESULT_AS_LIST	= 0x02
+				RETURN_RESULT_AS_XML	= 0x03
+			
+				def initialize( parent, fixture_name )
+					Kernel::raise ArgumentError.new("Invalid argument type for fixture name. (Actual: %s, Expected: String)" % [ fixture_name.class.to_s ] ) unless fixture_name.kind_of?( String )
+					@parent, @fixture_name = parent, fixture_name
+				end
+
+				def list_methods
+					execute( RETURN_RESULT_AS_LIST, 'list_methods' )
+				end
+
+				def list_class_methods( class_name )
+					Kernel::raise ArgumentError.new("Invalid argument type for class name. (Actual: %s, Expected: String)" % [ class_name.class.to_s ]) unless class_name.kind_of?( String )
+					execute( RETURN_RESULT_AS_LIST, 'list_class methods', { :class => class_name } )
+				end
+
+				def method_missing( method_name, *args, &block )
+					execute( RETURN_RESULT_VALUE, 'invoke_method', { :method => "#{ method_name }", :args =>  MobyUtil::FixtureParameter.new( *args ).to_s } )
+				end
+
+				def debug_invoke_method( method_name, *args )
+					# call methods normally
+					execute( RETURN_RESULT_AS_XML, 'invoke_method', { :method => "#{ method_name }", :args =>  MobyUtil::FixtureParameter.new( *args ).to_s } )
+				end
+
+			private
+
+				def execute( return_result_as_mode, command, *args )
+
+					result = nil
+
+					@parent.fixture( @fixture_name, command, *args ).tap{ | result_xml |
+
+						case return_result_as_mode
+			
+							when RETURN_RESULT_VALUE
+
+								# return value as QtMethodReturnValue
+								MobyUtil::XML.parse_string( result_xml ).tap{ | xml_data |
+									xml_data.xpath( "*//object[@type='QtMethod']/attributes" ).first.tap{ | element |
+										result = QtMethodReturnValue.new( 
+											element.xpath( "attribute[@name='returnValueType']/value" ).first.content,
+											element.xpath( "attribute[@name='returnValue']/value" ).first.content
+										) unless element.nil?
+									} 
+								}
+
+								Kernel::raise RuntimeError.new("Unable to parse fixture result xml (QtApiAccessor)") if result.nil?
+
+							when RETURN_RESULT_AS_LIST
+
+								# return result as Array 
+								result = []
+
+								# TODO: This branch needs to be refactored --> method needed that retrieves ALL TestObjects of given type without MultipleTestObjectsFound exception
+								MobyUtil::XML.parse_string( result_xml ).tap{ | xml_data |
+									xml_data.xpath( "*//object[@type='QtMethod']" ).each{ | element |
+										result << { :method => "#{ element.attribute("name") }" }
+										element.xpath( "attributes/*" ).each{ | attributes |
+											result.last.merge!( { attributes.attribute( "name" ).to_sym => attributes.xpath( "value" ).first.content } )
+										}
+									} 
+								}
+
+							when RETURN_RESULT_AS_XML
+								# return result as is (xml string)
+								result = result_xml
+
+						end
+
+					}
+
+					result
+
+				end
+
+				# enable hooking for performance measurement & debug logging
+				MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+			end
+
+      # == nodoc
+			def QtMethod
+
+				MobyBehaviour::QT::ApiMethodBehaviour::Method.new( self, "tasqtapiaccessor" )
+
+			end
+		
+			# enable hooking for performance measurement & debug logging
+			MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+  
+		end
+
+	end
+
+end

data/lib/testability-driver-plugins/testability-driver-qt-sut-plugin/behaviours/record.rb

@@ -0,0 +1,124 @@
+############################################################################
+## 
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). 
+## All rights reserved. 
+## Contact: Nokia Corporation (testabilitydriver@nokia.com) 
+## 
+## This file is part of TDriver. 
+## 
+## 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 MobyBehaviour
+
+	module QT
+
+    # == description
+    # Record specific behaviours
+    #
+    # == behaviour
+    # QtRecord
+    #
+    # == requires
+    # testability-driver-qt-sut-plugin
+    #
+    # == input_type
+    # *
+    #
+    # == sut_type
+    # QT
+    #
+    # == sut_version
+    # *
+    #
+    # == objects
+    # application
+    #
+		module Record
+
+			include MobyBehaviour::QT::Behaviour
+
+			def start_recording
+
+				begin
+
+					command = plugin_command() #in qt_behaviour
+					command.command_name( 'Start' )
+					command.service( 'recordEvents' )
+					@sut.execute_command( command)
+
+				rescue Exception => e
+
+					MobyUtil::Logger.instance.log "behaviour" , "FAIL;Failed start_recording.;#{ identity };start_recording;"
+					Kernel::raise e
+
+				end
+
+				MobyUtil::Logger.instance.log "behaviour" , "PASS;Operation start_recording executed successfully.;#{ identity };start_recording;"
+
+				nil
+			end
+
+			def stop_recording
+
+				begin
+
+					command = plugin_command() #in qt_behaviour
+					command.command_name( 'Stop' )
+					command.service( 'recordEvents' )
+					@sut.execute_command( command)
+
+				rescue Exception => e
+
+					MobyUtil::Logger.instance.log "behaviour" , "FAIL;Failed stop_recording.;#{ identity };stop_recording;"
+					Kernel::raise e
+
+				end
+
+				MobyUtil::Logger.instance.log "behaviour" , "PASS;Operation stop_recording executed successfully.;#{ identity };stop_recording;"
+
+				nil
+
+			end
+
+			def print_recordings
+
+				ret = nil
+
+				begin
+
+					command = plugin_command(true) #in qt_behaviour
+					command.command_name( 'Print' )
+					command.service( 'recordEvents' )
+					ret = @sut.execute_command( command )
+
+				rescue Exception => e
+
+					MobyUtil::Logger.instance.log "behaviour" , "FAIL;Failed print_recordings.;#{ identity };print_recordings;"
+					Kernel::raise e
+
+				end
+
+				MobyUtil::Logger.instance.log "behaviour" , "PASS;Operation print_recordings executed successfully.;#{ identity };print_recordings;"
+
+				return ret
+
+			end
+
+			# enable hooking for performance measurement & debug logging
+			MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+
+		end # Record
+
+	end
+
+end # MobyBase

data/lib/testability-driver-plugins/testability-driver-qt-sut-plugin/behaviours/screen_capture.rb

@@ -0,0 +1,283 @@
+############################################################################
+## 
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). 
+## All rights reserved. 
+## Contact: Nokia Corporation (testabilitydriver@nokia.com) 
+## 
+## This file is part of TDriver. 
+## 
+## 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 MobyBehaviour
+
+	module QT
+
+    # == description
+    # ScreenCapture specific behaviours
+    #
+    # == behaviour
+    # QtScreenCapture
+    #
+    # == requires
+    # testability-driver-qt-sut-plugin
+    #
+    # == input_type
+    # *
+    #
+    # == sut_type
+    # QT
+    #
+    # == sut_version
+    # *
+    #
+    # == objects
+    # *
+    #
+		module ScreenCapture
+
+			include MobyBehaviour::QT::Behaviour
+
+      # == description
+			# Captures an object to a file. This can be used on widget or the whole application
+			# == arguments
+      # format
+      #  String
+      #   description: Image format for output file (currently only PNG supported)
+      #   example: "PNG"
+      #   default: "PNG"
+      #
+      # file_name
+      #  String
+      #   description: Filename of output image with/without absolute or relative path.
+      #   example: output_image.png
+      #   example: my_relative_folder/output_image.png
+      #   example: c:/my_windows_folder/output_image.png
+      #   example: ~/my_linux_folder/output_image.png
+			#   default: nil
+      #
+      # draw
+      #  Boolean
+      #  description:	When set to true repaint signal is sent to object before capturing the bitmap.
+      #  example: true
+      #  default: false
+      #  
+			# == returns
+			# String
+      #  description:	Image binary
+      #  example: File.open("image.PNG", 'wb:binary') { |f2| f2.puts @screen_capture_data }
+      #  
+			# == exceptions
+			# TestObjectNotFoundError
+      #  description: If a graphics item is not visible on screen
+			# ArgumentError
+      #  description: If the text is not a string.
+			#
+			def capture_screen( format = "PNG", file_name = nil, draw = false )
+
+				ret = nil
+
+				begin
+
+					# convert string representation of draw value to boolean
+					draw = ( draw.downcase == 'true' ? true : false ) if draw.kind_of?( String )
+
+					# verify that image format is type of string
+					Kernel::raise ArgumentError.new( "Unexpected argument type (%s) for image format, expected %s" % [ format.class, "String" ] ) unless format.kind_of?( String )
+
+					# verify that filename is type of string
+					Kernel::raise ArgumentError.new( "Unexpected argument type (%s) for filename, expected %s" % [ file_name.class, "String" ] ) unless file_name.nil? || file_name.kind_of?( String )
+
+					# verify that draw flag is type of boolean
+					Kernel::raise ArgumentError.new( "Unexpected argument type (%s) for draw flag, expected %s" % [ draw.class, "boolean (TrueClass or FalseClass)" ] ) unless [ TrueClass, FalseClass ].include?( draw.class )
+
+					command = command_params #in qt_behaviour
+					command.command_name( 'Screenshot' )
+					command.command_params( 'format'=>format, 'draw' => draw.to_s )
+					command.set_require_response( true )
+					command.transitions_off
+					command.service( 'screenShot' )
+
+					image_binary = @sut.execute_command( command )
+
+					File.open(file_name, 'wb:binary'){ | image_file | image_file << image_binary } if ( file_name )
+
+				rescue Exception => e
+
+					#MobyUtil::Logger.instance.log "behaviour" , "FAIL;Failed capture_screen with format \"#{format}\", file_name \"#{file_name}\".;#{ identity };capture_screen;"
+
+					MobyUtil::Logger.instance.log "behaviour" , "FAIL;Failed capture_screen with format \"%s\", file_name \"%s\".;%s;capture_screen;" % [ format, file_name, identity ]
+
+					Kernel::raise e
+
+				end
+
+				#MobyUtil::Logger.instance.log "behaviour" , "PASS;Operation capture_screen executed successfully with format \"#{format}\", file_name \"#{file_name}\".;#{ identity };capture_screen;"
+				MobyUtil::Logger.instance.log "behaviour" , "PASS;Operation capture_screen executed successfully with format \"%s\", file_name \"%s\".;%s;capture_screen;" % [ format, file_name, identity ]
+
+				image_binary
+
+			end
+
+
+      # == description
+			# Searches the SUT screen for the given image and returns top left coordinates if a match is found. Alternatively the search can be limited to only parts of the display by calling this method for a widget.
+			#
+			# == arguments
+			# image_or_path
+      #  String
+      #   description: Path to image being searched for. Must not be empty.
+      #   example: 'image_data/icon_help.png'
+      #  Magick::Image
+      #   description: RMagick Image object to be searched for. You must 'require RMagick' in your script prior to using this.
+      #   example: Magick::Image.read('image_data/icon_help.png').first
+      #  Magick::ImageList
+      #   description: RMagick ImageList object where the current image is the one to be searched for. You must 'require RMagick' in your script prior to using this.
+      #   example: Magick::ImageList.new('image_data/icon_help.png')
+      #
+			# tolerance
+      #  Integer
+      #  description: Integer defining the maximum percentage difference in RGB value when compared to maximum values where two pixels are still considered to be equal.
+      #  example: 20
+      #  default: 0
+			# == returns
+			# Array
+      #  description: Array containing x and y coordinates as Integers, or nil if the image cannot be found on the screen.
+      #  example: [24,50]
+      # Nil
+      #  description: The image could not be found
+      #  example: -
+      #  
+			# == exceptions
+			# ArgumentError
+      #  description: image_or_path was not of one of the allowed image types or a non empty String, or tolerance was not an Integer in the [0,100] range.
+      # RuntimeError
+      #  description: No image could be loaded from the path given in image_or_path
+      #
+			def find_on_screen( image_or_path, tolerance = 0 )
+
+			# RuntimeError:: No image could be loaded from the path given in image_or_path
+				begin
+
+					require 'RMagick'
+
+					Kernel::raise ArgumentError.new("The tolerance argument was not an Integer in the [0,100] range.") unless tolerance.kind_of? Integer and tolerance >= 0 and tolerance <= 100
+
+					target = nil
+
+					if image_or_path.kind_of? Magick::Image
+
+						target = image_or_path
+
+					elsif image_or_path.kind_of? Magick::ImageList
+
+						Kernel::raise ArgumentError.new("The supplied ImageList argument did not contain any images.") unless image_or_path.length > 0
+						target = image_or_path
+
+					elsif image_or_path.kind_of? String and !image_or_path.empty?
+
+						begin
+							target = Magick::ImageList.new(image_or_path)
+						rescue        
+							Kernel::raise RuntimeError.new("Could not load target for image comparison from path: \"#{image_or_path.to_s}\".")
+						end
+
+					else
+						Kernel::raise ArgumentError.new("The image_or_path argument was not of one of the allowed image types or a non empty String.")
+					end
+
+					begin      
+						screen = Magick::Image.from_blob(capture_screen){ self.format = "PNG" }.first
+						screen.fuzz = tolerance.to_s + "%"
+					rescue
+						Kernel::raise RuntimeError.new("Failed to capture SUT screen for comparison. Details:\n" << $!.message)  
+					end
+
+					result = screen.find_similar_region( target )
+
+				rescue Exception => e
+
+					MobyUtil::Logger.instance.log "behaviour", 
+						"FAIL;Failed when searching for image on the screen.;#{ identity };find_on_screen;#{(image_or_path.respond_to?(:filename) ? image_or_path.filename : image_or_path.to_s)},#{tolerance.to_s}"  
+
+					Kernel::raise e
+
+				end
+
+				MobyUtil::Logger.instance.log "behaviour", 
+					"PASS;Image search completed successfully.;#{ identity };find_on_screen;#{(image_or_path.respond_to?(:filename) ? image_or_path.filename : image_or_path.to_s)},#{tolerance.to_s}"
+
+				result
+
+			end
+
+      # == description
+			# Verifies if the given image is found on the device screen. Alternatively the verification can be limited to only parts of the display by calling this method for a widget.
+			#
+			# == arguments
+			# image_or_path
+      #  String
+      #   description: Path to image being searched for. Must not be empty.
+      #   example: 'image_data/icon_help.png'
+      #  Magick::Image
+      #   description: RMagick Image object to be searched for. You must 'require RMagick' in your script prior to using this.
+      #   example: Magick::Image.read('image_data/icon_help.png').first
+      #  Magick::ImageList
+      #   description: RMagick ImageList object where the current image is the one to be searched for. You must 'require RMagick' in your script prior to using this.
+      #   example: Magick::ImageList.new('image_data/icon_help.png')
+      #
+			# tolerance
+      #  Integer
+      #  description: Integer defining the maximum percentage difference in RGB value when compared to maximum values where two pixels are still considered to be equal.
+      #  example: 20
+      #  default: 0
+      #
+			# == returns
+			# Boolean
+      #  description: true if the given image is found on the device screen.
+      #  description: false if the image was not found on the screen.
+      #  example: true
+      #
+			# == exceptions
+			# ArgumentError
+      #  description: image_or_path was not of one of the allowed image types or a non empty String, or tolerance was not an Integer in the [0,100] range.
+			# RuntimeError
+      #  description: No image could be loaded from the path given in image_or_path
+			def screen_contains?( image_or_path, tolerance = 0 )
+
+				begin
+					# find_on_screen returns nil if the image is not found on the device screen
+					result = !find_on_screen(image_or_path, tolerance).nil?
+				rescue Exception => exc
+
+					MobyUtil::Logger.instance.log "behaviour", 
+						"FAIL;Failed when searching for image on the screen.;#{ identity };screen_contains?;#{(image_or_path.respond_to?(:filename) ? image_or_path.filename : image_or_path.to_s)},#{tolerance.to_s}"
+
+					Kernel::raise exc
+
+
+				end      
+
+				MobyUtil::Logger.instance.log "behaviour", 
+					"PASS;Image search completed successfully.;#{ identity };screen_contains?;#{(image_or_path.respond_to?(:filename) ? image_or_path.filename : image_or_path.to_s)},#{tolerance.to_s}"
+
+				result
+
+			end
+
+			# enable hooking for performance measurement & debug logging
+			MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+
+		end
+
+	end
+end