testability-driver 1.2.1 → 1.3.0

data/lib/tdriver/util/common/string.rb

@@ -34,7 +34,14 @@ class String
 
   def not_empty( message = "String must not be empty", exception = ArgumentError )
 
-    raise exception, message, caller if empty? 
+    if empty?
+  
+      # replace macros
+      #message.gsub!( '$1', self.inspect )
+  
+      raise exception, message, caller 
+
+    end
 
     self
 

data/lib/tdriver/util/filters/attribute_filter.rb

@@ -0,0 +1,121 @@
+############################################################################
+## 
+## 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 AttributeFilter
+
+    # TODO: document me
+    def self.add_attribute( attribute )
+
+      _attribute = attribute.to_s
+
+      unless @attributes.include?( _attribute )
+
+        @attributes << _attribute.to_s
+
+        @attributes_string = @attributes.join( ',' )
+
+        yield if block_given?
+
+      end
+
+    end
+
+    # TODO: document me
+    def self.add_attributes( attributes )
+
+      updated_list = @attributes | attributes.collect{ | value | value.to_s }
+
+      unless updated_list == @attributes
+
+        @attributes = updated_list
+        
+        @attributes_string = @attributes.join( ',' )
+
+        yield if block_given?
+
+      end
+
+    end
+
+    # TODO: document me
+    def self.has_attribute?( attribute )
+
+      @attributes.include?( attribute.to_s )
+
+    end
+
+    # TODO: document me
+    def self.filter_string
+
+      @attributes_string
+
+    end
+
+    # TODO: document me
+    def self.reset
+
+      @attributes_string = ""
+
+      @attributes = []
+
+    end
+
+    class << self
+
+      private
+
+      # TODO: document me
+      def initialize_class
+
+        @attributes_string = ""
+
+        @attributes = []
+
+      end
+
+    end
+
+    # initialize attribute filter class
+    initialize_class
+
+    # enable hooking for performance measurement & debug logging
+    TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
+
+  end # AttributeFilter
+
+end # TDriver
+
+# for backwards compatibility
+module MobyUtil
+
+  class DynamicAttributeFilter
+
+    def self.instance
+
+      warn_caller '$1:$2 warning: deprecated class MobyUtil::DynamicAttributeFilter; please use static TDriver::AttributeFilter class instead'
+
+      TDriver::AttributeFilter
+
+    end 
+
+  end # DynamicAttributeFilter
+
+end # MobyUtil

data/lib/tdriver/util/filters/loader.rb

@@ -0,0 +1,29 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+[ 
+
+  # dynamic attribute filter module
+  'attribute_filter.rb'
+
+].each{ | filename |
+
+  require File.expand_path( File.join( File.dirname( __FILE__ ), filename ) )
+
+}

data/lib/tdriver/util/fixture/loader.rb

@@ -0,0 +1,22 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+# fixture services module
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'service.rb' ) )
+

data/lib/tdriver/util/fixture/service.rb

