testability-driver 1.1.1 → 1.2.1

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

@@ -30,16 +30,32 @@ module MobyBase
       :type         # type of object ("SUT"), used when applying behaviour
     )
 
+	#added for now
+    attr_reader(
+	  :test_object_adapter
+	)
+
     # 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 )
+    def initialize( sut_controller, test_object_factory, sut_id, test_object_adapter = nil )
+
+      @sut_controller = sut_controller
+      
+      #@sut_controller.test_object_factory = test_object_factory
 
+      #@sut_controller.test_object_adapter = test_object_adapter || TDriver::TestObjectAdapter
+
+      # remove this line when possible
       @_sutController = sut_controller
+
+      # remove this line when possible
+      @test_object_factory = test_object_factory # @sut_controller.test_object_factory
       
-      @test_object_factory = test_object_factory || TDriver::TestObjectFactory.new( :test_object_adapter => TDriver::TestObjectAdapter )
+      # remove this line when possible
+      @test_object_adapter = test_object_adapter || TDriver::TestObjectAdapter #@sut_controller.test_object_adapter
       
       @id = sut_id
 
@@ -65,7 +81,7 @@ module MobyBase
     # Boolean:: what ever SutController returns 
     def execute_command( command )
 
-      @_sutController.execute_command( command )
+      @sut_controller.execute_command( command )
 
     end
 

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

@@ -23,33 +23,45 @@ module MobyBase
 
     attr_reader(
       :sut,     # SUT associated to test object
-      :type,     # test object type (from xml)
-      :id,     # test object id (from xml)
+      :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
+      :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
+    # Creation of a new TestObject requires options hash 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
+    # options:: Hash containing xml object describing the object and all other required configuration values e.g. test object factory, -adapter etc.
     # === returns
     # TestObject:: new TestObject instance
     # === raises
-    def initialize( test_object_factory, sut, parent = nil, xml_object = nil )
+    def initialize( options )
 
-      # 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
-      @object_behaviours = []
+      # verify that given argument is type of hash    
+      options.check_type Hash, 'wrong argument type $1 for TestObject#new (expected $2)'
 
-      #self.xml_data = xml_object if xml_object
-      method( :xml_data= ).call( xml_object ) if xml_object
-      
+      # verify that required keys is found from options hash and initialize the test object with these values.
+      @test_object_factory = options.require_key( :test_object_factory )
+      @test_object_adapter = options.require_key( :test_object_adapter )
+      @creation_attributes = options.require_key( :creation_attributes )
+
+      @sut = options.require_key( :sut )
+
+      @sut_id = @sut.instance_variable_get( :@id )
+
+      @parent = options.require_key( :parent )
+      @parent_application = options.require_key( :parent_application )
+
+      # apply xml object if given; test object type, id and name are retrieved from the xml 
+      self.xml_data = options[ :xml_object ] if options.has_key?( :xml_object )
+
+      # initialize cache object 
+      @child_object_cache = TDriver::TestObjectCache.new
+
+      # empty test object behaviours list
+      @object_behaviours = []
+ 
     end
 
     # Function to verify is DATA of two TestObjects are the same, 
@@ -110,7 +122,7 @@ module MobyBase
       # optimized version
       #( ( ( 17 * 37 + @id.to_i ) * 37 + @type.hash ) * 37 + @name.hash )
 
-      TDriver::TestObjectAdapter.test_object_hash( @id.to_i, @type, @name )
+      @test_object_adapter.test_object_hash( @id.to_i, @type, @name )
 
     end
 
@@ -144,7 +156,7 @@ module MobyBase
     # Function to be renamed, possibly refactored
     def xml_data=( xml_object )
 
-      @x_path, @name, @type, @id, @env = TDriver::TestObjectAdapter.get_test_object_identifiers( xml_object, self )
+      @x_path, @name, @type, @id, @env = @test_object_adapter.get_test_object_identifiers( xml_object, self )
 
     end
 
@@ -158,7 +170,7 @@ module MobyBase
 
       begin
       
-        TDriver::TestObjectAdapter.get_xml_element_for_test_object( self )
+        @test_object_adapter.get_xml_element_for_test_object( self )
 
       rescue MobyBase::TestObjectNotFoundError
       
@@ -179,6 +191,14 @@ module MobyBase
 
     end
     
+    private
+    
+    def sut_parameters
+      
+      $parameters[ @sut_id ]
+    
+    end
+    
     # enable hooking for performance measurement & debug logging
     TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
 

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

@@ -34,7 +34,7 @@ module TDriver
 
             # allow multiple values options for attribute, e.g. object which 'text' attribute value is either '1' or '2' 
             ( values.kind_of?( Array ) ? values : [ values ] ).collect{ | value |
-            
+
               # concatenate string if it contains single and double quotes, otherwise return as is
               value = xpath_literal_string( value )
 
@@ -71,7 +71,7 @@ module TDriver
             }.join( ' or ' ) # join attribute alternative values
                     
           }.join( ' and ' ) # join all required attributes
