cutedriver-qt-sut-plugin 2.0.0.20210120165900

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

@@ -0,0 +1,185 @@
+############################################################################
+## 
+## 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 MobyController
+
+  module QT
+
+    module Comms
+
+      # Command types
+      ERROR_MSG = 0
+      VALID_MSG = 1
+      OK_MESSAGE = "OK"
+
+      class Inflator
+
+        def self.inflate( response )
+
+          # strip 4 extra bytes written by qt compression, return empty string if no raw data found, otherwise inflate it
+          ( raw_data = response[ 4 .. -1 ] ).empty? ? "" : Zlib::Inflate.inflate( raw_data )
+
+        end
+
+        # enable hooking for performance measurement & debug logging
+        TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
+
+      end # Inflator
+
+      # deprecated: see send_service_request#adapter.rb
+      # Wrapper for protocol message.
+      class QTResponse
+
+        attr_accessor :msg_body, :flag, :crc, :message_id
+
+        # deprecated: see send_service_request#adapter.rb
+        # Initialize QT Response.      
+        # == params
+        # command_flag Indicator flad for message type (error or ok)
+        # message_code 0 or an error code
+        # msg_body Body of the message. For command a simple "OK" message for ui state the xml document as string  
+        # == returns
+        def initialize( command_flag, msg_body, crc, message_id )
+
+          @flag, @msg_body, @crc, @message_id = command_flag, msg_body, crc, message_id
+
+        end
+
+        # deprecated: see send_service_request#adapter.rb
+        def validate_message( msg_id )
+
+          #check that response matches the request
+          if @message_id != msg_id 
+
+            msg = "Response to request did not match: #{ @message_id.to_s.inspect }!=#{ msg_id.to_s.inspect }"
+
+            $logger.fatal msg
+
+            $logger.fatal @msg_body 
+
+            raise RuntimeError, msg
+
+          end
+
+          #raise error if error flag
+          if @flag == Comms::ERROR_MSG
+
+            raise MobyBase::ApplicationNotAvailableError, @msg_body if @msg_body =~ /The application with Id \d+ is no longer available/
+
+            raise RuntimeError, @msg_body
+
+          end
+
+        end
+
+        # enable hooking for performance measurement & debug logging
+        TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
+
+      end # QTResponse
+
+      # Message generator for qt tas messages
+      class MessageGenerator
+
+        def self.generate( message_data, message_flag = VALID_MSG )
+
+          MobyController::QT::Comms::QtMessage.new( message_flag, message_data )
+
+        end
+
+        # enable hooking for performance measurement & debug logging
+        TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
+
+      end # MobyController
+
+      class QtMessage
+
+        attr_reader :flag, :data, :compression, :size
+
+        attr_accessor :message_id 
+
+        def initialize( message_flag, message_data )
+
+          # message flag
+          @flag = message_flag
+
+          # no compression by default
+          @compression = 1
+
+          @data = message_data
+
+          @size = @data.size
+
+          # calculate crc only when requested
+          @crc = nil
+
+        end
+
+        def crc
+
+          if @crc.nil?
+
+            # calculate outgoing message crc; sent in message header to receiver for data validation
+            @crc = TDriver::Checksum.crc16_ibm( @data ) 
+
+          else
+
+            @crc
+
+          end
+          
+        end
+
+        def make_binary_message( message_id )
+
+
+          [ @flag, @size, crc, @compression, message_id, @data ].pack( 'CISCIa*' )
+
+        end
+
+        def deflate( level = 9 )
+
+          unless @compression == 2
+
+            @compression = 2
+
+            data_size = @data.size
+
+            # qUncompress required the data length at the beginning so append it - the bytes need to be arranged in the below method (see QByteArray::qUncompress)
+            @data = [ ( data_size & 0xff000000 ) >> 24, ( data_size & 0x00ff0000 ) >> 16, ( data_size & 0x0000ff00 ) >> 8, ( data_size & 0x000000ff ), Zlib::Deflate.deflate( @data, level ) ].pack('C4a*')
+
+            # update data size
+            @size = @data.size
+
+            # recalculate crc
+            @crc = nil
+
+          end
+          
+        end      
+
+        # enable hooking for performance measurement & debug logging
+        TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
+
+      end # QtMessage
+
+    end # Comms
+
+  end # QT
+
+end # MobyController

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

