cutedriver-driver 2.0.0.20210120164037

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

@@ -0,0 +1,46 @@
+############################################################################
+## 
+## 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__ ), 'abstract.rb' ) )
+
+# factory class
+#require File.expand_path( File.join( File.dirname( __FILE__ ), 'factory.rb' ) )
+
+[
+  # behaviour abstract class
+  'abstract.rb',
+
+  # behaviour factory class
+  'factory.rb'
+
+].each{ | filename |
+
+  require File.expand_path( 
+    File.join( File.dirname( __FILE__ ), filename ) 
+  )
+
+}
+
+# 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,29 @@
+############################################################################
+## 
+## 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
+  'command_data.rb'
+
+].each{ | filename |
+
+  require File.expand_path( File.join( File.dirname( __FILE__ ), filename ) )
+
+}

data/lib/tdriver/base/controller/abstraction.rb

@@ -0,0 +1,56 @@
+############################################################################
+## 
+## 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 Abstraction
+
+    # TODO: document me
+    def set_adapter( adapter )
+  
+      @sut_adapter = adapter
+  
+    end           
+
+		# Execute the command(s). Sends output generated by make_message to the device using the @sut_adapter (see base class)     
+		# == params
+		# == returns
+		# == raises
+		def execute
+
+			@sut_adapter.send_service_request( 
+			
+			  *make_message
+
+      )
+
+		end
+
+  private
+  
+    # TODO: document me
+    def make_message
+
+      raise NotImplementedError, "controller not implemented for #{ self.class.name }"
+    
+    end
+  
+  end # Abstraction
+
+end # MobyController

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

@@ -0,0 +1,21 @@
+############################################################################
+## 
+## 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 controller abstraction class etc.
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'abstraction.rb' ) )

data/lib/tdriver/base/errors.rb

