soda 1.1.19 → 1.2.0

data/bin/SodaSuite

@@ -70,17 +70,18 @@ class SodaSuite
       @soda = nil
 
 	   if (NEEDED_SODA_VERSION != Soda::SODA_VERSION)
-         print "(!)Failed matching Soda Class Versions!\n" +
-            "--)Required Version: #{NEEDED_SODA_VERSION}\n" +
-            "--)Found Version   : #{Soda::SODA_VERSION}\n\n"
+         SodaUtils.PrintSoda("Failed matching Soda Class Versions!\n")
+         SodaUtils.PrintSoda("Required Version: #{NEEDED_SODA_VERSION}\n")
+         SodaUtils.PrintSoda("Found Version   : #{Soda::SODA_VERSION}\n")
          exit(-1)
       end
 
       if ("#{Watir::VERSION}" != "#{Soda::SODA_WATIR_VERSION}")
-         print "(!)Failed matching installed Watir version to Soda's" +
-            " required version!\n" +
-            "--)Required Version: #{Soda::SODA_WATIR_VERSION}\n" +
-            "--)Found Version   : #{Watir::VERSION}\n\n"
+         SodaUtils.PrintSoda("Failed matching installed Watir version to"+
+            " Soda's required version!\n", SodaUtils::ERROR)
+         SodaUtils.PrintSoda("--)Required Version: "+
+            "#{Soda::SODA_WATIR_VERSION}\n")
+         SodaUtils.PrintSoda("--)Found Version   : #{Watir::VERSION}\n")
          exit(-1)
       end
 	end
@@ -238,7 +239,7 @@ Optional Flags:
    --sugarwait: This enables the auto sugarwait functionality for every click.
 
    --restartcount: This tells soda to restart the web browser after so many
-      tests have been ran.
+      tests have been ran.  This flag can only be using when running suites!
 
    --restarttest: This is a soda test that will be ran right after the browser
       is restarted.
@@ -322,8 +323,9 @@ def CreateResultsDir(dir)
       FileUtils::mkdir_p(dir)
       result = 0
    rescue Exception => e
-      print "(!)Failed to create results directory: #{dir}!\n"
-      print "--)Reason: #{e.message}\n\n"
+      SodaUtils.PrintSoda("Failed to create results directory: #{dir}!\n",
+         SodaUtils::ERROR)
+      SodaUtils.PrintSoda("--)Reason: #{e.message}\n")
       result = -1
    end
    
@@ -353,50 +355,6 @@ def GetFileSetFiles(dir)
    return test_files
 end
 
-###############################################################################
-# GetSuiteTestFiles - function
-#     This function reads a sode suite file and creates a list of tests from
-#     the file, by expanding on filesets and files.
-#
-# Params:
-#     suite_file: This is the suite xml file.
-#
-# Results:
-#     returns an array of files.
-#
-###############################################################################
-def GetSuiteTestFiles(suite_file)
-   test_files = []  
-   parser = nil
-   doc = nil
-
-   parser = LibXML::XML::Parser.file(suite_file)
-   doc = parser.parse()
-   
-   doc.root.each do |node|
-      if (node.name != 'script')
-         next
-      end
-
-      attrs = node.attributes()
-      attrs.each do |a|
-         h = attrs.to_h()
-         if (h.key?("file"))
-            test_files.push(h['file'])
-         elsif (h.key?('fileset'))
-            fs = h['fileset']
-            if (File.directory?(fs))
-               fs_set = GetFileSetFiles(fs)
-               test_files.concat(fs_set)
-               fs_set = nil
-            end
-         end
-      end
-   end
-
-   return test_files
-end
-
 ###############################################################################
 # ReadConfigFile - function
 #     This functions reads the soda config file into a hash.
@@ -586,7 +544,7 @@ def Main
             when "--nonzippytext"
                params['nonzippytext'] = true
             when "--version"
-               print "(*)SODA Version: #{SODA_GEM_VERSION}\n\n"
+               SodaUtils.PrintSoda("(*)SODA Version: #{SODA_GEM_VERSION}\n")
                return 0
          end
       end
@@ -611,6 +569,12 @@ def Main
 		PrintHelp()
 	end
 
+	if (params['suites'].length < 1 && params['restart_count'] > 0)
+		SodaUtils.PrintSoda("Error: --restartcount can only be used with"+
+         " --suite!\n\n")
+		PrintHelp()
+	end
+
    if (params['debug'])
       SodaUtils.PrintSoda("SodaSuite Params:\n")
       params.each do |k, v|
