testability-driver 0.9.2

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

@@ -0,0 +1,28 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+
+
+
+# behaviour abstract class
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'behaviour' ) )
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'factory' ) )
+
+# load generic behaviours
+MobyUtil::FileHelper.load_modules( File.expand_path( File.join( File.dirname( __FILE__ ), 'behaviours' ) ) )

data/lib/tdriver/base/command_data/command_data.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 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 to represent Controller interface
+
+	class CommandData
+
+		def initialize
+		end
+
+		def set_application_uid( id )
+			@_application_id = id
+		end
+
+		def get_application_id
+			@_application_id = "" unless @_application_id
+			@_application_id
+		end
+
+		def set_sut( sut )
+			@_sut = sut
+		end
+
+		def get_sut( sut )
+			@_sut
+		end
+
+	end
+
+end # module

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

@@ -0,0 +1,25 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+
+
+
+# command_data abstract class
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'command_data' ) )
+

data/lib/tdriver/base/errors.rb

@@ -0,0 +1,131 @@
+############################################################################
+## 
+## 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 Error
+
+		@@errors = {
+			:WrongArgumentType => {:type => "ArgumentError", :text => "Wrong argument type %s (Expected %s)"},
+			:WrongArgumentTypeFor => {:type => "ArgumentError", :text => "Wrong argument type %s for %s (Expected %s)"},
+			:ArgumentSymbolExpected => {:type => "ArgumentError", :text => "Symbol %s expected in argument(s)"}, 
+			:InvalidStringLengthFor => {:type => "ArgumentError", :text => "Invalid string length (%i) for %s (Expected %s)"},
+			:BehaviourErrorOccured => {:type => "RuntimeError", :text => "%s method failed with message: %s. Debug info: %s"}
+		}
+
+		def self.raise( error_id, *params )
+
+			if @@errors.has_key?( error_id )
+
+				error_type = eval(@@errors[ error_id ][ :type ])
+				error_text = @@errors[ error_id ][ :text ]
+
+				# Replace %s to given parameters
+				message = error_text.gsub( /\%[-]*\d*[disxX]/ ) { | match | ( params.size > 0 ) ? "#{ match }" % params.shift : match }
+
+			else
+
+				# Raise ArgumentError if given id is not defined in @@error_base hash table
+				error_type = ArgumentError
+				message = "No error found for ID '%s' (Parameters: %s)" % [ error_id, params.join( ", " ) ]
+
+			end
+
+			error = error_type.new( message )
+			Kernel::raise error
+		end
+
+		# enable hooking for performance measurement & debug logging
+		MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+	end
+
+	# TODO: document
+	class MobyStandardError < StandardError
+		# Construct a new error, optionally passing in a message
+		def initialize ( message = nil ); super( message ); end
+	end
+
+	# TODO: document
+	class TestObjectNotVisibleError < MobyStandardError; end;
+
+	# TODO: document
+	class TestObjectNotFoundError < MobyStandardError; end;
+
+	# TODO: document
+	class MultipleTestObjectsIdentifiedError < MobyStandardError; end;
+
+	# TODO: document
+	class MultipleAttributesFoundError < MobyStandardError; end;
+
+	# TODO: document
+	class AttributeNotFoundError < MobyStandardError; end;
+
+	# TODO: document
+	class TestObjectNotInitializedError < MobyStandardError; end;
+
+	# TODO: document
+	class FileNotFoundError < MobyStandardError; end;
+
+	# TODO: document
+	class TestObjectIdentificatorError < MobyStandardError; end;
+
+	#Raised when a method is called with an invalid parameter(eg. wrong type, impossible value, nil)
+	class InvalidParameterError < MobyStandardError; end;
+
+	# This error should be raised when verification results were not as expected
+	class VerificationError < MobyStandardError; end;
+
+	# This verification error should overwrite standard verification procedure and
+	# fail immediately
+	class ContinuousVerificationError < VerificationError; end;
+
+	# This error should be raised to indicate that a synchronization timeout has elapsed without 
+	# synchronization conditions having been met.
+	class SyncTimeoutError < MobyStandardError; end;
+
+	class ControllerError < MobyStandardError; end; #def initialize ( msg = nil ); super( msg ); end; end # class
+
+	class ControllerNotFoundError < MobyStandardError; end;
+
+	class CommandNotFoundError < MobyStandardError; end
+
+
+	# TODO: document
+	class MobyCustomError < StandardError
+		attr_reader :message
+		def initialize( message = "" )
+			# get backtrace from error
+			tmp_trace = ( ( $!.nil? ) ? [] : $!.backtrace ) 
+			# add caller method to backtrace
+			set_backtrace( ( ( caller( 2 ).nil? ) ? tmp_trace : tmp_trace.unshift( caller( 2 ).first[ /(.+):in/, 1 ] ) ) )
+			@message = message << ( $!.nil? ? "" : ". Exception: #{ $!.message }" )
+			super
+		end
+	end
+
+	# TODO: document
+	class BehaviourError < MobyCustomError
+		def initialize ( method_name = nil, description = nil )
+			super( "%s failed. %s" % [ method_name, description ] )
+		end
+	end
+
+end # MobyBase

