testability-driver 1.1.0 → 1.1.1

data/lib/tdriver/report/report_test_run.rb

@@ -94,6 +94,7 @@ module TDriverReportCreator
       @fail_statuses=MobyUtil::Parameter[ :report_failed_statuses, "failed" ].split('|')
       @not_run_statuses=MobyUtil::Parameter[ :report_not_run_statuses, "not run" ].split('|')
       @report_editable=MobyUtil::Parameter[ :report_editable, "false" ]
+      @report_short_folders=MobyUtil::Parameter[ :report_short_folders, 'false']
     end
     #This method sets the test case user defined status
     #
@@ -806,14 +807,23 @@ module TDriverReportCreator
         link='',
         total_dump=0,
         total_sent=0,
-        total_received=0 )
+        total_received=0,
+        user_data_rows=nil,
+        user_data_columns=nil)
       while $result_storage_in_use==true
         sleep 1
       end
       $result_storage_in_use=true
       begin
         storage_file=nil
-        html_link=status+'_'+index.to_s+'_'+testcase+'/index.html' if link==''
+
+        if @report_short_folders=='true'
+          html_link=status+'_'+index.to_s+'/index.html' if link==''
+        else
+          html_link=status+'_'+index.to_s+'_'+testcase+'/index.html' if link==''
+        end
+
+
         storage_file='all_cases.xml'
 
         file=@report_folder+'/'+storage_file
@@ -881,6 +891,23 @@ module TDriverReportCreator
             test<<test_data
           end
 
+
+          if user_data_rows!=nil && !user_data_columns.empty?
+
+            test_data = Nokogiri::XML::Node.new("user_table_data",test)
+            #create the table rows
+            user_data_rows.each do |row_hash|
+              row_hash.sort{|a,b| a[0]<=>b[0]}.each do |value|
+                data_value=Nokogiri::XML::Node.new("column",test_data)
+                data_value.set_attribute("name",value[0].to_s)
+                data_value.content = value[1].to_s                
+                test_data << data_value
+              end
+            end
+            test<<test_data
+          end
+
+
           xml_data.root.add_child(test)
           File.open(file, 'w') {|f| f.write(xml_data.to_xml) }
           test=nil
@@ -893,6 +920,7 @@ module TDriverReportCreator
             user_data_values = user_data.values
             counter = user_data_values.size-1
           end
+
           builder = Nokogiri::XML::Builder.new do |xml|
             xml.tests {
               xml.test {
@@ -911,6 +939,7 @@ module TDriverReportCreator
                 xml.dump_count calculate_total_values_from_hash(total_dump)
                 xml.sent_bytes calculate_total_values_from_hash(total_sent)
                 xml.received_bytes calculate_total_values_from_hash(total_received)
+                
                 if user_data!=nil && !user_data.empty?
                   xml.user_display_data {
                     (0..counter).each { |i|
@@ -921,6 +950,21 @@ module TDriverReportCreator
                     }
                   }
                 end
+                
+                if user_data_rows!=nil && !user_data_columns.empty?
+
+                  xml.user_table_data{
+                    #create the table rows
+                    user_data_rows.each do |row_hash|
+                      row_hash.sort{|a,b| a[0]<=>b[0]}.each do |value|
+                        xml.column("name"=>value[0].to_s){
+                            xml.text value[1].to_s
+                        }
+                      end
+                    end
+                  }
+
+                end
               }
             }
           end

data/lib/tdriver/report/report_writer.rb

