testability-driver 1.2.1 → 1.3.0

data/lib/tdriver/base/sut/generic/commands/agent.rb

@@ -0,0 +1,43 @@
+############################################################################
+## 
+## Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). 
+## All rights reserved. 
+## Contact: Nokia Corporation (testabilitydriver@nokia.com) 
+## 
+## This file is part of TDriver. 
+## 
+## If you have questions regarding the use of this file, please contact 
+## Nokia at testabilitydriver@nokia.com . 
+## 
+## This library is free software; you can redistribute it and/or 
+## modify it under the terms of the GNU Lesser General Public 
+## License version 2.1 as published by the Free Software Foundation 
+## and appearing in the file LICENSE.LGPL included in the packaging 
+## of this file. 
+## 
+############################################################################
+
+module MobyCommand
+
+  class AgentCommand < MobyCommand::CommandData
+
+	  attr_accessor :parameters
+		
+	  # == description
+	  # Agent command holds the required parameters to execute a agent information queries in the target.
+	  # == arguments
+	  # params
+	  #  Hash
+	  #   description: Hash for holding the parameters need by the agent information query operation.
+	  #   example: {}
+	  def initialize( parameters = {} )
+
+      parameters.check_type Hash, 'wrong argument type $1 for agent service command object (expected $2)'
+
+	    @parameters = parameters
+
+	  end
+	
+  end # AgentCommand
+
+end # MobyCommand

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

@@ -23,17 +23,17 @@ module MobyBase
   class SUT
 
     attr_accessor(
-      :id,          # id of current SUT
-      :ui_type,     # ui type
-      :ui_version,  # ui version
-      :input,       # the input method used for interacting with this sut as a symbol, eg. :key or :touch. 
-      :type         # type of object ("SUT"), used when applying behaviour
+      :id,                  # id of current SUT
+      :ui_type,             # ui type
+      :ui_version,          # ui version
+      :input                # the input method used for interacting with this sut as a symbol, eg. :key or :touch. 
     )
 
-	#added for now
     attr_reader(
-	  :test_object_adapter
-	)
+      :type,                # type of object ("SUT"), used when applying behaviour
+  	  :environment,         # sut environment from parameters file
+  	  :test_object_adapter  # test object adapter -- added for now?
+  	)
 
     # Initialize SUT by giving references to the used controller and test object factory
     # == params
@@ -68,6 +68,8 @@ module MobyBase
 
       @object_behaviours = []
 
+      @environment = $parameters[ sut_id ][ :env ]
+
       @forced_xml = false
 
     end  

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

@@ -41,26 +41,28 @@ module MobyBase
       # verify that given argument is type of hash    
       options.check_type Hash, 'wrong argument type $1 for TestObject#new (expected $2)'
 
-      # 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 )
+      # verify that required keys is found from options hash and initialize the test object with these values
+      @sut                  = options.require_key :sut
 
-      @sut = options.require_key( :sut )
+      @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_id = @sut.instance_variable_get( :@id )
+      # verify that parent object and parent application is given in options hash
+      @parent               = options.require_key :parent
+      @parent_application   = options.require_key :parent_application
 
-      @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 )
+      # store sut id
+      @sut_id               = @sut.instance_variable_get :@id
 
       # initialize cache object 
-      @child_object_cache = TDriver::TestObjectCache.new
+      @child_object_cache   = TDriver::TestObjectCache.new
 
       # empty test object behaviours list
-      @object_behaviours = []
+      @object_behaviours    = []
+
+      # apply xml object if given; test object type, id and name are retrieved from the xml 
+      __send__ :xml_data=, options[ :xml_object ] if options.has_key?( :xml_object )
  
     end
 
@@ -75,7 +77,7 @@ module MobyBase
     # nothing
     def eql?( test_object )
 
-      self == test_object
+      __send__ :==, test_object
 
     end
 