@@ -0,0 +1,157 @@
+############################################################################
+##
+## 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 FixturePluginService
+
+    # remove all public methods
+    instance_methods.each{ | method | 
+
+      undef_method( method ) unless method =~ /^__|^(methods|inspect|to_s|class|nil?|extend)/ 
+
+    }
+
+    # TODO: document me
+    def initialize( options = {} )
+
+      # verify that options is type of hash
+      options.check_type Hash, 'wrong argument type $1 for fixture service options (expected $2)'
+
+      # verify that name is defined in options hash
+      options.require_key :name
+
+      options.require_key :arguments
+
+      options.require_key :target
+
+      options.require_key :configuration
+
+      # store given options
+      @options = options
+      
+      # store caller backtrace
+      @caller = caller
+
+      self
+
+    end      
+
+    def method_missing( fixture_method, arguments = {} )
+
+      begin
+
+        arguments.check_type Hash, 'wrong argument type $1 for fixture method arguments (expected $2)'
+
+        result = nil
+
+        _async = @options[ :arguments ][ :async ].true?
+
+        _target = @options[ :target ]
+
+        _fixture_name = @options[ :name ].to_s
+
+        _fixture_method = fixture_method.to_s
+
+        _sut = _target.sut
+
+        params = { :name => _fixture_name.to_s, :command_name => _fixture_method, :parameters => arguments, :async => _async }
+
+        if _target.sut?
+
+          params.merge!( :application_id => nil, :object_id => _target.id, :object_type => :Application )
+
+        else
+
+          params.merge!( :application_id => _target.get_application_id, :object_id => _target.id, :object_type => _target.attribute( 'objectType' ).to_sym )
+
+        end
+
+        result = _sut.execute_command( MobyCommand::Fixture.new( params ) )
+
+      rescue
+
+        $logger.behaviour "FAIL;Failed when calling fixture #{ @options[:arguments ].inspect } with name #{ _fixture_name.inspect }, method #{ _fixture_method.inspect } and parameters #{ arguments.inspect }.;#{ _target.id.to_s };sut;{};fixture;"
+
+        raise MobyBase::BehaviourError.new("Fixture", "Failed when calling fixture #{ @options[:arguments ].inspect } with name #{ _fixture_name.inspect }, method #{ _fixture_method.inspect } and parameters #{ arguments.inspect }")
+
+      end
+
+      $logger.behaviour "PASS;The fixture command (#{ @options[ :arguments ]}) was executed successfully with name #{ _fixture_name.inspect }, method #{ _fixture_method.inspect } and parameters #{ arguments.inspect }.;#{ _target.id.to_s };sut;{};fixture;"
+
+      result
+
+    end
+
+  end # FixturePluginService
+
+  class FixtureService
+
+    # remove all public methods
+    instance_methods.each{ | method | 
+
+      undef_method( method ) unless method =~ /^__|^(methods|inspect|to_s|class|nil?|extend)/ 
+
+    }
+
+    # TODO: document me
+    def initialize( options = {} )
+
+      # verify that options is type of hash
+      options.check_type Hash, 'wrong argument type $1 for fixture service options (expected $2)'
+
+      # verify that target object is defined in options hash
+      options.require_key :target
+
+      # store given options
+      @options = options
+
+      # store sut variable
+      @target = options[ :target ]
+      
+      # store caller backtrace
+      @caller = caller
+
+      self
+
+    end      
+
+    def method_missing( name, arguments = {} )
+
+      arguments.check_type Hash, 'wrong argument type $1 for fixture options (expected $2)'
+
+      _fixtures = $parameters[ @target.sut.id ][ :fixtures, {} ]
+
+      if _fixtures.has_key?( name )
+
+        FixturePluginService.new( :target => @target, :name => name, :arguments => arguments, :configuration => _fixtures[ name ] )
+
+      else
+
+        $logger.behaviour "FAIL;Failed to execute fixture due to #{ name.inspect } not foudn for #{ @target.sut.id.inspect }.;#{ @target.id.to_s };sut;{};fixture;"
+
+        raise MobyBase::BehaviourError.new( "Fixture", "Failed to execute fixture due to #{ name.to_s.inspect } not found for #{ @target.sut.id.inspect }" )
+
+      end
+
+    end
+    
+  end # FixtureService
+
+end # TDriver

data/lib/tdriver/util/loader.rb

@@ -37,8 +37,8 @@ require 'rubygems'
   # statistics module
   'statistics/statistics.rb',
 
-  # dynamic attribute filter module
-  'filters/dynamic_attributes.rb', 
+  # filter modules
+  'filters/loader.rb', 
 
   # plugin service modules
   'plugin/loader.rb', 
@@ -61,6 +61,12 @@ require 'rubygems'
   # recorder and scripter modules
   'recorder/loader.rb', 
 
+  # agent service command modules
+  'agent/loader.rb', 
+
+  # fixture service modules
+  'fixture/loader.rb', 
+
   # video capture/util modules
   'video/loader.rb',
 

data/lib/tdriver/util/logger/logger.rb

@@ -452,10 +452,14 @@ module MobyUtil
           @logger_instance = get_logger( 'TDriver' )
 
           # create unique name for logfile or use default (TDriver.log)