@@ -627,7 +591,6 @@ def Main
 
    if (params['resultsdir'] != nil)
       err = CreateResultsDir(params['resultsdir'])
-      print "Result: #{err}\n"
       if (err != 0)
          exit(-1)
       end
@@ -640,7 +603,7 @@ def Main
 
    if (params['suites'].length > 0)
       sweet = SodaSuite.new(params)
-      result = sweet.ExecuteTestSuites(params['suites'])
+      suites_result = sweet.ExecuteTestSuites(params['suites'])
    end
 
    if (params['test_files'].length > 0)
@@ -668,9 +631,8 @@ def Main
                params['summaryfile'], true)
          end
       rescue Exception => e
-         print "Error: calling: SodaReportSummery: #{e.message}\n"
-         print e.backtrace.join("\n")
-         print "\n\n"
+         SodaUtils.PrintSoda("SodaReportSummery: #{e.message}\n", 
+            SodaUtils::ERROR)
          exit(-1)
       ensure
       end

data/lib/Soda.rb

@@ -104,7 +104,7 @@ class Soda
       $mutex = Mutex.new()
       @whiteList = []
       @white_list_file = ""
-      @restart_test = ""
+      @restart_test = nil
       @restart_count = 0
       @non_lib_test_count = 0
       @last_test = ""
@@ -777,18 +777,12 @@ class Soda
          valid_xml = false
       end
 
-      if (valid_xml && !@restart_test_running && file != @last_file &&
-            @non_lib_test_count >= @restart_count)
-         RestartBrowserTest()
-      end
-
       if (valid_xml)
          $run_script = file
          PrintDebug("Parsing Soda test file: \"#{file}\".\n")
          begin
             checker = SodaTestCheck.new(file, @rep)
             script_check = checker.Check()
-
             if (!script_check)
                script = nil
                @rep.IncSkippedTest()
@@ -797,19 +791,11 @@ class Soda
             end
          rescue Exception => e
             @rep.ReportException(e, file)
+            script = nil
          ensure
          end
       end
 
-      dir = File.dirname(file)
-      if (dir !~ /lib/)
-         if(!is_restart && !@restart_test_running && file != @last_test)
-            @non_lib_test_count += 1
-            @rep.IncTestCount()
-            PrintDebug("Test since last restart: #{@non_lib_test_count +1}.\n")
-         end
-      end
-
       return script
    end
               
@@ -824,48 +810,40 @@ class Soda
 #     None.
 #
 ###############################################################################
-   def RestartBrowserTest()
-      return 0 if (@restart_count < 1)
+   def RestartBrowserTest(suitename)
 
-      if (@non_lib_test_count >= @restart_count)
-         @rep.log("Restarting browser.\n")
-       
-         if (!@GotWatchDog) 
-            begin 
-               @browser.close()
-               sleep(1)
-            rescue Exception => e
-            end
-            @GotWatchDog = false
+      if (!@GotWatchDog)   
+         begin 
+            @browser.close()
+            sleep(1)
+         rescue Exception => e
          end
+         @GotWatchDog = false
+      end
 
-         RestartGlobalTime()
+      RestartGlobalTime()
 
-         if (@params['browser'] =~ /firefox/i)
-            SodaFireFox.KillProcesses()
-         end
+      if (@params['browser'] =~ /firefox/i)
+         SodaFireFox.KillProcesses()
+      end
+      
+      err = NewBrowser()
+      if (err != 0)
+         print "(!)Failed to restart browser!\n"
+      end
 
-         err = NewBrowser()
-         if (err != 0)
-            @rep.ReportFailure("Failed to restart browser!\n")
-         end
+      if (!@restart_test.empty?)
+         resultdir = "#{@resultsDir}/#{suitename}"
+         @rep = SodaReporter.new(@restart_test, @saveHtml, resultdir,
+            0, nil, false);
+         @rep.log("Restarting browser.\n")
+         restart_script = getScript(@restart_test)
+         handleEvents(restart_script)
          @rep.log("Finished: Browser restart.\n")
-         @non_lib_test_count = 0
-
-         if (!@restart_test.empty?)
-            parent_test = @currentTestFile
-            restart_data = getScript(@restart_test, true)
-            if (restart_data != nil)
-               @currentTestFile = @restart_test
-               @restart_test_running = true
-               @rep.log("Executing restart test: '#{@restart_test}'\n")
-               handleEvents(restart_data)
-               @restart_test_running = false
-               @currentTestFile = parent_test
-               @rep.log("Finished restart test: '#{@restart_test}'\n")
-            end 
-         end
+         @rep.EndTestReport()
       end
