testability-driver 1.0.4 → 1.1.0

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

@@ -1,20 +1,20 @@
 ############################################################################
-## 
-## 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. 
-## 
+##
+## 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 MobyBehaviour
@@ -47,24 +47,24 @@ module MobyBehaviour
     # == nodoc
     attr_accessor(
 
-        :dump_count,                # number of UI dump requests done to current SUT
-        :current_application_id,    # id of the current appication if set
-        :input,                     # the input method used for interacting with this sut as a symbol, eg. :key or :touch.
-        :refresh_tries,             # number of retries for ui dump on error case
-        :refresh_timeout           # timeout between timeout retry
+      :dump_count,                # number of UI dump requests done to current SUT
+      :current_application_id,    # id of the current appication if set
+      :input,                     # the input method used for interacting with this sut as a symbol, eg. :key or :touch.
+      :refresh_tries,             # number of retries for ui dump on error case
+      :refresh_timeout           # timeout between timeout retry
 
     )
 
     # == nodoc
     attr_reader(
 
-        :xml_data,      # sut xml_data
-        :x_path,        # x_path pattern for xml_data
-        :ui_type,       # type of the UI used on the sut, ie. s60, qt, windows
-        :ui_version,    # version of the ui used on the sut, ie 3.2.3
-        :frozen,        # flag that tells if the ui dump getting is disabled
-        :xml_data_crc,  # crc of the previous ui state message
-        :verify_blocks  # verify blocks              
+      :xml_data,      # sut xml_data
+      :x_path,        # x_path pattern for xml_data
+      :ui_type,       # type of the UI used on the sut, ie. s60, qt, windows
+      :ui_version,    # version of the ui used on the sut, ie 3.2.3
+      :frozen,        # flag that tells if the ui dump getting is disabled
+      :xml_data_crc,  # crc of the previous ui state message
+      :verify_blocks  # verify blocks
 
     )
 
@@ -108,7 +108,7 @@ module MobyBehaviour
     # == examples
     #  @sut.disconnect
     def received_data
-    
+
       @_sutController.received_bytes
 
     end
@@ -122,7 +122,7 @@ module MobyBehaviour
     # == examples
     #  @sut.sent_data
     def sent_data
-      
+
       @_sutController.sent_bytes
 
     end
@@ -130,7 +130,7 @@ module MobyBehaviour
     # == description
     # Function to disable taking UI dumps from target for a moment. This method might be deprecated in future release.\n
     # \n
-    # [b]NOTE:[/b] Remember to enable ui dumps again using unfreeze! 
+    # [b]NOTE:[/b] Remember to enable ui dumps again using unfreeze!
     # == returns
     # NilClass
     #  description: -
@@ -171,21 +171,21 @@ module MobyBehaviour
         warn("warning: SUT##{ __method__ } is not supported when use_find_objects optimization is enabled")
 
       else
-      
+
         @frozen = false
 
       end
 =end
 
       @frozen = false
-  
+
       nil
 
     end
 
     # == nodoc
     # == description
-    # Force to use user defined ui state (e.g. for debugging purposes). Freezes the SUT xml_data, until unfreezed or set to nil. 
+    # Force to use user defined ui state (e.g. for debugging purposes). Freezes the SUT xml_data, until unfreezed or set to nil.
     #
     # == arguments
     # xml
@@ -236,7 +236,7 @@ module MobyBehaviour
     end
 
 
-    # TODO: merge TestObject#child and SUT#child 
+    # TODO: merge TestObject#child and SUT#child
     # == description
     # Creates a child test object from this SUT. SUT object will be associated as child test objects parent.\n
     #
@@ -261,22 +261,22 @@ module MobyBehaviour
       #
       #  NOTICE: Please do not add anything unnessecery to this method, it might cause a major performance impact
       #
-            
+
       # verify attributes argument format
       attributes.check_type( Hash, "Wrong argument type $1 for attributes (expected $2)" )
-            
+
       # store original hash
       creation_hash = attributes.clone
 
       identification_directives = creation_hash.strip_dynamic_attributes!
 
-      # raise exception if wrong value type given for ;__logging 
-      identification_directives[ :__logging ].check_type( 
-      
-        [ TrueClass, FalseClass ], 
-        
+      # raise exception if wrong value type given for ;__logging
+      identification_directives[ :__logging ].check_type(
+
+        [ TrueClass, FalseClass ],
+
         "Wrong value type $1 for :__logging test object creation directive (expected $2)"
-        
+
       ) if identification_directives.has_key?( :__logging )
 
       # disable logging if requested, remove pair from creation_hash
@@ -289,10 +289,10 @@ module MobyBehaviour
 
           # current object as parent, can be either TestObject or SUT
           :parent => self,
-  
+
           # test object identification hash
           :object_attributes_hash => creation_hash,
-          
+
           :identification_directives => identification_directives
 
         )
@@ -327,6 +327,101 @@ module MobyBehaviour
 
     end
 