-          filename = ( MobyUtil::StringHelper.to_boolean( Parameter[ :logging_outputter_unique_filename ] ) ? "TDriver_#{ Time.now.to_i }.log" : "TDriver.log" )
+          if $parameters[ :logging_outputter_unique_filename, false ].true?
+            filename = "TDriver_#{ Time.now.to_i }.log"
+          else
+            filename = 'TDriver.log'
+          end
 
           # check if outputter is enabled
-          if MobyUtil::StringHelper.to_boolean( Parameter[ :logging_outputter_enabled ] )
+          if $parameters[ :logging_outputter_enabled, false ].true? 
 
             # create new outputter instance type of FileOutputter
             outputter = create_outputter(
@@ -470,7 +474,7 @@ module MobyUtil
               :filename => File.join( outputter_path, filename ), 
 
               # append to or truncate file
-              :trunc => MobyUtil::StringHelper.to_boolean( Parameter[ :logging_outputter_append ] ) == false, 
+              :trunc => $parameters[ :logging_outputter_append, false ].false?, 
 
               # logging level
               :level => logging_level
@@ -478,7 +482,7 @@ module MobyUtil
             ) 
 
             # set outputter log event write pattern
-            set_outputter_pattern( outputter, Parameter[ :logging_outputter_pattern ] )
+            set_outputter_pattern( outputter, $parameters[ :logging_outputter_pattern, '%d [%c] [%l] %M' ] )
 
             # add outputter to logger instance
             add_outputter( @logger_instance, outputter )
@@ -486,14 +490,16 @@ module MobyUtil
           end
 		  
           # Add stdout outputter if set on configuration parameters
-          if MobyUtil::StringHelper.to_boolean( Parameter[ :logging_stdout_outputter_enabled ] )
+          if $parameters[ :logging_stdout_outputter_enabled, false ].true?
             stdout_outputter = create_outputter(
               Log4r::StdoutOutputter, # outputter type
               "TDriver_LOG_stdout",	# outputter name
               :level => logging_level # logging level
             ) 
-            set_outputter_pattern( stdout_outputter, Parameter[ :logging_outputter_pattern ] )
+            set_outputter_pattern( stdout_outputter, $parameters[ :logging_outputter_pattern, '%d [%c] [%l] %M' ] )
+
             add_outputter( @logger_instance, stdout_outputter )
+
           end
 
         rescue

data/lib/tdriver/util/parameter/parameter.rb

@@ -427,6 +427,65 @@ module TDriver
 
           case element.name
 
+            when 'include'
+
+              directory = MobyUtil::FileHelper.expand_path( attributes[ 'directory' ] )
+
+              files_pattern = Regexp.new( attributes[ 'files' ] )
+
+=begin
+              pattern_flags = attributes[ 'flags' ].to_s.each_char.inject( 0 ){ | flags, char | 
+
+                case char
+
+                  when /m/i
+
+                    flags += Regexp::MULTILINE
+
+                  when /i/i
+
+                    flags += Regexp::IGNORECASE
+
+                  when /x/i
+
+                    flags += Regexp::EXTENDED
+
+                else
+
+                  raise ArgumentError, "Invalid regular expression pattern flag #{ char.inspect } (expected: 'm', 'i' or 'x')"
+
+                end
+
+              }
+=end
+  
+              value = ParameterHash.new
+
+              included_files = []
+
+              # iterate each found file from given directory
+              Dir.glob( File.join( directory, '*' ) ).each do | file |
+
+                # and merge content of the file if filename matches with given files pattern
+                if File.basename( file ) =~ files_pattern
+
+                  value.merge!( process_file( file, false ) ) 
+
+                  included_files << file
+
+                end
+
+              end
+
+              # merge included values to results
+              results.merge!( value )
+
+              # store included files to :included_files value
+              name = "included_files"
+
+              # append to :included files value
+              value = ( results[ name.to_sym, [] ].concat( included_files ) ).compact.uniq
+
             when 'keymap'
 
               # use element name as parameter name ("keymap")
@@ -672,8 +731,12 @@ module TDriver
 
         end
 