+
+      RestartGlobalTime()
    end
 
 ###############################################################################
@@ -893,7 +871,6 @@ class Soda
          fd = Dir.open(file)
          fd.each do |f|
             files.push("#{file}/#{f}") if (f =~ /\.xml$/i)
-#           @rep.IncTestTotalCount() if (f !~ /lib/i)
          end
          fd.close()
 
@@ -915,22 +892,11 @@ class Soda
             ((file !~ /^setup/) || (file !~ /^cleanup/) ) )
             @rep.log("Starting new soda test file: \"#{file}\".\n")
 
-            if (file !~ /lib/i)
-               if (@non_lib_test_count >= @restart_count && file != @last_test)
-                  RestartBrowserTest()
-               end
-
-               @rep.IncTestCount()
-               @non_lib_test_count += 1
-               @last_test = file
-            end
-
             script = getScript(file)
             if (script != nil)
                parent_test_file = @currentTestFile
                @currentTestFile = file
                results = handleEvents(script)
-               PrintDebug("Test since last restart: #{@non_lib_test_count +1}.\n")
                if (results != 0)
                   @FAILEDTESTS.push(@currentTestFile)
                   @rep.IncFailedTest()
@@ -2286,8 +2252,6 @@ JSCode
          when "disabled"
             event['disabled'] = getStringBool(event['disabled'])
             FieldUtils.CheckDisabled(@curEl, event['disabled'], @rep)
-         when "exists"
-            # do nothing #
          else
             msg = "Failed to find supported field action.\n"
             @rep.log(msg, SodaUtils::WARN)
@@ -2723,7 +2687,7 @@ JSCode
       result = 0
       master_result = 0
       thread_soda = nil
-      thread_timeout = (60 * 10) # 10 minutes #
+      thread_timeout = (60 * 6) # 6 minutes #
       time_check = nil
       resultsdir = nil
       blocked = false
@@ -2745,9 +2709,15 @@ JSCode
       @rep = SodaReporter.new(file, @saveHtml, resultsdir, 0, nil, rerun);
       SetGlobalVars()
       blocked = remBlockScript(file)
-      
+ 
       if (!blocked)
-         script = getScript(file)
+         checker = SodaTestCheck.new(file, @rep)
+         script_check = checker.Check()
+         if (!script_check)
+            script = nil
+         else
+            script = getScript(file)
+         end
       else 
          script = nil
       end
@@ -2766,10 +2736,10 @@ JSCode
 
                if (time_diff >= thread_timeout)
                   msg = "Soda watchdog timed out after #{time_diff} seconds!\n"
+                  @GotWatchDog = true
                   @rep.ReportFailure(msg)
                   PrintDebug("Global Time was: #{$global_time}\n")
                   PrintDebug("Timeout Time was: #{time_check}\n")
-                  @GotWatchDog = true
                   @rep.IncTestWatchDogCount()
                   begin
                      result_dir = @rep.GetResultDir()
@@ -2827,6 +2797,7 @@ JSCode
    def RunAllSuites(suites)
       results = {}
       err = 0
+      global_err = 0
       indent = " " * 2
       indent2 = "#{indent}" * 2
       indent3 = "#{indent}" * 4
@@ -2835,11 +2806,23 @@ JSCode
 
       suites.each do |s|
          base_suite_name = File.basename(s)
+         if (results.key?(base_suite_name))
+            suite_dup_id = 1
+            while (results.key?("#{base_suite_name}-#{suite_dup_id}"))
+               suite_dup_id += 1
+            end
+            base_suite_name = "#{base_suite_name}-#{suite_dup_id}"
+         end
+
          RestartGlobalTime()
          results[base_suite_name] = RunSuite(s)
          RestartGlobalTime()
       end
 
+      if (results.empty?)
+         return results
+      end
+
       time = Time.now()
       time = "#{time.to_i}-#{time.usec}"
       suite_report = "#{@resultsDir}/#{hostname}-#{time}-suite.xml"
@@ -2851,21 +2834,31 @@ JSCode
       results.each do |k,v|
          fd.write("\t<suite>\n")
          fd.write("\t#{indent}<suitefile>#{k}</suitefile>\n")
