testability-driver 0.9.2

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

@@ -0,0 +1,101 @@
+############################################################################
+## 
+## 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 ParameterHash < Hash
+
+    def initialize( hash = {} )
+
+      Kernel::raise ArgumentError.new( "Unexpected argument type %s, expecting Hash or ParameterHash" % [ hash.class ] ) unless [ Hash, ParameterHash ].include?( hash.class )
+
+      merge!( 
+
+        hash.empty? ? hash : convert_hash( hash )
+
+      )
+
+    end
+
+    def convert_hash( hash )
+
+      hash.kind_of?( ParameterHash ) ? hash : ParameterHash[ hash.collect{ | key, value | [ key, value.kind_of?( Hash ) ? convert_hash( value ) : value ] } ]
+
+    end
+
+    def []( key, *default, &block )
+
+      $last_parameter = fetch( key ){ 
+
+        if default.empty?
+
+          Kernel::raise ParameterNotFoundError.new( "Parameter %s not found." % [ key ] ) unless block_given?
+
+          # yield with key if block given
+          result = yield( key )
+
+        else
+          Kernel::raise ArgumentError.new( "Only one default value allowed for parameter (%s)" % [ default.join(", ") ] ) unless default.size == 1
+
+          result = default[ 0 ]
+
+        end
+
+        result.kind_of?( Hash ) ? convert_hash( result ) : result
+
+      }
+
+    end
+
+    def []=( key, value )
+
+      Kernel::raise ParameterNotFoundError.new( "Parameter key nil is not valid." ) unless key
+
+      store( key, ( value.kind_of?( Hash ) ? convert_hash( value ) : value ) )
+
+    end
+
+    # Merge this Hash with another, primary Hash. Any values found in the other hash will overwrite local values and any Hash values will be recursively merged.
+    def merge_with_hash!( primary_hash )
+
+      raise ArgumentError.new( "Unable to merge, the other Hash was not a Hash, it was of type \"" + primary_hash.class.to_s + "\"." ) unless primary_hash.kind_of?( Hash )
+
+      primary_hash.each_pair do | key, value |
+
+        if ( self.has_key?( key ) && self[ key ].kind_of?( Hash ) ) and primary_hash[ key ].kind_of?( Hash )
+
+          self[ key ].merge_with_hash!( value )
+
+        else
+
+          self[ key ] = value
+
+        end
+
+      end
+
+      self
+      
+    end
+
+    MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+  end # ParameterHash
+
+end # MobyUtil

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

@@ -0,0 +1,120 @@
+############################################################################
+## 
+## 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 ParameterTemplates
+
+    include Singleton
+
+    def initialize
+
+      @@templates = nil
+
+    end
+
+    def load_templates()
+
+      content = MobyUtil::ParameterXml.instance.merge_files( 'templates/', 'templates', '/templates/*' )
+
+      @@templates = MobyUtil::XML::parse_string( content )
+
+    end
+
+    # Helper method for 'get_template_from_xml' to retrieve all requested inherited parameters.
+    # === params
+    # list_of_inherited_templates:: String representation of template names, separated with ";"
+    # === returns
+    # Hash:: Hash containing parameters
+    # === raises
+    # === example
+    # result_hash = get_inherited_parameters( "template1;template2;template3" )
+    def get_inherited_parameters( list_of_inherited_templates )
+
+      result = ParameterHash.new
+      
+      if list_of_inherited_templates.kind_of?( String )
+
+        list_of_inherited_templates.split( ";" ).each{ | inherits_from | 
+          
+          result.merge_with_hash!( 
+
+            get_template_from_xml( inherits_from ) 
+          
+          ) 
+
+        }
+
+      end
+
+      result
+
+    end
+
+    def get_template_from_xml( template_name )
+
+      result = ParameterHash.new 
+
+      # return empty template hash if no templates loaded
+      return result unless @@templates
+
+      begin
+
+        template_nodeset = @@templates.xpath( "/templates/template[@name='%s']" % [ template_name ] )
+
+        if template_nodeset.size > 0
+
+          template_nodeset.each{ | template_node | 
+
+            # merge and overwrite inherited template parameters 
+            result.merge!( 
+
+              get_inherited_parameters( 
+
+                template_node.attribute( 'inherits' ).to_s
+
+              ) 
+
+            ).merge!( 
+
+              # merge template to hash
+              MobyUtil::ParameterXml.instance.parse( template_node.to_s ) 
+
+            )
+          }
+
+        end
+
+      rescue Exception => exception
+
+        Kernel::raise RuntimeError.new( 
+          "Error retrieving template %s from xml. Reason: %s (%s)" % [ template_name, exception.message, exception.class ] 
+        ) 
+
+      end
+
+      result
+
+    end
+
+    MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+  end # ParameterTemplates
+
+end # MobyUtil

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

