testability-driver-qt-sut-plugin 0.9.2

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

@@ -0,0 +1,227 @@
+############################################################################
+## 
+## 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
+    # Behaviours for handling attributes
+    #
+    # == behaviour
+    # QtAttribute
+    #
+    # == requires
+    # testability-driver-qt-sut-plugin
+    #
+    # == input_type
+    # *
+    #
+    # == sut_type
+    # qt
+    #
+    # == sut_version
+    # *
+    #
+    # == objects
+    # *
+    #
+		module Attribute
+
+			include MobyBehaviour::QT::Behaviour
+
+			# == description
+      # Sets an attribute of the target object.
+      #
+      # == arguments
+      # attribute
+      #  String
+      #   description: Name of the attribute to be set
+      #   example: "text"
+      #
+      # value
+      #  String
+      #   description: New value of the attribute.
+      #   example: "Menu"
+      #
+      #  Integer
+      #   description: New value of the attribute.
+      #   example: 200
+      #
+      #  Boolean
+      #   description: New value of the attribute.
+      #   example: true
+      #
+      # type
+      #  String
+      #   description: Type of the value. If this argument is not given, the type will be detected based on the class of the value argument. 
+      #   example: "QPoint"
+      #   default: nil
+      #
+      # == tables
+	    # attribute_types_table
+	    #  title: Valid type argument values
+      #  |Type|Example|
+      #  |QRect|'10,10,150,150'|
+      #  |QPoint|'100,200'|
+      #  |QSize|'50,80'|
+      #  |QDate|'15.08.2009'|
+      #  |QDateTime|'1373352400'|
+      #
+      # == returns
+      # NilClass
+      #  description: Always returns nil
+      #  example: nil
+      #
+      # == exceptions
+      # ArgumentError
+      #  description: One of the arguments is not valid   
+      # RuntimeError
+      #  description: Setting of the attribute failed
+			def set_attribute(attribute, value, type = nil)
+
+				Kernel::raise ArgumentError.new( "Attribute-name was empty" ) if attribute.empty?
+				Kernel::raise ArgumentError.new( "Argument type must be nil or a non empty String." ) unless type.nil? || ( type.kind_of?( String ) && !type.empty? )
+
+				command = command_params #in qt_behaviour 
+				command.transitions_off 
+				command.command_name( 'SetAttribute' )
+
+				case type
+
+					when nil
+
+						# Implicit typing
+
+						# by class
+						if value.kind_of? Integer
+							params = { 'attribute_name' => attribute.to_s, 'attribute_value' => value.to_s.strip, 'attribute_type' => 'int'} 
+
+						elsif value.kind_of? Date
+							temp_date = value.day.to_s << '.' << value.month.to_s << '.' << value.year.to_s
+							params = { 'attribute_name' => attribute.to_s, 'attribute_value' => temp_date, 'attribute_type' => 'QDate' }
+
+						elsif value.kind_of? Time
+							params = { 'attribute_name' => attribute.to_s, 'attribute_value' => value.to_i.to_s, 'attribute_type' => 'QDateTime' }
+
+						elsif value.kind_of? DateTime
+							params = { 'attribute_name' => attribute.to_s, 'attribute_value' => Time.parse(value.to_s).to_i.to_s, 'attribute_type' => 'QDateTime' }
+
+						elsif value.kind_of? TrueClass
+							params = { 'attribute_name' => attribute.to_s, 'attribute_value' => value.to_s.downcase, 'attribute_type' => 'bool'}
+
+						elsif value.kind_of? FalseClass
+							params = { 'attribute_name' => attribute.to_s, 'attribute_value' => value.to_s.downcase, 'attribute_type' => 'bool'}
+
+						else
+							# by format
+							# if ( value.kind_of?( Integer ) || ( value.kind_of?( String ) && value.strip == value.strip.to_i.to_s ) )
+							if value.kind_of?( String ) && value.strip == value.strip.to_i.to_s
+								params = { 'attribute_name' => attribute.to_s, 'attribute_value' => value.to_s.strip, 'attribute_type' => 'int'}
+
+							elsif (value == true || value == false || (value.kind_of?(String) && (value.strip.downcase == "true" || value.strip.downcase == "false")))
+								params = { 'attribute_name' => attribute.to_s, 'attribute_value' => value.to_s.downcase, 'attribute_type' => 'bool'}
+
+							else
+								params = { 'attribute_name' => attribute.to_s, 'attribute_value' => value.to_s, 'attribute_type' => 'string'}
+
+							end 
+
+						end
+
+					when "QRect"
+						params = { 'attribute_name' => attribute.to_s, 'attribute_value' => value.to_s, 'attribute_type' => 'QRect'}
+
+					when "QPoint"
+						params = { 'attribute_name' => attribute.to_s, 'attribute_value' => value.to_s, 'attribute_type' => 'QPoint'} 
+
+					when "QSize"
+						params = { 'attribute_name' => attribute.to_s, 'attribute_value' => value.to_s, 'attribute_type' => 'QSize'}
+
+					when "QDateTime"
+
+						params = { 'attribute_name' => attribute.to_s, 'attribute_type' => 'QDateTime' }
+
+						if value.kind_of? String
+							params[ 'attribute_value' ] = value.to_s
+
+						elsif value.kind_of? Integer
+							params[ 'attribute_value' ] = value.to_s
+
+						elsif value.kind_of? Time 
+							params[ 'attribute_value' ] = value.to_i.to_s
+
+						elsif value.kind_of? DateTime 
+							params[ 'attribute_value' ] = Time.parse( value.to_s ).to_i.to_s
+
+						else
+							Kernel::raise ArgumentError.new( "The value for QDateTime type attributes must be of type String, Integer, Time or DateTime, it was #{value.class.to_s}." )
+
+						end 
+
+					when "QDate"
+
+						params = { 'attribute_name' => attribute.to_s, 'attribute_type' => 'QDate' }
+
+						if value.kind_of? String
+							params[ 'attribute_value' ] = value.to_s
+
+						elsif value.kind_of? Date
+							temp_date = value.day.to_s << '.' << value.month.to_s << '.' << value.year.to_s
+							params[ 'attribute_value' ] = temp_date
+
+						else
+							Kernel::raise ArgumentError.new( "The value for QDate type attributes must be of type String or Date, it was #{value.class.to_s}." )
+
+						end
+
+				else
+
+					#puts "Unidentified.\nName: " << attribute.to_s << "\nValue: " << value.to_s << "\nType: " << type.to_s
+					params = { 'attribute_name' => attribute.to_s, 'attribute_value' => value.to_s, 'attribute_type' => type.to_s }
+
+				end 
+
+				command.command_params( params )
+				command.service( 'objectManipulation' )
+				returnValue = @sut.execute_command( command )
+			  
+   			    returnValue = "OK"
+			    begin 
+				  returnValue = @sut.execute_command( command )
+				rescue
+				  MobyUtil::Logger.instance.log "behaviour" , "FAIL;Failed when calling method set_attribute with values attribute:#{attribute.to_s} value:#{value.to_s}.;#{identity};set_attribute;"
+				  Kernel::raise RuntimeError.new("Setting attribute '%s' to value '%s' failed with error: %s" % [attribute, value, returnValue])
+				end
+			  
+			    MobyUtil::Logger.instance.log "behaviour" , "PASS;The method set_attribute was executed successfully with with values attribute:#{attribute.to_s} value:#{value.to_s}.;#{identity};set_attribute;"
+	  
+			    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/behaviour.rb

