testability-driver-qt-sut-plugin 0.9.2

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

@@ -0,0 +1,54 @@
+############################################################################
+## 
+## 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 ScreenCapture 
+
+			def set_adapter( adapter )      
+				@sut_adapter = adapter
+			end
+
+			def execute
+
+				@sut_adapter.send_service_request(
+					Comms::MessageGenerator.generate(
+						Nokogiri::XML::Builder.new{
+							TasCommands( :id=> 1, :service => "screenShot" ) {
+								Target( :TasId => 1, :type => "Application" ) {
+									Command( :name => "Screenshot", :format => @context.image_mime_type, :draw => @context.redraw.to_s )
+								}
+							}
+						}.to_xml
+					)
+				)
+
+			end
+
+			# enable hooking for performance measurement & debug logging
+			MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+
+		end # ScreenCapture
+
+	end # QT
+
+end # MobyController

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

@@ -0,0 +1,51 @@
+############################################################################
+## 
+## 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 Tap 
+
+			def set_adapter( adapter )      
+				@sut_adapter = adapter
+			end
+
+			def execute
+
+				command_xml = Nokogiri::XML::Builder.new{
+				  TasCommands( :service => "uiCommand" ) {
+				    Target( :TasId => 1, :type => "Application" ) {
+				      Command( :name => "TapScreen", :x => get_x, :y => get_y, :button => 1, :count => 1, :mouseMove => true, :useCoordinates => true, :time_to_hold => get_hold )
+				    }
+				  }
+				}.to_xml
+
+				@sut_adapter.send_service_request(Comms::MessageGenerator.generate(command_xml))
+
+			end
+
+			# enable hooking for performance measurement & debug logging
+			MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+		end # Tap
+
+	end # QT
+
+end # MobyController

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

@@ -0,0 +1,72 @@
+############################################################################
+## 
+## 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 WidgetCommand 
+
+			# Execute the command). 
+			# Sends the message to the device using the @sut_adapter (see base class)     
+			# == params         
+			# == returns
+			# == raises
+			# NotImplementedError: raised if unsupported command type       
+			def execute
+			  command_params = {:eventType => get_event_type, :name => get_command_name}
+			  command_params.merge!(get_command_params) if get_command_params
+
+			  builder = Nokogiri::XML::Builder.new{
+				TasCommands( :id=> get_application_id, :transitions => get_transitions, :service => get_service || 'uiCommand' ) {
+				  Target( :TasId => get_object_id, :type => get_object_type ) {
+					if get_command_value.kind_of? Array
+					  get_command_value.each do | command_part |
+						Command( command_part[ :value ], command_part[ :params ] )
+					  end
+					else
+					  Command( get_command_value || "", command_params )
+					end
+				  }
+				}
+			  }						  
+
+			  if @sut_adapter.group?
+				@sut_adapter.append_command(builder.doc.root.children)
+			  else
+				@sut_adapter.send_service_request(Comms::MessageGenerator.generate(builder.to_xml))
+			  end
+
+			end
+
+			def set_adapter( adapter )
+				@sut_adapter = adapter
+			end
+
+			# enable hooking for performance measurement & debug logging
+			MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+
+		end #module Action
+
+	end #module QT
+
+end #module MobyController

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