-        # apply global parameters to root level (e.g. MobyUtil::Parameter[ :logging_outputter_enabled ])
-        @parameters.recursive_merge!( get_template( 'global' ) )
+        # apply global parameters to root level (e.g. TDriver::Parameter[ :logging_outputter_enabled ])
+        @parameters.recursive_merge!( 
+
+          get_template( 'global' ) 
+
+        )
 
         # load and apply default parameter values
         load_default_parameters if options[ :load_default_parameters ] == true
@@ -694,7 +757,7 @@ module TDriver
       end
 
       # TODO: document me
-      def process_file( filename )
+      def process_file( filename, root = true )
 
         begin
         
@@ -702,7 +765,9 @@ module TDriver
           file_content = load_file( filename )
         
           # parse file content and retrieve root element
-          root_element = MobyUtil::XML.parse_string( file_content ).root
+          root_element = MobyUtil::XML.parse_string( file_content ) #.root
+
+          root_element = root_element.root if root == true
         
           # parse root element
           process_element( root_element )
@@ -766,192 +831,196 @@ module TDriver
       
     end # self
     
-    # TODO: document me
-    def self.parse_file( filename, reset_parameters = false )
+    class << self
 
-      # check argument type for filename
-      filename.check_type [ String ], 'wrong argument type $1 for filename argument (expected $2)'
+      # TODO: document me
+      def parse_file( filename, reset_parameters = false )
 
-      # check argument type for filename
-      reset_parameters.check_type [ TrueClass, FalseClass ], 'wrong argument type $1 for reset_parameters boolean argument (expected $2)'
+        # check argument type for filename
+        filename.check_type [ String ], 'wrong argument type $1 for filename argument (expected $2)'
 
-      # reset parameter hash if requested
-      @parameters.clear if reset_parameters == true
-    
-      # load and parse given file
-      load_parameters_file( filename )
-    
-    end
-    
-    # TODO: document me
-    def self.parse_string( source, merge_hashes = true )
-    
-      # check argument type for source
-      source.check_type [ String ], 'wrong argument type $1 for source XML argument (expected $2)'
+        # check argument type for filename
+        reset_parameters.check_type [ TrueClass, FalseClass ], 'wrong argument type $1 for reset_parameters boolean argument (expected $2)'
 
-      # check argument type for merge_hashes
-      merge_hashes.check_type [ TrueClass, FalseClass ], 'wrong argument type $1 for merge_hashes argument (expected $2)'
+        # reset parameter hash if requested
+        @parameters.clear if reset_parameters == true
+      
+        # load and parse given file
+        load_parameters_file( filename )
+      
+      end
+      
+      # TODO: document me
+      def parse_string( source, merge_hashes = true )
+      
+        # check argument type for source
+        source.check_type [ String ], 'wrong argument type $1 for source XML argument (expected $2)'
+
+        # check argument type for merge_hashes
+        merge_hashes.check_type [ TrueClass, FalseClass ], 'wrong argument type $1 for merge_hashes argument (expected $2)'
+
+        # process xml string, returns hash as result
+        hash = process_string( source )  
 
-      # process xml string, returns hash as result
-      hash = process_string( source )  
+        if merge_hashes
+        
+          @parameters.recursive_merge!( hash )
+        
+        else
 
-      if merge_hashes
+          @parameters.merge!( hash )
+        
+        end
       
-        @parameters.recursive_merge!( hash )
+      end
+          
+      # TODO: document me
+      def clear
       
-      else
-
-        @parameters.merge!( hash )
+        @parameter_files.clear
+      
+        @parameters.clear
       
       end
-    
-    end
-        
-    # TODO: document me
-    def self.clear
-    
-      @parameter_files.clear
-    
-      @parameters.clear
-    
-    end
 
-    # TODO: document me
-    def self.files
-    
-      # return loaded parameter files list
-      @parameter_files
-    
-    end
+      # TODO: document me
+      def files
+      
+        # return loaded parameter files list
+        @parameter_files
+      
+      end
 
-    # TODO: document me
-    def self.template_files
-    
-      # return loaded parameter files list
-      @template_files
-    
-    end
+      # TODO: document me
+      def template_files
+      
+        # return loaded parameter files list
+        @template_files
+      
+      end
 