@@ -95,9 +97,9 @@ module MobyBase
     def ==( test_object )
 
       #return false unless test_object.instance_of?( MobyBase::TestObject ) 
-      #return false unless self.type == test_object.type
-      #return false unless self.id == test_object.id
-      #return false unless self.name == test_object.name
+      #return false unless @type == test_object.type
+      #return false unless @id == test_object.id
+      #return false unless @name == test_object.name
       #return true
 
       # optimized version
@@ -112,11 +114,10 @@ module MobyBase
     # Fixnum:: hash number representing current TestObject
     def hash
 
-
       #result = 17
-      #result = result * 37 + self.id.to_i
-      #result = result * 37 + type.hash
-      #result = result * 37 + name.hash
+      #result = result * 37 + @id.to_i
+      #result = result * 37 + @hash
+      #result = result * 37 + @hash
       #return result
 
       # optimized version
@@ -131,17 +132,17 @@ module MobyBase
     # should not be used normally. Thus, not documented.
     def <=>( test_object )
 
-      #self_type = self.type
+      #self_type = @type
       #other_type = test_object.type
       #return -1 if self_type < other_type
       #return 1  if self_type > other_type
 
-      #self_name = self.name
+      #self_name = @name
       #other_name = test_object.name
       #return -1 if self_name < other_name
       #return 1  if self_name > other_name
 
-      #self_id = self.id
+      #self_id = @id
       #other_id = test_object.id
       #return -1 if self_id < other_id
       #return 1  if self_id > other_id

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

@@ -87,6 +87,40 @@ module TDriver
           
         end # xpath_attributes
  
+          #merges elements from the nodeset, used in hybrid app situations
+          def create_merged_element(nodeset, environments, close_element=true)
+            merged_element_set = false
+
+            merged_xml = ""
+
+            nodeset.each{ | object |        
+             
+              # only one top element
+              unless merged_element_set
+
+                # retrieve object attributes
+                attributes = object.attributes
+                
+                # merge env to attributes hash
+                attributes['env'] = environments.join(';')
+                
+                # add application object xml element to new xml string
+                merged_xml << "<object #{ hash_to_element_attributes( attributes ) }>"
+                
+                # merged element is now set, no need to do it again
+                merged_element_set = true
+                
+              end
+              
+              # append all found elements
+              object.xpath('./*').each{ | object | merged_xml << object.to_s }
+            }
+            merged_xml << "</object>" if close_element and merged_element_set
+            merged_xml
+          end
+
+
+
         # TODO: document me
         def initialize_class
 
@@ -425,50 +459,53 @@ module TDriver
 
     # TODO: document me
     def self.test_object_attributes( source_data, inclusive_filter = [] )
-      
+
       # convert all keys to lowercase
       inclusive_filter.collect!{ | key | key.to_s.downcase } unless inclusive_filter.empty?
-      
+
       # return hash of test object attributes