@@ -0,0 +1,134 @@
+############################################################################
+## 
+## 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 )
+			raise error
+		end
+
+		# enable hooking for performance measurement & debug logging
+		TDriver::Hooking.hook_methods( self ) if defined?( TDriver::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;
+	class ContinuousVerificationError < MobyStandardError; 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
+
+	# TODO: document
+	class ApplicationNotAvailableError < MobyStandardError; end;
+
+end # MobyBase

data/lib/tdriver/base/loader.rb

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

data/lib/tdriver/base/state_object.rb

@@ -0,0 +1,373 @@
+############################################################################
+## 
+## 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::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
+
+    # TODO: document me
+    attr_reader(
+        :type,      # object type
+        :name,      # object name
+        :id         # object id
+    )
+
+    # Creation of a new StateObject from source data.
+    # === params
+    # options:: Hash containing source data describing the object and all other required configuration values e.g. test object factory, -adapter etc.
+    # === returns
+    # StateObject:: new StateObject instance
+    # === raises
+    def initialize( *options )
+
+      # clone original options array; array is modified below
+      options = options.clone
+
+      # determine is method called with new or deprecated API
+      
+      if options.count == 1 and options.first.kind_of?( Hash )
+
+        # retrieve first array element
+        options = options.shift
+
+        # verify options argument type
+        options.check_type Hash, 'wrong argument type $1 for StateObject options (expected $2)'
+
+        # verify that :source_data key exists in hash       
+        source_data = options.require_key :source_data
+
+        # retrieve reference to parent object
+        parent = options[ :parent ]
+
+        # retrieve reference to test object adapter
+        test_object_adapter = options[ :test_object_adapter ]
+      
+      else
+      
+        # print warning if deprecated API is used
+        warn_caller '$1:$2 warning: deprecated API; use hash with :source_data, :parent, :test_object_adapter as argument instead of StateObject.new( source_data, parent, test_object_adapter )'
+
+        # retrieve source data
+        source_data = options.shift
+
+        # retrieve reference to parent object
+        parent = options.shift
+
+        # retrieve reference to test object adapter
+        test_object_adapter = options.shift
+
+      end
+
+      # verify that parent argument type is correct
+      parent.check_type [ NilClass, MobyBase::StateObject, MobyBase::TestObject, MobyBase::SUT ], 'wrong argument type $1 for parent object (expected $2)'
+
+      # verify that test object adapter argument type is correct
+      test_object_adapter.check_type [ NilClass, Class ], 'wrong argument type $1 for test object adapter (expected $2)'
+
+      # verify that source data argument type is correct
+      source_data.check_type [ String, MobyUtil::XML::Element ], 'wrong argument type $1 for source data (expected $2)'
+
+      # parse source data if given argument is type of string
+      source_data = MobyUtil::XML.parse_string( source_data ).root if source_data.kind_of?( String )
+
+      # store reference to parent object
+      @parent = parent
+
+      # store reference to test object adapter
+      if test_object_adapter.nil?
+
+        if @parent.kind_of?( MobyBase::SUT )
+
+          @test_object_adapter = @parent.instance_variable_get( :@test_object_adapter )
+
+        else
+
+          # Load the new xml only, so old is not supported
+          @test_object_adapter = TDriver::OptimizedXML::TestObjectAdapter
+
+        end
+
+      else
+
+        @test_object_adapter = test_object_adapter
+
+      end
+
+      # retrieve object attributes
+      method( :xml_data= ).call( source_data )
+
+      # initialize child objects cache for state object
+      @child_object_cache = TDriver::TestObjectCache.new
+
+      # create accessor methods for any child state objects.
+      @test_object_adapter.create_child_accessors!( source_data, 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 )
+
+      rules_hash = method_arguments.first
+
+      rules_hash = Hash.new unless rules_hash.kind_of? Hash
+
+      rules_hash[ :type ] = method_id 
+
+      begin
+
+        return child( rules_hash )
+
+      rescue MobyBase::TestObjectNotFoundError, MobyBase::TestObjectNotVisibleError
+
+        rules_hash_clone = rules_hash.clone
+        
+        rules_hash_clone.delete( :type )
+
+        # string representation of used rule hash
+        search_attributes_string = rules_hash_clone.collect{ | key, value | ":#{ key } => #{ value.inspect }" }.join( ', ')
+
+        # construct literal representation of object identifiers        
+        object_attributes = []        
+        object_attributes << "id: #{ @id }" if @id
+        object_attributes << "type: #{ @type.inspect }" if @type
+        object_attributes << "name: #{ @name.inspect }" if @name
+        
+        if search_attributes_string.empty?
+        
+          # do not show any attribute details if none given                
+          search_attributes_string = ""
+          
+        else
+  
+          # show used attributes      
+          search_attributes_string = " (attributes #{ search_attributes_string })"
+
+        end
+
+        # raise exception
+        raise MobyBase::TestObjectNotFoundError.new(
+          "The state object (#{ object_attributes.join(", ") }) has no child object with type or behaviour method with name #{ method_id.to_s.inspect }#{ search_attributes_string }" 
+        )
+
+      end
+
+    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 ==( test_object )
+
+      # optimized version
+      test_object.instance_of?( MobyBase::StateObject ) && ( @type == test_object.type ) && ( @id == test_object.id ) && ( @name == test_object.name )
+
+    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
+
+
+    # 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
+            
+      unused_xpath, @name, @type, @id = @test_object_adapter.get_test_object_identifiers( xml_object )
+      
+    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 )
+
+      # check argument variable type
+      name.check_type( String, "wrong argument type $1 for attribute name (expected $2)" )
+
+      begin
+
+        # retrieve attribute(s) from test object; never access ui state xml data directly from behaviour implementation
+        @test_object_adapter.test_object_attribute( @_xml_data, name.to_s )
+
+      rescue MobyBase::AttributeNotFoundError
+      
+        raise MobyBase::AttributeNotFoundError, "Could not find attribute '#{ name.to_s }' for state object of type '#{ type.to_s }'"
+        
+      end
+
+    end
+
+    def get_cached_test_object!( object )
+
+      if @child_object_cache.has_object?( object ) 
+
+        object = @child_object_cache[ object ]
+
+        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 )
+
+      get_objects( attributes, false )
+
+    end
+
+    # TODO: document me
+    def children( attributes )
+
+      get_objects( attributes, true )
+    
+    end
+    
+    # TODO: document me
+    def inspect
+
+      "#<#{ self.class }:0x#{ ( "%x" % ( object_id.to_i << 1 ) )[ 3 .. -1 ] } @id=#{ @id.inspect } @type=\"#{ @type }\" @name=\"#{ @name }\">"
+
+    end
+
+  private
+  
+    def get_objects( attributes, multiple_objects )
+    
+      rules = attributes.clone
+
+      # strip dynamic attributes from rules hash
+      dynamic_attributes = rules.strip_dynamic_attributes!
+
+      # retrieve application object from sut.xml_data
+      matches, unused_rule = @test_object_adapter.get_objects( @_xml_data, rules, true )
+
+      if matches.count == 0
+
+        # raise exception if no matches found
+        raise MobyBase::TestObjectNotFoundError 
+
+      elsif matches.count > 1 and multiple_objects == false and dynamic_attributes.has_key?( :__index ) == false
+
+        # raise exception if multiple maches found      
+        raise MobyBase::MultipleTestObjectsIdentifiedError, "Multiple objects found with attributes #{ attributes.inspect }"
+
+      end
+
+      # fetch matches, use index if given
+      matches = [ matches[ dynamic_attributes[ :__index ] || 0 ] ] unless multiple_objects
+      
+      # create state objects
+      matches = matches.collect{ | object_xml |
+
+        result = StateObject.new( 
+          :source_data => object_xml, 
+          :parent => self,
+          :test_object_adapter => @test_object_adapter
+        )
+        
+        # use cached state object if once already retrieved
+        get_cached_test_object!( result ).tap{ | found_in_cache |
+
+          # add child to objects cache 
+          @child_object_cache.add_object( result ) unless found_in_cache
+
+        }
+      
+        # pass result object to array
+        result
+                
+      }
+
+      # return results      
+      multiple_objects ? matches : matches.first
+        
+    end
+
+    # enable hooking for performance measurement & debug logging
+    TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
+
+  end # StateObject 
+
+end # MobyBase