testability-driver-qt-sut-plugin 0.9.2

data/env.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 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. 
+## 
+############################################################################
+
+
+
+PLUGIN_NAME = "Testability Driver Qt SUT plugin"
+GEM_NAME = 'testability-driver-qt-sut-plugin'
+GEM_SUMMARY = 'Testability Driver - Testability Driver Interface Qt SUT plugin'
+PLUGIN_VERSION = "0.8.4"
+

data/installer/extconf.rb

@@ -0,0 +1,62 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+
+
+require 'rubygems'
+
+begin
+
+	require 'tdriver/util/common'
+
+rescue LoadError => exception
+
+	Kernel::raise LoadError.new( "SUT plugin requires TDriver" )
+
+end
+
+MobyUtil::GemHelper.install( MobyUtil::FileHelper.tdriver_home ){ | tdriver_home_folder |
+
+	[ 
+
+		# default parameters & sut configuration
+		[ "../xml/defaults/*.xml",  "defaults/", true ],
+
+		# parameters
+		[ '../xml/behaviour/*.xml', "behaviours/", true ],
+		[ '../xml/behaviour/*.xml', "default/behaviours/", true ],
+
+		# templates
+		[ "../xml/template/*.xml",  "templates/", true ],
+		[ "../xml/template/*.xml",  "default/templates/", true ],
+
+		# behaviours
+		[ "../xml/keymap/*.xml",  "keymaps/", true ],
+		[ "../xml/keymap/*.xml",  "default/keymaps/", true ]
+
+		].each { | task |
+
+			source, destination, overwrite = task
+
+			MobyUtil::FileHelper.copy_file( source, "#{ tdriver_home_folder }/#{ destination }", false, overwrite, true )
+
+	}
+
+}
+

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

@@ -0,0 +1,23 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+
+
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'testability-driver-qt-sut-plugin/plugin.rb' ) )
+

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

@@ -0,0 +1,156 @@
+############################################################################
+## 
+## 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
+		# This module contains behaviours specific to actions
+		#
+		# == behaviour
+		# QtAction
+		#
+		# == requires
+		# testability-driver-qt-sut-plugin
+		#
+		# == input_type
+		# touch
+		#
+		# == sut_type
+		# qt
+		#
+		# == sut_version
+		# *
+		#
+		# == objects
+		# QAction
+		#
+		module Action
+
+			include MobyBehaviour::QT::Behaviour
+
+			# == description
+			# Hover over an action inside a visible widget.\n
+			# \n
+			# Hover is done by determining action's coordinates inside parent widget and moving mouse cursor there.
+			# Therefore, the parent object in script must be a visible widget containing that action.
+			# For example, a menu must be opened first, before actions inside the menu can be hovered.\n
+                        # \n
+			# [b]NOTE:[/b] Moving mouse cursor over action's position may not do anything,
+			# unless test application window is topmost, or at least not obscured by other windows.
+			# This can be a problem especially when testing desktop applications on Windows 7.\n
+			# \n
+			# [b]IMPORTANT:[/b] In future this method may be changed to call hover slot of QAction instead of using mouse, 
+			# or deprecated and replace by a new method of different name better describing that this uses mouse.
+			#
+			# == arguments
+			# refresh
+			#  Boolean
+			#   description: Determine is refresh done after trigger command
+			#   example: true
+			#   default: false
+			#
+			# == returns
+			# NilClass
+			#   description: -
+			#   example: -
+			#
+			# == exceptions
+			# Exception
+			#   description: No special exceptions, may throw any exception
+			def hover( refresh = false )
+				begin
+
+					command = command_params #in qt_behaviour
+					command.object_type( :Action )
+					command.command_name( 'Hover' )
+					command.object_id( @parent.id )
+					command.command_params( 'id' => id )
+					@sut.execute_command( command )
+					self.force_refresh({:id => get_application_id}) if refresh
+
+				rescue Exception => e
+
+					MobyUtil::Logger.instance.log "behaviour" , "FAIL;Failed hover with refresh \"#{ refresh.to_s }\".;#{ identity };hover;"
+					Kernel::raise e
+
+				end
+
+				MobyUtil::Logger.instance.log "behaviour" , "PASS;Hover operation executed successfully with refresh \"#{ refresh.to_s }\".;#{ identity };hover;"
+				nil
+			end
+
+			# == description
+			# Activate action inside a visible widget.\n
+			# \n
+			# Trigger is done by determining action's coordinates inside parent widget, performing mouse press down and up there.
+			# Therefore, the parent object in script must be a visible widget containing that action.
+			# For example, a menu must be opened first, before actions inside the menu can be triggered.\n
+			# \n
+			# [b]IMPORTANT:[/b] In future this method may be changed to call trigger slot of QAction instead of using mouse,
+			# or deprecated and replace by a differently named method better describing that this uses mouse.
+			#
+			# == arguments
+			# refresh
+			#  Boolean
+			#   description: Determine is refresh done after trigger command
+			#   example: true
+			#   default: false
+			#
+			# == returns
+			# NilClass
+			#   description: -
+			#   example: -
+			# 
+			# == exceptions
+			# Exception
+			#   description: No special exceptions, may throw any exception
+			def trigger( refresh = false )
+
+				begin
+					command = command_params #in qt_behaviour
+					command.object_type( :Action )
+					command.command_name( 'Trigger' )
+					command.object_id( @parent.id )
+					command.command_params( 'id'=>id )
+
+					@sut.execute_command( command )
+					self.force_refresh({:id => get_application_id}) if refresh
+
+				rescue Exception => e
+
+					MobyUtil::Logger.instance.log "behaviour" , "FAIL;Failed trigger with refresh \"#{ refresh.to_s }\".;#{ identity };trigger;"
+					Kernel::raise e
+
+				end
+
+				MobyUtil::Logger.instance.log "behaviour" , "PASS;Trigger operation executed successfully with refresh \"#{ refresh.to_s }\".;#{ identity };trigger;"
+				nil
+			end
+
+			# enable hooking for performance measurement & debug logging
+			MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+
+		end # Action
+
+	end # QT
+
+end # MobyBehaviour

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