-    # TODO: document me
-    def self.has_key?( key )
-    
-      @parameters.has_key?( key )
-    
-    end
+      # TODO: document me
+      def has_key?( key )
+      
+        @parameters.has_key?( key )
+      
+      end
 
-    # TODO: document me
-    def self.has_value?( key )
-    
-      @parameters.has_value?( key )
-    
-    end
+      # TODO: document me
+      def has_value?( key )
+      
+        @parameters.has_value?( key )
+      
+      end
 
-    # TODO: document me
-    def self.keys
-    
-      @parameters.keys
-    
-    end
+      # TODO: document me
+      def keys
+      
+        @parameters.keys
+      
+      end
 
-    # TODO: document me
-    def self.values
-    
-      @parameters.values
-    
-    end
+      # TODO: document me
+      def values
+      
+        @parameters.values
+      
+      end
 
-    # TODO: document me
-    def self.[]( key, *default )
-    
-      @parameters[ key, *default ]
-          
-    end
+      # TODO: document me
+      def []( key, *default )
+      
+        @parameters[ key, *default ]
+            
+      end
 
-    # TODO: document me
-    def self.[]=( key, value )
-    
-      @parameters[ key ] = value
-    
-    end
+      # TODO: document me
+      def []=( key, value )
+      
+        @parameters[ key ] = value
+      
+      end
 
-    # TODO: document me
-    def self.fetch( key, *default, &block )
+      # TODO: document me
+      def fetch( key, *default, &block )
 
-      @parameters.__send__( :[], key, *default, &block )
+        @parameters.__send__( :[], key, *default, &block )
 
-    end
+      end
 
-    # TODO: document me
-    def self.if_found( key, &block )
+      # TODO: document me
+      def if_found( key, &block )
 
-      @parameters.__send__( :if_found, key, &block )
+        @parameters.__send__( :if_found, key, &block )
 
-    end
+      end
 
-    # TODO: document me
-    def self.delete( key )
-    
-      @parameters.delete( key )
-    
-    end
-    
-    # TODO: document me
-    def self.inspect
-    
-      @parameters.inspect
-    
-    end
+      # TODO: document me
+      def delete( key )
+      
+        @parameters.delete( key )
+      
+      end
+      
+      # TODO: document me
+      def inspect
+      
+        @parameters.inspect
+      
+      end
 
-    # TODO: document me
-    def self.templates
-    
-      @templates
-    
-    end
+      # TODO: document me
+      def templates
+      
+        @templates
+      
+      end
 
-    def self.parameters
+      def parameters
 
-      warn "warning: deprecated method #{ self.name }##{ __method__ }; please use #{ self.name }#hash instead"
-    
-      hash
+        warn "warning: deprecated method #{ self.name }##{ __method__ }; please use #{ self.name }#hash instead"
       
-    end
+        hash
+        
+      end
 
-    def self.hash
-    
-      @parameters
+      def hash
       
-    end
+        @parameters
+        
+      end
 
-    # TODO: document me
-    def self.reset
+      # TODO: document me
+      def reset
 
-      reset_hashes
-          
-    end
+        reset_hashes
+            
+      end
 
-    # TODO: document me
-    def self.configured_suts
-    
-      @sut_list
-    
-    end
-  
-    # deprecated methods
-    def self.reset_parameters
-    
-      warn "warning: deprecated method #{ self.name }##{ __method__ }; please use #{ self.name }#reset instead"
-    
-      reset
+      # TODO: document me
+      def configured_suts
+      
+        @sut_list
+      
+      end
     
-    end
+      # deprecated methods
+      def reset_parameters
+      
+        warn "warning: deprecated method #{ self.name }##{ __method__ }; please use #{ self.name }#reset instead"
+      
+        reset
+      
+      end
+
+      # load parameter xml files
+      def load_parameters_xml( filename, reset = false )
 
-    # load parameter xml files
-    def self.load_parameters_xml( filename, reset = false )
+        warn "warning: deprecated method #{ self.name }##{ __method__ }; please use #{ self.name }#parse_file instead"
 
-      warn "warning: deprecated method #{ self.name }##{ __method__ }; please use #{ self.name }#parse_file instead"
+        parse_file( filename, reset )
 
-      parse_file( filename, reset )
+      end
 
     end