cutedriver-qt-sut-plugin 2.0.0.20210120165900

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

@@ -0,0 +1,300 @@
+############################################################################
+## 
+## 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 as string
+      #   example: "text"
+      #
+      #  Symbol
+      #   description: Name of the attribute to be set as symbol
+      #   example: :text
+      #
+      # value
+      #  String
+      #   description: New value of the attribute.
+      #   example: "Menu"
+      #
+      #  Integer
+      #   description: New value of the attribute.
+      #   example: 200
+      #
+      #  TrueClass
+      #   description: New value of the attribute.
+      #   example: true
+      #
+      #  FalseClass
+      #   description: New value of the attribute.
+      #   example: false
+      #
+      #  Date
+      #   description: New value of the attribute.
+      #   example: Date.today
+      #
+      #  Time
+      #   description: New value of the attribute.
+      #   example: Time.now
+      #
+      #  DateTime
+      #   description: New value of the attribute.
+      #   example: DateTime.now
+      #  
+      # 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 )
+
+        # verify attribute argument variable type
+        attribute.check_type [ Symbol, String ], 'wrong argument type $1 for attribute name (expected $2)'
+
+        # verify type argument variable type 
+        type.check_type [ NilClass, String ], 'wrong argument type $1 for attribute type (expected $2)'
+
+        # convert symbol to string
+        attribute = attribute.to_s if attribute.kind_of?( Symbol )
+
+        # raise exception if attribute name was not given
+        attribute.not_empty 'attribute name cannot be be empty string'
+
+        type.not_empty 'argument type must be either nil or non empty string' if type.kind_of?( String )
+
+        # in qt_behaviour 
+        command = command_params 
+
+        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
+              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
+              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
+          $logger.behaviour "FAIL;Failed when calling method set_attribute with values attribute:#{attribute.to_s} value:#{value.to_s}.;#{identity};set_attribute;"
+          raise RuntimeError.new("Setting attribute '%s' to value '%s' failed with error: %s" % [attribute, value, returnValue])
+        end
+        
+          $logger.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
+
+      # == description
+      # Wrapper method to set test object's attribute value. See  [link="#QtAttribute:set_attribute"]supported value argument types[/link] and [link="#attribute_types_table"]attribute types table[/link].\n\n
+      # Minimum number of required arguments is 2; attribute name and new value. Please see examples for correct call sequence.
+      #
+      # == arguments
+      # name
+      #  String
+      #   description: Attribute name
+      #   example: "attribute_name"
+      # *arguments
+      #  Array
+      #   description: Attribute value and type
+      #   example: ["0,0", "QPoint"] 
+      #
+      # == returns
+      # NilClass
+      #   description: -
+      #   example: -
+      def []=( name, *arguments )
+
+        _argument_count = arguments.count
+
+        if _argument_count == 0 || _argument_count > 2
+
+          raise ArgumentError, "wrong number of arguments (#{ _argument_count } of 2)"
+        
+        elsif _argument_count == 2
+
+          # set_attribute( name, arguments.last, arguments.first )
+          arguments.reverse!
+        
+        end
+      
+        # do magic
+        set_attribute( name, *arguments )
+
+        nil
+    
+      end
+
+      # enable hooking for performance measurement & debug logging
+      TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
+
+    end
+
+  end
+end

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

@@ -0,0 +1,214 @@
+############################################################################
+## 
+## 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 ]
+      @@_events_enabled = false
+
+      # == nodoc
+      # should this method be private?
+      def command_params( command = MobyCommand::WidgetCommand.new )   
+
+        if attribute( 'objectType' ) == 'Graphics' and attribute( 'visibleOnScreen' ) == 'false' and @creation_attributes[ :visibleOnScreen ] != 'false'
+
+          begin
+
+            #try to make the item visible if so wanted
+            fixture( 'qt', 'ensureVisible'   ) if sut_parameters[ :ensure_visible,     false ].true?
+            fixture( 'qt', 'ensureQmlVisible') if sut_parameters[ :ensure_qml_visible, false ].true?
+            
+            @creation_attributes.merge!( 'visibleOnScreen' => 'true' )
+
+            @parent.child( @creation_attributes )
+
+          rescue
+
+            raise MobyBase::TestObjectNotVisibleError
+
+          end
+
+        end
+
+        _object_type = attribute( 'objectType' ).intern
+
+        #for components with object visible on screen but not actual widgets or graphicsitems
+        if _object_type == :Embedded
+
+          _object_type = @parent.attribute( 'objectType' ).intern
+
+          _object_id = @parent.id
+
+        else
+
+          _object_id = @id
+
+        end
+
+        command.application_id( get_application_id )
+
+        command.set_object_id( _object_id )
+
+        command.object_type( _object_type )
+
+        command.set_event_type( sut_parameters[ :event_type, "0" ] )
+
+        # set app id as vkb if the attribute exists as the command needs to go to the vkb app
+        begin
+
+          # raises exception if value not found
+          value = attribute( 'vkb_app_id' )
+
+          command.application_id( value )
+
+        rescue MobyBase::AttributeNotFoundError
+
+        end    
+
+        command
+
+      end
+
+    private   
+
+      # == nodoc
+      # should this method be private?
+      def plugin_command( require_response = false, command = MobyCommand::WidgetCommand.new )
+        command.set_event_type(sut_parameters[ :event_type, "0" ])
+        command.application_id( get_application_id )
+        command.set_object_id( @id )
+        command.object_type( attribute('objectType' ).intern)
+        command.transitions_off    
+        command
+      end
+
+      # TODO: document me
+      def do_sleep(time)
+
+        time = time.to_f * 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
+
+      # TODO: document me
+      def center_x
+
+        #x = attribute( 'x_absolute' ).to_i
+        #width = attribute( 'width' ).to_i
+        #x = x + ( width/2 )
+        #x.to_s
+
+        ( ( attribute( 'x_absolute' ).to_i ) + ( attribute( 'width' ).to_i / 2 ) ).to_s
+
+      end
+
+      # TODO: document me
+      def center_y
+
+        #y = attribute( 'y_absolute' ).to_i
+        #height = attribute( 'height' ).to_i
+        #y = y + ( height/2 )
+        #y.to_s
+
+        ( ( attribute( 'y_absolute' ).to_i ) + ( attribute( 'height' ).to_i / 2 ) ).to_s
+
+      end  
+
+      # TODO: document me
+      def param_set_configured?( params, key )
+
+        if params.kind_of?(Hash) && params.has_key?(key)
+
+          #( params[ key ].nil? ? sut_parameters[ key, 'false' ] : params[ key ].to_s ).to_s == "true"
+
+          ( params[ key ] || sut_parameters[ key, false ] ).true?
+
+        else
+
+          #sut_parameters[ key, 'false' ].true?
+
+          sut_parameters[ key, false ].true?
+
+        end
+      end
+
+      # TODO: document me
+      def execute_behavior( params, command )
+
+        if !get_application.multitouch_ongoing? && !@@_events_enabled && param_set_configured?( params, :ensure_event ) 
+
+          ensure_event(:retry_timeout => 5, :retry_interval => 0.5) {
+
+            @sut.execute_command( command )
+
+          }
+
+        else
+
+          @sut.execute_command( command )
+
+        end
+
+      end
+
+      # enable hooking for performance measurement & debug logging
+      TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
+
+    end
+
+  end
+
+end
+