+
+    # == description
+    # Method for executing sut specific setup method
+    # == returns
+    # Result
+    #  description: -
+    #  example: -
+    # == exceptions
+    # BehaviourError
+    #  description: If the implementation is missing for the method
+    def setup
+
+      if self.parameter[ :sut_setup, nil ] || self.parameter[ :setup, nil ]
+
+        if self.parameter[ :sut_setup, nil ]
+          require MobyUtil::FileHelper.expand_path(self.parameter[ :sut_setup ])
+
+          TDriver.logger.behaviour "PASS;sut.setup method found"
+
+          self.setup
+
+          TDriver.logger.behaviour "PASS;sut.setup executed"
+        end
+
+        if self.parameter[ :setup, nil ]
+          TDriver.logger.behaviour "PASS;sut.setup parameters found"
+          methods=self.parameter[ :setup ]
+          methods.each do |method|
+            m=method[0].to_s
+            args=method[1]
+            if args.to_s == ""
+              eval("self.#{m}")
+            else
+              eval("self.#{m}(:#{args.to_sym})")
+            end
+          end
+          TDriver.logger.behaviour "PASS;sut.setup parameter methods executed"
+        end
+
+      else
+        TDriver.logger.behaviour "FAIL;No methods or parameters found for sut.setup"
+
+        Kernel::raise MobyBase::BehaviourError.new("Setup", "Failed to load sut.setup method check the :sut_setup parameter")
+      end
+
+
+
+    end
+
+    # == description
+    # Method for executing sut specific teardown method
+    # == returns
+    # Result
+    #  description: -
+    #  example: -
+    # == exceptions
+    # BehaviourError
+    #  description: If the implementation is missing for the method
+    def teardown
+
+      if self.parameter[ :sut_teardown, nil ] || self.parameter[ :teardown, nil ]
+
+        if self.parameter[ :sut_teardown, nil ]
+          require MobyUtil::FileHelper.expand_path(self.parameter[ :sut_teardown ])
+
+          TDriver.logger.behaviour "PASS;sut.teardown method found"
+
+          self.teardown
+
+          TDriver.logger.behaviour "PASS;sut.teardown executed"
+        end
+
+        if self.parameter[ :teardown, nil ]
+          TDriver.logger.behaviour "PASS;sut.teardown parameters found"
+          methods=self.parameter[ :teardown ]
+          methods.each do |method|
+            m=method[0].to_s
+            args=method[1]
+            if args.to_s == ""
+              eval("self.#{m}")
+            else
+              eval("self.#{m}(:#{args.to_sym})")
+            end
+          end
+          TDriver.logger.behaviour "PASS;sut.teardown parameter methods executed"
+        end
+
+      else
+        TDriver.logger.behaviour "FAIL;No method or parameters found for sut.teardown"
+
+        Kernel::raise MobyBase::BehaviourError.new("Teardown", "Failed to load sut.teardown method check the :sut_teardown parameter")
+      end
+
+    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.
@@ -369,7 +464,7 @@ module MobyBehaviour
     def application( attributes = {} )
 
       begin
-      
+
         attributes.check_type( Hash, "Wrong argument type $1 for attributes (expected $2)" )
 
         attributes[ :type ] = 'application'
@@ -378,16 +473,16 @@ module MobyBehaviour
 
         @current_application_id = nil if attributes[ :id ].nil?
 
-        # create test object and return it as result 
+        # create test object and return it as result
         test_object = child( attributes )
 
         # store parent application to test object
         test_object.instance_variable_set( :@parent_application, test_object )
 
         test_object
-        
+
       rescue
-      
+
         TDriver.logger.behaviour(
           "FAIL;Failed to find application.;#{ id.to_s };sut;{};application;#{ attributes.kind_of?( Hash ) ? attributes.inspect : attributes.class.to_s }"
         )
@@ -396,9 +491,9 @@ module MobyBehaviour
         Kernel::raise $!
 
       ensure
-      
+
         TDriver.logger.behaviour "PASS;Application found.;#{ id.to_s };sut;{};application;#{ attributes.inspect }" if $!.nil?
-      
+
       end
 
     end
@@ -409,7 +504,7 @@ module MobyBehaviour
     # == arguments
     # arguments
     #  Hash
-    #   description: 
+    #   description:
     #    Options to be used for screen capture. See [link="#capture_options_table"]Options table[/link] for valid keys
     #   example: ( :filename => "output.png" )
     #
@@ -422,7 +517,7 @@ module MobyBehaviour
     # == returns
     # NilClass
     #   description: -
-    #   example: -    
+    #   example: -
     #
     # == exceptions
     # TypeError
@@ -434,9 +529,9 @@ module MobyBehaviour
     # ArgumentError
     #  description: Wrong argument type %s for output filename (expected String)
     #
-    # ArgumentError 
+    # ArgumentError
     #   description: Output filename must not be empty string
-    # 
+    #
     def capture_screen( arguments )
 
       begin
@@ -462,13 +557,13 @@ module MobyBehaviour
         command.redraw = arguments[ :Redraw ] if arguments[ :Redraw ]
 
         # execute command and write binary to file
