testability-driver 0.9.2 → 1.0.0

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

@@ -0,0 +1,202 @@
+############################################################################
+## 
+## 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 TDriver
+  
+  class TestObjectFactory
+
+    attr_accessor :timeout, :retry_interval, :test_object_adapter
+
+    def initialize( test_object_adapter )
+    
+      #@timeout = 5
+      
+      #@retry_interval = 1
+    
+      @test_object_adapter = test_object_adapter
+    
+      @timeout = MobyUtil::Parameter[ :synchronization_timeout, "20" ].to_f
+
+      @retry_interval = MobyUtil::Parameter[ :synchronization_retry_interval, "1" ].to_f
+                
+    end # initialize
+        
+    def get_objects( source_data, rules, &block )
+  
+      # __multiple_objects
+      # __all_children
+      #
+
+      #TDriver::TestObjectIdentificator.new( creation_hash )
+      # {:type=>"application", :name=>"calculator"}
+
+      test_object_attributes = rules[ :attributes ]
+
+      dynamic_attributes = strip_dynamic_attributes!( test_object_attributes )
+
+      # add keys from rules to dynamic attribute filter list -- to avoid IRB bug
+      MobyUtil::DynamicAttributeFilter.instance.add_attributes( rules.keys )
+
+      #p dynamic_attributes
+      #p rules
+
+      refresh = false
+
+      MobyUtil::Retryable.until( 
+      
+        :timeout   => @timeout, 
+        :interval  => @retry_interval,
+        :exception => [ MobyBase::TestObjectNotFoundError, MobyBase::MultipleTestObjectsIdentifiedError ] 
+
+      ){
+
+        # refresh source data if refresh flag is set to true
+        source_data = yield( source_data ) if refresh
+
+        # set refresh flag to true 
+        refresh = true    
+
+        matches, rule = @test_object_adapter.get_objects( source_data, test_object_attributes )
+   
+        # create string representation of hash merged with and dynamic attributes 
+        rules_string = test_object_attributes.merge( dynamic_attributes ).inspect
+                
+        # raise exception if multiple matches found
+        Kernel::raise MobyBase::MultipleTestObjectsIdentifiedError.new(
+        
+          "Multiple test objects found with rule: #{ rules_string }"
+          
+        ) if !dynamic_attributes.has_key?( :__index ) and (!( rules[ :multiple_objects ] || false ) and matches.size > 1)
+        
+        # raise exception if no matches found
+			  Kernel::raise MobyBase::TestObjectNotFoundError.new(
+			   
+			    "Cannot find object with rule: #{ rules_string }"
+			    
+		    ) if matches.size.zero?
+
+        # ... or proceed if no exceptions raised  
+
+        # sort elements if required by caller
+        # @test_object_adapter.sort_elements....
+
+        # return only one element if index given
+        matches = [ matches[ dynamic_attributes[ :__index ] ] ] if dynamic_attributes.has_key?( :__index )
+        
+        # return array of matching test object(s)
+        make_test_objects( matches, rules )
+
+      }
+      
+    end # get_objects
+
+  private
+
+    def make_test_objects( matches, rules )
+
+      #p rules
+    
+      sut = rules[ :sut ]
+    
+      # return array of matching test object(s)
+      matches.collect{ | source_data |
+                
+        # get test object type from xml
+        object_type = @test_object_adapter.test_object_attribute( 'type', source_data )
+
+        # create new test object instance
+        test_object = MobyBase::TestObject.new( 
+
+          # test object factory
+          self,             
+
+          # associated sut
+          sut,    
+
+          # associated parent object; either test object, application or sut
+          rules[ :parent_object ], 
+
+          # test object xml data
+          source_data
+          
+        )
+
+        # apply object composition behaviour to test object
+        test_object.extend( MobyBehaviour::ObjectBehaviourComposition )
+        
+        # TODO: behaviours should be applied by using BehaviourFactory directly 
+        # apply behaviours to test object
+        test_object.apply_behaviour!(
+          :object_type  => [ '*', object_type ],
+          :sut_type     => [ '*', sut.ui_type ],
+          :input_type   => [ '*', sut.input.to_s ],
+          :version      => [ '*', sut.ui_version ]
+        )
+        
+        # create child accessors
+        @test_object_adapter.create_child_accessors!( test_object, source_data )
+
+        # TODO: call verification block if defined (verify_ui_dump)
+        
+#      # do not make test object verifications if we are operating on the 
+#      # base sut itself (allow run to pass)
+#      unless parent.kind_of?( MobyBase::SUT )
+#       verify_ui_dump( sut ) unless sut.verify_blocks.empty?
+#      end
+
+        # pass test object with behaviours as result
+        test_object
+        
+      }
+    
+    end # make_test_objects
+
+    def strip_dynamic_attributes!( hash )
+
+      # remove dynamic attributes from hash and return as result     
+      Hash[ 
+
+        # iterate through each hash key
+        hash.select{ | key, value | 
+
+          # dynamic attribute name has "__" prefix
+          if key.to_s =~ /^__/ 
+
+            # remove dynamic attribute key from hash
+            hash.delete( key )
+
+            # add to hash
+            true
+
+          else
+
+            # do not add to hash
+            false
+
+          end
+
+        } 
+
+      ]
+
+    end # strip_dynamic_attributes!
+   
+  end # TestObjectFactory
+
+end # TDriver

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