-         v.each do |testname, testhash|
-            fd.write("\t#{indent2}<test>\n")
-            fd.write("\t#{indent3}<testfile>#{testname}</testfile>\n")
-            testhash.each do |tname, tvalue|
-               if (tname == "result")
-                  err = -1 if (tvalue.to_i != 0)
+
+         if (v.key?("Suite Failure"))
+            v.each do |sek, sev|
+               name = sek
+               name = name.gsub(" ", "_")
+               fd.write("\t#{indent2}<#{name}>#{sev}</#{name}>\n")
+            end 
+         else
+            v.each do |testname, testhash|
+               fd.write("\t#{indent2}<test>\n")
+               fd.write("\t#{indent3}<testfile>#{testname}</testfile>\n")
+               testhash.each do |tname, tvalue|
+                  if (tname == "result")
+                     err = -1 if (tvalue.to_i != 0)
+                  end
+                  new_name = "#{tname}"
+                  new_name = new_name.gsub(" ", "_")
+                  fd.write("\t#{indent3}<#{new_name}>#{tvalue}</#{new_name}>\n")
                end
-               new_name = "#{tname}"
-               new_name = new_name.gsub(" ", "_")
-               fd.write("\t#{indent3}<#{new_name}>#{tvalue}</#{new_name}>\n")
+               fd.write("\t#{indent2}</test>\n")
             end
-            fd.write("\t#{indent2}</test>\n")
          end
          fd.write("\t</suite>\n")
       end
+
       fd.write("</data>\n")
       fd.close()
 
@@ -2881,17 +2874,26 @@ JSCode
       parser = nil
       doc = nil
       test_order = 0
+      test_since_restart = 0
       result = {}
       tests = []
       suite_name = File.basename(suitefile, ".xml")
       
       begin
+         LibXML::XML::Error.set_handler(&LibXML::XML::Error::QUIET_HANDLER)
          parser = LibXML::XML::Parser.file(suitefile)
          doc = parser.parse()
          doc = doc.root()
 
          doc.each do |node|
-            next if (node.name !~ /script/)
+            next if (node.name =~ /text/i)
+            next if (node.name =~ /comment/i)
+            
+            if (node.name !~ /script/i)
+               raise "Using unsupported Soda suite element: '#{node.name}'"+
+                  " in suite file: '#{suitefile}'!"
+            end
+
             attrs = node.attributes()
             attrs = attrs.to_h()
 
@@ -2906,22 +2908,30 @@ JSCode
             end
          end
       rescue Exception => e
-         print "ERROR: #{e.message}!\n"
-         print e.backtrace.join("\n")
-         result = nil
+         SodaUtils.PrintSoda(e.message, SodaUtils::ERROR)
+         err_hash = {
+            'result' => -1,
+            'Suite Failure' => true,
+            'Suite Error' => "#{e.message}"
+         }
+         return err_hash
       ensure
       end   
 
       tests.each do |test|
+         if ((@restart_count > 0) && (test_since_restart >= @restart_count))
+            SodaUtils.PrintSoda("Restarting browser...\n")
+            RestartBrowserTest(suite_name)
+            test_since_restart = 0
+            SodaUtils.PrintSoda("(*)Browser restart finished.\n")
+         end
+
          test_order += 1
          tmp_result = {}
-         test_basename = File.basename(test, ".xml")
          tmp_result['result'] = run(test, false, true, suite_name)
          tmp_result['Test_Order'] = test_order
          tmp_result.merge!(@rep.GetRawResults)
-         tmp_result['Real_Test_Name'] = test
-         logfile = tmp_result['Test Log File']
-
+         
          if (tmp_result['Test Failure Count'].to_i != 0)
             tmp_result['result'] = -1
          elsif (tmp_result['Test JavaScript Error Count'].to_i != 0)
@@ -2932,8 +2942,25 @@ JSCode
             tmp_result['result'] = -1
          end
 
-         result[test] = tmp_result
+         tmp_result['Real_Test_Name'] = test
+         test_basename = File.basename(test, ".xml")
+         logfile = tmp_result['Test Log File']
+
+         if (logfile =~ /#{test_basename}-\d+/)
+            logfile =~ /#{test_basename}(-\d+)/
+            ran_test_name = "#{test_basename}#{$1}"
+            ran_test_name << ".xml"
+         else
+            ran_test_name = test
+         end
+
+         result[ran_test_name] = tmp_result
          @rep.ZeroTestResults()
+
+         test_dir = File.dirname(test)
+         if (test_dir !~ /lib/i)
+            test_since_restart += 1
+         end
       end
 
       return result