-      Hash[ 
+      object_attributes=Hash.new
 
-        # iterate each attribute and collect name and value      
-        source_data.xpath( 'attributes/attribute/value' ).collect{ | value | 
+        # iterate each attribute and collect name and value
+        source_data.xpath( 'attributes/attribute/value' ).collect{ | value |
 
           # retrieve attribute name
           name = value.parent.attribute('name').to_s
 
           # collect attribute elements name and content
           unless inclusive_filter.empty?
-          
-            [ name, value.content ] if inclusive_filter.include?( name.downcase )
-                    
+
+            object_attributes[name]=value.content if inclusive_filter.include?( name.downcase )
+
           else
 
             # pass the attribute pair - no filtering done
-            [ name, value.content ]
-          
+            if object_attributes[name]
+                object_attributes[name]="#{object_attributes[name]},#{value.content}"
+            else
+                object_attributes[name]=value.content
+            end
+
           end
 
         }
 
-      ]
+      object_attributes
 
     end
 
     # TODO: document me
     def self.application_layout_direction( sut )
 
-      # temporary fix until testobject will be associated to parent application object
-      unless MobyUtil::DynamicAttributeFilter.instance.has_attribute?( 'layoutDirection' )
-        
-        # temporary fix: add 'layoutDirection' to dynamic attributes filtering whitelist...
-        MobyUtil::DynamicAttributeFilter.instance.add_attribute( 'layoutDirection' ) 
-        
+      # temporary fix until testobject will be associated to parent application object; add 'layoutDirection' to dynamic attributes filtering whitelist...
+      TDriver::AttributeFilter.add_attribute( 'layoutDirection' ){ 
+
+        # this block will be executed if attribute was not in filter list
+
         # temporary fix: ... and refresh sut to retrieve updated xml data
         sut.refresh
-      
-      end 
+
+      }
             
       # TODO: parent application test object should be passed to get_test_objects; TestObjectAdapter#test_object_attribute( @app.xml_data, 'layoutDirection')
       ( sut.xml_data.at_xpath('*//object[@type="application"]/attributes/attribute[@name="layoutDirection"]/value/text()').content || 'LeftToRight' ).to_s
@@ -642,32 +679,18 @@ module TDriver
         # collect environment values
         environments = document_root.xpath('/tasMessage/tasInfo/object[@type="application"]/@env').collect{ | attribute | attribute.to_s }
 
-        # iterate through each object found in xml
-        nodeset.each{ | object |        
-  
-          # only one application element
-          unless application_element_set
-          
-            #application_objects << object
-
-            # retrieve object attributes
-            attributes = object.attributes
-
-            # merge env to attributes hash
-            attributes['env'] = environments.join(';')
-
-            # add application object xml element to new xml string
-            new_xml << "<object #{ hash_to_element_attributes( attributes ) }>"
-          
-            # application element is now set, no need to do it again
-            application_element_set = true
-            
-          end
+        #limit to apps
+        nodeset = document_root.xpath('/tasMessage/tasInfo/object[@type="application"]')
+        close_vkb = false
+        if nodeset.count > 0
+          new_xml << create_merged_element(nodeset, environments, false) 
+          close_vkb = true
+        end
 
-          # append all found elements
-          object.xpath('./*').each{ | object | new_xml << object.to_s }
-          
-        }
+        # do the same to the vkbs
+        environments = document_root.xpath('/tasMessage/tasInfo/object[@type="vkb_app"]/@env').collect{ | attribute | attribute.to_s }
+        nodeset = document_root.xpath('/tasMessage/tasInfo/object[@type="vkb_app"]')
+        new_xml << create_merged_element(nodeset, environments, close_vkb)
 
         # multiple applications found, return merged application xml
         new_xml << "</object></tasInfo></tasMessage>"

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

@@ -76,6 +76,7 @@ module MobyBehaviour
 
     end
 
+=begin
     # == description
     # Determines if the current test object is of type 'application'
     # == returns
@@ -87,6 +88,7 @@ module MobyBehaviour
       @type == 'application'
 
     end
+=end
 
     # == description
     # Return all test object attributes
@@ -250,12 +252,24 @@ 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 = nil )
-
-      refresh_args = @creation_attributes if refresh_args.nil?
+    def refresh( refresh_args = {} )
 
       refresh_args.check_type Hash, "wrong argument type $1 for #{ application? ? 'application' : 'test object' } refresh attributes (expected $2)"
 
