testability-driver 0.9.2

data/lib/tdriver/util/other/config.rb

@@ -0,0 +1,221 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+
+#!/usr/bin/ruby
+
+require 'tdriver'
+
+#require File.expand_path( File.join( File.dirname( __FILE__ ), 'xml/xml' ) )
+#require File.expand_path( File.join( File.dirname( __FILE__ ), 'common' ) )
+
+def find_xml_element( document, name )
+
+	document.root.xpath( "/parameters/*[@name='#{ name }']" )
+
+end
+
+def change_attr_value( node, attribute_name, value )
+  
+	node.xml.attr( attribute_name, value.to_s )
+
+end
+
+def change_value( path, attribute, value )
+
+	filename = MobyUtil::FileHelper.fix_path( "#{ MobyUtil::FileHelper.tdriver_home }/tdriver_parameters.xml" )
+
+	xml_document = MobyUtil::XML::parse_file( filename )
+
+	node = find_xml_element( xml_document, path )
+	#p node
+
+	change_attr_value( node, attribute, value)
+	#p node
+
+	File.open( filename, "w" ){ | file_object | file_object << xml_document.xml }
+  
+end
+
+#xml_document = MobyUtil::XML::parse_file( MobyUtil::FileHelper.fix_path( "#{ MobyUtil::FileHelper.tdriver_home }/tdriver_parameters.xml" ) )
+
+#root_element = xml_document.root.xpath("/parameters/*[@id='sut_qt']")
+
+=begin
+root_element = xml_document.root.xpath("/parameters/parameter[@name='app_path']") 
+
+p root_element.xml
+
+root_element.xml.attr("value", "10")
+
+p root_element.xml
+
+p xml_document
+
+=end
+
+#p root_element.xml.class
+
+=begin
+  
+nimi = 'sut_qt'
+
+root_element = xml_document.root.xpath("/parameters/*[@id='#{ nimi }' or @name='#{ nimi }']/fixtures") #*[@id='#{ nimi }' or @name='#{ nimi }']")
+
+p root_element
+
+root_element = xml_document.root.xpath("/parameters/*[@id='#{ nimi }' or @name='#{ nimi }']")
+
+
+p root_element
+
+=end
+
+
+#p root_element.xml.keys
+
+#node = Nokogiri::XML::Node.new("<nimi>l</nimi>", xml_document.xml)
+
+#root_element.xml.push( node )
+
+#xml_document.root.xml.add_child( node )
+
+
+#p root_element.xml.to_xml
+
+#p xml_document.xml.to_xml
+
+
+#p root_element.class
+
+#p xml_document.xml
+
+#exit
+
+def help
+
+=begin
+
+Usage:    
+Products: 
+Options:
+          -a arch   architecture [all] (arm, x86, all)
+          -c path   custom scratchbox path [/scratchbox]
+          -d        display debug messages
+                    WARNING: may contain sensitive information such as password
+          -e        create targets that use files.maemo.org as the repository
+          -f        overwrite previously existing target if one exists
+          -h        display help
+          -p pass   password for the repository/rootstrap download
+          -r name   release name [pre-release] (current, pre-release, previous)
+                    you can use build number instead of release name
+          -s        select the created target
+          -t prefix custom prefix for target names [maemoX]
+                    target name will be \$prefix-\$arch
+          -u user   username for the repository/rootstrap download
+          -A        save authentication data into .netrc in your scratchbox home
+                    WARNING: your username and password will be written
+                             in cleartext into your scratchbox home .netrc
+          -C config use custom configuration as rootstrap [minimaldev]
+                    configuration used will be \$arch-\$config
+          -D        don't install debug links
+          -I        don't install files to rootstrap
+          -P        don't allow unauthenticated packages
+          -R        don't install rootstrap
+          -S        keep sources.list provided by rootstrap
+          -U        save authentication data in sources.list
+                    WARNING: your username and password will be written
+                             in cleartext into your target's sources.list
+
+
+=end
+
+  puts <<HELP
+
+Usage: 
+  tdriver-config read [path]
+    
+Example:
+  tdriver-config read                        - List keys from root level 
+  tdriver-config read sut_qt                 - List keys from "sut_qt" hash
+  tdriver-config read sut_qt/keymap/kApp   - Retrieve value of kApp
+  
+HELP
+
+  exit
+  
+end
+
+def print_key( key, value )
+  puts "%s %s" % [ "#{key} ".ljust(65, '.'), value.kind_of?( Hash ) ? "<Multiple values>" : "\"#{ value.to_s }\"" ]    
+end
+
+def dump_hash_values( hash, path = "" )
+  hash.keys.sort{ |a,b| a.to_s <=> b.to_s }.each{ | key | print_key( key, hash[ key ] ) }  
+end
+
+def resolve_hash_path( hash, path_string )
+  return [ "", hash ] if path_string.nil? or ( path_string.kind_of?( String) and path_string.empty? )
+  path = hash; path_array = path_string.split( "/" ); current_path = []  
+  [ path_array[ -1 ], ( path_array.collect{ | key |   
+    current_path = current_path + [ key ]    
+    if !path.has_key?( key.to_sym );  puts "No such key/hash found (%s)\n\n" % [ current_path.join( "::" ) ]; exit; end
+    path = path[ key.to_sym ]    
+  }.compact)[ -1 ] ]
+end
+
+if ARGV.count < 1;
+
+  help; 
+
+else
+  
+  if ![ 'read', 'write' ].include?( ARGV[ 0 ].downcase ) #!= 'read'
+    puts "Currently only read and write is supported"; help; exit
+  end
+  
+  mode = ARGV[ 0 ].downcase == 'read' ? :read : :write 
+
+  puts "\n"   
+   
+  case mode
+    
+  when :write
+    
+      change_value( ARGV[ 1 ], "value", ARGV[ 2 ])
+      print_key ARGV[ 1 ], ARGV[ 2 ]
+  
+      # reload new settings
+      #Singleton.__init__( MobyUtil::Parameter )     
+      
+    when :read
+
+      require 'tdriver'
+
+      result = resolve_hash_path( MobyUtil::Parameter.parameters, ARGV[ 1 ])
+
+      result[ 1 ].kind_of?( Hash ) ? ( dump_hash_values result[ 1 ] ) : ( print_key result[ 0 ], result[ 1 ] )  
+    
+  end
+
+  puts "\n"
+    
+    
+end
+

