testability-driver 0.9.2

data/lib/tdriver/base/sut/generic/commands/key_sequence.rb

@@ -0,0 +1,82 @@
+############################################################################
+## 
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). 
+## All rights reserved. 
+## Contact: Nokia Corporation (testabilitydriver@nokia.com) 
+## 
+## This file is part of Testability Driver. 
+## 
+## 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 MobyCommand
+
+	class KeySequence < MobyCommand::CommandData
+
+		attr_accessor :id
+
+		# Constructor to KeySequence
+		# == params
+		# key_symbol:: (optional) Symbol of key to be added to sequence if given.
+		# type_symbol:: (optional) Symbol of keypress type of key if given, otherwise use default.
+		# == returns
+		# Instance of KeySequence
+		def initialize( key_symbol = nil, type_symbol = :ShortPress )
+			#TODO: Review comment (OR): @sequence -> @_sequence?
+			@sequence = Array.new( 0 )
+			#@_sut = sut
+			self.append!( key_symbol, type_symbol ) unless key_symbol == nil
+		end
+
+		# Function to append a keypress with type to KeySequence.sequence array
+		# == params
+		# key_symbol:: Symbol of key to be appended to sequence.
+		# type_symbol:: (optional) Symbol of keypress type of key if given, otherwise use default.
+		# == returns
+		# self 
+		def append!( key_symbol, type_symbol = :ShortPress )
+			@sequence.push({:value => key_symbol, :type => type_symbol})    
+			self       
+		end
+
+		# Function to repeat last added keypress in sequence unless count is less than one or keypress sequence is empty  
+		# == params
+		# int:: times of key repeated, default is one   
+		# == returns
+		# self
+		# == raises
+		# ArgumentError:: Fixnum expected as argument
+		# ArgumentError:: Positive value expected as argument
+		# IndexError:: Not allowed when empty key sequence
+		def times!( int = 1 )
+			Kernel::raise ArgumentError.new("Fixnum expected as argument") if int.class != Fixnum
+			Kernel::raise ArgumentError.new("Positive value expected as argument") if int < 0
+			Kernel::raise IndexError.new("Not allowed when empty key sequence") if @sequence.size == 0
+			int.times do | iteration |
+				@sequence.push @sequence.fetch( -1 ) unless iteration == 0 
+			end
+			self
+		end
+				
+		# Returns the stored sequence as an Array with Hash elements having :value and :type keys for each press.
+		# == returns
+		# Array:: Stored key sequence
+		def get_sequence
+		  return @sequence
+		end
+
+		# enable hooking for performance measurement & debug logging
+		MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+	end # KeySequence
+
+end # MobyCommand

data/lib/tdriver/base/sut/generic/commands/screen_capture.rb

@@ -0,0 +1,58 @@
+############################################################################
+## 
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). 
+## All rights reserved. 
+## Contact: Nokia Corporation (testabilitydriver@nokia.com) 
+## 
+## This file is part of Testability Driver. 
+## 
+## 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 MobyCommand
+
+	class ScreenCapture < MobyCommand::CommandData
+
+		attr_accessor(
+			:command, 
+			:image_mime_type, 
+			:color_depth, 
+			:redraw
+		)
+
+		# Constructor to ScreenCapture
+		# == params
+		# hash:: (optional) Hash of image related attributes
+		# == returns
+		# Instance of ScreenCapture
+		def initialize( hash = {} )
+
+			# Default values
+			@command = hash[ :type ] ||= :Screen
+			@image_mime_type = hash[ :mime_type ] ||= :PNG
+			@color_depth = hash[ :color_depth ] ||= :Color4K
+			@redraw = hash[ :redraw ] ||= false
+
+			Kernel::raise ArgumentError.new("Wrong argument type %s for command type (expected Symbol)" % hash[ :type ].class ) unless hash[ :type ].kind_of? Symbol
+
+			Kernel::raise ArgumentError.new("Wrong argument type %s for image MIME type (expected Symbol)" % hash[ :mime_type ].class ) unless hash[ :mime_type ].kind_of? Symbol
+
+			Kernel::raise ArgumentError.new("Wrong argument type %s for image color depth type (expected Symbol)" % hash[ :color_depth ].class ) unless hash[ :color_depth ].kind_of? Symbol
+
+		end
+
+		# enable hooking for performance measurement & debug logging
+		MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+	end # ScreenCapture
+
+end # MobyCommand

data/lib/tdriver/base/sut/generic/plugin.rb

