testability-driver 1.1.1 → 1.2.1

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

@@ -1,120 +0,0 @@
-############################################################################
-## 
-## 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.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.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
-
-    TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
-
-  end # ParameterTemplates
-
-end # MobyUtil

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

@@ -1,116 +0,0 @@
-############################################################################
-## 
-## 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
-
-    # TODO: document me
-    def self.instance
-
-      warn("warning: #{ self.name } is static class, use MobyUtil::ParameterUserAPI#method instead of using instance method")
-
-      MobyUtil::ParameterUserAPI
-
-    end
-
-    # TODO: document me
-    def self.[]=( key, value )
-
-      $parameters[ key ] = value
-
-    end
-
-    # TODO: document me
-    def self.[]( *args )
-
-      $parameters[ *args ]
-
-    end
-
-    # TODO: document me
-    def self.fetch( *args, &block )
-
-      $parameters.fetch( *args, &block )
-
-    end
-
-    # TODO: document me
-    def self.files
-
-      $parameters.files
-
-    end
-
-    # TODO: document me
-    def self.clear
-
-      $parameters.clear
-
-    end
-
-    # TODO: document me
-    def self.load_xml( filename )
-
-      $parameters.parse_file( filename )
-
-    end
-
-    # TODO: document me
-    def self.reset( *keys )
-
-      $parameters.reset
-
-    end
-
-    # TODO: document me
-    def self.inspect
-
-      $parameters.inspect
-
-    end
-
-    # TODO: document me
-    def self.to_s
-
-      $parameters.to_s
-
-    end
-
-    # TODO: document me
-    def self.keys
-
-      $parameters.keys
-
-    end
-
-    # TODO: document me
-    def self.values
-
-      $parameters.values
-
-    end
-
-    TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
-
-  end # ParameterUserAPI
-
-end # MobyUtil

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

@@ -1,261 +0,0 @@
-############################################################################
-## 
-## 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
-
-    # default values
-    @@sut_list = []
-
-    def self.reset
-
-      @@sut_list = []
-
-    end
-
-    # return list of configured suts
-    def self.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 self.parse( xml )
-
-      # default results 
-      results = MobyUtil::ParameterHash.new
-
-      # retrieve platform name
-      platform = MobyUtil::EnvironmentHelper.platform
-
-      # detect is posix platform
-      is_posix = MobyUtil::EnvironmentHelper.posix?
-
-      begin
-
-        # create new xml document
-        document = XML::parse_string( xml )
-
-      rescue Exception => exception
-
-        raise ParameterXmlParseError, "Error occured while parsing XML. Reason: \"#{ exception.message }\" (#{ exception.class })"
-
-      end
-
-      # go through each element in xml
-      #document.xpath( "/#{ document.root.name }/*" ).each{ | element |
-
-      # go through each element in xml
-      document.root.xpath( "*" ).each{ | element |
-
-        attribute = element.attributes.to_hash
-
-        name = attribute[ "name" ].to_s
-
-        # default value
-        value = attribute[ "value" ].to_s
-
-        # generic posix value - overwrites attribute["value"] if found
-        value = attribute[ "posix" ].to_s unless attribute[ "posix" ].nil? if is_posix
-
-        # platform specific value - overwrites existing value
-        value = attribute[ platform.to_s ].to_s unless attribute[ platform.to_s ].nil?
-
-        case element.name
-            
-          when 'fixture'
-
-            plugin = attribute[ "plugin" ].to_s
-
-    		    env = attribute[ "env" ].to_s unless attribute[ "env" ].nil?
-
-            raise SyntaxError, "No name defined for fixture with value #{ name }" if name.empty?
-
-            raise SyntaxError, "No plugin defined for fixture with name #{ name }" if plugin.empty?
-
-   		      value = { :plugin => plugin, :env => env }
-
-          when 'parameter'
-
-            raise SyntaxError, "No name defined for parameter with value #{ 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
-
-          if templates.empty?
-
-            # empty value by default - content will be retrieved above
-            value = ParameterHash.new()
-
-          else
-
-            # use template if defined
-            value = MobyUtil::ParameterTemplates.instance.get_template_from_xml( templates ) unless templates.empty?
-
-          end
-
-          # 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
-
-          # merge hash values (value type of hash)
-          value.merge_with_hash!( content )
-
-          name = ( element.attribute( "id" ) || element.name ).to_s
-
-        end
-
-        # store values to parameters
-        results[ name.to_sym ] = value
-
-      }
-
-      # return results hash
-      results
-
-    end
-
-    # TODO: document me
-    def self.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
-
-    # TODO: document me
-    def self.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
-
-    # TODO: document me
-    def self.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
-
-    TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
-
-  end # ParameterXml
-
-end # MobyUtil