@@ -379,12 +379,35 @@ background: black; /*background of tabs for hover state, plus tab with "selected
 }
 
 
-img
-{
-	width:50%;
-	height:50%;
-}
-    .togList
+div.img
+  {
+  margin:2px;
+  border:0px;
+  height:auto;
+  width:auto;
+  text-align:left;
+  }
+div.img img
+  {
+  display:inline;
+  margin:3px;
+  border:0px;
+  }
+div.img a:hover img
+  {
+  border:1px solid #0000ff;
+  height:20%;
+  width:20%;
+  }
+div.desc
+  {
+  text-align:left;
+  font-weight:normal;
+  width:120px;
+  margin:3px;
+  }
+
+.togList
 {
 
 }
@@ -651,7 +674,7 @@ display: block;
       else
         stylesheet='<link rel="stylesheet" title="TDriverReportStyle" href="../../tdriver_report_style.css"/>'
       end
-      
+
     end
     html_start='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">' <<
       '<html xmlns="http://www.w3.org/1999/xhtml">'<<
@@ -872,8 +895,7 @@ display: block;
     html_body=nil
     @test_case_execution_log=nil
     @test_case_behaviour_log=nil
-    @test_case_user_data=nil
-    @test_case_user_data_columns=nil
+
   end
   def tog_list_begin(name)
     html_body='<dl class="togList">'<<
@@ -902,7 +924,7 @@ display: block;
     end
     tdriver_group = nil
     html_body=nil
-    
+
   end
   def write_test_case_summary_body(page,status,tc_arr,chronological_page=nil,report_page=nil,test_case_name=nil)
     html_body=Array.new
@@ -920,7 +942,7 @@ display: block;
       html_body << '<form action="save_results_to" ><input type="submit" name="save_results_to" value="Download report" /></form>' if @report_editable=='true'
       tdriver_group=nil
       html_result=nil
-    elsif @fail_statuses.include?(status) || status == "failed" 
+    elsif @fail_statuses.include?(status) || status == "failed"
       title='<div class="page_title"><center><h1>Failed</h1></center></div>'<<
         '<div class="summary_failed">' <<
         '<form action="save_total_run_results" >'
@@ -1026,13 +1048,13 @@ display: block;
       chronological_html_body=nil
     end # case
 	end # if
-	
+
     html_body << '</div>'
     File.open(page, 'a') do |f2|
       f2.puts html_body
     end
     html_body=nil
-    
+
   end
 
   def write_summary_body(page,start_time,end_time,run_time,total_run,total_passed,total_failed,total_not_run,total_crash_files,total_device_resets,summary_arr=nil)

data/lib/tdriver/tdriver.rb

@@ -147,5 +147,8 @@ $parameters.init
 # enable logging engine
 $logger.enable_logging
 
+# reporting modules
+require File.expand_path( File.join( File.dirname( __FILE__ ), 'report/report.rb' ) ) if MobyUtil::Parameter[ :enable_reporter, 'true' ]=='true'
+
 # initialization done, everything is ready
 $TDRIVER_INITIALIZED = true

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

@@ -17,38 +17,83 @@
 ## 
 ############################################################################
 
-module MobyUtil
+module TDriver
 
-  # Plugin service implementation
   class PluginService
 
-    include Singleton
+    # private methods and variables
+    class << self
 
-    # intialize plugin service
-    def initialize
+      private
 
-      @@registered_plugins = {}
+      # TODO: document me
+      def initialize_class
 
-    end
+        reset_plugins_list
+
+      end
+
+      # TODO: document me
+      def reset_plugins_list
+
+        # list of registered plugins
+        @registered_plugins = {}
+
+        # list of enabled plugins
+        @enabled_plugins = []
+
+      end
+
+      # TODO: document me
+      def delete_plugin( plugin_name )
+
+        # remove from the plugins hash
+        @registered_plugins.delete( plugin_name )
 
-    # return all or plugins of given type
-    def registered_plugins( type = nil )
+        # remove plugin from enabled plugins list
+        @enabled_plugins.delete( plugin_name )
+
+      end
+
+      # TODO: document me
+      def plugin_data_value( plugin_module, value_name, optional = false )
+        
+        begin
+
+          plugin_module.send( value_name.to_sym )
+
+        rescue NoMethodError
+
+          raise RuntimeError, "Plugin must have #{ value_name.to_s } value defined" if !optional
+
+        rescue Exception
+
+          raise
+
+        end
+
+      end
+
+    end # self
+
+    # TODO: document me
+    def self.registered_plugins( type = nil )
 
       # return all or plugins of given type
-      Hash[ @@registered_plugins.select{ | key, value | type.nil? || value[ :type ] == type } ]
+      Hash[ @registered_plugins.select{ | key, value | type.nil? || value[ :type ] == type } ]
 
     end
 
     # returns true if plugin is registered, plugin type can be given as optional parameter
-    def plugin_registered?( plugin_name, type = nil )
+    def self.plugin_registered?( plugin_name, type = nil )
     
       # check if given plugin is registered
-      if @@registered_plugins.has_key?( plugin_name )
+      if @registered_plugins.has_key?( plugin_name )
       
         unless type.nil?
         
           # plugin registered, compare that given plugin type matches
-          @@registered_plugins[ plugin_name ][ :type ] == type
+          @registered_plugins[ plugin_name ][ :type ] == type
                 
         else
         
@@ -59,142 +104,189 @@ module MobyUtil
       
       else
       
-        # plugin not registered, not found from @@registered_plugins hash
+        # plugin not registered, not found from registered_plugins list
         false
       
       end
 
     end
 
-    def enable_plugin( plugin_name )
-        
-      ( @@registered_plugins[ plugin_name ][ :enabled ] = true ) rescue Kernel::raise( ArgumentError.new( "No such plugin registered %s" % [ plugin_name ] ) )
+    # TODO: document me
+    def self.enabled_plugins
+
+      @enabled_plugins
+
+    end
+
+    # TODO: document me
+    def self.enable_plugin( plugin_name )
       
+      begin
+
+        # enable plugin
+        @registered_plugins[ plugin_name ][ :enabled ] = true
+
+        # add name to enabled plugins list
+        @enabled_plugins << plugin_name unless @enabled_plugins.include?( plugin_name )
+
+      rescue 
+
+        raise ArgumentError, "No such plugin registered #{ plugin_name }"
+
+      end
+
     end
 
-    def disable_plugin( plugin_name )
+    # TODO: document me
+    def self.disable_plugin( plugin_name )
+
+      begin
+
+        # disable plugin
+        @registered_plugins[ plugin_name ][ :enabled ] = false
+
+        # remove name from enabled plugins list
+        @enabled_plugins.delete( plugin_name )
 
-      ( @@registered_plugins[ plugin_name ][ :enabled ] = false ) rescue Kernel::raise( ArgumentError.new( "No such plugin registered %s" % [ plugin_name ] ) )
+      rescue 
+
+        raise ArgumentError, "No such plugin registered #{ plugin_name }"
+
+      end
       
     end
 
-    def plugin_enabled?( plugin_name )
+    # TODO: document me
+    def self.plugin_enabled?( plugin_name )
 
-      ( @@registered_plugins[ plugin_name ][ :enabled ] ) rescue false
-          
+      @enabled_plugins.include?( plugin_name )
+      
     end
 
-    def register_plugin( plugin_module )
+    # TODO: document me
+    def self.register_plugin( plugin_module )
  
-      # retrieve plugin name
+      # retrieve plugin name 
       plugin_name = plugin_data_value( plugin_module, :plugin_name )
 
       # throw exception if plugin is already registered
-      Kernel::raise ArgumentError.new( "Plugin %s is already registered" % [ plugin_name ] ) if @@registered_plugins.has_key?( plugin_name )
+      raise ArgumentError, "Plugin #{ plugin_name } is already registered" if @registered_plugins.has_key?( plugin_name )
 
       # plugin configuration
-      @@registered_plugins[ plugin_name ] = { 
+      @registered_plugins[ plugin_name ] = {
+ 
+        # store plugin type
         :type => plugin_data_value( plugin_module, :plugin_type ), 
+
+        # store plugin implementation module name
         :plugin_module => plugin_module, 
+
+        # set plugin to enabled state
         :enabled => true 
+
       } 
 
       # register plugin
       plugin_module.register_plugin
 
-    end
-
-    def unregister_plugin( plugin_name )
-
-      # unregister plugin, raise exception if plugin is not registered
-      ( @@registered_plugins[ plugin_name ][ :plugin_module ].unregister_plugin ) rescue Kernel::raise( ArgumentError.new( "Unregister failed due to plugin %s is not registered" % [ plugin_name ] ) )
-
-      # remove from the plugins hash
-      @@registered_plugins.delete( plugin_name )
+      # add name to enabled plugins list
+      @enabled_plugins << plugin_name unless @enabled_plugins.include?( plugin_name )
 
     end
 
-    def load_plugin( plugin_name )
+    # TODO: document me
+    def self.unregister_plugin( plugin_name )
 
       begin
 
-        # load plugin implementation
-        require plugin_name 
+        # call plugin unregister mechanism
+        @registered_plugins[ plugin_name ][ :plugin_module ].unregister_plugin
 
-      rescue LoadError => exception
+        # remove from the plugins hash
+        @registered_plugins.delete( plugin_name )
 
-        Kernel::raise RuntimeError.new( 
+        # remove from the plugins hash
+        @enabled_plugins.delete( plugin_name )
 
-          "Error while loading plugin %s. Please verify that the plugin is installed properly (%s: %s)" % [ plugin_name, exception.class, exception.message ]
+      rescue
 
-        )
+        raise ArgumentError, "Failed to unregister plugin due to plugin #{ plugin_name.inspect } is not registered"
 
       end
 
     end
 
-    def call_plugin_method( plugin_name, method_name, *args )
+    # TODO: document me
+    def self.load_plugin( plugin_name )
 
       begin
 
-        plugin_module = @@registered_plugins[ plugin_name ][ :plugin_module ]
-        
-      rescue
-      
-        Kernel::raise( ArgumentError.new( "No such plugin registered %s" % [ plugin_name ] ) )
+        # load plugin implementation
+        require plugin_name 
+
+      rescue LoadError
+
+        raise RuntimeError, "Error while loading plugin #{ plugin_name.to_s }. Please verify that the plugin is installed properly (#{ $!.class }: #{ $!.message })"
 
       end
 
+    end
+
+    # TODO: document me
+    def self.call_plugin_method( plugin_name, method_name, *args )
+
       begin
 
-        plugin_module.send( method_name.to_sym, *args )
+        @registered_plugins.fetch( plugin_name ){
 
-      rescue Exception => exception
+          # in case if plugin not found from registered plugins list
+          raise ArgumentError, "No such plugin registered #{ plugin_name }"
 
-        raise PluginError.new( "Error occured during calling %s method for %s (%s: %s)" % [ method_name, plugin_name, exception.class, exception.message ] )
+        }[ :plugin_module ].send( method_name.to_sym, *args )
 
-      end
+      rescue ArgumentError
 
-    end
+        # raise argument errors as is
+        raise      
 
-  private
+      rescue 
 
-    def reset_plugins_list
+        # raise all other exceptions as PluginError
+        raise PluginError, "Error occured during calling #{ method_name } method for #{ plugin_name } (#{ $!.class }: #{ $!.message })"
 
-      @@registered_plugins = {}
+      end
 
     end
 
-    def delete_plugin( plugin_name )
-
-      # remove from the plugins hash
-      @@registered_plugins.delete( plugin_name )
+    # initialize plugin service 
+    initialize_class
 
-    end
+    # enable hooking for performance measurement & debug logging
+    TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
 
-    def plugin_data_value( plugin_module, value_name, optional = false )
-      
-      begin
+  end # PluginService
 
-        result = plugin_module.send( value_name.to_sym )
+end
 
-      rescue NoMethodError
+module MobyUtil
 
-        Kernel::raise RuntimeError.new( "Plugin must have %s value defined" % [ value_name.to_s ] ) if !optional
+  # deprecated plugin service implementation; please use TDriver::PluginService instead of this
+  class PluginService
 
-      rescue => exception
+    # deprecated
+    def self.instance
 
-        Kernel::raise exception
+      # retrieve caller information
+      file, line = caller.first.split(":")
 
-      end
+      # show warning
+      warn "#{ file }:#{ line } warning: deprecated method MobyUtil::PluginService.instance#method; please use static class TDriver::PluginService#method instead"
 
-      result
+      # redirect to new implementation
+      TDriver::PluginService
 
     end
 
-    # enable hooking for performance measurement & debug logging
-    TDriver::Hooking.hook_methods( self ) if defined?( TDriver::Hooking )
-
-  end # PluginService
+  end
 
-end # MobyUtil
+end