testability-driver 1.3.0 → 1.3.1

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

@@ -65,18 +65,18 @@ module MobyBehaviour
 		#
 		# == returns
 		# MobyBase::TestObject
-		#  description: Returns self
+		#  description: Returns receiver object of this method, not the found object 
 		#  example: - 
 		#
 		# == exceptions
 		# TypeError
-		#  description: Wrong argument type %s for attributes (expected Hash)
+		#  description: Wrong argument type <class> for attributes (expected Hash)
 		#
 		# TypeError
-		#  description: Wrong argument type %s for attribute :type (expected String)
+		#  description: Wrong argument type <class> for attribute :type (expected String)
 		#
 		# TypeError
-		#  description: Wrong argument type %s for timeout (expected Integer, Fixnum or Float)
+		#  description: Wrong argument type <class> for timeout (expected Integer, Fixnum or Float)
 		#
 		# ArgumentError
 		#  description: Argument retry_interval was not a valid. Expected: Integer, Fixnum or Float
@@ -111,11 +111,12 @@ module MobyBehaviour
           :identification_directives => dynamic_attributes.default_values(
             :__timeout => timeout,
             :__retry_interval => retry_interval,
-            :__refresh_arguments => self.kind_of?( MobyBase::SUT ) ? attributes : { :id => self.get_application_id }
+            :__refresh_arguments => self.kind_of?( MobyBase::SUT ) ? attributes : { :id => self.get_application_id },
+            :__parent_application => self.sut? == true ? nil : @parent_application 
           ),
           :parent => self        
         )
-
+        
 			rescue MobyBase::TestObjectNotFoundError
 
 				# the child object was not found in the specified timeout

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

@@ -51,6 +51,17 @@ module MobyBehaviour
     #  example: { :name => 'Triangle1', :type => :Triangle }
     attr_accessor :creation_attributes
 
+=begin
+    # == description
+    # Returns the actual test object that was used as the parent when this object instance was created
+    #
+    # == returns
+    # TestObject
+    #   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: -
+    attr_reader :parent
+=end
+
 =begin
     # == nodoc
     # == description
@@ -189,7 +200,7 @@ module MobyBehaviour
 
     # == description
     # Returns the parent test object for the current object in question, according to the UI object hierarchy. For getting the test object that was actually used 
-    # as the parent when the test object instance was created, see parent_object.
+    # as the parent when the test object instance was created, see [link="#GenericTestObject:parent"]parent[/link] method.
     # == returns
     # TestObject
     #   description: test object that is parent of this test object, self if no parent (ie. application objects)
@@ -419,7 +430,7 @@ module MobyBehaviour
     #
     # == exceptions
     # TypeError
-    #  description: Wrong argument type %s for attributes (expected Hash)
+    #  description: Wrong argument type <class> for attributes (expected Hash)
     #
     # MultipleTestObjectsIdentifiedError
     #  description:  raised if multiple objects found that match the given attributes
@@ -767,19 +778,9 @@ module MobyBehaviour
 
         end
 
-        $logger.behaviour(
+        $logger.behaviour "FAIL;#{ description };#{ identity };#{ dynamic_attributes[ :__multiple_objects ] ? "children" : "child" };#{ attributes.inspect }"
 
-          "%s;%s;%s;%s;%s" % [ 
-            "FAIL", 
-            description, 
-            identity, 
-            dynamic_attributes[ :__multiple_objects ] ? "children" : "child", 
-            attributes.inspect 
-          ]
-
-        )
-
-        Kernel::raise exception
+        raise exception
 
       ensure
 
@@ -839,7 +840,7 @@ module MobyBehaviour
 
       rescue MobyBase::TestObjectNotFoundError
 
-        Kernel::raise MobyBase::TestObjectNotVisibleError
+        raise MobyBase::TestObjectNotVisibleError
 
       end
 
@@ -957,12 +958,12 @@ module MobyBehaviour
 
   public
 
-    # This method is deprecated, please use [link="#GenericTestObject:parent"]TestObject#parent[/link] instead.
     # == deprecated
     # 0.8.x
     #
     # == description
     # This method is deprecated, please use TestObject#parent
+    # This method is deprecated, please use [link="#GenericTestObject:parent"]TestObject#parent[/link] instead.
     #
     def parent_object
 
@@ -980,12 +981,11 @@ module MobyBehaviour
 
     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
+    # This method is deprecated, please use [link="#GenericTestObject:state_object"]TestObject#state_object[/link] instead.
     #
     def state
 

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

@@ -17,29 +17,95 @@
 ## 
 ############################################################################
 
-module MobyBase
+module TDriver
 