@@ -0,0 +1,69 @@
+############################################################################
+## 
+## 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 MobyController
+
+	module QT
+
+		module SutController
+
+			def disconnect
+
+				@sut_adapter.disconnect
+
+			end
+
+			def connect( id )
+
+				@sut_adapter.connect( id )
+
+			end
+
+      def received_bytes
+
+				@sut_adapter.socket_received_bytes
+
+			end
+
+      def sent_bytes
+
+				@sut_adapter.socket_sent_bytes
+
+			end
+
+      def received_packets
+
+				@sut_adapter.socket_received_packets
+
+			end
+
+      def sent_packets
+
+				@sut_adapter.socket_sent_packets
+
+			end
+
+			# enable hooking for performance measurement & debug logging
+			TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
+
+		end # SutController
+
+	end # QT
+
+end # MobyController

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

@@ -0,0 +1,287 @@
+############################################################################
+## 
+## 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 MobyUtil
+  
+  module FindObjectGenerator
+
+    def generate_message
+    
+      # get sut paramteres only once, store to local variable
+      sut_parameters = $parameters[ @_sut.id ]
+
+	    filter_type = sut_parameters[ :filter_type, 'none' ]
+	
+      plugin_timeout = sut_parameters[ :qttas_plugin_timeout, 10000 ].to_i
+      
+	    if filter_type != 'none'
+
+	      filters = {}
+
+        sut_parameters.if_found( :filter_properties ){ | key, value | filters[ 'filterProperties' ] = value }
+        sut_parameters.if_found( :plugin_blacklist  ){ | key, value | filters[ 'pluginBlackList'  ] = value }
+        sut_parameters.if_found( :plugin_whitelist  ){ | key, value | filters[ 'pluginWhiteList'  ] = value }
+        sut_parameters.if_found( :use_view_crop     ){ | key, value | filters[ 'useViewCrop'      ] = value }
+
+	      case filter_type
+		
+	        when 'dynamic'
+		
+            value = TDriver::AttributeFilter.filter_string
+
+		        filters[ 'attributeWhiteList' ] = value unless value.blank?
+
+	        when 'static'
+		
+            sut_parameters.if_found( :attribute_blacklist ){ | key, value | filters[ 'attributeBlackList' ] = value }
+            sut_parameters.if_found( :attribute_whitelist ){ | key, value | filters[ 'attributeWhiteList' ] = value }
+
+	        end
+
+      else
+
+        filters = {}
+
+      end
+
+      #xml = "<?xml version=\"1.0\"?>"
+
+      xml = "<TasCommands plugin_timeout=\"#{plugin_timeout}\" service=\"findObject\" #{ @_app_details.to_attributes }"
+
+      # pass checksum value if known from previous service request result
+      #unless @_checksum.nil?
+      #  xml << " checksum=\"#{ @_checksum.to_s }\" "
+      #end
+
+      unless @_params.empty?
+
+        # TasCommands close    
+        xml << '><Target>'
+        
+        # temp. objects xml fragment
+        objects = ""
+
+        # collect objects with attributes
+        @_params.reverse_each{ | parameters |
+        
+          if parameters == @_params.last
+          
+            objects = "<object #{ parameters.to_attributes } />"          
+            
+          else
+          
+            objects = "<object #{ parameters.to_attributes }>#{ objects }</object>"
+            
+          end
+        
+        }
+
+        # add objects to xml
+        xml << objects
+
+        xml << '<Command name="findObject">'
+
+        filters.each{ | name, value | xml << "<param name=\"#{ name }\" value=\"#{ value }\" />" }
+
+        xml << '</Command></Target></TasCommands>'
+    
+      else
+    
+        # TasCommands close
+        xml << ' />'
+      
+      end
+      
+      xml
+
+    end
+
+=begin	
+    def generate_message
+    
+      # get sut paramteres only once, store to local variable
+      sut_parameters = $parameters[ @_sut.id ]
+
+	    filter_type = sut_parameters[ :filter_type, 'none' ]
+	
+	    if filter_type != 'none'
+
+	      filters = {}
+	      value = nil
+	      filters[ 'filterProperties' ] = value if ( value = sut_parameters[ :filter_properties, nil ] )
+	      filters[ 'pluginBlackList'  ] = value if ( value = sut_parameters[ :plugin_blacklist,  nil ] )
+	      filters[ 'pluginWhiteList'  ] = value if ( value = sut_parameters[ :plugin_whitelist,  nil ] )
+
+	      case filter_type
+		
+	        when 'dynamic'
+
+		        filters[ 'attributeWhiteList' ] = value if ( value = TDriver::AttributeFilter.filter_string ) 
+		
+	        when 'static'
+
+		        filters[ 'attributeBlackList' ] = value if ( value = sut_parameters[ :attribute_blacklist, nil ] )
+		        filters[ 'attributeWhiteList' ] = value if ( value = sut_parameters[ :attribute_whitelist, nil ] ) 
+		
+	        end
+
+      else
+
+        filters = {}
+
+      end
+
+      #xml = "<?xml version=\"1.0\"?>"
+
+      xml = "<TasCommands service=\"findObject\" #{ @_app_details.to_attributes }"
+      
+      unless @_params.empty?
+
+        # TasCommands close    
+        xml << '><Target>'
+        
+        # temp. objects xml fragment
+        objects = ""
+
+        # collect objects with attributes
+        @_params.reverse.each_with_index{ | parameters, index |
+        
+          if index == 0
+          
+            objects = "<object #{ parameters.to_attributes } />"          
+            
+          else
+          
+            objects = "<object #{ parameters.to_attributes }>#{ objects }</object>"
+            
+          end
+        
+        }
+
+        # add objects to xml
+        xml << objects
+
+        xml << '<Command name="findObject">'
+
+        filters.each{ | name, value | xml << "<param name=\"#{ name }\" value=\"#{ value }\" />" }
+
+        xml << '</Command></Target></TasCommands>'
+    
+      else
+    
+        # TasCommands close
+        xml << ' />'
+      
+      end
+      
+      xml
+
+    end
+=end
+
+=begin	
+	  def generate_message
+	
+	    filter_type = $parameters[ @_sut.id ][ :filter_type, 'none' ]
+	
+	    filters = make_params if filter_type == 'dynamic'
+
+	    builder = Nokogiri::XML::Builder.new do |xml|
+
+		    xml.TasCommands( ( @_app_details || {} ).merge( :service => "findObject") ) {			
+
+		      xml.Target{			  
+
+			      add_objects( xml, @_params )
+
+			      xml.Command( :name => 'findObject' ){ filters.collect{ | name, value | xml.param( :name => name, :value => value ) } } if filter_type == 'dynamic'
+
+		      } if @_params and @_params.size > 0
+
+		    }
+
+	    end
+
+	    builder.to_xml
+
+	  end
+	
+
+  private
+
+	  def add_objects( builder, params )
+
+	    parent = builder.parent
+
+	    params.each{| objectParams | 
+	    
+	      parent = create_object_node( builder, objectParams, parent ) 
+	      
+      }
+
+	  end
+	
+	  def create_object_node( builder, params, parent )
+
+	    node = Nokogiri::XML::Node.new( 'object', builder.doc )
+
+	    params.keys.each{ | key | node[ key.to_s ] = params[ key ].to_s }
+
+	    parent.add_child( node )
+
+	  end
+
+	  def make_params
+	
+	    params = {}
+
+	    # get sut paramteres only once, store to local variable
+	    sut_parameters = $parameters[ @_sut.id ]
+
+	    params[ 'filterProperties' ] = $last_parameter if sut_parameters[ :filter_properties, nil ]
+	    params[ 'pluginBlackList'  ] = $last_parameter if sut_parameters[ :plugin_blacklist,  nil ]
+	    params[ 'pluginWhiteList'  ] = $last_parameter if sut_parameters[ :plugin_whitelist,  nil ]
+
+	    case sut_parameters[ :filter_type, 'none' ]
+		
+	      when 'dynamic'
+
+		      white_list = TDriver::AttributeFilter.filter_string
+		      
+		      params['attributeWhiteList'] = white_list if white_list
+		
+	      when 'static'
+
+		      params['attributeBlackList'] = $last_parameter if sut_parameters[ :attribute_blacklist, nil ]
+		      params['attributeWhiteList'] = $last_parameter if sut_parameters[ :attribute_whitelist, nil ]
+		
+      end
+
+      params		
+
+    end
+=end
+
+    # enable hoo./base/test_object/factory.rb:king for performance measurement & debug logging
+    TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
+
+  end
+  
+end
+