data/lib/tdriver/util/parameter.rb

@@ -0,0 +1,24 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+
+STDOUT.puts "Please require 'util/parameter/loader.rb' instead of 'util/parameter.rb'"
+
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'parameter/loader.rb' ) )
+

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

@@ -0,0 +1,45 @@
+############################################################################
+## 
+## 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
+
+	# This is template for tdriver custom errors
+	class CustomError < StandardError; 
+
+		def initialize( msg = nil )
+		
+			super( msg )
+
+		end
+
+	end
+
+	# This error should be raised when referred parameter is not found
+	class ParameterNotFoundError < CustomError; end
+
+	# This error should be raised when parameter file parsing fails
+	class ParameterFileParseError < CustomError; end
+
+	# This error should be raised when desired template was not found
+	class TemplateNotFoundError < CustomError; end
+
+	# This error should be raised when desired template was not found
+	class TemplatesFileNotLoaded < CustomError; end
+
+end # MobyUtil

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

@@ -0,0 +1,37 @@
+############################################################################
+## 
+## 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. 
+## 
+############################################################################
+
+# Parameter related errors
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'error.rb' ) )
+
+# Parameter hash class 
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'parameter_hash.rb' ) )
+
+# Parameter API etc
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'parameter_template.rb' ) )
+
+# Parameter API etc
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'parameter_xml.rb' ) )
+
+# Parameter end user API etc
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'parameter_user_api.rb' ) )
+
+# Parameter API etc
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'parameter.rb' ) )
+

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