@@ -0,0 +1,119 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+# verify that TDriver is loaded
+Kernel::raise RuntimeError.new( "SUT plugin requires TDriver" ) unless (defined?( MATTI ) || defined?( TDriver ))
+
+module MobyPlugin
+
+	module QT
+
+		class SUT < MobyUtil::Plugin
+
+			## plugin configuration, constructor and deconstructor methods
+			def self.plugin_name
+
+				# return plugin name as string
+				"testability-driver-qt-sut-plugin"
+				#File.basename( __FILE__, '.rb' ).downcase # => "tdriver-qt-sut-plugin" 
+
+			end
+
+			def self.plugin_type
+
+				# return plugin type as symbol
+				:sut
+
+			end
+
+			def self.register_plugin
+
+				# load plugin specific implementation or other initialization etc.
+				MobyUtil::FileHelper.load_modules( 
+
+					# load utility module(s)
+					'util/*.rb', 
+
+					# sut adapter
+					'sut/communication.rb', 
+
+					# sut adapter
+					'sut/adapter.rb', 
+
+					# sut controller
+					'sut/controller.rb', 
+
+					# qt behaviour abstract
+					'behaviours/behaviour.rb', 
+
+					# load behaviour(s)
+					'behaviours/*.rb', 
+
+					# load command(s)
+					'commands/*.rb',
+
+					# load command controller(s)
+					'controllers/*.rb'
+
+				)
+
+			end
+
+			def self.unregister_plugin
+
+				# unregister plugin
+
+			end
+
+			## plugin specific methods
+
+			# return sut type that plugin implements
+			def self.sut_type
+
+				# return sut type as string
+				"QT"
+
+			end
+
+			# returns SUT object - this method will be called from MobyBase::SUTFactory
+			def self.make_sut( sut_id )
+
+				# tcp/ip read/write timeouts, default: 15 (seconds)
+				socket_read_timeout  = MobyUtil::Parameter[ sut_id ][ :socket_read_timeout,  "15" ].to_i
+				socket_write_timeout = MobyUtil::Parameter[ sut_id ][ :socket_write_timeout, "15" ].to_i
+
+				MobyBase::SUT.new(
+					MobyBase::SutController.new( "QT", MobyController::QT::SutAdapter.new( sut_id, socket_read_timeout, socket_write_timeout ) ), 
+					MobyBase::TestObjectFactory.instance, 
+					sut_id 
+				)
+
+			end
+
+			# enable hooking for performance measurement & debug logging
+			MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+			# register plugin
+			MobyUtil::PluginService.instance.register_plugin( self ) # Note: self is MobyPlugin::QT::SUT
+
+		end # SUT
+
+	end # QT
+
+end # MobyPlugin

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