@@ -81,28 +81,28 @@ module MobyBase
 		# Sort XML nodeset of test objects with layout direction
 		def sort_elements_by_xy_layout!( nodeset, layout_direction = "LeftToRight" )
 
-			attribute_pattern = "./attributes/attribute[@name='%s']/value"
+			attribute_pattern = "./attributes/attribute[@name='%s']/value/text()"
 
 			# collect only nodes that has x_absolute and y_absolute attributes
 			nodeset.collect!{ | node |
 
-				node unless node.xpath( attribute_pattern % 'x_absolute' ).empty? || node.xpath( attribute_pattern % 'y_absolute' ).empty?
+				node unless node.at_xpath( attribute_pattern % 'x_absolute' ).to_s.empty? || node.at_xpath( attribute_pattern % 'y_absolute' ).to_s.empty?
 
-			}.compact!.sort!{ | a, b |
+			}.compact!.sort!{ | element_a, element_b |
 
-				a_x = a.xpath( attribute_pattern % 'x_absolute' ).first.content.to_i
-				a_y = a.xpath( attribute_pattern % 'y_absolute' ).first.content.to_i
+				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
 
-				b_x = b.xpath( attribute_pattern % 'x_absolute' ).first.content.to_i
-				b_y = b.xpath( attribute_pattern % 'y_absolute' ).first.content.to_i
+				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
 
 				if ( layout_direction =~ /LeftToRight/i )
 
-					( a_y == b_y ) ? ( a_x <=> b_x ) : ( a_y <=> b_y ) 
+					( element_a_y == element_b_y ) ? ( element_a_x <=> element_b_x ) : ( element_a_y <=> element_b_y ) 
 
 				elsif ( layout_direction =~ /RightToLeft/i )
 
-					( a_y == b_y ) ? ( b_x <=> a_x ) : ( a_y <=> b_y ) 
+					( element_a_y == element_b_y ) ? ( element_b_x <=> element_a_x ) : ( element_a_y <=> element_b_y ) 
 
 				else
 
@@ -393,6 +393,7 @@ module MobyBase
 
 		end
 
+=begin
 		## Returns array of element nodes
 		def sort_elements_by_xy_layout( element_set, layout_direction = "LeftToRight" )
 
@@ -413,19 +414,20 @@ module MobyBase
 			# Sort remaining by layout direction and up to down
 			# Requires .to_a to return an array of MobyUtil::XML::Elements
 			element_set.to_a.sort!{ |a, b| 
-				a_x = a.xpath("./attributes/attribute[@name = 'x_absolute']/value").first.content.to_i
-				a_y = a.xpath("./attributes/attribute[@name = 'y_absolute']/value").first.content.to_i
-				b_x = b.xpath("./attributes/attribute[@name = 'x_absolute']/value").first.content.to_i
-				b_y = b.xpath("./attributes/attribute[@name = 'y_absolute']/value").first.content.to_i
+				element_a_x = a.xpath("./attributes/attribute[@name = 'x_absolute']/value").first.content.to_i
+				element_a_y = a.xpath("./attributes/attribute[@name = 'y_absolute']/value").first.content.to_i
+				element_b_x = b.xpath("./attributes/attribute[@name = 'x_absolute']/value").first.content.to_i
+				element_b_y = b.xpath("./attributes/attribute[@name = 'y_absolute']/value").first.content.to_i
 				if ( layout_direction.downcase == "LeftToRight".downcase )
-					( a_y == b_y ) ? ( a_x <=> b_x ) : ( a_y <=> b_y ) 
+					( element_a_y == element_b_y ) ? ( element_a_x <=> element_b_x ) : ( element_a_y <=> element_b_y ) 
 				elsif ( layout_direction.downcase == "RightToLeft".downcase ) 
-					( a_y == b_y ) ? ( b_x <=> a_x ) : ( a_y <=> b_y ) 
+					( element_a_y == element_b_y ) ? ( element_b_x <=> element_a_x ) : ( element_a_y <=> element_b_y ) 
 				else
 					Kernel::raise ArgumentError.new("Unexpected layout direction: " + layout_direction)
 				end
 			}
 		end
+=end
 
 		# Function to identify an object from tasMessage xml content
 		# 
@@ -439,7 +441,9 @@ module MobyBase
 		# ArgumentError:: if 'from_xml_element' is not of type MobyUtil::XML::Element
 		def find_object_data( from_xml_element, layout_direction = nil )
 
-			Kernel::raise ArgumentError.new( "Wrong argument type %s for argument 'xml_element' (expected MobyUtil::XML::Element)" % from_xml_element.class ) unless from_xml_element.kind_of?( MobyUtil::XML::Element )
+      from_xml_element.check_type( MobyUtil::XML::Element, "Wrong argument type $1 for XML element (expected $2)" )
+
+			#Kernel::raise ArgumentError.new( "Wrong argument type %s for argument 'xml_element' (expected MobyUtil::XML::Element)" % from_xml_element.class ) unless from_xml_element.kind_of?( MobyUtil::XML::Element )
 
 			xpath = get_xpath_to_identify( from_xml_element )
 
@@ -475,7 +479,10 @@ module MobyBase
 		# TestObjectNotFoundError:: if no TestObject can be identified
 		# ArgumentError:: if 'from_xml_element' is not of type MobyUtil::XML::Element
 		def find_multiple_object_data( from_xml_element, find_all_children, layout_direction = nil )
-			Kernel::raise ArgumentError.new( "Wrong argument type %s for argument 'xml_element' (expected MobyUtil::XML::Element)" % from_xml_element.class ) unless from_xml_element.kind_of?( MobyUtil::XML::Element )
+
+      from_xml_element.check_type( MobyUtil::XML::Element, "Wrong argument type $1 for XML element (expected $2)" )
+
+			#Kernel::raise ArgumentError.new( "Wrong argument type %s for argument 'xml_element' (expected MobyUtil::XML::Element)" % from_xml_element.class ) unless from_xml_element.kind_of?( MobyUtil::XML::Element )
 				
 			element_set = from_xml_element.xpath( xpath = get_xpath_to_identify( from_xml_element ,nil,find_all_children) )  
 			ret = Array.new

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

@@ -17,9 +17,6 @@
 ## 
 ############################################################################
 
-
-
-
 # load test object abstract class
 require File.expand_path( File.join( File.dirname( __FILE__ ), 'abstract' ) )
 
@@ -29,6 +26,15 @@ require File.expand_path( File.join( File.dirname( __FILE__ ), 'identificator' )
 # load test object factory
 require File.expand_path( File.join( File.dirname( __FILE__ ), 'factory' ) )
 
+# load test object cache
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'cache' ) )
+
+# load test object adapter
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'adapter' ) )
+
+# load verify ui module
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'verification' ) )
+
 # load test object behaviours
 MobyUtil::FileHelper.load_modules( File.expand_path( File.join( File.dirname( __FILE__ ), 'behaviours' ) ) )
 

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