-        File.open( File.expand_path( arguments[ :filename ] ), 'wb:binary' ){ | file | 
+        File.open( File.expand_path( arguments[ :filename ] ), 'wb:binary' ){ | file |
 
-          file << execute_command( command ) 
+          file << execute_command( command )
 
         }
 
-      rescue 
+      rescue
 
         TDriver.logger.behaviour "FAIL;Failed to capture screen.;#{ id.to_s };sut;{};capture_screen;#{ arguments.kind_of?( Hash ) ? arguments.inspect : arguments.class.to_s }"
 
@@ -501,11 +596,11 @@ module MobyBehaviour
     #  |:name|String|Executable name of the application|{ :name => 'calculator' }|
     #  |:arguments|String|Comma separated list of arguments passed to the application when it is started|{ :arguments => '--nogui,-v' }|
     #	|:sleep_time|Integer|Number of seconds to sleep immediately after launching the process|{ :sleep_time => 10 }|
-    #	|:start_command|String|When set, the run method will execute this command and expect the application provided by the :name key to be launched eventually. Note that applications launched this way can't be sent a Kill message and its start up events and signals may not be recorded.|{ :start_command => 'start_app.bat',:name => 'calculator' }|
-    #	|:try_attach|Boolean|If set to true, run will attempt to attach to an existing application with the given name or id. If not found the application will be launched as normal. If more than 1 are found then an exception is thrown|{:try_attach => true,:name => 'calculator'}|
+    #	|:start_command|String|When set, the run method will execute this command and expect the application provided by the :name key to be launched. Note that applications launched this way can't be sent a Kill message and its start up events and signals may not be recorded.|{ :start_command => 'start_app_batch',:name => 'calculator' }|
+    #	|:try_attach|Boolean|If set to true, run will attempt to attach to an existing application with the given name or id. If not found the application will be launched as normal. If more than 1 are found then an exception is thrown|{:try_attach => true, :name => 'calculator'}|
     #	|:environment|String|Environment variables you want to pass to started process, passed as key value pairs separated by '=' and pairs separated by spaces |{ :environment => 'LC_ALL=en SPECIAL_VAR=value' }|
     #	|:events_to_listen|String|List of events you want to start listening to when application starts, passed as comma separated string.  You can retrieve a list of events fired by a test object by first enabling event listening and then using the get_events method. See methods enable_events, get_events and disable_events |{ :events_to_listen => 'Paint,Show' }|
-    #	|:signals_to_listen|String|List of signals you want to start listening to when application starts, passed as comma separated string. Check your application class what signals it can emit, or you can use the 'signal' fixture's 'list_signal' method to retrieve an xml string listing all the signals the object can emit.  E.g. xml = @object.fixture('signal', 'list_signals')|{ :signals_to_listen => 'applicationReady()' }|	
+    #	|:signals_to_listen|String|List of signals you want to start listening to when application starts, passed as comma separated string. Check your application class what signals it can emit, or you can use the 'signal' fixture's 'list_signal' method to retrieve an xml string listing all the signals the object can emit.  E.g. xml = @object.fixture('signal', 'list_signals')|{ :signals_to_listen => 'applicationReady()' }|
     #
     # == returns
     # TestObject
@@ -515,7 +610,7 @@ module MobyBehaviour
     # == exceptions
     # TypeError
     #  description: Wrong argument type %s for run method (expected Hash)
-    #  
+    #
     # ArgumentError
     #  description: Required key :uid or :name not found from argument hash
     #
@@ -539,7 +634,8 @@ module MobyBehaviour
         # raise exception if :uid or :name not found from hash
         target.require_key( [ :uid, :name ], "Required key :uid or :name not found from argument hash" )
 
-        sleep_time = target[ :sleep_after_launch ].to_i
+        # due to bug #1488
+        sleep_time = ( target[ :sleep_after_launch ] || target[ :sleep_time ] ).to_i
 
         Kernel::raise ArgumentError, "Sleep time need to be >= 0" unless sleep_time >= 0
 
@@ -600,7 +696,7 @@ module MobyBehaviour
           )
 
         end
-        
+
         # do not remove this, unless qttas server & plugin handles the syncronization between plugin registration & first ui state request
         # first ui dump is requested too early and target/server seems not be ready...
         #sleep 0.100
@@ -616,6 +712,8 @@ module MobyBehaviour
         error_details = target[ :name ].nil? ? "" : "name: " << target[ :name ].to_s
         error_details << ( error_details.empty? ? "" : ", ") << "id: " << target[ :uid ].to_s if !target[ :uid ].nil?
 
+        app_name=target[ :name ].nil? ? "" : "name: " << target[ :name ].to_s
+
         if( !expected_attributes[ :FullName ].nil? )
 
           if( expected_attributes[ :FullName ].include?('/') )
@@ -639,42 +737,55 @@ module MobyBehaviour
           end
 
           expected_attributes.delete( :FullName )
+          expected_attributes.delete( :name )
 
         end
 
         begin
+          timeout_time=$parameters[ @id ][ :application_synchronization_timeout, '5' ].to_f
+          retryinterval=$parameters[ @id ][ :application_synchronization_retry_interval, '0.5' ].to_f
 