-  # class to represent TestObjectFactory.
-  #
-  # when a SUT asks for factory to create test objects, it shall give reference to the SUT so that 
-  # factory can make a call back for SUT object dump (in xml)
-  class TestObjectFactory
+  module TestObjectFactory
+  
+    # private methods and variables
+    class << self
+
+    private
+
+      # TODO: document me
+      def initialize_class
+
+        reset
+
+      end
+
+      # TODO: document me
+      def get_object_params( creation_attributes )
+
+        if creation_attributes[ :type ] != 'application'
+          
+          object_search_params = creation_attributes.clone
+
+          # see below lines how to do following easier
+          #object_search_params[ :className  ] = object_search_params.delete( :type ) if creation_attributes.has_key?( :type )
+          #object_search_params[ :objectName ] = object_search_params.delete( :name ) if creation_attributes.has_key?( :name )
+
+          object_search_params.rename_key!( :type, :className ){} 
+          object_search_params.rename_key!( :name, :objectName ){}
+
+          object_search_params
+
+        else
+        
+          {}
+        
+        end    
+      
+      end
+
+      # TODO: document me
+      def get_parent_params( test_object )
+
+        unless [ 'application', 'sut' ].include?( test_object.type ) 
+
+          search_params = []
+        
+          search_params.concat( get_parent_params( test_object.parent ) ) if test_object.parent
+          search_params.concat( [ :className => test_object.type, :tasId => test_object.id ] ) #if test_object
+          
+          search_params
+          
+        else
+        
+          []
+        
+        end
+
+      end
+
+      # TODO: document me
+      def list_matching_test_objects_as_list( test_object_adapter, matches )
 
-    include Singleton
+        test_object_adapter.list_test_objects_as_string( matches ).each_with_index.collect{ | object, object_index | 
 
-    attr_reader :timeout, :test_object_adapter
+          "#{ ( object_index + 1 ).to_s.rjust( 3, '0' ) }) #{ object.to_s }"
 
-    # TODO: Document me (TestObjectFactory::initialize)
-    def initialize( options = {} )
+        }.join( "\n" )
+
+      end
+
+    end # self 
+
+    # TODO: document me
+    def self.reset
 
       # get timeout from parameters, use default value if parameter not found
       @timeout = $parameters[ :application_synchronization_timeout, "20" ].to_f
 
       # get timeout retry interval from parameters, use default value if parameter not found
       @_retry_interval = $parameters[ :application_synchronization_retry_interval, "1" ].to_f
+    
+    end
 
-      #@test_object_adapter = TDriver::TestObjectAdapter
-
+    # function to get timeout for TestObjectFactory
+    def self.timeout
+    
+      @timeout
+      
     end
 
     # Function to set timeout for TestObjectFactory
@@ -50,7 +116,7 @@ module MobyBase
     # new_timeout:: Fixnum which defines the new timeout
     # == raises
     # ArgumentError:: if parameter is not kind of Fixnum
-    def timeout=( value )
+    def self.timeout=( value )
 
       value.check_type( Numeric, "Wrong argument type $1 for timeout value (expected $2)" )
 
@@ -59,7 +125,7 @@ module MobyBase
     end
 
     # TODO: document me
-    def identify_object( rules )
+    def self.identify_object( rules )
   
       # retrieve test object identification directives; e.g. :__index, :__xy_sorting etc 
       directives = rules[ :identification_directives ]
@@ -76,9 +142,9 @@ module MobyBase
       # search parameters for find_objects feature    
       search_parameters = make_object_search_params( rules[ :parent ], rules[ :object_attributes_hash ] )
       