@@ -0,0 +1,181 @@
+
+module TDriver
+
+  module TestObjectVerification
+
+    # private variables and methods  
+    class << self
+    
+      # TODO: Document me (TestObjectFactory::check_verify_always_reporting_settings)
+      def check_verify_always_reporting_settings
+
+        @@reporter_attached = MobyUtil::Parameter[ :report_attach_continuous_verification_to_reporter, 'false' ]
+
+        @@rcv_raise_errors = MobyUtil::Parameter[ :report_continuous_verification_raise_errors, 'true' ]
+
+        @@rcv_fail_test_case = MobyUtil::Parameter[ :report_continuous_verification_fail_test_case_on_error, 'true' ]
+
+        @@rvc_capture_screen = MobyUtil::Parameter[ :report_continuous_verification_capture_screen_on_error, 'true' ]
+
+      end
+
+      # TODO: Document me (TestObjectFactory::restore_verify_always_reporting_settings)
+      def restore_global_verify_always_reporting_settings
+
+        @@reporter_attached = @@global_reporter_attached
+
+        @@rcv_raise_errors = @@rcv_global_raise_errors
+
+        @@rcv_fail_test_case = @@rcv_global_fail_test_case
+
+        @@rvc_capture_screen = @@rvc_global_capture_screen
+
+      end
+
+      def initialize_settings
+
+        # defaults
+        @@global_reporter_attached = MobyUtil::Parameter[ :report_attach_continuous_verification_to_reporter, 'false' ]
+
+        @@rcv_global_raise_errors = MobyUtil::Parameter[ :report_continuous_verification_raise_errors, 'true' ]
+
+        @@rcv_global_fail_test_case = MobyUtil::Parameter[ :report_continuous_verification_fail_test_case_on_error, 'true' ]
+
+        @@rvc_global_capture_screen = MobyUtil::Parameter[ :report_continuous_verification_capture_screen_on_error, 'true' ]
+
+        @@inside_verify = false
+
+        @@initialized = true
+
+      end
+
+      # defaults
+      @@initialized = false
+                    
+    end
+      
+    def self.verify_ui_dump( sut )
+
+      initialize_settings unless @@initialized
+
+      return if @@inside_verify
+
+      begin
+
+        @@inside_verify = true
+
+        logging_enabled = MobyUtil::Logger.instance.enabled
+
+        sut.verify_blocks.each do | verify |
+
+          check_verify_always_reporting_settings()
+
+          begin
+
+            MobyUtil::Logger.instance.enabled = false
+
+            begin
+            
+              result = verify.block.call( sut )
+
+            rescue Exception => e
+
+              if @@rcv_raise_errors == 'true' || @@reporter_attached == 'false'
+
+                raise MobyBase::ContinuousVerificationError.new(
+                  "Verification failed as an exception was thrown when the verification block was executed. %s\nDetails: %s\nNested exception:\n%s" % [ verify.source, ( verify.message || "none" ), e.inspect ]
+                )
+              elsif @@reporter_attached == 'true' && @@rcv_raise_errors == 'false'
+
+                TDriverReportAPI::tdriver_report_set_test_case_status('failed') if @@rcv_fail_test_case == 'true'
+
+                if @@rvc_capture_screen == 'true'
+
+                  TDriverReportAPI::tdriver_capture_state
+
+                else
+
+                  TDriverReportAPI::tdriver_capture_state( false )
+                  
+                end
+
+                TDriverReportAPI::tdriver_report_log("Verification failed as an exception was thrown when the verification block was executed. %s\nDetails: %s\nNested exception:\n%s" % [ verify.source, ( verify.message || "none" ), e.inspect ])
+
+                TDriverReportAPI::tdriver_report_log("<hr />")
+                
+                MobyUtil::Logger.instance.enabled = logging_enabled
+                MobyUtil::Logger.instance.log "behaviour" , "FAIL;Verification #{verify.message.nil? ? '' : '\"' << verify.message << '\" '}failed:#{e.to_s}.\n#{verify.timeout.nil? ? '' : ' using timeout ' + verify.timeout.to_s}.;#{sut.id.to_s+';sut'};{};verify_always;" << verify.expected.to_s
+
+              end
+
+            end
+
+            unless result == verify.expected
+
+              if @@rcv_raise_errors == 'true' || @@reporter_attached == 'false'
+              
+                raise MobyBase::ContinuousVerificationError.new(
+                  "Verification failed. %s\nDetails: %s\nThe block did not return %s. It returned: %s" % [ 
+                    verify.source, ( verify.message || "none" ), verify.expected.inspect, result.inspect 
+                  ]
+                )
+                
+              elsif @@reporter_attached == 'true' && @@rcv_raise_errors == 'false'
+              
+                TDriverReportAPI::tdriver_report_set_test_case_status('failed') if @@rcv_fail_test_case == 'true'
+                
+                if @@rvc_capture_screen == 'true'
+
+                  TDriverReportAPI::tdriver_capture_state
+
+                else
+
+                  TDriverReportAPI::tdriver_capture_state( false )
+
+                end
+                
+                TDriverReportAPI::tdriver_report_log(
+                  "Verification failed. %s\nDetails: %s\nThe block did not return %s. It returned: %s " % [ 
+                    verify.source, ( verify.message || "none" ), verify.expected.inspect, result.inspect
+                  ]
+                )
+                
+                TDriverReportAPI::tdriver_report_log("<hr />")
+
+                MobyUtil::Logger.instance.enabled = logging_enabled
+                
+                MobyUtil::Logger.instance.log "behaviour" , "FAIL;Verification #{verify.message.nil? ? '' : '\"' << verify.message << '\" '}failed:#{e.to_s}.\n#{verify.timeout.nil? ? '' : ' using timeout ' + verify.timeout.to_s}.;#{sut.id.to_s+';sut'};{};verify_always;" << verify.expected.to_s
+
+              end
+            
+            end
+
+          rescue Exception => e
+
+            MobyUtil::Logger.instance.enabled = logging_enabled
+
+            MobyUtil::Logger.instance.log "behaviour" , "FAIL;Verification #{verify.message.nil? ? '' : '\"' << verify.message << '\" '}failed:#{e.to_s}.\n#{verify.timeout.nil? ? '' : ' using timeout ' + verify.timeout.to_s}.;#{sut.id.to_s+';sut'};{};verify_always;" << verify.expected.to_s
+
+            @@inside_verify = false
+
+            Kernel::raise e
+          
+          end
+
+          # Do NOT report PASS cases, like other verify blocks do. This would clog the log with useless info.
+          restore_global_verify_always_reporting_settings
+        
+        end
+
+      ensure
+
+        MobyUtil::Logger.instance.enabled = logging_enabled
+        @@inside_verify = false      
+
+      end
+      
+    end # verify_ui
+      
+  end # TestObjectVerification
+
+end # TDriver