-          # verify that application is launched and application test object is found from xml
-          self.wait_child(
+          MobyUtil::Retryable.until(
+            :timeout => timeout_time,
+            :interval => retryinterval,
+            :exception => MobyBase::ApplicationNotAvailableError) {
+            # verify that application is launched and application test object is found from xml
+            expected_attributes.delete( :name )
 
-            # attributes to identify application object
-            expected_attributes,
+            self.wait_child(
 
-            # timeout to for application synchronization
-            $parameters[ @id ][ :application_synchronization_timeout, '5' ].to_f,
+              # attributes to identify application object
+              expected_attributes,
 
-            # wait retry interval and try again if application was not found
-            $parameters[ @id ][ :application_synchronization_retry_interval, '0.5' ].to_f
+              # timeout to for application synchronization
+              timeout_time,
 
-          )
+              # wait retry interval and try again if application was not found
+              retryinterval
+
+            )
+
+            expected_attributes[ :name ] = app_name
+            # retrieve application object element from sut.xml_data
+
+            @@matches, unused_rule = TDriver::TestObjectAdapter.get_objects( xml_data, expected_attributes, true )
 
-          # retrieve application object element from sut.xml_data
-          matches, unused_rule = TDriver::TestObjectAdapter.get_objects( xml_data, expected_attributes, true )
+            # raise exception if application element was not found; this shouldn't ever happen?
+            raise MobyBase::ApplicationNotAvailableError if @@matches.count == 0
 
-          # raise exception if application element was not found; this shouldn't ever happen?
-          #raise MobyBase::TestObjectNotFoundError if matches.count == 0
+          }
 
           # create application test object