@@ -0,0 +1,285 @@
+############################################################################
+##
+## 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 Parameter
+
+    include Singleton
+
+    @@initialized = false
+
+    private
+
+    def initialize
+
+      # this can be done only once due to following method removes --tdriver_parameters argument from ARGV
+      @@filename_from_command_list_arguments = parse_command_line_arguments
+
+      # initialize and load templates, default parameters and user defined parameter file
+      reset( true, true, true, true )
+
+      # parameter singleton is now initialized
+      @@initialized = true
+
+    end
+
+    def parse_command_line_arguments
+
+      # reset user_defined_file_defined_in_command_line_arguments flag
+      @@user_defined_parameters_file_defined_in_command_line_arguments = false
+
+      filename = Array.new
+      delete_values=Array.new
+
+      # use command line argument if one exists.
+      ARGV.each_index do | index |
+
+        if ARGV[ index ].to_s == '--matti_parameters'
+          puts "--matti_parameters is deprecated, use -tdriver_parameters instead"
+          Kernel::raise ArgumentError.new( "TDriver parameters command line argument given without a filename" ) if ARGV.count == index + 1
+          delete_values << ARGV[ index ].to_s
+        end
+
+        if ARGV[ index ].to_s == '--tdriver_parameters'
+          Kernel::raise ArgumentError.new( "TDriver parameters command line argument given without a filename" ) if ARGV.count == index + 1
+          delete_values << ARGV[ index ].to_s
+        end
+
+        if ARGV[ index ].to_s.downcase.include?('.xml')
+          # no absolute path required
+          filename << File.expand_path( ARGV[ index ].to_s )
+          #filename << MobyUtil::FileHelper.expand_path( ARGV[ index ].to_s )
+          @@user_defined_parameters_file_defined_in_command_line_arguments = true
+          delete_values << ARGV[ index ].to_s
+        end
+
+      end
+
+      #clean up ARGV
+      delete_values.each do | value |
+        indx = ARGV.index( value )
+        ARGV.delete_at( indx )
+      end
+
+      if filename
+        filename.each do | parameter_file |
+          Kernel::raise MobyUtil::FileNotFoundError.new( "User defined TDriver parameters file %s does not exist" % [ parameter_file ] ) if !File.exist?( parameter_file )
+        end
+      end
+
+      filename
+
+    end
+
+    protected
+
+    def reset_flags
+
+      # reset loaded_parameter_files list
+      @@loaded_parameter_files = []
+
+      # reset templates_loaded flag
+      @@templates_loaded = false
+
+      # reset default_parameters_loaded flag
+      @@default_parameters_loaded = false
+
+    end
+
+    def reset( load_template_files = true, load_parameter_defaults = true, load_default_parameters = true, load_command_line_parameters = true )
+
+      reset_flags
+
+      # load parameter templates
+      load_templates if load_template_files
+
+      # load global parameters (root level, e.g. MobyUtil::Parameter[ :logging_outputter_enabled ])
+      @@parameters = MobyUtil::ParameterTemplates.instance.get_template_from_xml( 'global' )
+
+      # load and merge with default parameters
+      @@parameters.merge_with_hash!( load_default_parameter_files ) if load_parameter_defaults
+
+      # use filename from command line argument if one exists otherwise use default.
+      filename = load_command_line_parameters ? @@filename_from_command_list_arguments : nil
+
+      # load default tdriver/tdriver_parameters.xml file
+      load_parameters_xml( "tdriver_parameters.xml" ) if load_default_parameters
+
+      # load parameters files unless file does not exist
+      if filename
+        filename.each do |parameter_file|
+
+          load_parameters_xml( parameter_file ) if File.exist?( parameter_file )
+
+        end
+      end
+
+
+    end
+
+    def load_templates
+
+      @@templates_loaded = true
+
+      MobyUtil::ParameterTemplates.instance.load_templates()
+
+    end
+
+    def load_default_parameter_files
+
+      @@default_parameters_loaded = true
+
+      # load default parameter values
+      MobyUtil::ParameterXml.instance.parse(
+
+        MobyUtil::ParameterXml.instance.merge_files( 'defaults/', 'parameters', '/parameters/*' ){  | filename |
+
+          @@loaded_parameter_files << filename unless @@loaded_parameter_files.include?( filename )
+
+        }
+
+      )
+
+    end
+
+    public
+
+    # reset parameters class
+    def reset_parameters
+
+      MobyUtil::ParameterXml.instance.reset
+
+      reset( true, true, true, true )
+
+    end
+
+    # load additional parameter xml files
+    def load_parameters_xml( filename, reset = false )
+
+      reset_parameters if reset == true
+
+      filename = MobyUtil::FileHelper.expand_path( filename )
+
+      Kernel::raise MobyUtil::FileNotFoundError.new( "Parameters file %s does not exist" % [ filename ] ) if !File.exist?( filename )
+
+      @@parameters.merge_with_hash!(
+
+        MobyUtil::ParameterXml.instance.parse_file( filename )
+
+      )
+
+      @@loaded_parameter_files << filename
+
+    end
+ 
+    # empty parameters hash
+    def clear
+
+      MobyUtil::ParameterXml.instance.reset
+
+      reset_flags
+
+      @@parameters.clear
+
+    end
+
+    public # singleton methods
+
+    # Function for returning the value of a parameter. If the parameters is not yet populated it populates
+    # it with default file (tdriver_home/tdriver_parameters.xml)
+    # == params
+    # key:: Symbol containing the name of the parameter to be returned
+    # == returns
+    # String:: value of the parameter, or nil if not found
+    def self.[]( key, *default )
+
+      self.instance unless @@initialized
+
+      @@parameters[ key, *default ]
+
+    end
+
+    def self.fetch( key, *default, &block )
+
+      self.instance unless @@initialized
+
+      @@parameters.method(:[]).call( key, *default, &block )
+
+    end
+
+    # Function for setting the value of a parameter. If the parameters is not yet populated it populates
+    # it with default file (tdriver_home/tdriver_parameters.xml)
+    # == params
+    # key:: Symbol containing the name of the parameter to be modified
+    # == returns
+    # String:: new value of the parameter, or nil if not found
+    def self.[]=( key, value )
+
+      self.instance unless @@initialized
+
+      Kernel::raise ParameterNotFoundError.new( "Unable to set parameter value due to nil is not valid key; Parameter key must be type of String or Symbol" ) unless key
+
+      @@parameters[ key ] = value
+
+    end
+
+    def self.inspect
+
+      self.instance unless @@initialized
+
+      @@parameters.inspect
+
+    end
+
+    def self.to_s
+
+      self.instance unless @@initialized
+
+      @@parameters.to_s
+
+    end
+
+    def self.parameters
+
+      self.instance unless @@initialized
+
+      @@parameters
+
+    end
+
+    def self.configured_suts
+
+      self.instance unless @@initialized
+
+      MobyUtil::ParameterXml.instance.sut_list
+
+    end
+
+    def self.files
+
+      @@loaded_parameter_files
+
+    end
+
+    MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+  end # Parameter
+
+end # MobyUtil