@@ -0,0 +1,318 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+include TDriverVerify
+
+module MobyBehaviour
+
+  module QT
+
+    # == description
+    # Application specific behaviours
+    #
+    # == behaviour
+    # QtApplication
+    #
+    # == requires
+    # testability-driver-qt-sut-plugin
+    #
+    # == input_type
+    # touch
+    #
+    # == sut_type
+    # qt
+    #
+    # == sut_version
+    # *
+    #
+    # == objects
+    # Application
+    #
+	  module Application
+
+	    # == description
+	    # Drag from the start coordinates to the end coordinates.
+	    # 
+      # == arguments
+	    # start_x
+	    #  Integer
+	    #   description: Starting x coordinate
+	    #   example: 10
+	    #
+      # == arguments
+	    # start_y
+	    #  Integer
+	    #   description: Starting y coordinate
+	    #   example: 10
+	    #
+      # == arguments
+	    # end_x
+	    #  Integer
+	    #   description: End x coordinate
+	    #   example: 30
+	    #
+      # == arguments
+	    # end_y
+	    #  Integer
+	    #   description: End y coordinate
+	    #   example: 100
+	    #
+	    # duration
+	    #  Integer
+	    #   description: How long will the drag take in millis
+	    #   example: 1000
+	    #
+	    # == returns
+	    # NilClass
+	    #   description: -
+	    #   example: -
+	    #	  
+	    def drag( start_x, start_y, end_x, end_y, duration = 1000 )
+
+		    @sut.execute_command( MobyCommand::Drag.new( start_x, start_y, end_x, end_y, duration ) )
+
+	    end
+
+	    # == description
+	    # Kills the application process
+	    # 
+	    # == returns
+	    # NilClass
+	    #   description: -
+	    #   example: -
+	    #
+	    def kill
+
+		    @sut.execute_command( MobyCommand::Application.new( :Kill, self.executable_name, self.uid, self.sut, nil ) )
+
+	    end
+
+	    # == description
+	    # Start to track a popup that may appear on the screen. Tracking is done based on the class name of the 
+	    # widget implementing popup functionality. Base class name can also be used in case framework level 
+	    # popup base class is available. The idea of the detection is to track info notes that appear 
+	    # on the screen for a moment and are therefore difficult to verify manually.
+	    # 
+      # == arguments
+	    # class_name
+	    #  String
+	    #   description: Name of the popup implementation class. Base class name can also be used.
+	    #   example: PopupClass
+	    #
+	    # wait_time
+	    #  Integer
+	    #   description: How long to wait for the popup to appear
+	    #   example: 5
+	    #
+	    # == returns
+	    # NilClass
+	    #   description: -
+	    #   example: -
+	    #
+	    def track_popup(class_name, wait_time=1)
+		    wait_time = wait_time*1000
+		    fixture('popup', 'waitPopup',{:className => class_name, :interval => wait_time.to_s})
+	    end
+
+	    # == description
+	    # Verify was the popup on the screen or not. The method uses matti verify internally for the verification. 
+	    # If the popup was shown then the entire application ui state is returned as a test object. 
+	    # More detailed verification can be done for the object (e.g. the content of the popup, labels etc...).
+	    # \n
+	    # Note: If the popup does not close the verification will fail. Detection is based on grabbing the ui state just before the popup closes.
+	    # 
+      # == arguments
+	    # class_name
+	    #  String
+	    #   description: Name of the popup implementation class. Base class name can also be used.
+	    #   example: PopupClass
+	    #
+	    # time_out
+	    #  Integer
+	    #   description: Time in seconds for how long to wait for the popup data.
+	    #   example: 5
+	    #
+	    # == returns
+	    # TestObject
+	    #   description: An ui state test object from the time the popup was detected. Can be used the same way as other test objects.
+	    #   example: -
+	    #
+	    #
+	    def verify_popup(class_name, time_out = 5)
+		  xml_source = nil
+		  verify(time_out) {xml_source = @sut.application.fixture('popup', 'printPopup',{:className => class_name})}  
+		  MobyBase::StateObject.new( xml_source )			  
+	    end
+	    
+	    # == description
+	    # Bring the application to foreground. Note! Currently this works only for Symbian OS target!
+	    # 
+	    # == returns
+	    # NilClass
+	    #   description: -
+	    #   example: -
+	    #
+	    #
+	    def bring_to_foreground
+		  @sut.execute_command(MobyCommand::Application.new(:BringToForeground, nil, self.uid, self.sut))
+        end
+
+	    # == description
+	    # Taps the given objects at the same time (multitouch).
+	    # 
+      # == arguments
+	    # objects
+	    #  Array
+	    #   description: Array of objects to tap.
+	    #   example: [@app.Square( :name => 'topLeft' ), @app.Square( :name => 'topRight' )]
+	    #
+	    # == returns
+	    # NilClass
+	    #   description: -
+	    #   example: -
+	    #
+	    # == exceptions
+      # ArgumentError
+      #  description: objects is not an array
+      #    
+	    def tap_objects(objects)
+
+		    raise ArgumentError.new("Nothing to tap") unless objects.kind_of?(Array)
+
+		    multitouch_operation{
+		      objects.each { |o| o.tap }
+		    }
+		
+	    end
+
+	    # == description
+	    # Taps down the given objects at the same time (multitouch).
+	    # 
+      # == arguments
+	    # objects
+	    #  Array
+	    #   description: Array of objects to tap down.
+	    #   example: [@app.Square( :name => 'topLeft' ), @app.Square( :name => 'topRight' )]
+	    #
+	    # == returns
+	    # NilClass
+	    #   description: -
+	    #   example: -
+	    #
+	    # == exceptions
+      # ArgumentError
+      #  description: objects is not an array
+      #    
+	    def tap_down_objects(objects)
+
+		    raise ArgumentError.new("Nothing to tap") unless objects.kind_of?(Array)
+
+		    multitouch_operation{
+		      objects.each { |o| o.tap_down }
+		    }
+		
+	    end
+
+
+	    # == description
+	    # Taps up the given objects at the same time (multitouch).
+	    # 
+      # == arguments
+	    # objects
+	    #  Array
+	    #   description: Array of objects to tap up.
+	    #   example: [@app.Square( :name => 'topLeft' ), @app.Square( :name => 'topRight' )]
+	    #
+	    # == returns
+	    # NilClass
+	    #   description: -
+	    #   example: -
+	    #
+	    # == exceptions
+      # ArgumentError
+      #  description: objects is not an array
+      #    
+	    def tap_up_objects(objects)
+
+		    raise ArgumentError.new("Nothing to tap") unless objects.kind_of?(Array)
+
+		    multitouch_operation{
+		      objects.each { |o| o.tap_up }
+		    }
+		
+	    end
+
+	    # == description
+	    # Performs the given operations at the same time (when possible). 
+	    # Note that only ui behaviours can be used here (e.g. taps, gestures).
+	    # 
+      # == arguments
+	    # &block
+	    #  Proc
+	    #   description: code block containing the operations to perform.
+	    #   example: {@app.ScribbleArea.tap_object(400,50)
+	    #             @app.ScribbleArea.gesture(:Right, 1, 50)}
+	    # == returns
+	    # NilClass
+	    #   description: -
+	    #   example: -
+	    #
+	    #
+ 	    def multi_touch(&block)
+
+	  	  multitouch_operation(&block)
+
+	    end
+
+	    private
+	    
+	    def multitouch_operation(&block)
+
+		    #make sure the situation is ok before freeze
+		    self.force_refresh
+
+		    @sut.freeze
+		
+		    #disable sleep to avoid unnecessary sleeping
+		    MobyUtil::Parameter[ @sut.id ][ :sleep_disabled] = 'true'
+
+		    command = MobyCommand::Group.new(0, self, block )
+		    command.set_multitouch(true)
+		    ret = @sut.execute_command( command )
+		
+		    MobyUtil::Parameter[ @sut.id ][ :sleep_disabled] = 'false'
+
+		    #sleep the biggest stored value
+		    sleep MobyUtil::Parameter[ @sut.id ][ :skipped_sleep_time, 0 ] if MobyUtil::Parameter[ @sut.id ][ :skipped_sleep_time, 0 ] > 0
+		
+		    #reset to 0
+		    MobyUtil::Parameter[ @sut.id ][ :skipped_sleep_time] = 0
+
+		    @sut.unfreeze
+		
+      end
+	      
+      # enable hooking for performance measurement & debug logging
+      MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+	  end # Application
+
+  end # QT
+
+end # MobyBehaviour