-                    
+
           # return created xpath or nil if no attributes given 
           if attributes.empty?
           
@@ -113,9 +113,24 @@ module TDriver
 
       # convert hash keys to downcased string
       rules = Hash[ 
+
         rules.collect{ | key, value | 
-          [ key.to_s.downcase, value.kind_of?( Regexp ) ? value : value.to_s ] 
+
+          case value
+
+            # pass the value as is if type of regexp or array; array is used in localisation cases e.g. [ 'one', 'yksi', 'uno' ] # etc
+            when Regexp, Array
+
+              [ key.to_s.downcase, value ] 
+
+          else
+
+              [ key.to_s.downcase, value.to_s ] 
+
+          end
+
         } 
+
       ]
 
       # xpath container array
@@ -236,12 +251,26 @@ module TDriver
     # Sort XML nodeset of test objects with layout direction
     def self.sort_elements( nodeset, layout_direction = 'LeftToRight' )
 
-      attribute_pattern = './attributes/attribute[@name="%s"]/value/text()'
+      # cache for x_absolute and y_absolute values; reduces dramatically number of xpath calls
+      cache = {}
+
+      # xpath pattern to be used for x_absolute attribute value
+      x_absolute_pattern = './attributes/attribute[@name="x_absolute"]/value/text()'
+
+      # xpath pattern to be used for x_absolute attribute value
+      y_absolute_pattern = './attributes/attribute[@name="y_absolute"]/value/text()'
 
       # collect only nodes that has x_absolute and y_absolute attributes
       nodeset.collect!{ | node |
 
-        if node.at_xpath( attribute_pattern % 'x_absolute' ).nil? || node.at_xpath( attribute_pattern % 'y_absolute' ).nil?
+        # retrieve x_absolute attribute
+        x_absolute = node.at_xpath( x_absolute_pattern )
+
+        # retrieve y_absolute attribute
+        y_absolute = node.at_xpath( y_absolute_pattern )
+
+        # return unmodified nodeset if both attributes was not found 
+        if x_absolute.nil? || y_absolute.nil?
 
           #warn("Warning: Unable to sort object set due to object type of #{ node.attribute( 'type' ).inspect } does not have \"x_absolute\" or \"y_absolute\" attribute")
 
@@ -249,6 +278,10 @@ module TDriver
 
         else
 
+          # store attributes to cache for further processing
+          cache[ node ] = [ x_absolute.content.to_i, y_absolute.content.to_i ]
+
+          # return node as result
           node
 
         end
@@ -256,12 +289,10 @@ module TDriver
       }.compact!.sort!{ | element_a, element_b |
 
         # retrieve element a's attributes x and y
-        element_a_x = element_a.at_xpath( attribute_pattern % 'x_absolute' ).content.to_i
-        element_a_y = element_a.at_xpath( attribute_pattern % 'y_absolute' ).content.to_i
+        element_a_x, element_a_y = cache[ element_a ]
 
         # retrieve element b's attributes x and y
-        element_b_x = element_b.at_xpath( attribute_pattern % 'x_absolute' ).content.to_i
-        element_b_y = element_b.at_xpath( attribute_pattern % 'y_absolute' ).content.to_i
+        element_b_x, element_b_y = cache[ element_b ]
 
         case layout_direction
         
@@ -650,6 +681,28 @@ module TDriver
 
     end
 
+    # TODO: document me
+    def self.list_test_objects_as_string( matches )
+
+      matches.collect{ | object |
+          
+        path = [ object.attribute( 'type' ) ]
+
+        while object.attribute( 'type' ) != 'application' do
+        
+          # object/objects/object/../..
+          object = object.parent.parent
+          
+          path << object.attribute( 'type' )
+        
+        end
+
+        path.reverse.join( '.' )
+      
+      }.sort
+    
+    end
+
     # enable hooking for performance measurement & debug logging
     TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
 

data/lib/tdriver/base/test_object/behaviours/syncronization.rb

@@ -53,7 +53,7 @@ module MobyBehaviour
 		#   description: Hash defining the set of attributes that the child test object must possess.
 		#   example: {:text=>'1'}
 		#
-		# timeout_secs
+		# timeout
 		#  Fixnum
 		#   description: Overriding the default synchronization timeout
 		#   example: 30
@@ -84,7 +84,7 @@ module MobyBehaviour
 		# MobyBase::SyncTimeoutError
 		#  description: Synchronization timed out (%i) before the defined child object could be found
 		#
-		def wait_child( attributes = {}, timeout_secs = 10, retry_interval = 0.5 )
+		def wait_child( attributes = {}, timeout = 10, retry_interval = 0.5 )
 
       # verify that attributes is type of Hash
       attributes.check_type( Hash, "Wrong argument type $1 for attributes (expected $2)" )
@@ -96,7 +96,7 @@ module MobyBehaviour
       attributes[ :type ].not_empty( "Attribute :type must not be empty" )
 
       # verify timeout type is numeric
-      timeout_secs.check_type( [ Integer, Fixnum, Float ], "Wrong argument type $1 for timeout (expected $2)" )
+      timeout.check_type( [ Integer, Fixnum, Float ], "Wrong argument type $1 for timeout (expected $2)" )
 
       # verify timeout type is numeric
       retry_interval.check_type( [ Integer, Fixnum, Float ], "Wrong argument type $1 for retry interval (expected $2)" )
@@ -109,7 +109,7 @@ module MobyBehaviour
         @test_object_factory.identify_object(
           :object_attributes_hash => attributes,
           :identification_directives => dynamic_attributes.default_values(
-            :__timeout => timeout_secs,
+            :__timeout => timeout,
             :__retry_interval => retry_interval,
             :__refresh_arguments => self.kind_of?( MobyBase::SUT ) ? attributes : { :id => self.get_application_id }
           ),
@@ -119,8 +119,12 @@ module MobyBehaviour
 			rescue MobyBase::TestObjectNotFoundError
 
 				# the child object was not found in the specified timeout
-				raise MobyBase::SyncTimeoutError, "Synchronization timed out (#{ timeout_secs }) before the defined child object could be found."
-
+				raise MobyBase::SyncTimeoutError, "Synchronization timed out (#{ timeout }) before the defined child object could be found."
+      
+      rescue MobyBase::ApplicationNotAvailableError
+        
+        raise
+      
       rescue # unexpected errors
 
 				raise RuntimeError, "Synchronization failed due to #{ $!.message } (#{ $!.class })"

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

@@ -99,9 +99,6 @@ module MobyBehaviour
     # attributes_hash = @test_app.Triangle( :name => 'Triangle1' ).attributes # retrieve all attribute for triangle object
     def attributes
 
-      # retrieve sut parameters
-      sut_parameters = $parameters[ @sut.id ]
-
       # retrieve sut attribute filter type
       filter_type = sut_parameters[ :filter_type, 'none' ] 
 
@@ -145,7 +142,7 @@ module MobyBehaviour
       end
 
       # return hash of test object attributes
-      TDriver::TestObjectAdapter.test_object_attributes( _xml_data )
+      @test_object_adapter.test_object_attributes( _xml_data )
 
     end
 
@@ -206,10 +203,10 @@ module MobyBehaviour
       @sut.refresh if disable_optimizer
 
       # retrieve parent of current xml element; objects/object/objects/object/../..
-      parent_element = TDriver::TestObjectAdapter.parent_test_object_element( self )
+      parent_element = @test_object_adapter.parent_test_object_element( self )
 
       # retrieve parent element attributes
-      parent_attributes = TDriver::TestObjectAdapter.test_object_element_attributes( parent_element )
+      parent_attributes = @test_object_adapter.test_object_element_attributes( parent_element )
 
       if self.get_application_id && parent_attributes[ 'type' ] != 'application'
 
@@ -253,9 +250,20 @@ module MobyBehaviour
     # @sut.refresh might have a side effect that changes the @_active instance variable.
     # === raises
     # TestObjectNotFoundError:: if TestObject is not identified within synch timeout.
-    def refresh( refresh_args = {} )
+    def refresh( refresh_args = nil )
+
+      refresh_args = @creation_attributes if refresh_args.nil?
+
+      refresh_args.check_type Hash, "wrong argument type $1 for #{ application? ? 'application' : 'test object' } refresh attributes (expected $2)"
+
+      @sut.refresh( 
+
+        refresh_args, @test_object_factory.make_object_search_params( parent, @creation_attributes )
+
+      )
 
-      @sut.refresh( refresh_args, @test_object_factory.make_object_search_params( parent, @creation_attributes ) )
+      # update childs if required, returns true or false
+      update( xml_data )
 
     end
 
@@ -269,7 +277,9 @@ module MobyBehaviour
     # @sut.force_refresh might have a side effect that changes the @_active instance variable.
     # === raises
     # TestObjectNotFoundError:: if TestObject is not identified within synch timeout.
-    def force_refresh( refresh_args = {} )
+    def force_refresh( refresh_args = nil )
+
+      refresh_args = @creation_attributes if refresh_args.nil?
 
       refresh( refresh_args )
 
@@ -332,22 +342,30 @@ module MobyBehaviour
      end
 
     # == description
-    # Returns a StateObject containing the current state of this test object as XML.
-    # The state object is static and thus is not refreshed or synchronized etc.
+    # Returns a StateObject containing the current state of this test object as XML. The state object is static and thus is not refreshed or synchronized etc.
+    #
     # == returns
     # StateObject
     #  description: State of this test object
     #  example: -
+    #
     # == exceptions
     # ArgumentError
     #  description: If the xml source for the object cannot be read
-    # == example
-    # app_state = @sut.application( :name => "calculator" ).state #get the state object for the app
-    # button_state = app_state.Button( :text => "Backspace" ) #get the state for test object button
-    # button_text = button_state.attribute( "text" ) #get attribute text from the button state object
-    def state
+    def state_object
 
-      MobyBase::StateObject.new( xml_data, self )
+      # == example
+      # app_state = @sut.application( :name => "calculator" ).state #get the state object for the app
+      # button_state = app_state.Button( :text => "Backspace" ) #get the state for test object button
+      # button_text = button_state.attribute( "text" ) #get attribute text from the button state object
+
+      MobyBase::StateObject.new( 
+
+        :source_data => xml_data, 
+        :parent => self,
+        :test_object_adapter => @test_object_adapter
+
+      )
 
     end
 
@@ -433,16 +451,16 @@ module MobyBehaviour
       attributes[ :type ] = '*' if attributes.select{ | key, value | key.to_s !~ /^__/ ? true : false }.empty?
 
       # children method specific settings
-      attributes.merge!( :__multiple_objects => true, :__find_all_children => find_all_children )
+      attributes.merge!( :__multiple_objects => true, :__find_all_children => find_all_children, :__no_caching => true )
 
       # disable optimizer state if enabled
-      disable_optimizer
+      #disable_optimizer -> leave it on, tuukka if breaks take it back...
 
       # retrieve child objects
       result = get_child_objects( attributes )
 
       # restore optimizer state if it was enabled
-      enable_optimizer
+      #enable_optimizer
 
       # return results
       result
@@ -466,7 +484,7 @@ module MobyBehaviour
       begin
 
         # find object from new xml data
-        _xml_data, unused_rule = TDriver::TestObjectAdapter.get_objects( xml_document, { :type => @type, :id => @id, :name => @name }, true )
+        _xml_data, unused_rule = @test_object_adapter.get_objects( xml_document, { :type => @type, :id => @id, :name => @name }, true )
                         
         # deactivate if test object not found or multiple matches found
         raise unless _xml_data.count == 1 
@@ -488,11 +506,14 @@ module MobyBehaviour
             # remove cached behaviour module 
             MobyBase::BehaviourFactory.instance.reset_modules_cache
 
+            # apply only application behaviours if test object is type of 'application'
+            object_type = ( @type == "application" ? [ @type ] : [ '*', @type ] )
+
             # reapply behaviours to test object if environment value has changed
             MobyBase::BehaviourFactory.instance.apply_behaviour!(
 
               :object => self,
-              :object_type => [ '*', @type ], 
+              :object_type => object_type, 
               :input_type => [ '*', @sut.input.to_s ],
               :env => [ '*', *@env.to_s.split(";") ],
               :version => [ '*', @sut.ui_version.to_s ]
@@ -524,8 +545,6 @@ module MobyBehaviour
     # TODO: document me
     def disable_optimizer
 
-      sut_parameters = $parameters[ @sut.id ]
-
       # disable optimizer for this call since it will not work
       @_enable_optimizer = false
 
@@ -544,7 +563,7 @@ module MobyBehaviour
     # TODO: document me
     def enable_optimizer
 
-      $parameters[ @sut.id ][ :use_find_object ] = 'true' if @_enable_optimizer
+      sut_parameters[ :use_find_object ] = 'true' if @_enable_optimizer
 
       @_enable_optimizer = false
 
@@ -561,7 +580,7 @@ module MobyBehaviour
       rules_hash = {} unless rules_hash.kind_of?( Hash ) 
 
       # set test object type
-      rules_hash[ :type ] = method_id #.to_s
+      rules_hash[ :type ] = method_id.to_s
   
       begin
 
@@ -753,13 +772,13 @@ module MobyBehaviour
 
       refresh_args = ( attributes[ :type ] == 'application' ? { :name => attributes[ :name ], :id => attributes[ :id ] } : { :id => get_application_id } )
 
-      refresh( refresh_args)
+      refresh( refresh_args )
 
       begin
 
         @parent.child( :type => @type, :id => @id )
 
-      rescue MobyBase::TestObjectNotFoundError => exception
+      rescue MobyBase::TestObjectNotFoundError
 
         Kernel::raise MobyBase::TestObjectNotVisibleError
 
@@ -809,8 +828,14 @@ module MobyBehaviour
 
             end
 
-            #lets refresh if attribute not found on first attempt
-            refresh( refresh_args )
+            #refresh( refresh_args )
+
+            # lets refresh if attribute not found on first attempt
+            @sut.refresh( 
+
+              refresh_args, @test_object_factory.make_object_search_params( parent, @creation_attributes )
+
+            )
 
             # retrieve updated xml data
             _xml_data = xml_data
@@ -818,18 +843,16 @@ module MobyBehaviour
           end
 
           # raise eception if xml data is empty or nil
-          Kernel::raise MobyBase::TestObjectNotInitializedError.new if _xml_data.nil? || _xml_data.to_s.empty?
+          raise MobyBase::TestObjectNotInitializedError.new if _xml_data.nil? || _xml_data.to_s.empty?
 
           begin
           
             # retrieve attribute(s) from test object; never access ui state xml data directly from behaviour implementation
-            TDriver::TestObjectAdapter.test_object_attribute( _xml_data, name )
+            @test_object_adapter.test_object_attribute( _xml_data, name )
 
           rescue MobyBase::AttributeNotFoundError
           
-            Kernel::raise MobyBase::AttributeNotFoundError.new(
-              "Could not find attribute #{ name.inspect } for test object of type #{ @type.to_s }"
-            )
+            raise MobyBase::AttributeNotFoundError, "Could not find attribute #{ name.inspect } for test object of type #{ @type.to_s }"
 
           end
 
@@ -855,20 +878,19 @@ module MobyBehaviour
 
     end
 
-    # this method will be automatically invoked after module is extended to sut object  
+    # this method will be automatically invoked after module is extended to target object
     def self.extended( target_object )
 
       target_object.instance_exec{ 
       
-        # initialize cache object 
-        @child_object_cache = TDriver::TestObjectCache.new
-      
-        @parent_application = nil
-      
         # defaults
-        @_application_id = nil
-        @creation_attributes = nil
-        @_active = true
+        @_application_id ||= nil
+
+        @creation_attributes ||= nil
+
+        @_active ||= true
+
+        @parent_application ||= nil
         
       }
 
@@ -883,7 +905,7 @@ module MobyBehaviour
     # == description
     # This method is deprecated, please use TestObject#parent
     #
-    def parent_object()
+    def parent_object
 
       # == description
       # Returns the actual test object that was used as the parent when this object instance was created. 
@@ -892,13 +914,28 @@ module MobyBehaviour
       #
       # == returns
       # TestObject:: 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)
-
-      $stderr.puts "warning: TestObject#parent_object is deprecated, please use TestObject#parent instead."      
+  
+      warn_caller '$1:$2 warning: TestObject#parent_object is deprecated, please use TestObject#parent instead.'
 
       @parent
 
     end
 
+    # This method is deprecated, please use [link="#GenericTestObject:state_object"]TestObject#state_object[/link] instead.
+    # == deprecated
+    # 1.1.1
+    #
+    # == description
+    # This method is deprecated, please use TestObject#state_object
+    #
+    def state
+
+      warn_caller '$1:$2 warning: deprecated method TestObject#state; please use TestObject#state_object instead'
+
+      state_object
+
+    end
+
     # enable hooking for performance measurement & debug logging
     TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )