cutedriver-driver 2.0.0.20210120164037

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

@@ -0,0 +1,47 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+require 'rbconfig'  # ??
+
+# common modules - should be generic and runnable as standalone
+[ 
+  # Ruby object extensions
+  'object.rb', 
+  'numeric.rb', 
+  'hash.rb', 
+  'string.rb',
+  'boolean.rb',
+  
+  'exceptions.rb', 
+  'error.rb', # TODO: move custom exceptions to exceptions.rb
+  
+  'array.rb', 
+  'crc16.rb', 
+  'environment.rb', 
+  'file.rb', 
+  'gem.rb', 
+  'kernel.rb', 
+  'retryable.rb',
+  'stackable.rb' 
+
+].each{ | filename |
+
+  require File.expand_path( File.join( File.dirname( __FILE__ ), filename ) )
+
+}

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

@@ -0,0 +1,159 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+# extend Ruby Numeric class functionality
+class Numeric
+
+  # TODO: document me
+  def positive?
+
+    self > 0
+
+  end
+
+  # TODO: document me  
+  def non_negative?
+
+    self >= 0
+
+  end
+
+  # TODO: document me  
+  def non_positive?
+
+    self <= 0  
+
+  end
+
+  # TODO: document me  
+  def negative?
+
+    self < 0
+
+  end
+
+  # TODO: document me
+  def not_negative( message = 'Given value ($1) must not be negative', exception = ArgumentError )
+
+    if negative?
+
+      # replace macros
+      message.gsub!( '$1', inspect )
+
+      raise exception, message, caller
+
+    end
+  
+    self
+    
+  end
+
+  # TODO: document me
+  def not_zero( message = 'Given value must not be zero', exception = ArgumentError )
+
+    if zero?
+
+      # replace macros
+      message.gsub!( '$1', inspect )
+
+      raise exception, message, caller
+
+    end
+      
+    self
+  
+  end
+
+  # TODO: document me
+  def not_positive( message = 'Given value ($1) must not be positive', exception = ArgumentError )
+
+    if positive?
+
+      # replace macros
+      message.gsub!( '$1', inspect )
+
+      raise exception, message, caller
+
+    end
+  
+    self
+  
+  end
+
+  # TODO: document me
+  def check_range( range, message = "value $1 is out of range ($2)"  )
+
+    # check that given argument is type of Range
+    raise TypeError, 'wrong argument type #{ range.class } for range (expected Range)' unless range.kind_of?( Range )
+
+    # check that given argument is type of Range
+    raise TypeError, 'wrong argument type #{ message.class } for exception message (expected String)' unless message.kind_of?( String )
+
+    # replace macros
+    message.gsub!( '$1', inspect )
+    
+    message.gsub!( '$2', range.inspect )
+
+    # raise exception if number is out of range
+    raise RangeError, message unless range.include?( self )
+    
+    # return self
+    self
+    
+  end
+
+  # TODO: document me
+  def limit( minimum_value, maximum_value )
+
+    # limit current value
+    min( minimum_value ).max( maximum_value )
+
+  end
+
+  # TODO: document me
+  def max( value )
+
+    if value.kind_of?( Numeric )
+
+      self > value ? value : self
+
+    else
+
+      raise TypeError, "wrong type #{ value.class } for value (expected Numeric)"
+
+    end
+
+  end
+
+  # TODO: document me
+  def min( value )
+
+    if value.kind_of?( Numeric )
+
+      self < value ? value : self
+
+    else
+
+      raise TypeError, "wrong type #{ value.class } for value (expected Numeric)"
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,159 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+# extend Ruby Object class functionality
+class Object
+
+  # TODO: document me
+  def blank?
+  
+    respond_to?( :empty? ) ? empty? : !self
+  
+  end
+
+  # TODO: document me
+  def true?
+
+    false
+  
+  end
+  
+  # TODO: document me
+  def false?
+  
+    false
+  
+  end
+
+  # TODO: document me
+  def not_blank( message = "object must not be blank", exception = ArgumentError )
+
+    raise exception, message, caller if blank? 
+
+    self
+
+  end
+  
+  # define method to class instance
+  def meta_def( method_name, &block )
+  
+    ( class << self; self; end ).instance_eval{ define_method method_name, &block }
+    
+  end
+
+  # Compare receiver object type with given types. Raises exception is class name does not equal.
+  def check_type( types, message = "wrong argument type $1 (expected $2)" )
+
+    # raise exception if message is not type of String
+    raise TypeError, "wrong argument type #{ message.class } for message (expected String)", caller unless message.kind_of?( String )
+
+    # create array of types
+    type_array = Array( types )
+
+    # default result value
+    found = false
+
+    # collect verbose type list
+    verbose_type_list = type_array.each_with_index.collect{ | type, index | 
+
+      raise TypeError, "invalid argument type #{ type } for check_type. Did you mean #{ type.class }?", caller unless type.kind_of?( Class )
+
+      if kind_of?( type )
+
+        found = true 
+
+        break
+
+      end
+
+      # result string, separate types if multiple types given
+      "#{ ( ( index > 0 ) ? ( index + 1 < type_array.count ? ", " : " or " ) : "" ) }#{ type.to_s }"
+          
+    }
+
+    # raise exception if type did not match
+    unless found
+
+      # convert macros
+      [ self.class, verbose_type_list.join, inspect ].each_with_index{ | param, index | message.gsub!( "$#{ index + 1 }", param.to_s ) }
+
+      # raise the exception
+      raise TypeError, message, caller
+
+    end
+
+    # pass self as return value
+    self
+
+  end
+
+  def not_nil( message = "Value must not be nil", exception = ArgumentError )
+
+    raise exception, message, caller unless self
+
+    self
+
+  end
+
+  def validate( values, message = "Unexpected value $3 for $1 (expected $2)" )
+
+    # raise exception if message is not type of String
+    raise TypeError, "wrong argument type #{ message.class } for message (expected String)", caller unless message.kind_of?( String )
+
+    # create array of values
+    values_array = Array( values )
+
+    # default result value
+    found = false
+
+    # collect verbose type list
+    verbose_values_list = values_array.each_with_index.collect{ | value, index | 
+
+      raise TypeError, "Invalid argument type #{ value.class } for value (expected #{ self.class })", caller unless value.kind_of?( self.class )
+
+      if self == value
+      
+        found = true 
+        
+        break
+        
+      end
+
+      # result string, separate types if multiple types given
+      "#{ ( ( index > 0 ) ? ( index + 1 < values_array.count ? ", " : " or " ) : "" ) }#{ value.inspect }"
+          
+    }
+
+    # raise exception if value was not found
+    unless found
+
+      # convert macros
+      [ self.class, verbose_values_list.join, inspect ].each_with_index{ | param, index | message.gsub!( "$#{ index + 1 }", param.to_s ) }
+
+      # raise the exception
+      raise ArgumentError, message, caller
+
+    end
+
+    # pass self as return value
+    self
+        
+  end
+
+end

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

@@ -0,0 +1,179 @@
+############################################################################
+## 
+## 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 MobyUtil
+
+  class Retryable
+
+    # TODO: document me
+    def self.sleep_retry_interval( time )
+
+      sleep( time )
+
+    end
+
+    # Function to retry code block for x times if exception raises
+    # == params
+    # options:: Hash of options 
+    #   :tries  Number of tries to perform. Default is 1
+    #   :interval  Timeout between retry. Default is 0
+    #   :exception  Retry if given type of exception occures. Default is Exception (any error)
+    # == returns
+    def self.while( options = {}, &block )
+
+      # default options
+      options.default_values( :tries => 1, :interval => 0, :exception => Exception )
+
+      attempt = 1
+
+
+      # number of block arguments
+      _block_arity = block.arity 
+
+      if _block_arity > 1
+
+        _block_arity = 2
+
+      elsif _block_arity < 1
+
+        _block_arity = 0
+
+      end
+
+      # last exception
+      _exception = nil
+
+      # default
+      _arguments = []
+
+      begin
+
+        case _block_arity
+
+          when 1
+          arguments = [ attempt ]
+
+          when 2
+          arguments = [ attempt, _exception ]
+
+        end
+
+        # yield given block and pass attempt number as parameter
+        yield( *arguments )
+
+      rescue *options[ :exception ]
+
+        _exception = $!
+
+        if ( attempt < options[ :tries ] ) && ![ *options[ :unless ] ].include?( $!.class )
+
+          sleep_retry_interval( options[ :interval ] ) if options[ :interval ] > 0
+
+          attempt += 1
+
+          retry
+
+        end
+
+        # raise exception with correct exception backtrace
+        raise $!
+
+      end
+      
+    end
+
+    # Function to retry code block until timeout expires if exception raises 
+    # == params
+    # options:: Hash of options 
+    #   :timeout  Timeout until fail. Default is 0
+    #   :interval  Timeout between retry. Default is 0
+    #   :exception  Retry if given type of exception occures. Default is Exception (any error)
+    # == returns
+    def self.until( options = {}, &block )
+
+      # default options
+      options.default_values( :timeout => 0, :interval => 0, :exception => Exception )
+      
+      # store start time
+      start_time = Time.now
+
+      # attempt number
+      attempt = 0
+
+      # number of block arguments
+      _block_arity = block.arity 
+
+      if _block_arity > 1
+
+        _block_arity = 2
+
+      elsif _block_arity < 1
+
+        _block_arity = 0
+
+      end
+
+      # last exception
+      _exception = nil
+
+      # default
+      _arguments = []
+
+      begin
+
+        case _block_arity
+
+          when 1
+          arguments = [ attempt ]
+
+          when 2
+          arguments = [ attempt, _exception ]
+
+        end
+
+        # execute block
+        yield( *arguments )
+
+      rescue *options[ :exception ]
+
+        _exception = $!
+
+        if (Time.now - start_time) <= options[ :timeout ] && ![ *options[ :unless ] ].include?( $!.class )
+
+          sleep_retry_interval( options[ :interval ] ) if options[ :interval ] > 0
+
+          attempt += 1
+
+          retry
+
+        end
+
+        # raise exception with correct exception backtrace
+        raise $!
+
+      end
+
+    end
+
+    # enable hooking for performance measurement & debug logging
+    TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
+
+  end # Retryable
+
+end # MobyUtil