@@ -0,0 +1,84 @@
+############################################################################
+## 
+## 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 ParameterUserAPI
+
+    include Singleton
+
+    def []=( key, value )
+
+      MobyUtil::Parameter[ key ] = value
+
+    end
+
+    def []( *args )
+
+      MobyUtil::Parameter[ *args ]
+
+    end
+
+    def fetch( *args, &block )
+
+      MobyUtil::Parameter.fetch( *args, &block )
+
+    end
+
+    def files
+
+      MobyUtil::Parameter.files
+
+    end
+
+    def clear
+
+      MobyUtil::Parameter.instance.clear
+
+    end
+
+    def load_xml( filename )
+
+      MobyUtil::Parameter.instance.load_parameters_xml( filename )
+
+    end
+
+    def reset( *keys )
+
+      MobyUtil::Parameter.instance.reset_parameters
+
+    end
+
+    def inspect
+
+      MobyUtil::Parameter.inspect
+
+    end
+
+    def to_s
+
+      MobyUtil::Parameter.to_s
+
+    end
+
+    MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+  end # ParameterUserAPI
+
+end # MobyUtil

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

@@ -0,0 +1,247 @@
+############################################################################
+## 
+## 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 ParameterXml
+
+    include Singleton
+
+    @@initialized = false
+
+    # initialize class with default values
+    def initialize
+
+      reset
+
+      @@initialized = true
+
+    end
+
+    def reset
+
+      @@sut_list = []
+
+    end
+
+    # return list of configured suts
+    def sut_list
+
+      @@sut_list
+
+    end
+
+    # Recursive function to process xml. Requires input to be either a valid xml fragment (as string) or a xml fragment as object. 
+    # Note: validity of the xml-fragment is not checked: please use appropriate methods for that
+    # === params
+    # root_element:: document or string containing xml
+    # === returns
+    # Hash:: Hash containing any attributes, parameters and id:s
+    # === raises
+    # SyntaxError:: if parameter-element does not have a name
+    # ParameterError:: if loading subfile fails, see get_xmldocument_from_file function
+    def parse( xml )
+
+      # default results 
+      results = ParameterHash.new()
+
+      begin
+        # create new xml document
+        document = MobyUtil::XML::parse_string( xml )
+
+      rescue Exception => exception
+
+        Kernel::raise ParameterFileParseError.new( "Error occured while parsing XML. Reason %s (%s)" % [ exception.message, exception.class ] )
+
+      end
+
+      # go through each element in xml
+      document.xpath( "/#{ document.root.name }/*" ).each{ | element |
+
+        attribute = element.attributes.to_hash
+
+        name = attribute[ "name" ].to_s
+        value = attribute[ "value" ].to_s
+
+        case element.name
+            
+          when 'fixture'
+
+            plugin = attribute[ "plugin" ].to_s
+
+            Kernel::raise SyntaxError.new( "No name defined for fixture with value %s" % name ) if name.empty?
+            Kernel::raise SyntaxError.new( "No plugin defined for fixture with name %s" % name ) if plugin.empty?
+
+            value = plugin
+
+          when 'parameter'
+
+            Kernel::raise SyntaxError.new( 
+
+              "No name defined for parameter with value %s" % attribute[ 'value' ]
+
+            ) unless attribute[ "name" ]
+
+        else
+
+          if element.name == 'sut'
+
+            id = attribute[ 'id' ].to_s
+
+            # store sut id to array if element is type of sut
+            @@sut_list << id unless @@sut_list.include?( id ) 
+
+          end
+
+          # get template name(s) if given
+          templates = attribute[ "template" ].to_s
+
+          # empty value by default - content will be retrieved above
+          value = ParameterHash.new()
+
+          # use template if defined
+          value = MobyUtil::ParameterTemplates.instance.get_template_from_xml( templates.to_s ) unless templates.empty?
+
+          # read xml file from given location if defined - otherwise pass content as is
+          if element.attribute( "xml_file" )
+
+            content = parse( MobyUtil::FileHelper.get_file( element.attribute( "xml_file" ).to_s ) )
+
+          else
+
+            content = parse( "<xml>#{ element.inner_xml }</xml>" )
+
+          end
+
+          value.merge_with_hash!( content )
+
+          name = ( element.attribute( "id" ) || element.name ).to_s
+
+        end
+
+        # store values to parameters
+        results[ name.to_sym ] = value
+
+      }
+
+      # dispose xml document
+      document = nil
+
+      # return results hash
+      results
+
+    end
+
+    def load_file( filename )
+
+      filename = MobyUtil::FileHelper.expand_path( filename )
+
+      begin
+
+        file_content = MobyUtil::FileHelper.get_file( filename )
+
+      rescue EmptyFilenameError
+
+        Kernel::raise EmptyFilenameError.new( "Unable to load parameters xml file due to filename is empty or nil" )
+
+      rescue FileNotFoundError => exception
+
+        Kernel::raise exception
+
+      rescue IOError => exception
+
+        Kernel::raise IOError.new( "Error occured while loading xml file. Reason: %s (%s)"  % [ exception.message, exception.class ] )
+
+      rescue => exception
+
+        Kernel::raise ParameterFileParseError.new("Error occured while parsing parameters xml file %s\nDescription: %s" % [ filename, exception.message ] )
+
+      end
+
+    end
+
+    def parse_file( filename )
+
+      begin
+      
+        parse( 
+
+          load_file( filename ) 
+
+        )
+
+      rescue Exception => exception
+
+        Kernel::raise ParameterFileParseError.new( 
+
+          "Error occured while parsing parameters xml file %s. Reason: %s (%s)" % [ filename, exception.message, exception.class ] 
+
+        )
+
+      end
+
+    end
+
+    def merge_files( path, root_element_name, xpath_to_element = '/*', &block )
+
+      @filename = ""
+
+      xml = ""
+
+      begin
+  
+        # merge all xml files
+        Dir.glob( File.join( MobyUtil::FileHelper.expand_path( path ), '/*.xml' ) ).each { | filename | 
+
+          @file_name = filename
+
+          content = MobyUtil::FileHelper.get_file( filename )
+
+          xml << MobyUtil::XML::parse_string( content ).root.xpath( xpath_to_element ).to_s
+
+          # pass the filename to block if one given
+          yield( filename ) if block_given?
+
+        }
+
+        xml = "<%s>%s</%s>" % [ root_element_name, xml.to_s, root_element_name ]
+
+      rescue MobyUtil::EmptyFilenameError
+
+        Kernel::raise EmptyFilenameError.new( "Unable to load xml file due to filename is empty or nil" )
+
+      rescue MobyUtil::FileNotFoundError => exception
+
+        Kernel::raise exception
+
+      rescue Exception => exception
+
+        Kernel::raise RuntimeError.new( "Error occured while parsing xml file %s. Reason: %s (%s)" % [ @filename, exception.message, exception.class ] )
+
+      end
+
+      xml
+
+    end
+
+    MobyUtil::Hooking.instance.hook_methods( self ) if defined?( MobyUtil::Hooking )
+
+  end # ParameterXml
+
+end # MobyUtil