@@ -0,0 +1,225 @@
+############################################################################
+## 
+## 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
+	
+	# Sut adapter that used TCP/IP connections to send and receive data from QT side. 
+	class SutAdapter < MobyController::SutAdapter
+	  
+	  attr_reader :sut_id
+
+	  attr_accessor(
+
+					:socket_read_timeout,
+					:socket_write_timeout,
+					:socket_received_bytes,
+					:socket_sent_bytes
+
+					)
+	  
+	  # TODO: better way to set the host and port parameters   
+	  # Initialize the tcp adapter for communicating with the device.
+	  # Communication is done using two tcp channels one form commanding
+	  # the device and one for receiving ui state data.
+	  # UI state data receivin is done in a seprate thread so it is good
+	  # once usage is complete the shutdown_comms is called
+	  # == params
+	  # sut_id id for the sut so that client details can be fetched from params
+	  def initialize( sut_id, receive_timeout = 25, send_timeout = 25 )
+
+		@socket = nil
+		@connected = false
+        @socket_received_bytes=0
+        @socket_sent_bytes=0
+
+		@sut_id = sut_id
+
+		# set timeouts
+		@socket_read_timeout = receive_timeout
+		@socket_write_timeout = send_timeout
+
+		@counter = rand( 1000 )
+
+		# connect socket
+		#connect( @sut_id )
+
+	  end
+
+	  def disconnect
+
+		@socket.close if @connected
+
+		@connected = false
+
+	  end
+
+	  def connect( id = nil )
+
+		id ||= @sut_id
+
+		begin
+
+		  @socket = TCPSocket.open( MobyUtil::Parameter[ id ][ :qttas_server_ip ], MobyUtil::Parameter[ id ][ :qttas_server_port ].to_i )
+
+		rescue => ex
+
+		  ip = "no ip" if ( ip = MobyUtil::Parameter[ id ][ :qttas_server_ip, "" ] ).empty?
+		  port = "no port" if ( port = MobyUtil::Parameter[ id ][ :qttas_server_port, "" ] ).empty?
+
+		  Kernel::raise IOError.new("Unable to connect QTTAS server, verify that it is running properly (#{ ip }:#{ port }): .\nException: #{ ex.message }")
+		end
+
+		@connected = true
+
+	  end
+
+	  def group?
+		@_group
+	  end
+
+	  # Set the document builder for the grouped behaviour message.
+	  def set_message_builder(builder)
+		@_group = true
+		@_builder = builder
+	  end
+
+	  def append_command(node_list)		  
+		node_list.each {|ch| @_builder.doc.root.add_child(ch)}				  
+	  end
+
+	  # Sends a grouped command message to the server. Sets group to false and nils the builder
+	  # to prevent future behviours of being grouped (unless so wanted)
+	  # == returns    
+	  # the amout of commands grouped (and send)
+	  def send_grouped_request
+		@_group = false
+		size = @_builder.doc.root.children.size
+		send_service_request(Comms::MessageGenerator.generate(@_builder.to_xml))
+		@_builder = nil
+		size
+	  end
+
+	  # Send the message to the qt server         
+	  # If there is no exception propagated the send to the device was successful
+	  # == params   
+	  # message:: message in qttas protocol format   
+	  # == returns    
+	  # the response body
+	  def send_service_request( message, return_crc = false )
+
+		connect if !@connected        
+
+		# set request message id
+		message.message_id = ( @counter += 1 )
+
+		# write request message to socket
+		write_socket( message.make_binary_message(@counter) )
+
+		# read response to determine was the message handled properly and parse the header
+		# header[ 0 ] = command_flag
+        # header[ 1 ] = body_size
+        # header[ 2 ] = crc
+        # header[ 3 ] = compression_flag
+        # header[ 4 ] = message_id
+		header = nil
+		body = nil
+
+		read_message_id = 0
+		until read_message_id == @counter
+		  header = read_socket( 12 ).unpack( 'CISCI' )
+
+		  # read the message body and compare crc checksum
+		  Kernel::raise IOError.new( "CRC do not match. Maybe the message is corrupted!" ) if CRC::Crc16.crc16_ibm( body = read_socket( header[ 1 ] ) , 0xffff ) != header[ 2 ]
+		  
+		  # validate response message; check that response message id matches the request
+		  # if smaller than expected try to read the next message but if bigger raise error
+		  read_message_id = header[ 4 ]
+		  if read_message_id < @counter
+			MobyUtil::Logger.instance.log "warning" , "Response to request did not match: \"#{ header[ 4 ].to_s }\"<\"#{ @counter.to_s }\""
+		  elsif read_message_id > @counter
+			MobyUtil::Logger.instance.log "fatal" , "Response to request did not match: \"#{ header[ 4 ].to_s }\">\"#{ @counter.to_s }\""
+			# save to file?
+			MobyUtil::Logger.instance.log "fatal" , body
+			Kernel::raise RuntimeError.new( "Response to request did not match: \"#{ header[ 4 ].to_s }\"!=\"#{ @counter.to_s }\"" )
+		  end
+		end
+		
+        # inflate the message body if compressed
+        if ( header[ 3 ] == 2 )
+		  
+          body = Zlib::Inflate.inflate( body ) unless ( body = body[ 4..-1 ] ).empty?
+
+        end
+
+        # raise exception if messages error flag is set
+		# Flag statuses:
+		#   0 -> ERROR_MSG
+        #   1 -> VALID_MSG
+        #   2 -> OK_MESSAGE
+		Kernel::raise RuntimeError.new( body ) if header[ 0 ] == 0
+
+		# return the body ( and crc if required )
+		return_crc ? [ body, header[ 2 ] ] : body
+
+	  end
+
+	  private
+
+	  def read_socket( bytes_count )
+
+		# store time before start receving data
+		start_time = Time.now
+
+		# verify that there is data available to be read 
+		Kernel::raise IOError.new( "Socket reading timeout (%i) exceeded for %i bytes" % [ @socket_read_timeout, bytes_count ] ) if TCPSocket::select( [ @socket ], nil, nil, @socket_read_timeout ).nil?
+
+		# read data from socket
+		read_buffer = @socket.read( bytes_count ){
+
+		  Kernel::raise IOError.new( "Socket reading timeout (%i) exceeded for %i bytes" % [ @socket_read_timeout, bytes_count ] ) if ( Time.now - start_time ) > @socket_read_timeout
+
+		}
+
+		Kernel::raise IOError.new( "Socket reading error for %i bytes - No data retrieved" % [ bytes_count ] ) if read_buffer.nil?
+        @socket_received_bytes+=read_buffer.size
+		read_buffer
+
+	  end
+
+	  def write_socket( data )
+        @socket_sent_bytes+=data.size
+
+		@socket.write( data )
+
+		# verify that there is no data in writing buffer 
+		Kernel::raise IOError.new( "Socket writing timeout (%i) exceeded for %i bytes" % [ @socket_write_timeout, data.length ] ) if TCPSocket::select( nil, [ @socket ], nil, @socket_write_timeout ).nil?
+
+	  end
+
+	  # enable hooking for performance measurement & debug logging
+	  MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+
+	end # SutAdapter
+
+  end # QT
+
+end # MobyController