@@ -0,0 +1,140 @@
+############################################################################
+## 
+## 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
+    # Base behaviour 
+    #
+    # == behaviour
+    # QtBehaviour
+    #
+    # == requires
+    #  sut_qt
+    #
+    # == sut_type
+    # qt
+    #
+    # == input_type
+    # All
+    #
+    # == sut_version
+    # *
+    #
+    # == objects
+    # sut;application
+    #
+    module Behaviour
+
+      include MobyBehaviour::Behaviour
+
+      @@_valid_buttons = [ :NoButton, :Left, :Right, :Middle ]
+      @@_buttons_map = { :NoButton => '0', :Left => '1', :Right => '2', :Middle => '4' }
+      @@_valid_directions = [ :Up, :Down, :Left, :Right ]
+      @@_direction_map = { :Up => '0', :Down => '180', :Left => '270', :Right => '90' }
+      @@_pinch_directions = { :Horizontal => '90', :Vertical => '0'}
+      @@_rotate_direction = [ :Clockwise, :CounterClockwise ]
+
+      # == nodoc
+      # should this method be private?
+      def command_params( command = MobyCommand::WidgetCommand.new )   
+
+        if self.attribute( 'objectType' ) == 'Graphics' and self.attribute( 'visibleOnScreen' ) == 'false' and self.creation_attributes[:visibleOnScreen] != 'false'
+          begin
+            self.creation_attributes.merge!({'visibleOnScreen' => 'true'})
+            self.parent.child(self.creation_attributes)
+          rescue
+            Kernel::raise MobyBase::TestObjectNotVisibleError
+          end
+        end
+
+        command.set_event_type(MobyUtil::Parameter[ @sut.id ][ :event_type, "0" ])
+
+        #for components with object visible on screen but not actual widgets or graphicsitems
+        if self.attribute( 'objectType' ) == 'Embedded'
+          command.application_id( get_application_id )
+          command.object_id( parent.id )
+          command.object_type( parent.attribute( 'objectType' ).intern )
+        else
+          command.application_id( get_application_id )
+          command.object_id( self.id )
+          command.object_type( self.attribute( 'objectType' ).intern )
+        end
+
+        command
+
+      end
+
+      # == nodoc
+      # should this method be private?
+      def plugin_command( require_response = false, command = MobyCommand::WidgetCommand.new )
+        command.set_event_type(MobyUtil::Parameter[ @sut.id ][ :event_type, "0" ])
+        command.application_id( get_application_id )
+        command.object_id( self.id )
+        command.object_type( self.attribute('objectType' ).intern)
+        command.transitions_off    
+        command
+      end
+
+    private   
+
+      def do_sleep(time)
+
+        time = time.to_f
+        time = time * 1.3
+        #for flicks the duration of the gesture is short but animation (scroll etc..) may not
+        #so wait at least one second
+        time = 1 if time < 1  
+        sleep time
+
+      end
+
+      def center_x
+
+        #x = self.attribute( 'x_absolute' ).to_i
+        #width = self.attribute( 'width' ).to_i
+        #x = x + ( width/2 )
+        #x.to_s
+
+        ( ( self.attribute( 'x_absolute' ).to_i ) + ( self.attribute( 'width' ).to_i / 2 ) ).to_s
+
+      end
+
+      def center_y
+
+        #y = self.attribute( 'y_absolute' ).to_i
+        #height = self.attribute( 'height' ).to_i
+        #y = y + ( height/2 )
+        #y.to_s
+
+        ( ( self.attribute( 'y_absolute' ).to_i ) + ( self.attribute( 'height' ).to_i / 2 ) ).to_s
+
+      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/configure_behaviour.rb