-      # default rules      
+      # default rules
       directives.default_values(
-      
+            
         # get timeout from rules hash or TestObjectFactory
         :__timeout => @timeout,
 
@@ -109,28 +175,53 @@ module MobyBase
 
         parent_application = directives[ :__parent_application ] || rules[ :parent_application ]
 
-        unless parent_application.nil?
+        # application could be retrieved also like this...
+        # rules[ :parent ].instance_variable_get( :@parent_application )
+
+        # when e.g. wait_child is called to SUT, TDriver is unable to determine layout direction used for sorting/indexing
+        if rules[ :parent ].sut?
+
+          application_layout_direction = directives[ :__layout_direction ]
+        
+          raise RuntimeError, 'layout direction is not available for indexing/xy_sorting; please use e.g. :__layout_direction => "LeftToRight"' if application_layout_direction.blank?
+                
+        else
+        
+          # retrieve layout direction from application object if available
+          unless parent_application.nil?
 
-          begin
+            begin
 
-            application_layout_direction = parent_application.attribute( 'layoutDirection' ).to_s
+              application_layout_direction = ""
 
-            raise if application_layout_direction.empty?
+              if directives[ :__layout_direction ].blank?
+              
+                application_layout_direction = parent_application.attribute( 'layoutDirection' ).to_s 
+              
+              end
 
-          rescue
+              raise if application_layout_direction.empty?
 
-            application_layout_direction = 'LeftToRight'
+            rescue
 
-          end
+              application_layout_direction = directives[ :__layout_direction ]
 
-        else
+              # parent application not defined/available, use default value
+              application_layout_direction = 'LeftToRight' if application_layout_direction.blank?
 
-          raise RuntimeError, 'parent application not given, unable to retrieve layoutDirection'
+            end
+
+          else
+
+            raise RuntimeError, 'parent application not given; unable to retrieve layoutDirection attribute'
+
+          end
 
         end
 
-      end
 
+      end
+      
       # identify objects until desired matches found or timeout exceeds
       MobyUtil::Retryable.until( 
 
@@ -159,7 +250,7 @@ module MobyBase
          directives[ :__find_all_children ] 
 
         )
-        
+                  
         # Temporary prevent users misleading :Text with :text (as they are different)
         if ( rules[ :object_attributes_hash ].has_key?(:Text) )
 
@@ -223,7 +314,7 @@ module MobyBase
     end
 
     # TODO: document me
-    def get_test_objects( rules )
+    def self.get_test_objects( rules )
 
       # retrieve sut object
       sut = rules[ :parent ].instance_variable_get( :@sut )
@@ -398,7 +489,7 @@ module MobyBase
     end
 
     # TODO: document me
-    def make_test_object( rules )
+    def self.make_test_object( rules )
 
       # get parent object from hash
       parent = rules[ :parent ]
@@ -532,7 +623,7 @@ module MobyBase
     end
 
     # create test object search parameters for find_objects service
-    def make_object_search_params( test_object, creation_attributes )
+    def self.make_object_search_params( test_object, creation_attributes )
 
       result = get_parent_params( test_object ).push( get_object_params( creation_attributes ) )
 
@@ -542,70 +633,9 @@ module MobyBase
 
     end
 
-  private 
+    def self.set_timeout( new_timeout )
 
-    # TODO: document me
-    def get_object_params( creation_attributes )
-
-      if creation_attributes[ :type ] != 'application'
-        
-        object_search_params = creation_attributes.clone
-
-        # see below lines how to do following easier
-        #object_search_params[ :className  ] = object_search_params.delete( :type ) if creation_attributes.has_key?( :type )
-        #object_search_params[ :objectName ] = object_search_params.delete( :name ) if creation_attributes.has_key?( :name )
-
-        object_search_params.rename_key!( :type, :className ){} 
-        object_search_params.rename_key!( :name, :objectName ){}
-
-        object_search_params
-
-      else
-      
-        {}
-      
-      end    
-    
-    end
-
-    # TODO: document me
-    def get_parent_params( test_object )
-
-      unless [ 'application', 'sut' ].include?( test_object.type ) 
-
-        search_params = []
-      
-        search_params.concat( get_parent_params( test_object.parent ) ) if test_object.parent
-        search_params.concat( [ :className => test_object.type, :tasId => test_object.id ] ) #if test_object
-        
-        search_params
-        
-      else
-      
-        []
-      
-      end
-
-    end
-
-    # TODO: document me
-    def list_matching_test_objects_as_list( test_object_adapter, matches )
-
-      test_object_adapter.list_test_objects_as_string( matches ).each_with_index.collect{ | object, object_index | 
-
-        "%3s) %s" % [ object_index + 1, object ] 
-
-      }.join( "\n" )
-
-      #list_matching_test_objects( matches ).each_with_index.collect{ | object, object_index | "%3s) %s" % [ object_index + 1, object ] }.join( "\n" )
-
-    end
-
-  public # deprecated methods
-
-    def set_timeout( new_timeout )
-
-      warn "warning: deprecated method TestObjectFactory#set_timeout( value ); please use TestObjectFactory#timeout=( value ) instead"
+      warn "warning: deprecated method TDriver::TestObjectFactory#set_timeout( value ); please use TDriver::TestObjectFactory#timeout=( value ) instead"
 
       self.timeout = new_timeout
 
@@ -615,17 +645,38 @@ module MobyBase
     #
     # === returns
     # Numeric:: Timeout
-    def get_timeout
+    def self.get_timeout
 
-      warn "warning: deprecated method TestObjectFactory#get_timeout; please use TestObjectFactory#timeout instead"
+      warn "warning: deprecated method TDriver::TestObjectFactory#get_timeout; please use TDriver::TestObjectFactory#timeout instead"
 
       @timeout
 
     end
 
-    # enable hoo./base/test_object/factory.rb:king for performance measurement & debug logging
+    # enable hooking for performance measurement & debug logging
     TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
 
+    # initialize plugin service 
+    initialize_class
+  
+    
   end # TestObjectFactory
 
+end # TDriver
+
+# for backwards compatibility
+module MobyBase
+
+  class TestObjectFactory
+
+    def self.instance
+    
+      warn_caller '$1:$2 deprecated class MobyBase::TestObjectFactory, please use static class TDriver::TestObjectFactory instead'
+    
+      TDriver::TestObjectFactory
+    
+    end
+
+  end # SUTFactory
+  
 end # MobyBase