testability-driver-qt-sut-plugin 0.9.2 → 1.0.0

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

@@ -21,90 +21,95 @@ require 'zlib'
 
 module MobyController
 
-	module QT
+  module QT
 
-		module Comms
+	module Comms
 
-			# Command types
-			ERROR_MSG = 0
-			VALID_MSG = 1
-			OK_MESSAGE = "OK"
+	  # Command types
+	  ERROR_MSG = 0
+	  VALID_MSG = 1
+	  OK_MESSAGE = "OK"
 
-			class Inflator
+	  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
+		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
-				MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+		# enable hooking for performance measurement & debug logging
+		MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
 
-			end
+	  end
 
       # deprecated: see send_service_request#adapter.rb
-			# Wrapper for protocol message.
-			class QTResponse
+	  # Wrapper for protocol message.
+	  class QTResponse
 
-				attr_accessor :msg_body, :flag, :crc, :message_id
+		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 )
+		# 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
+		  @flag, @msg_body, @crc, @message_id = command_flag, msg_body, crc, message_id
 
-				end
+		end
 
         # deprecated: see send_service_request#adapter.rb
-				def validate_message( msg_id )
-
-					#check that response matches the request
-					if @message_id != msg_id 
-					
-						MobyUtil::Logger.instance.log "fatal" , "Response to request did not match: \"#{@message_id}\"!=\"#{msg_id.to_s}\""
-						MobyUtil::Logger.instance.log "fatal" , @msg_body 
-						
-						Kernel::raise RuntimeError.new("Response to request did not match: \"#{@message_id}\"!=\"#{msg_id.to_s}\"") 
-						
-					end
-
-					#raise error if error flag
-				  Kernel::raise RuntimeError.new( @msg_body ) if @flag == Comms::ERROR_MSG
-          
-				end
+		def validate_message( msg_id )
+
+		  #check that response matches the request
+		  if @message_id != msg_id 
+			
+			MobyUtil::Logger.instance.log "fatal" , "Response to request did not match: \"#{@message_id}\"!=\"#{msg_id.to_s}\""
+			MobyUtil::Logger.instance.log "fatal" , @msg_body 
+			
+			Kernel::raise RuntimeError.new("Response to request did not match: \"#{@message_id}\"!=\"#{msg_id.to_s}\"") 
+			
+		  end
+
+		  #raise error if error flag
+		  if @flag == Comms::ERROR_MSG
+			if @msg_body =~ /The application with Id \d+ is no longer available/
+			  Kernel::raise MobyBase::ApplicationNotAvailableError.new( @msg_body) 
+			else
+			  Kernel::raise RuntimeError.new( @msg_body ) 
+			end
+          end
+		end
 
-				# enable hooking for performance measurement & debug logging
-				MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+		# enable hooking for performance measurement & debug logging
+		MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
 
-			end #class
+	  end #class
 
-			# Message generator for qt tas messages
-			class MessageGenerator
+	  # Message generator for qt tas messages
+	  class MessageGenerator
 
-				def self.generate( message_data, message_flag = VALID_MSG )
+		def self.generate( message_data, message_flag = VALID_MSG )
 
-					MobyController::QT::Comms::QtMessage.new( message_flag, message_data )
+		  MobyController::QT::Comms::QtMessage.new( message_flag, message_data )
 
-				end
+		end
 
-				# enable hooking for performance measurement & debug logging
-				MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+		# enable hooking for performance measurement & debug logging
+		MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
 
-			end
+	  end
 
-			class QtMessage
+	  class QtMessage
 
-				attr_reader :flag, :data, :crc, :compression, :size
-				attr_accessor :message_id 
+		attr_reader :flag, :data, :crc, :compression, :size
+		attr_accessor :message_id 
 
-				def initialize( message_flag, message_data )
+		def initialize( message_flag, message_data )
           # message flag
           @flag = message_flag
 
@@ -116,23 +121,23 @@ module MobyController
 
           # calculate outgoing message crc; sent in message header to receiver for data validation
           @crc = CRC::Crc16.crc16_ibm( @data, 0xffff )
-				end
+		end
 
-				def make_binary_message( message_id )
+		def make_binary_message( message_id )
 
-					[ @flag, @size, @crc, @compression, message_id, @data ].pack( 'CISCIa*' )
+		  [ @flag, @size, @crc, @compression, message_id, @data ].pack( 'CISCIa*' )
 
-				end
+		end
 
-				def compression
-					@compression
-				end           
+		def compression
+		  @compression
+		end           
 
-				def deflate
-				  @compression = 2
-				  #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 = [
+		def deflate
+		  @compression = 2
+		  #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, 9)
@@ -141,14 +146,14 @@ module MobyController
           # update data size
           @size = @data.size
           
-				end			
+		end			
 
-				# enable hooking for performance measurement & debug logging
-				MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+		# enable hooking for performance measurement & debug logging
+		MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
 
-			end # class
+	  end # class
 
-		end # module Comms
+	end # module Comms
 
-	end
+  end
 end

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