+      if refresh_args.blank? 
+
+        if application?
+
+          refresh_args = { :name => @name, :id => @id }
+
+        else
+
+          refresh_args = { :name => @parent_application.name, :id => @parent_application.id }
+
+        end
+
+      end
+
       @sut.refresh( 
 
         refresh_args, @test_object_factory.make_object_search_params( parent, @creation_attributes )
@@ -265,6 +279,8 @@ module MobyBehaviour
       # update childs if required, returns true or false
       update( xml_data )
 
+      nil
+
     end
 
     # == nodoc
@@ -313,7 +329,15 @@ module MobyBehaviour
 
       # return application object or nil if no parent found
       # Does is make sense to return nil - should  n't all test objects belong to an application? Maybe throw exception if application not found
-      return @sut.child( :type => 'application' ) rescue nil
+      begin 
+
+        @sut.child( :type => 'application' ) 
+
+      rescue 
+
+        nil
+
+      end
 
     end
 
@@ -326,11 +350,17 @@ module MobyBehaviour
     # puts @app.Node( :name => 'Node1' ).get_application_id() #print the application id, this should print @app.id
     def get_application_id
 
-      return @parent_application.id if @parent_application
+      if @parent_application
+
+        @parent_application.id
+
+      else
+
+        # workaround
+        # What about the case when get_application returns nil? This line will throw an exception in that case.
+        get_application.id
 
-      # workaround
-      # What about the case when get_application returns nil? This line will throw an exception in that case.
-      get_application.id
+      end
 
     end
 
@@ -402,8 +432,24 @@ module MobyBehaviour
     def child( attributes )
 
       # verify attributes argument format
-      attributes.check_type( Hash, "wrong argument type $1 for attributes (expected $2)" )
-    
+      attributes.check_type [ Hash, String, Symbol, Regexp, Array ], "wrong argument type $1 for attributes (expected $2)"
+
+      # set rules hash to empty Hash if rules hash is not type of Hash
+      unless attributes.kind_of?( Hash ) 
+
+        # pass empty rules hash if no argument given, otherwise assume value to be object name
+        if attributes.blank?
+
+          attributes = {}
+
+        else
+
+          attributes = { :name => attributes }
+
+        end
+
+      end
+
       get_child_objects( attributes )
     
     end
@@ -504,19 +550,19 @@ module MobyBehaviour
           if @env != previous_environment
 
             # remove cached behaviour module 
-            MobyBase::BehaviourFactory.instance.reset_modules_cache
+            TDriver::BehaviourFactory.reset_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!(
+            TDriver::BehaviourFactory.apply_behaviour(
 
-              :object => self,
-              :object_type => object_type, 
-              :input_type => [ '*', @sut.input.to_s ],
-              :env => [ '*', *@env.to_s.split(";") ],
-              :version => [ '*', @sut.ui_version.to_s ]
+              :object       => self,
+              :object_type  => object_type, 
+              :input_type   => [ '*', @sut.input.to_s       ],
+              :env          => [ '*', *@env.to_s.split(";") ],
+              :version      => [ '*', @sut.ui_version.to_s  ]
 
             )
             
@@ -577,7 +623,20 @@ module MobyBehaviour
       rules_hash = method_arguments.first
 
       # set rules hash to empty Hash if rules hash is not type of Hash
-      rules_hash = {} unless rules_hash.kind_of?( Hash ) 
+      unless rules_hash.kind_of?( Hash ) 
+
+        # pass empty rules hash if no argument given, otherwise assume value to be object name
+        if rules_hash.blank?
+
+          rules_hash = {}
+
+        else
+
+          rules_hash = { :name => rules_hash }
+
+        end
+
+      end
 
       # set test object type
       rules_hash[ :type ] = method_id.to_s
@@ -674,7 +733,7 @@ module MobyBehaviour
         # TODO: refactor me
         child_test_object = @test_object_factory.get_test_objects(
 
-          # current objec  t as parent, can be either TestObject or SUT
+          # current object as parent, can be either TestObject or SUT
           :parent => self,
  
           # pass parent application
@@ -862,7 +921,7 @@ module MobyBehaviour
           if ( attempt == 1 )
 
             # add to attribute filter 
-            MobyUtil::DynamicAttributeFilter.instance.add_attribute( name )
+            TDriver::AttributeFilter.add_attribute( name )
 
             # refresh test object ui state
             refresh