@@ -0,0 +1,317 @@
+############################################################################
+## 
+## 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
+    # Behaviours for configuring the logging services on the target.
+    #
+    # == behaviour
+    # QtConfigureBehaviour
+    #
+    # == requires
+    # testability-driver-qt-sut-plugin
+    #
+    # == sut_type
+    # qt
+    #
+    # == input_type
+    # All
+    #
+    # == sut_version
+    # *
+    #
+    # == objects
+    # sut;application
+    #
+	  module ConfigureBehaviour
+
+	    include MobyBehaviour::QT::Behaviour
+
+	    @@_valid_levels = [ :FATAL, :ERROR, :INFO, :WARNING, :DEBUG ]
+
+      # == description
+      # Enabled the logging on the target for the given application or sut (qttasserver). 
+      # Logs are written to the target in (\logs\testability)
+      #
+      # == returns
+      # NilClass
+      #   description: -
+      #   example: -
+      #
+      # == exceptions
+      # ArgumentError
+      #  description:  In case the given parameters are not valid.
+	    def enable_logger
+  		  configure_logger( {:logEnabled => true} )
+	    end
+
+      # == description
+      # Disable the logging on the target for the given application or sut (qttasserver). 
+      # Logs are left as they are.
+      #
+      # == returns
+      # NilClass
+      #   description: -
+      #   example: -
+      #
+      # == exceptions
+      # ArgumentError
+      #  description:  In case the given parameters are not valid.
+	    def disable_logger		
+  		  configure_logger( {:logEnabled => false} )
+	    end
+
+      # == description
+      # Set the log level for the application or sut (qttasserver). Affects only the running process. 
+      # Will not be stored as permanent setting.
+      #
+      # == arguments
+      # level
+      #  Symbol 
+      #   description:
+      #    The log level.
+      #    See [link="#log_levels_table"]Valid log levels table[/link] for valid keys. 
+      #    example: :INFO
+      #
+      # == tables
+      # log_levels_table
+      #  title: Valid log levels
+      #  |Level|Type|Description|
+      #  |:FATAL|Symbol|Log fatal level message|
+      #  |:ERROR|Symbol|Log fatal and error level messages|
+      #  |:INFO|Symbol|Log fatal, error and info level messages|
+      #  |:WARNING|Symbol|Log fatal, error, info and warning level messages|
+      #  |:DEBUG|Symbol|Log all messages|
+      #
+      # == returns
+      # NilClass
+      #   description: -
+      #   example: -
+      #
+      # == exceptions
+      # ArgumentError
+      #  description:  In case the given level is not valid.
+	    def set_log_level(level)
+  		  configure_logger( {:logLevel => level} )
+	    end
+	    
+      # == description
+      # Change the folder to where the logs are written to for the application or sut (qttasserver).
+      #
+      # == arguments
+      # folder
+      #  String 
+      #   description:
+      #    New location for the logs.
+      #    example: '/tmp/logs'
+      #
+      # == returns
+      # NilClass
+      #   description: -
+      #   example: -
+	    def set_log_folder(folder)
+  		  configure_logger( {:logFolder => folder} )
+	    end
+
+      # == description
+      # Can be used to set logging to be done to qDebug. All tdriver target logging
+      # will go to qDebug not the log file.
+      #
+      # == arguments
+      # to_qdebug
+      #  boolean
+      #   description:
+      #    True to logs message to qDebug instead of a file.	  
+      #    example: true
+      #
+      # == returns
+      # NilClass
+      #   description: -
+      #   example: -
+	    def log_to_qdebug(to_qdebug = true)
+  		  configure_logger( {:logToQDebug => to_qdebug} )
+	    end
+
+      # == description
+      # Set the qDebug message to be append to the logs or not.
+      # By default qDebug messages are not written to the logs.
+      #
+      # == arguments
+      # include
+      #  boolean
+      #   description:
+      #    True to log qDebug messages and false to not
+      #    example: true
+      #
+      # == returns
+      # NilClass
+      #   description: -
+      #   example: -
+	    def log_qdebug(include = true)
+  		  configure_logger( {:logQDebug => include} )
+	    end
+
+      # == description
+      # Set max size for the log file. When the level is reached the log file is renamed
+      # as old_"name of log file".log and a new file is started. By default the size is 
+      # 100000.
+      #
+      # == arguments
+      # size
+      #  integer
+      #   description:
+      #    The new log file size
+      #    example: 500000
+      #
+      # == returns
+      # NilClass
+      #   description: -
+      #   example: -
+	    def set_log_size(size)
+  		  configure_logger( {:logSize => size} )
+	    end
+
+      # == description
+      # Clears the log file.	  
+      #
+      # == returns
+      # NilClass
+      #   description: -
+      #   example: -
+	    def clear_log
+  		  configure_logger( {:clearLog => true} )
+	    end
+
+      # == description
+      # Set the logger to log listed events. Events have to be separated by comma.
+      # e.g MouseEvent, Paint
+      # The event name does not have to be complete. e.g Mouse will log all events with the
+      # word Mouse.
+      # 
+      # == arguments
+      # event_list
+      #  String
+      #   description:
+      #    Comma separated list of events
+      #    example: 'Mouse','Touch'
+      #
+      # == returns
+      # NilClass
+      #   description: -
+      #   example: -
+      #	  
+	    def log_events( event_list = '')
+		    begin 
+
+		      params = {:logEvents => 'true'}
+		      perform_command( MobyCommand::ConfigureCommand.new( "configureEventLogging", params, event_list ) )		
+
+		    rescue Exception => e
+		      
+		      MobyUtil::Logger.instance.log "behaviour" , "FAIL;Failed to enable event logging. With event_list \"#{event_list};log_events"
+		      Kernel::raise e        
+
+		    end      
+
+		    MobyUtil::Logger.instance.log "behaviour" , "PASS;Event logging enabled. With event_list \"#{event_list};log_events"
+
+	    end
+
+      # == description
+      # Stop logging events.
+      #
+      # == returns
+      # NilClass
+      #   description: -
+      #   example: -
+      #	  
+	    def stop_event_logging
+		    begin
+
+		      params = {:logEvents => 'false'}
+		      perform_command( MobyCommand::ConfigureCommand.new( "configureEventLogging", params) )		
+
+		    rescue Exception => e
+		      
+		      MobyUtil::Logger.instance.log "behaviour" , "FAIL;Failed to stop event logging.;stop_event_logging"
+		      Kernel::raise e        
+
+		    end      
+
+		    MobyUtil::Logger.instance.log "behaviour" , "PASS;Event logging stopped.;stop_event_logging"
+
+	    end
+
+    private
+	    
+	    # Configure the logger for qttasserver and plugins
+	    # Parameters are to be passed as a hash with one or more
+	    # of the following values:
+	    # :logLevel => :DEBUG (or :FATAL, :ERROR, :INFO or :WARNING. DEBUG will log the most)
+   	  # :logToQDebug => true/false
+	    # :logFolder => '/tmp/logs/'
+	    # :logQDebug => true/false
+	    # :logSize => 10000
+	    # :logEnabled => true/false
+	    def configure_logger( params_hash  = nil)
+
+		    begin 
+		      raise ArgumentError.new( "No parameters given." ) unless params_hash
+
+		      log_level = params_hash[:logLevel]  
+
+		      if log_level
+			    raise ArgumentError.new( "Invalid log level." ) unless @@_valid_levels.include?(log_level)
+		      end
+
+		      perform_command(MobyCommand::ConfigureCommand.new( "configureLogger", params_hash ))  
+		      
+		    rescue Exception => e
+		      
+		      MobyUtil::Logger.instance.log "behaviour" , "FAIL;Failed to configure logger. With params \"#{params_hash.to_s};configure_logger"
+		      Kernel::raise e        
+
+		    end      
+
+		    MobyUtil::Logger.instance.log "behaviour" , "PASS;Succesfully configured logger. With params \"#{params_hash.to_s};configure_logger"
+
+	    end
+
+	    def perform_command(command)
+		
+		    if self.class == MobyBase::SUT
+		      execute_command( command ) 
+		    else
+		      command.application_id = get_application_id
+		      @sut.execute_command( command )
+		    end
+
+      end
+	    
+	    # enable hooking for performance measurement & debug logging
+	    MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+	  end # ConfigureBehaviour
+
+  end # QT
+
+end # MobyBehaviour