@@ -0,0 +1,93 @@
+############################################################################
+## 
+## 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
+	  filters = make_params if MobyUtil::Parameter[ @_sut.id ][ :filter_type, 'none' ] == 'dynamic'
+
+	  params = search_parameters
+
+	  builder = Nokogiri::XML::Builder.new do |xml|
+		xml.TasCommands( ( application_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 MobyUtil::Parameter[ @_sut.id ][ :filter_type, 'none' ] == '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 = MobyUtil::Parameter[ @_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'
+
+		# updates the filter with the current backtrace file list
+		MobyUtil::DynamicAttributeFilter.instance.update_filter( caller( 0 ) ) 
+
+		white_list = MobyUtil::DynamicAttributeFilter.instance.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
+end
+

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

@@ -0,0 +1,161 @@
+############################################################################
+## 
+## 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 MessageComposer
+	 
+	  def make_parametrized_message( service_details, command_name, params, command_params = {} )
+
+		Nokogiri::XML::Builder.new{
+		  TasCommands( service_details ) {
+			Target( :TasId => "Application" ) {
+			  Command( ( params || {} ).merge( :name => command_name ) ){
+				command_params.collect{ | name, value | 
+				  param( :name => name, :value => value ) 
+				}					        
+			  }
+			}
+		  }
+		}.to_xml
+
+	  end
+
+	  def make_xml_message( service_details, command_name, params, command_value = nil )
+
+		Nokogiri::XML::Builder.new{
+		  TasCommands( service_details ) {
+			Target( :TasId => "Application" ) {
+			  Command( command_value || "", ( params || {} ).merge( :name => command_name ) )
+			}
+		  }
+		}.to_xml		  
+
+	  end
+
+	  def make_fixture_message(fixture_plugin, params)
+		Nokogiri::XML::Builder.new{
+		  TasCommands( :id => params[:application_id].to_s, :service => "fixture", :async => params[:async].to_s ) {
+			Target( :TasId => params[:object_id].to_s, :type => params[:object_type].to_s ) {
+			  Command( :name => "Fixture", :plugin => fixture_plugin, :method => params[:command_name].to_s ) {
+				params[:parameters].collect{ | name, value | 
+				  param( :name => name, :value => value )
+				}
+			  }
+			}
+		  }
+		}.to_xml		
+	  end
+
+	  def encode_string( source )
+		source = source.to_s
+		source.gsub!( '&', '&' );
+		source.gsub!( '>', '>' );
+		source.gsub!( '<', '&lt;' );
+		source.gsub!( '"', '&quot;' );
+		source.gsub!( '\'', '&apos;' );
+		source
+	  end
+
+	  def make_filters
+
+		params = {}
+
+		# get sut paramteres only once, store to local variable
+		sut_parameters = MobyUtil::Parameter[ @_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'
+
+		  # updates the filter with the current backtrace file list
+		  MobyUtil::DynamicAttributeFilter.instance.update_filter( caller( 0 ) ) 
+
+		  white_list = MobyUtil::DynamicAttributeFilter.instance.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
+	  
+	  def state_message
+		app_details = { :service => 'uiState', :name => @_application_name, :id => @_application_uid }
+		app_details[ :applicationUid ] = @_refresh_args[ :applicationUid ] if @_refresh_args.include?( :applicationUid )
+		
+		case MobyUtil::Parameter[ @_sut.id ][ :filter_type, 'none' ]
+		when 'none' 
+		  command_xml = make_xml_message( app_details, 'UiState', @_flags || {} )
+		when 'dynamic'
+		  params = @_flags || {}
+		  params[ :filtered ] = 'true'
+		  command_xml = make_parametrized_message( app_details, 'UiState', params, make_filters )
+		else
+		  command_xml = make_parametrized_message( app_details, 'UiState', @_flags || {}, make_filters )
+		end
+		command_xml		
+	  end
+
+	  def run_message
+		#clone to not make changes permanent
+		arguments = MobyUtil::Parameter[ @_sut.id ][ :application_start_arguments, "" ].clone 
+		if @_arguments
+		  arguments << "," unless arguments.empty?
+		  arguments << @_arguments
+		end
+
+		parameters = { 
+		  'application_path' => @_application_name, 
+		  'arguments' => arguments, 
+		  'environment' => @_environment, 
+		  'events_to_listen' => @_events_to_listen, 
+		  'signals_to_listen' => @_signals_to_listen, 
+		  'start_command' => @_start_command 
+		}
+
+		make_xml_message({:service => 'startApplication'}, 'Run', parameters)				
+	  end
+
+	  def close_message
+		sut_id = @_sut.id
+
+		parameters = {
+		  'uid' => @_application_uid, 
+		  'kill' => ( @_flags || {} )[ :force_kill ] || MobyUtil::Parameter[ sut_id ][ :application_close_kill ], 
+		  'wait_time' => MobyUtil::Parameter[ sut_id ][ :application_close_wait ] 		  
+		}
+
+		make_xml_message({:service => 'closeApplication', :id => @_application_uid }, 'Close', parameters)
+	  end
+	  
+	end
+end
+