data/lib/tdriver/base/loader.rb

@@ -0,0 +1,38 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+
+# behaviour abstraction class, factory and all other related modules etc
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'behaviour/loader' ) )
+
+# command_data abstraction class etc.
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'command_data/loader' ) )
+
+# sut abstract class, generic sut etc
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'sut/loader' ) )
+
+# error classes
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'errors' ) )
+
+# test object abstraction, factory, identificator behaviours and all other related modules
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'test_object/loader' ) )
+
+# state object
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'state_object' ) )
+

data/lib/tdriver/base/state_object.rb

@@ -0,0 +1,270 @@
+############################################################################
+## 
+## 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
+
+	# Static representation of the state of a TestObject or SUT. 
+	# StateObject are not refreshed or synchronize etc.
+	class StateObject
+
+		#include MobyBehaviour::TestObjectComposition
+		include MobyBehaviour::ObjectComposition
+
+		# The test object factory is needed for populating child object accessor methods
+		#@test_object_factory
+
+		# == description
+		# attr_accessor
+		#
+		# == returns
+		# Test Object
+		#  description: test object that was used as parent when this object was created. Can also be of type SUT if sut was the parent (ie. application objects)
+		#  example: "@sut"
+		attr_accessor :parent
+
+		# Creates a new StateObject from XML source data.
+		#
+		# === params
+		# xml_source:: MobyUtil::XML::Element or String. Contains the root element of this state.
+		# parent:: TestObject, SUT or StateObject. Parent of this state object. Must be of type TestObjectComposition. 
+		# === returns
+		# StateObject:: New StateObject
+		def initialize( xml_source, parent = nil )
+
+			xml_element = nil
+
+			if xml_source.kind_of?( MobyUtil::XML::Element )
+
+				xml_element = xml_source
+
+			elsif xml_source.kind_of?( String )
+
+				xml_element = MobyUtil::XML.parse_string(xml_source).root
+
+			else
+
+				Kernel::raise ArgumentError.new("The XML source must be a String or MobyUtil::XML::Element, it was of type '#{ xml_source.class.to_s }'.")
+
+			end
+
+			@parent = nil
+			add_parent( parent ) unless parent.nil?
+
+			self.xml_data= xml_element
+
+			@_child_object_cache = {}
+
+			# Create accessor methods for any child state objects.
+			TestObjectFactory.instance.create_child_accessors!( self )
+
+		end
+
+		# Tries to use the missing method id as a child object type and find an object based on it
+		def method_missing( method_id, *method_arguments )
+
+			hash_rule = method_arguments.first
+
+			# method mapping/aliases
+			case method_id
+
+				when :Button;	
+					method_id = [ :Button, :QToolButton, :DuiButton, :HbPushButton, :softkey ]
+
+				when :List;	
+					method_id = [ :QList, :HbListWidgetView, :DuiList ]
+
+			end
+
+			hash_rule = Hash.new unless hash_rule.kind_of? Hash
+			hash_rule[ :type ] = method_id 
+
+			begin
+
+				return child( hash_rule )
+
+			rescue MobyBase::TestObjectNotFoundError, MobyBase::TestObjectNotVisibleError
+
+				hash_rule.delete(:type)
+
+				raise MobyBase::TestObjectNotFoundError.new(
+					"The state object with id: \"#{ self.id.to_s }\", type: \"#{ self.type.to_s }\" and name: \"#{ self.name.to_s }\" has no child object of type \"#{ method_id.inspect.to_s }\"" << 
+					( hash_rule.empty? ? "" : " attributes: #{ hash_rule.inspect },")) 
+			end
+
+		end
+
+
+		# Check to StateObject objects for equality (ie. contents, not if they are the same object).
+		# === param
+		# other_state_object:: StateObject this object is compared to.
+		# === returns
+		# true:: other_state_object is equal to this StateObject.
+		# false:: other_state_object is not equal to this StateObject.
+		def eql? (other_state_object)
+			self == other_state_object
+		end
+
+
+		# Verifies that another StateObject contains the same data as this object.
+		# type, id and name must match.
+		#
+		# == param
+		# other_state_object:: StateObject that this object is compared to.
+		# == returns
+		# true:: The other StateObject contains the same data as this one.
+		# false:: The other StateObject does notcontain the same data as this one.
+		# == raises
+		# nothing
+		def == (other_state_object)
+			return false unless other_state_object.instance_of?( MobyBase::StateObject ) 
+			return false unless self.type == other_state_object.type
+			return false unless self.id == other_state_object.id
+			return false unless self.name == other_state_object.name
+			return true
+		end
+
+
+		# Function to return type of the state object
+		# === returns
+		# type:: String value of the type
+		def type()
+			@type
+		end
+
+		# Function to return name of the state object
+		# === returns
+		# name String value of the name
+		def name()
+			@name
+		end
+
+		# Function to return id of the state object
+		# === returns
+		# id String value of the id
+		def id()
+			@object_id
+		end
+
+		# Sets the XML content of this state object. Also sets identification attributes based
+		# on the contents of the XML.
+		#
+		# === params
+		# xml_object:: MobyUtil::XML::Element. State as XML.
+		def xml_data=( xml_object ) 
+			@_xml_data = xml_object
+			@name = xml_object.attribute( 'name' )
+			@type = xml_object.attribute( 'type' )
+			@object_id = xml_object.attribute( 'id' )
+		end
+
+		# Returns a XML element representing this state object.
+		#
+		# === returns
+		# MobyUtil::XML::Element:: XML representation of this state object 
+		def xml_data()
+
+			@_xml_data
+
+		end
+
+		# Function provides access to parameters of the state object 
+		# === params
+		# name:: String defining the name of the attribute to get
+		# === returns
+		# String:: Value of the attribute as a string
+		# === raises
+		# ArgumentError:: name is not a String.
+		# AttributeNotFoundError:: if the requested attribute can not be found in the xml data of the object
+		def attribute( name )
+
+			# store xml_data to temp. variable
+			_xml_data = @_xml_data
+
+			Kernel::raise ArgumentError.new( "Wrong argument type %s for attribute argument (expected String)" % name.class ) unless name.class == String
+
+			Kernel::raise MobyBase::AttributeNotFoundError.new("Could not find attribute '#{ name.to_s }' for state object of type '#{ type.to_s }'.") if ( 
+				elements = _xml_data.xpath(
+					"attributes/attribute[translate(@name,'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')='#{ name.to_s.downcase }']"
+				) 
+			).size == 0 
+
+			elements.first.content.strip
+
+		end
+
+		def get_cached_test_object!( object )
+
+			object_hash = object.hash
+
+			if @_child_object_cache.has_key?( object_hash ) 
+
+				object = @_child_object_cache[ object_hash ]
+
+				true
+
+			else
+
+				false
+
+			end
+
+		end
+
+		# Creates a state object for a child object of this state object
+		# Associates child object as current object's child.
+		# and associates self as child object's parent.
+		#
+		# NOTE:
+		# Subsequent calls to #child always returns reference to same child
+		# === params
+		# attributes:: Hash object holding information for identifying which child to create, eg. :type => :slider
+		# === returns
+		# StateObject:: new child state object or reference to existing child
+		def child( attributes )
+
+			identified_object_xml = MobyBase::TestObjectIdentificator.new( attributes ).find_object_data( @_xml_data )
+
+			child_object = StateObject.new( identified_object_xml, self )
+
+			# use cached test object if once already retrieved
+			get_cached_test_object!( child_object ).tap{ | found_in_cache |
+
+				# add child to objects cache 
+				add_child( child_object ) unless found_in_cache
+
+			}
+
+			child_object
+
+		end
+
+		def inspect 
+
+			"#{ self.to_s }\nName: #{ self.name.to_s } Type: #{ self.type.to_s } Id: #{ self.id.to_s }"
+
+		end
+
+		# enable hooking for performance measurement & debug logging
+		MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+
+	end # StateObject 
+
+end # MobyBase