@@ -0,0 +1,96 @@
+############################################################################
+## 
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). 
+## All rights reserved. 
+## Contact: Nokia Corporation (testabilitydriver@nokia.com) 
+## 
+## This file is part of Testability Driver. 
+## 
+## 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 plugin engine and modules is loaded
+Kernel::raise RuntimeError.new( "SUT plugin requires TDriver" ) unless defined?( MobyUtil::Plugin )
+
+module MobyPlugin
+
+	module Generic
+
+		class SUT < MobyUtil::Plugin
+
+			## plugin configuration, constructor and deconstructor methods
+			def self.plugin_name
+
+				# return plugin name as string
+				"tdriver-generic-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 behaviour(s)
+					'behaviours/*.rb',
+
+					# load commands(s)
+					'commands/*.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
+				"generic"
+
+			end
+
+			# returns SUT object - this method will be called from MobyBase::SUTFactory
+			def self.make_sut( sut_id )
+
+				MobyBase::SUT.new( 
+					MobyBase::SutController.new( "", MobyController::SutAdapter.new() ), 
+					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::Generic::SUT
+
+		end # SUT
+
+	end # Generic
+
+end # MobyPlugin

data/lib/tdriver/base/sut/loader.rb

@@ -0,0 +1,35 @@
+############################################################################
+## 
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). 
+## All rights reserved. 
+## Contact: Nokia Corporation (testabilitydriver@nokia.com) 
+## 
+## This file is part of Testability Driver. 
+## 
+## 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. 
+## 
+############################################################################
+
+
+# load sut abstraction class
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'sut' ) )
+
+# load sut adapter abstraction class
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'adapter' ) )
+
+# load sut controller
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'controller' ) )
+
+# load sut factory
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'factory' ) )
+
+# generic sut
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'generic/plugin.rb' ) )
+

data/lib/tdriver/base/sut/sut.rb

@@ -0,0 +1,67 @@
+############################################################################
+## 
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). 
+## All rights reserved. 
+## Contact: Nokia Corporation (testabilitydriver@nokia.com) 
+## 
+## This file is part of Testability Driver. 
+## 
+## 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. 
+## 
+############################################################################
+
+# abstract class for SUT - no behaviours
+module MobyBase
+
+	class SUT
+
+		attr_accessor(
+			:id,		# id of current SUT
+			:ui_type,	# ui type
+			:ui_version,	# ui version
+			:input,		# the input method used for interacting with this sut as a symbol, eg. :key or :touch. 
+			:type		# type of object ("SUT"), used when applying behaviour
+		)
+
+		# Initialize SUT by giving references to the used controller and test object factory
+		# == params
+		# sut_controller:: Controller object that acts as a facade to the device represented by this SUT
+		# test_object_factory:: TestObjectFactory object, a factory for generating creating test objects for this SUT
+		# sut_id:: String representing the identification of this SUT - the identification will need to match with group id in parameters xml
+		def initialize( sut_controller, test_object_factory, sut_id )
+
+			@_sutController = sut_controller    
+			@test_object_factory = test_object_factory
+
+			@id = sut_id
+			@input = :key
+			@type = "sut"
+
+		end	
+
+		# Interface to forward command execution to sut specific controller (SutController#execute_command)
+		# == params
+		# command:: MobyBase::CommandData descendant object defining the command
+		# == raises
+		# ?:: what ever SutController#execute_command( command ) raises
+		# == returns
+		# Boolean:: what ever SutController returns 
+		def execute_command( command )
+
+			@_sutController.execute_command( command )
+
+		end
+
+		# enable hooking for performance measurement & debug logging
+		MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+	end # SUT
+ 
+end # MobyBase

data/lib/tdriver/base/test_object/abstract.rb