-          foreground_app = @test_object_factory.make_test_object( 
-        
+          foreground_app = @test_object_factory.make_test_object(
+
             :parent => self,
-            
+
             :parent_application => nil,
-            
+
             :object_attributes_hash => expected_attributes,
-            
-            :xml_object => matches.first
-        
+
+            :xml_object => @@matches.first
+
           )
 
           # store application reference to test application; this will be passed to it's child test object(s)
@@ -693,7 +804,7 @@ module MobyBehaviour
 
         end
 
-      # raise behaviour error if any exception is raised
+        # raise behaviour error if any exception is raised
       rescue # Exception => e
 
         TDriver.logger.behaviour "FAIL;Failed to launch application.;#{ id.to_s };sut;{};run;#{ target.kind_of?( Hash ) ? target.inspect : target.class.to_s }"
@@ -740,7 +851,7 @@ module MobyBehaviour
     #  MobyCommand::KeySequence
     #   description: a KeySequence object of key symbols
     #   example: @sut.press_key( MobyCommand::KeySequence.new(:kDown).times!(3).append!(:kLeft) )
-    # 
+    #
     # == returns
     # NilClass
     #  description: -
@@ -762,7 +873,7 @@ module MobyBehaviour
 
         execute_command( sequence )
 
-      rescue 
+      rescue
 
         TDriver.logger.behaviour "FAIL;Failed to press key(s).;#{id.to_s};sut;{};press_key;#{ value }"
 
@@ -775,7 +886,7 @@ module MobyBehaviour
       nil
 
     end
-    
+
     # == description
     # Wrapper function to access sut specific parameters.
     # Parameters for each sut are stored in the parameters xml file under group tag with name attribute matching the SUT id
@@ -824,108 +935,108 @@ module MobyBehaviour
 
     end
 
-  # == description
-  # Wrapper function to return translated string for this SUT to read the values from localisation database.
-  #
-  # == arguments
-  # logical_name
-  #  String
-  #   description: Logical name (LNAME) of the item to be translated. If prefix for User Information or Operator Data are used then the appropiate retrieve methods will be called
-  #   example: "txt_button_ok"
-  #  Symbol
-  #   description: Symbol form of the logical name (LNAME) of the item to be translated.
-  #   example: :txt_button_ok
-  #
-  # file_name
-  #  String
-  #   description: Optional FNAME search argument for the translation
-  #   example: "agenda"
-  #   default: nil
-  #
-  # plurality
-  #  String
-  #   description: Optional PLURALITY search argument for the translation
-  #   example: "a" or "singular"
-  #  default: nil
-  #
-  # numerus
-  #  String
-  #   description: Optional numeral replacement of an '%Ln | %1' tag on the translated string
-  #   example: "1"
-  #   default: nil
-  #  Integer
-  #   description: Optional numeral replacement of an '%Ln | %1' tag on the translated string
-  #   example: 1
-  #  Array
-  #   description: Optional numeral replacements for multiple '%L1 | %1, %L2 | %2, ...' tags on the translated string
-  #   example: [ 3, 2]
-  # 
-  # lengthvariant
-  #  String
-  #   description: Optional argument to specify a length variant with its priority number (1-9). Translations with no length variants are considered a variant of priority "1". The default 'nil' value will retrieve all variants available.
-  #   example: "1"
-  #   default: nil
-  #
-  # == returns
-  # String
-  #  description: Translation matching the logical_name
-  #  example: "Ok"
-  # Array
-  #  description: If multiple translations have been found for the search conditions an Array with all Strings be returned
-  #  example: ["Ok", "OK"]
-  # 
-  # == exceptions
-  # LanguageNotFoundError
-  #  description: In case language is not found
-  #
-  # LogicalNameNotFoundError
-  #  description: In case no logical name is not found for current language
-  #
-  # SqlError
-  #  description: In case there are problems with the database connectivity
-  #
-  def translate( logical_name, file_name = nil, plurality = nil, numerus = nil, lengthvariant = nil )
+    # == description
+    # Wrapper function to return translated string for this SUT to read the values from localisation database.
+    #
+    # == arguments
+    # logical_name
+    #  String
+    #   description: Logical name (LNAME) of the item to be translated. If prefix for User Information or Operator Data are used then the appropiate retrieve methods will be called
+    #   example: "txt_button_ok"
+    #  Symbol
+    #   description: Symbol form of the logical name (LNAME) of the item to be translated.
+    #   example: :txt_button_ok
+    #
+    # file_name
+    #  String
+    #   description: Optional FNAME search argument for the translation
+    #   example: "agenda"
+    #   default: nil
+    #
+    # plurality
+    #  String
+    #   description: Optional PLURALITY search argument for the translation
+    #   example: "a" or "singular"
+    #  default: nil
+    #
+    # numerus
+    #  String
+    #   description: Optional numeral replacement of an '%Ln | %1' tag on the translated string
+    #   example: "1"
+    #   default: nil
+    #  Integer
+    #   description: Optional numeral replacement of an '%Ln | %1' tag on the translated string
+    #   example: 1
+    #  Array
+    #   description: Optional numeral replacements for multiple '%L1 | %1, %L2 | %2, ...' tags on the translated string
+    #   example: [ 3, 2]
+    #
+    # lengthvariant
+    #  String
+    #   description: Optional argument to specify a length variant with its priority number (1-9). Translations with no length variants are considered a variant of priority "1". The default 'nil' value will retrieve all variants available.
+    #   example: "1"
+    #   default: nil
+    #
+    # == returns
+    # String
+    #  description: Translation matching the logical_name
+    #  example: "Ok"
+    # Array
+    #  description: If multiple translations have been found for the search conditions an Array with all Strings be returned
+    #  example: ["Ok", "OK"]
+    #
+    # == exceptions
+    # LanguageNotFoundError
+    #  description: In case language is not found
+    #
+    # LogicalNameNotFoundError
+    #  description: In case no logical name is not found for current language
+    #
+    # SqlError
+    #  description: In case there are problems with the database connectivity
+    #
+    def translate( logical_name, file_name = nil, plurality = nil, numerus = nil, lengthvariant = nil )
+
+      Kernel::raise LogicalNameNotFoundError, "Logical name is nil" if logical_name.nil?
+
+      translation_type = "localisation"
 
-    Kernel::raise LogicalNameNotFoundError, "Logical name is nil" if logical_name.nil?
+      # Check for User Information prefix( "uif_...")
+      $parameters[ :user_data_logical_string_identifier, 'uif_' ].split('|').each do |identifier|
 
-    translation_type = "localisation"
-    
-    # Check for User Information prefix( "uif_...")
-    $parameters[ :user_data_logical_string_identifier, 'uif_' ].split('|').each do |identifier|
+        if logical_name.to_s.index(identifier)==0
 
-      if logical_name.to_s.index(identifier)==0
+          translation_type="user_data"
 
-        translation_type="user_data"
+        end
 
       end
 
-    end
-    
-    # Check for Operator Data prefix( "operator_...")
-    $parameters[ :operator_data_logical_string_identifier, 'operator_' ].split('|').each do |identifier|
+      # Check for Operator Data prefix( "operator_...")
+      $parameters[ :operator_data_logical_string_identifier, 'operator_' ].split('|').each do |identifier|
 
-      if logical_name.to_s.index(identifier)==0
+        if logical_name.to_s.index(identifier)==0
 
-        translation_type="operator_data"
+          translation_type="operator_data"
+
+        end
 
       end
 
-    end
-    
-    case translation_type
+      case translation_type
 
       when "user_data"
 
         get_user_information( logical_name )
-    
+
       when "operator_data"
 
         get_operator_data( logical_name )
-    
+
       when "localisation"
 
         language=nil
-        
+
         if ( $parameters[ self.id ][:read_lang_from_app]=='true')
 
           #read localeName app
@@ -939,17 +1050,17 @@ module MobyBehaviour
           language=$parameters[ self.id ][ :language ]
 
         end
-        
+
         Kernel::raise LanguageNotFoundError, "Language cannot be determind to perform translation" if ( language.nil? || language.empty? )
 
-        translation = MobyUtil::Localisation.translation( 
-          logical_name, 
+        translation = MobyUtil::Localisation.translation(
+          logical_name,
           language,
-          $parameters[ self.id ][ :localisation_server_database_tablename ], 
-          file_name, 
-          plurality, 
-          lengthvariant 
-        )        
+          $parameters[ self.id ][ :localisation_server_database_tablename ],
+          file_name,
+          plurality,
+          lengthvariant
+        )
 
         if translation.kind_of? String and !numerus.nil?
 
@@ -959,7 +1070,7 @@ module MobyBehaviour
 
           elsif numerus.kind_of? String or numerus.kind_of? Integer
 
-            translation.gsub!(/%(Ln|1)/){|s| numerus.to_s} 
+            translation.gsub!(/%(Ln|1)/){|s| numerus.to_s}
 
           end
 
@@ -973,7 +1084,7 @@ module MobyBehaviour
 
             elsif numerus.kind_of? String or numerus.kind_of? Integer
 
-              trans.gsub!(/%(Ln|1)/){|s| numerus.to_s} 
+              trans.gsub!(/%(Ln|1)/){|s| numerus.to_s}
 
             end
 
@@ -983,134 +1094,134 @@ module MobyBehaviour
 
         translation
 
+      end
+
     end
 
-  end
-  
-  # == nodoc
-  # == description
-  # Translates all symbol values in hash using SUT's translate method.
-  #
-  # == arguments
-  # hash
-  #  Hash
-  #   description: containing key and value pairs. The hash will get modified if symbols are found from values
-  #   example: {:text=>:translate_me}
-  #
-  # == returns
-  # Hash
-  #  description: Translated hash
-  #  example: {:text=>'translated_text'}
-  # == exceptions
-  # LanguageNotFoundError
-  #   description: In case of language is not found
-  #
-  # LogicalNameNotFoundError
-  #  description: In case of logical name is not found for current language
-  #
-  # MySqlConnectError
-  #  description: In case problems with the db connectivity
-  #
-  def translate_values!( hash, file_name = nil, plurality = nil, numerus = nil, lengthvariant = nil )
+    # == nodoc
+    # == description
+    # Translates all symbol values in hash using SUT's translate method.
+    #
+    # == arguments
+    # hash
+    #  Hash
+    #   description: containing key and value pairs. The hash will get modified if symbols are found from values
+    #   example: {:text=>:translate_me}
+    #
+    # == returns
+    # Hash
+    #  description: Translated hash
+    #  example: {:text=>'translated_text'}
+    # == exceptions
+    # LanguageNotFoundError
+    #   description: In case of language is not found
+    #
+    # LogicalNameNotFoundError
+    #  description: In case of logical name is not found for current language
+    #
+    # MySqlConnectError
+    #  description: In case problems with the db connectivity
+    #
+    def translate_values!( hash, file_name = nil, plurality = nil, numerus = nil, lengthvariant = nil )
 
-    hash.each_pair do | _key, _value |
+      hash.each_pair do | _key, _value |
 
-      next if [ :name, :type, :id ].include?( _key )
+        next if [ :name, :type, :id ].include?( _key )
 
-      hash[ _key ] = translate( _value, file_name, plurality, numerus, lengthvariant ) if _value.kind_of?( Symbol )  
+        hash[ _key ] = translate( _value, file_name, plurality, numerus, lengthvariant ) if _value.kind_of?( Symbol )
 
-    end unless hash.nil?
+      end unless hash.nil?
 
-  end
-    
-  # == description
-  # Wrapper function to retrieve user information for this SUT from the user information database.
-  #
-  # == arguments
-  # user_data_lname
-  #  String
-  #   description: Logical name (LNAME) of the user information item to be retrieved.
-  #   example: "uif_first_name"
-  #  Symbol
-  #   description: Symbol form of the logical name (LNAME) of the user information item to be retrieved.
-  #   example: :uif_first_name
-  #
-  # == returns
-  # String
-  #  description: User data string
-  #  example: "Ivan"
-  # Array
-  #  description: Array of Strings when multiple user data strings found.
-  #  example: ["Ivan", "Manolo"]
-  # 
-  # == exceptions
-  # UserDataNotFoundError
-  #  description: In case the desired user data is not found
-  #
-  # UserDataColumnNotFoundError
-  #  description: In case the desired data column name to be used for the output is not found
-  #
-  # SqlError
-  #  description: In case there are problems with the database connectivity
-  #
-  def get_user_information( user_data_lname )
-
-    MobyUtil::UserData.retrieve( 
-      
-      user_data_lname, 
-      
-      # language
-      $parameters[ self.id ][ :language ],
-        
-      # table name
-      $parameters[ self.id ][ :user_data_server_database_tablename ] 
-      
-    )
+    end
 
-  end
-  
-  # == description
-  # Wrapper function to retrieve operator data for this SUT from the operator data database.
-  #
-  # == arguments
-  # operator_data_lname
-  #  String
-  #   description: Logical name (LNAME) of the operator data item to be retrieved.
-  #   example: "operator_welcome_message"
-  #  Symbol
-  #   description: Symbol form of the logical name (LNAME) of the operator data item to be retrieved.
-  #   example: :operator_welcome_message
-  #
-  # == returns
-  # String
-  #  description: User data string
-  #  example: "Welcome to Orange"
-  # 
-  # == exceptions
-  # OperatorDataNotFoundError
-  #  description: In case the desired operator data is not found
-  #
-  # OperatorDataColumnNotFoundError
-  #  description: In case the desired data column name to be used for the output is not found
-  #
-  # SqlError
-  #  description: In case there are problems with the database connectivity
-  #
-  def get_operator_data( operator_data_lname )
+    # == description
+    # Wrapper function to retrieve user information for this SUT from the user information database.
+    #
+    # == arguments
+    # user_data_lname
+    #  String
+    #   description: Logical name (LNAME) of the user information item to be retrieved.
+    #   example: "uif_first_name"
+    #  Symbol
+    #   description: Symbol form of the logical name (LNAME) of the user information item to be retrieved.
+    #   example: :uif_first_name
+    #
+    # == returns
+    # String
+    #  description: User data string
+    #  example: "Ivan"
+    # Array
+    #  description: Array of Strings when multiple user data strings found.
+    #  example: ["Ivan", "Manolo"]
+    #
+    # == exceptions
+    # UserDataNotFoundError
+    #  description: In case the desired user data is not found
+    #
+    # UserDataColumnNotFoundError
+    #  description: In case the desired data column name to be used for the output is not found
+    #
+    # SqlError
+    #  description: In case there are problems with the database connectivity
+    #
+    def get_user_information( user_data_lname )
 
-    MobyUtil::OperatorData.retrieve( 
+      MobyUtil::UserData.retrieve(
 
-      operator_data_lname, 
+        user_data_lname,
 
-      # operator 
-      $parameters[ self.id ][ :operator_selected ],
+        # language
+        $parameters[ self.id ][ :language ],
 
-      # table name 
-      $parameters[ self.id ][ :operator_data_server_database_tablename ]
-      
-    )
+        # table name
+        $parameters[ self.id ][ :user_data_server_database_tablename ]
+
+      )
+
+    end
+
+    # == description
+    # Wrapper function to retrieve operator data for this SUT from the operator data database.
+    #
+    # == arguments
+    # operator_data_lname
+    #  String
+    #   description: Logical name (LNAME) of the operator data item to be retrieved.
+    #   example: "operator_welcome_message"
+    #  Symbol
+    #   description: Symbol form of the logical name (LNAME) of the operator data item to be retrieved.
+    #   example: :operator_welcome_message
+    #
+    # == returns
+    # String
+    #  description: User data string
+    #  example: "Welcome to Orange"
+    #
+    # == exceptions
+    # OperatorDataNotFoundError
+    #  description: In case the desired operator data is not found
+    #
+    # OperatorDataColumnNotFoundError
+    #  description: In case the desired data column name to be used for the output is not found
+    #
+    # SqlError
+    #  description: In case there are problems with the database connectivity
+    #
+    def get_operator_data( operator_data_lname )
+
+      MobyUtil::OperatorData.retrieve(
 
-  end
+        operator_data_lname,
+
+        # operator
+        $parameters[ self.id ][ :operator_selected ],
+
+        # table name
+        $parameters[ self.id ][ :operator_data_server_database_tablename ]
+
+      )
+
+    end
 
     # == nodoc
     # Function to update all children of current SUT
@@ -1125,11 +1236,11 @@ module MobyBehaviour
 
       unless @childs_updated
 
-        @child_object_cache.each_object{ | test_object | 
+        @child_object_cache.each_object{ | test_object |
 
           test_object.send( :update, @xml_data )
 
-          #test_object.update( @xml_data ) 
+          #test_object.update( @xml_data )
 
         }
 
@@ -1138,10 +1249,10 @@ module MobyBehaviour
       @childs_updated = true
 
     end
-    
+
     # == nodoc
     def refresh( refresh_args = {}, creation_attributes = {} )
-            
+
       refresh_ui_dump( refresh_args, creation_attributes )
 
       # update childs only if ui state is new
@@ -1165,13 +1276,13 @@ module MobyBehaviour
     #
     # &block
     #  Proc
-    #   description: Code block to execute. 
+    #   description: Code block to execute.
     #   example: { @sut.xml_data.empty? == false }
     #
     # &block#sut
     #  MobyBase::SUT
-    #   description: 
-    #     Current SUT object is passed as block parameter. If the verify block is defined outside the scope of 
+    #   description:
+    #     Current SUT object is passed as block parameter. If the verify block is defined outside the scope of
     #     the current SUT (e.g. the SUT configuration file), this can be used to get a handle to the current SUT.
     #   example: -
     #
@@ -1179,7 +1290,7 @@ module MobyBehaviour
     # NilClass
     #  description: This method doesn't pass return value
     #  example: -
-    # 
+    #
     # == exceptions
     # MobyBase::VerificationError
     #  description: If verification failed
@@ -1207,35 +1318,35 @@ module MobyBehaviour
 
     # == nodoc
     def get_application_id
-     
+
       # retrieve application object from sut.xml_data
       matches, unused_rule = TDriver::TestObjectAdapter.get_objects( xml_data, { :type => 'application' }, true )
 
-      # retrieve id attribute if application test object found      
+      # retrieve id attribute if application test object found
       if matches.count > 0
 
         # return id attribute value
         TDriver::TestObjectAdapter.test_object_element_attribute( matches.first, 'id' )
-      
+
       else
-      
+
         # application not found
         '-1'
-      
+
       end
 
     end
 
-  private
+    private
 
     # TODO: document me
     def update_childs
-        
+
       # update childs only if ui state is new
       update if !@childs_updated
-    
+
     end
-  
+
     # == nodoc
     # Function asks for fresh xml ui data from the device and stores the result
     # == returns
@@ -1247,13 +1358,13 @@ module MobyBehaviour
       if !@frozen #&& ( @_previous_refresh.nil? || ( current_time - @_previous_refresh ).to_f >= @refresh_interval )
 
         use_find_objects = $parameters[ @id ][ :use_find_object, 'false' ] == 'true' and self.respond_to?( 'find_object' )
-        
+
         refresh_arguments = refresh_args.clone
 
         MobyUtil::Retryable.while(
           :tries => @refresh_tries,
           :interval => @refresh_interval,
-          :unless => [ MobyBase::ControllerNotFoundError, MobyBase::CommandNotFoundError, MobyBase::ApplicationNotAvailableError ] 
+          :unless => [ MobyBase::ControllerNotFoundError, MobyBase::CommandNotFoundError, MobyBase::ApplicationNotAvailableError ]
         ) {
 
           #use find_object if set on and the method exists
@@ -1263,44 +1374,44 @@ module MobyBehaviour
 
           else
 
-            app_command = MobyCommand::Application.new( 
-              :State, 
+            app_command = MobyCommand::Application.new(
+              :State,
               refresh_args[ :FullName ] || refresh_args[ :name ],
-              refresh_args[ :id ], 
-              self 
-            ) 
+              refresh_args[ :id ],
+              self
+            )
 
             # store in case needed
             app_command.refresh_args( refresh_args )
 
             new_xml_data, crc = execute_command( app_command )
 
-          end  
+          end
 
           @dump_count += 1
 
           @childs_updated = false
-          
+
           @xml_data = MobyUtil::XML.parse_string( new_xml_data ).root
 
           @_previous_refresh = Time.now
 
           # remove timestamp from the beginning of tasMessage, parse if not same as previous ui state
-          #if ( xml_data_no_timestamp = new_xml_data.split( ">", 2 ).last ) != @last_xml_data          
+          #if ( xml_data_no_timestamp = new_xml_data.split( ">", 2 ).last ) != @last_xml_data
           # @xml_data = MobyUtil::XML.parse_string( new_xml_data ).root
           # @last_xml_data = xml_data_no_timestamp
           #end
 
-          #if ( @xml_data_crc == 0 || crc != @xml_data_crc || crc.nil? )          
+          #if ( @xml_data_crc == 0 || crc != @xml_data_crc || crc.nil? )
           # @xml_data, @xml_data_crc, @childs_updated = MobyUtil::XML.parse_string( new_xml_data ).root, crc, false
           #end
 
-        } 
+        }
 
       end
 
       fetch_references( @xml_data )
-      
+
     end
 
     # TODO: document me
@@ -1337,7 +1448,7 @@ module MobyBehaviour
 
           # ref-ref parent does not know x coordinate, use the grandparent xys
           x_prev = x_abs.to_s unless x_abs.nil?
-          y_prev = y_abs.to_s unless y_abs.nil? 
+          y_prev = y_abs.to_s unless y_abs.nil?
 
           idx += 1
 
@@ -1346,33 +1457,33 @@ module MobyBehaviour
             begin
 
               subdata =
-                MobyUtil::XML.parse_string( 
-                                           execute_command( 
-                                                           MobyCommand::Application.new(
-                                                                                        :State,
-                                                                                        nil,
-                                                                                        pid,
-                                                                                        self,
-                                                                                        nil,
-                                                                                        nil,
-                                                                                        nil,
-                                                                                        nil,
-                                                                                        {
-                                                                                          'x_parent_absolute' => x_prev,
-                                                                                          'y_parent_absolute' => y_prev,
-                                                                                          'embedded' => 'true',
-                                                                                          'parent_size' => winSize
-                                                                                        }
-                                                                                        )
-                                                           )[ 0 ]
-                                           )
+                MobyUtil::XML.parse_string(
+                execute_command(
+                  MobyCommand::Application.new(
+                    :State,
+                    nil,
+                    pid,
+                    self,
+                    nil,
+                    nil,
+                    nil,
+                    nil,
+                    {
+                      'x_parent_absolute' => x_prev,
+                      'y_parent_absolute' => y_prev,
+                      'embedded' => 'true',
+                      'parent_size' => winSize
+                    }
+                  )
+                )[ 0 ]
+              )
 
               child = subdata.root.xpath('//object')[0]
 
               # Remove the attribute with the pid retrieval was not successful.
               # (server returns the previous hit if not found)
               if child.attribute('id' ) != pid
-                
+
                 element.remove
 
               else
@@ -1471,10 +1582,10 @@ module MobyBehaviour
         @refresh_interval = $parameters[ @id ][ :refresh_interval, @refresh_interval ].to_f
 
       end
-    
+
       @last_xml_data = nil
-    
-      ruby_file = $parameters[ @id ][ :verify_blocks ] 
+
+      ruby_file = $parameters[ @id ][ :verify_blocks ]
 
       @verify_blocks = []
 
@@ -1493,7 +1604,7 @@ module MobyBehaviour
 
     end
 
-  public # deprecated
+    public # deprecated
 
     # == nodoc
     # function to get TestObject
@@ -1502,12 +1613,12 @@ module MobyBehaviour
     # TODO: Document me when I'm ready
     def get_object( object_id )
 
-      warn("deprecated: use SUT#child instead of SUT#get_object in order to retrieve child test objects")
+      warn "warning: deprecated method SUT#get_object; please use SUT#child instead"
 
-      child( object_id )
+      child object_id
 
     end
-    
+
     # == nodoc
     #TODO: Update documentation
     #TODO: Is this function deprecated? (see SUT#refresh_ui_dump)
@@ -1518,7 +1629,7 @@ module MobyBehaviour
     # == raises
     # someException:: If Dump does not conform to the tasMessage schema error is raised
     def get_ui_dump( refresh_args = {} )
-    
+
       #$stderr.puts "warning: SUT#get_ui_dump is deprecated, please use SUT#refresh_ui_dump instead."
 
       refresh_ui_dump refresh_args, {}
@@ -1529,5 +1640,5 @@ module MobyBehaviour
     TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
 
   end # SUT
-  
+
 end # MobyBehaviour