@@ -0,0 +1,179 @@
+## 
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). 
+## All rights reserved. 
+## Contact: Nokia Corporation (testabilitydriver@nokia.com) 
+## 
+## This file is part of Testability Driver. 
+## 
+## 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 MobyBase
+
+	class TestObject
+
+		attr_reader(
+			:sut, 		# SUT associated to test object
+			:type, 		# test object type (from xml)
+			:id, 		# test object id (from xml)
+			:parent,	# parent test object
+			:name, 		# test object name (from xml)
+			:x_path		# xpath for test object, used when updating self with fresh ui dump
+		)
+
+		# Creation of a new TestObject requires a data object to be given to constructor
+		# === params
+		# factory:: TestObjectFactory used for creating test object for the sut this object is associated with
+		# sut:: SUT object that this test object is associated with
+		# xml_object:: REXML::Document object describing this test object
+		# === returns
+		# TestObject:: new TestObject instance
+		# === raises
+		def initialize( test_object_factory, sut, parent = nil, xml_object = nil )
+
+			# Initializes a test object by assigning it a test object factory and a sut and storing xml data 
+			# describing the object.
+			@test_object_factory = test_object_factory
+			@parent = parent
+			@sut = sut
+
+			#self.xml_data = xml_object if xml_object
+			method( :xml_data= ).call( xml_object ) if xml_object
+			
+		end
+
+		# Function to verify is DATA of two TestObjects are the same, 
+		# Defined in TestObject#== other_test_object
+		# === param
+		# other_test_object:: TestObject other, could be null
+		# === returns
+		# true:: if TestObjects have same DATA
+		# false:: if TestObjects have different DATA
+		# === raises
+		# nothing
+		def eql?( other_test_object )
+			self == other_test_object
+		end
+
+		# Function to verify is DATA of two TestObjects are the same, 
+		# return TRUE if other_test_object:
+		#   instance of MobyBase::TestObject
+		#   type's are equal
+		#   id's are equal
+		#   name's are equal
+		# == param
+		# other_test_object:: TestObject other, could be null
+		# == returns
+		# true:: if TestObjects have same DATA
+		# false:: if TestObjects have different DATA
+		# == raises
+		# nothing
+		def ==( other_test_object )
+
+			#return false unless other_test_object.instance_of?( MobyBase::TestObject ) 
+			#return false unless self.type == other_test_object.type
+			#return false unless self.id == other_test_object.id
+			#return false unless self.name == other_test_object.name
+			#return true
+
+			# optimized version			
+			other_test_object.instance_of?( MobyBase::TestObject ) && ( @type == other_test_object.type ) && ( @id == other_test_object.id ) && (@name == other_test_object.name )
+
+		end
+
+		# Function to calculate HASH value for a TestObject
+		# as required by, e.g. Set
+		#
+		# This is required, as eql? method is being overwritten.
+		# === returns
+		# Fixnum:: hash number representing current TestObject
+		def hash
+
+			#result = 17
+			#result = result * 37 + self.id.to_i
+			#result = result * 37 + type.hash
+			#result = result * 37 + name.hash
+			#return result
+
+			# optimized version
+			( ( ( 17 * 37 + @id.to_i ) * 37 + @type.hash ) * 37 + @name.hash )
+
+		end
+
+		# Function to support sorting TestObjects within an array.
+		# Mostly for unit testing purposes, as Set is not ordered.
+		# should not be used normally. Thus, not documented.
+		def <=>( other )
+
+			#self_type = self.type
+			#other_type = other.type
+			#return -1 if self_type < other_type
+			#return 1  if self_type > other_type
+
+			#self_name = self.name
+			#other_name = other.name
+			#return -1 if self_name < other_name
+			#return 1  if self_name > other_name
+
+			#self_id = self.id
+			#other_id = other.id
+			#return -1 if self_id < other_id
+			#return 1  if self_id > other_id
+
+			#0
+
+			# optimized version
+			( ( result = ( @type <=> other.type ) ) == 0 ? ( ( result = ( @name <=> other.name ) ) == 0 ? @id <=> other.id : result ) : result )  
+
+		end
+
+		# Function to be renamed, possibly refactored
+		def xml_data=( xml_object )
+
+=begin
+			@name, 
+			@x_path = 
+				xml_object.attribute( 'name' ), 
+				"%s/*//object[@type='%s' and @id='%s']" % [ 
+					@parent.x_path, 
+					@type = xml_object.attribute( 'type' ), 
+					@id = xml_object.attribute( 'id' ) 
+				]
+=end
+
+			@name, @x_path = xml_object.attribute( 'name' ), "#{ @parent.x_path }/*//object[@type='#{ @type = xml_object.attribute( 'type' ) }' and @id='#{ @id = xml_object.attribute( 'id' ) }']"
+
+		end
+
+		# Returns a XML node representing this test object.
+		#
+		# === returns
+		# LibXML::XML::Node:: XML representation of this test object
+		# === raises
+		# TestObjectNotFoundError:: The test object does not exist on the SUT any longer.
+		def xml_data()
+
+			#Kernel::raise MobyBase::TestObjectNotFoundError.new( 'The test object does not exist on the sut anymore.' ) if ( elements = @sut.xml_data.xpath( @x_path ) ).size.zero?
+
+			#Kernel::raise MobyBase::TestObjectNotFoundError.new( "The test object with id: \"#{ @id.to_s }\", type: \"#{ @type.to_s }\" and name: \"#{ @name.to_s }\" does not exist on sut \"#{ @sut.id.to_s }\" anymore" ) if ( elements = @sut.xml_data.xpath( @x_path ) ).size.zero?
+
+			Kernel::raise MobyBase::TestObjectNotFoundError.new( 'The test object (id: "%s", type: "%s", name: "%s") does not exist on sut (%s) anymore' % [ @id, @type, @name, @sut.id ]  ) if ( elements = @sut.xml_data.xpath( @x_path ) ).size.zero?
+
+			elements.first
+
+		end
+
+		# enable hooking for performance measurement & debug logging
+		MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+	end # TestObject 
+
+end # MobyBase