soda 0.0.1

data/lib/SodaReporter.rb

@@ -0,0 +1,452 @@
+###############################################################################
+# Copyright (c) 2010, SugarCRM, Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#    * Redistributions of source code must retain the above copyright
+#      notice, this list of conditions and the following disclaimer.
+#    * Redistributions in binary form must reproduce the above copyright
+#      notice, this list of conditions and the following disclaimer in the
+#      documentation and/or other materials provided with the distribution.
+#    * Neither the name of SugarCRM, Inc. nor the
+#      names of its contributors may be used to endorse or promote products
+#      derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
+# ARE DISCLAIMED. IN NO EVENT SHALL SugarCRM, Inc. BE LIABLE FOR ANY
+# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+###############################################################################
+
+###############################################################################
+# Required Ruby libs:
+###############################################################################
+require 'SodaUtils'
+require 'tmpdir'
+require 'SodaLogReporter'
+
+###############################################################################
+# SodaReporter -- Class
+#
+# Params:
+#     testfile: This is a soda XML test file.
+#     savehtml: This tells Soda to save html files that caused an issue.
+#     resultsdir: This is the directory where you want to store all results.
+#     debug: Setting this to true will cause this class to print full debug 
+#        messages.
+#
+# simple reporter class that tracks asserts, exceptions, and log messages
+###############################################################################
+class SodaReporter
+
+	def initialize(testfile, savehtml = false, resultsdir = nil, debug = 0,
+         callback = nil, rerun = false)
+		@sodatest_file = testfile
+      @saveHtmlFiles = savehtml
+      @debug = debug
+      @js_error_count = 0
+      @css_error_count = 0
+		@asserts_count = 0
+		@exception_major_count = 0
+		@assertFails_count = 0
+		@exception_count = 0	
+      @test_count = 0
+      @test_skip_count = 0
+		@fatals = 0
+		@total = 0
+      @failureCount = 0
+		@savedPages = 0
+      @ResultsDir = "#{Dir.pwd}"
+      @path = nil
+      @htmllog_filename = nil
+      @log_filename = nil
+      @print_callback = callback
+      hostname = "#{ENV['HOSTNAME']}"
+
+      if (resultsdir != nil)
+         @ResultsDir = resultsdir
+      end 
+
+      if ( (hostname.empty?) || (hostname.length < 5) )
+         hostname = `hostname`
+         hostname = hostname.chomp()
+      end
+
+      SodaUtils.PrintSoda("Debugging: => #{debug}\n")
+      SodaUtils.PrintSoda("Soda Test File: => #{@sodatest_file}\n")
+		base_testfile_name = File.basename(@sodatest_file, '.xml')
+
+      if (rerun)
+         base_testfile_name << "-SodaRerun"
+      end
+
+      now = Time.now().strftime("%d-%m-%Y-%H-%M")
+     
+      if (resultsdir == nil)
+         @ResultsDir = @ResultsDir + "/#{base_testfile_name}-#{now}-results"
+      end
+
+      FileUtils.mkdir_p(@ResultsDir)
+
+      @path = "#{@ResultsDir}/#{base_testfile_name}"
+      if (@path =~ /sugarinit/i)
+		   @log_filename = "#{@path}-#{hostname}.tmp"
+         @htmllog_filename = "#{@ResultsDir}/Report-#{base_testfile_name}"+
+            "-#{hostname}.html"
+      else
+         @htmllog_filename = "#{@ResultsDir}/Report-#{base_testfile_name}.html"
+		   @log_filename = "#{@path}.tmp"
+      end
+
+		@logfile = File.new(@log_filename, 'w+')
+      @logfile.sync = true # force buffers to write to disk asap! #
+      SodaUtils.PrintSoda("Created log file: => #{@log_filename}\n")
+      log("[New Test]\n")
+      log("Starting soda test: #{@sodatest_file}\n")
+      log("Saving HTML files => #{@saveHtmlFiles.to_s()}.\n")
+	end
+
+
+###############################################################################
+# IncSkippedTest -- Method
+#     This method incerments the count by 1 for tests that were skipped.
+#
+# Input:
+#     None.
+#
+# Output:
+#     None.
+#
+###############################################################################
+   def IncSkippedTest()
+      @test_skip_count += 1
+   end
+   public :IncSkippedTest
+
+###############################################################################
+# IncTestCount -- Method
+#     This method incerments the count by 1 for tests that were ran
+#
+# Input:
+#     None.
+#
+# Output:
+#     None.
+#
+###############################################################################
+   def IncTestCount()
+      @test_count += 1
+   end
+   public :IncTestCount
+
+###############################################################################
+# ReportHTML -- Method
+#     This function will generate an html report from the raw soda log file.
+#
+# Params:
+#     None.
+#
+# Results:
+#     None.
+#
+###############################################################################
+   def ReportHTML
+      slr = SodaLogReporter.new(@log_filename, @htmllog_filename)
+      slr.GenerateReport()
+      msg = "Created new html report: #{@htmllog_filename}\n"
+      SodaUtils.PrintSoda(msg)
+
+      if (@print_callback != nil)
+         @print_callback.call(msg)
+      end
+   end
+
+###############################################################################
+# ReportFailure -- Method
+#     This function reports and counts general Soda failures.
+#
+# Params:
+#     msg: This is the string failure message to be reported. 
+#
+# Results:
+#     None.
+#
+###############################################################################
+   def ReportFailure(msg)
+      @failureCount += 1
+      log("#{msg}", SodaUtils::ERROR)
+   end
+
+###############################################################################
+# ReportJavaScriptError -- Method
+#     This function reports and counts javascript failures.
+#
+# Params:
+#     msg: This is the string failure message to be reported. 
+#     skipcssreport: This skipps reporting CSS errors.
+#
+# Results:
+#     Always returns 0.
+#
+###############################################################################
+   def ReportJavaScriptError(msg, skipcssreport = false)
+
+      if ( (msg =~ /Cat::CSS\s+Parser/i) && (skipcssreport != true) )
+         msg = msg.gsub(/javascript\s+error:/i, "Css Error:")
+         log("#{msg}", SodaUtils::WARN)
+         @css_error_count += 1
+      elsif ( (msg =~ /Cat::CSS\s+Parser/i) && (skipcssreport != false) )
+         @css_error_count += 1
+         return 0
+      else
+         log("#{msg}", SodaUtils::ERROR)
+         @js_error_count += 1
+      end
+
+      return 0
+   end
+
+###############################################################################
+# SavePage -- Method
+#     This method saves an given HTML page from the browser for later use.
+#
+# Params:
+#     reason:  Just a string so when this methos is called the caller can
+#        give a reason in the log file.  I'd hope this is used to report
+#        errors.
+#
+# Results:
+#     always returns 0.
+#
+###############################################################################
+	def SavePage(reason = "")
+      if (@saveHtmlFiles != true)
+         return 0
+      end
+
+      @savedPages += 1
+      save_file_name = "#{@path}page#{@savedPages}.html"
+      page = File.new(save_file_name, 'w+')
+      page.write($curSoda.browser.url + "\n<br>#{reason}\n<br>" + 
+            $curSoda.browser.html)
+      page.close()
+
+      log("HTML Saved: #{save_file_name}\n")
+
+      return 0
+	end
+
+###############################################################################
+# AddEventCount -- Method
+#     This function incerments the internal event counter.
+#
+# Params:
+#     None.
+#
+# Results:
+#     None.
+#
+###############################################################################
+	def AddEventCount
+      @total += 1
+	end
+
+###############################################################################
+# EndTestReport -- Method
+#     This function is to be called after a test finishes running, so that the
+#     proper formatting is do to allow for an easy to parse raw log file.
+#
+# Params:
+#     None.
+#
+# Results:
+#     None.
+#
+###############################################################################
+   def EndTestReport 
+      log("Soda test: #{@sodatest_file} finished.\n")
+      log("[End Test]\n")
+      @logfile.close()
+
+      tmp_logfile = File.dirname(@log_filename)
+      tmp_logfile += "/" 
+      tmp_logfile += File.basename("#{@log_filename}", ".tmp")
+      tmp_logfile += ".log"
+      File.rename(@log_filename, tmp_logfile)
+      @log_filename = tmp_logfile
+      
+   end
+
+###############################################################################
+# log -- Method
+#     This method will log soda message to both stdout & the report's log file.
+#
+# Params:
+#     msg: This is a string message to log.
+#  
+#     error: Default is false, setting to true will format the message as an
+#        error.
+#
+# Results:
+#     None.
+#
+###############################################################################
+   def log(msg, error = 0)
+      SodaUtils.PrintSoda(msg, error, @logfile, @debug)
+      SodaUtils.PrintSoda(msg, error, nil, @debug, 1, @print_callback)
+	end
+
+###############################################################################
+# ReportException -- Method
+#     This method reports an Soda Exceptions from the Soda class.
+#
+# Params:
+#     sodaException: This is the exception that is passed from Soda.
+#     
+#     mojor: Tells use if this was a mojor exception or now.
+#
+#     file: The soda test file that the exception was raised by durring the
+#        test.
+#
+# Results:
+#     None.
+#
+# Notes:
+#     The major param seems totally useless and was left over from the org
+#     code from this file.  Soda.rb only ever calls this method with major.
+#     So I will be killer this param soon...
+#
+###############################################################################
+   def ReportException(sodaException, major = false, file = false)
+      msg = nil
+      @exception_count += 1
+	
+      if (sodaException.message.empty?)
+         msg = "No exception message found!"
+      else
+         msg = sodaException.message
+      end
+
+      if (file)
+         log("Exception raised for file: #{file}\n", SodaUtils::ERROR)
+      else
+         log("Exception raised: #{msg}\n", SodaUtils::ERROR)
+      end
+
+		if (major)
+			@exception_major_count += 1
+         bt = "--Exception Backtrace: " + sodaException.backtrace.join("--") +
+            "\n"
+         btm = "--Exception Message: #{msg}\n"
+         log("Major exception raised for file: #{file}" + btm + bt, 
+            SodaUtils::ERROR)
+		end
+	end
+
+###############################################################################
+# Assert -- Method 
+#     This method assert that the exp is equal to TRUE, and reports the results
+#
+# Params:
+#     exp: The expression to evaulate.
+#     msg: The message to report about the assertion.
+#
+#
+# Results:
+#     returns -1 on assert failed, or 0 on success.
+#
+###############################################################################
+   def Assert(exp, msg = "", file = "", line_number = "")
+      result = 0
+		@asserts_count += 1
+      url = nil
+
+      url = "#{$curSoda.browser.url}"
+      if ( (url.empty?) || (url.length < 1) || (url == "") )
+         url = "Unknown URL casued this Assert!"
+      end
+
+      if (file.empty?)
+         file = "No file provided."
+      end
+
+      if (msg.empty?)
+         msg = "No Assert message provided!"
+      end 
+
+      if ( (line_number == nil) || (line_number.empty?))
+         line_number = "Unknown line number"
+      end
+
+		if (!exp)
+         ass_msg = "Assertion: Failed!:--#{url}--#{file}" +
+         "--Assertion Message: #{msg}--Line: #{line_number}"
+         ass_msg = ass_msg.sub(/\n/,"")
+         ass_msg << "\n"
+
+         log(ass_msg, 1)
+			SavePage(msg)
+			@assertFails_count += 1
+         result = -1
+		else
+         if (msg.empty?)
+   			log("Assertion: Passed.\n")
+         else
+   			log("Assertion: Passed: #{msg}.\n")
+         end
+         result = 0
+		end
+
+      return result
+	end
+
+###############################################################################
+# AssertNot -- Method
+#     This method asserts if the exp is equal to FALSE, and reports the results
+#
+# Params:
+#     exp: The expression to evaulate.
+#     msg: The message to report with the assert.
+#
+#
+###############################################################################
+   def AssertNot(exp, msg = "", file = "")
+		Assert(!exp, msg, file)
+	end
+
+###############################################################################
+# SodaPrintCurrentReport -- Method
+#     This method is used for printing out the current results of the report.
+#
+# Params:
+#     None.
+#
+# Results:
+#     None.
+#
+###############################################################################
+   def SodaPrintCurrentReport()
+      msg = "Soda Test Report:" + 
+         "--Test File:#{@sodatest_file}" +
+         "--Test Failure Count:#{@failureCount}" +
+         "--Test CSS Error Count:#{@css_error_count}" +
+         "--Test JavaScript Error Count:#{@js_error_count}" +
+         "--Test Assert Failures:#{@assertFails_count}" +
+         "--Test Event Count:#{@total}" +
+         "--Test Assert Count:#{@asserts_count}" +
+         "--Test Exceptions:#{@exception_count}" +
+         "--Test Major Exceptions: #{@exception_major_count}" +
+         "--Test Count:#{@test_count}" +
+         "--Test Skip Count:#{@test_skip_count}\n"
+         log(msg)
+	end
+
+end
+

data/lib/SodaTestCheck.rb

@@ -0,0 +1,347 @@
+###############################################################################
+# Copyright (c) 2010, SugarCRM, Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#    * Redistributions of source code must retain the above copyright
+#      notice, this list of conditions and the following disclaimer.
+#    * Redistributions in binary form must reproduce the above copyright
+#      notice, this list of conditions and the following disclaimer in the
+#      documentation and/or other materials provided with the distribution.
+#    * Neither the name of SugarCRM, Inc. nor the
+#      names of its contributors may be used to endorse or promote products
+#      derived from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
+# ARE DISCLAIMED. IN NO EVENT SHALL SugarCRM, Inc. BE LIABLE FOR ANY
+# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+###############################################################################
+
+###############################################################################
+# Need Ruby Libs:
+###############################################################################
+require 'rubygems'
+require 'getoptlong'
+require 'digest/md5'
+require 'libxml'
+require 'SodaXML'
+require 'SodaUtils'
+
+###############################################################################
+###############################################################################
+class SodaTestCheck
+
+   def initialize(sodatest, reportobj)
+      err = 0
+      sodadata = nil
+      @SODA_ELEMENTS_FILE = "SodaElements.xml"
+      $ERROR_COUNT = 0
+      @report = reportobj
+      @sodatest = sodatest
+   end
+
+###############################################################################
+###############################################################################
+   def Check()
+      err = 0
+      elements_root = nil
+      elements_data = nil
+      sodadata = nil
+      msg = ""
+      
+      if (!File.exist?(@SODA_ELEMENTS_FILE))
+         msg = "Error: can't find needed file: '#{@SODA_ELEMENTS_FILE}'!\n"
+         @report.ReportFailure(msg)
+         return false
+      end
+   
+      elements_root = ParseSodaElementsXML()
+      if (elements_root == nil)
+         return false
+      end
+
+      elements_data = ElementsXMLToData(elements_root)
+      if (elements_data.empty?)
+         msg = "Error: XML element data is empty!\n"
+         @report.ReportFailure(msg)
+         return false
+      end
+
+      err = CheckFileformat(@sodatest)
+      if (err != 0)
+         return false
+      end
+
+      sodadata = ProcessSodaTestFile(@sodatest)
+      if (sodadata == nil)
+         return false
+      end
+
+      return true
+   end
+   public :Check
+
+###############################################################################
+# ParseSodaElementsXML -- method
+#     This finction parses the SodaElements.xml file.
+#
+# Input:
+#     None.
+#
+# Output:
+#     returns the doc.root from the XML parser, or nil on error.
+#
+###############################################################################
+   def ParseSodaElementsXML()
+      parser = nil
+      doc = nil
+      kids = nil
+
+      begin
+         LibXML::XML.default_line_numbers = true
+         parser = LibXML::XML::Parser.file(@SODA_ELEMENTS_FILE)
+         doc = parser.parse()
+      rescue Exception => e
+         doc = nil
+         @report.ReportException(e, false, @sodatest)
+      ensure
+      end
+
+      return nil if (doc == nil)
+      return doc.root
+   end
+###############################################################################
+# ElementsXMLToData -- method
+#     This function generates a hash of the SodaElements.xml file.
+#
+# Input:
+#     node: this is the root node from the xml parser.
+#
+# Output:
+#    returns a hash of the xml node. 
+#
+###############################################################################
+   def ElementsXMLToData(node)
+      elements = {}
+      kids = nil
+
+      if (!node.children?)
+         return {}
+      end
+
+      kids = node.children()
+      kids.each do |kid|
+         next if ( (kid.name == "text") || (!kid.children?) )
+
+         elements[kid.name] = Hash.new()
+         elements[kid.name]['accessor_attributes'] = []
+         elements[kid.name]['soda_attributes'] = []
+         
+         elems = kid.children()
+         elems.each do |e|
+            case (e.name)
+               when "accessor_attributes"
+                  access_kids = e.children()
+                  access_kids.each do |access|
+                     next if (access.name == "text")
+                  elements[kid.name]["accessor_attributes"].push(access.content)
+                  end
+               when "soda_attributes"
+                  access_kids = e.children()
+                  access_kids.each do |access|
+                     next if (access.name == "text")
+
+                     if (access.name =~ /accessor/)
+                        elements[kid.name]["soda_attributes"].push(
+                              access.content)
+                     end
+
+                     if (access.children?)
+                        access_kids = access.children()
+                        tmp_hash = {}
+                        tmp_hash[access.name] = [] 
+                        access_kids.each do |access_kid|
+                           next if (access_kid.name == "text")
+                           tmp_hash[access.name].push(access_kid.content)
+                        end
+                        elements[kid.name]["soda_attributes"].push(tmp_hash)
+                     else
+                        elements[kid.name]["soda_attributes"].push(
+                              access.content)
+                     end
+                  end
+            end
+         end
+      end
+
+      return elements
+   end
+   private :ElementsXMLToData
+
+###############################################################################
+# ProcessSodaTestFile -- method
+#     This function parses a soda test into an array of hashes, using the
+#     same SodaXML class that Soda uses, so there is a 1 to 1 on all data.
+#
+# Input:
+#     file: this is a soda test file.
+#
+# Output:
+#     returns an array of hashes, or nil on error.
+#
+###############################################################################
+   def ProcessSodaTestFile(file)
+      data = nil
+
+      begin
+         data = SodaXML.new.parse(file)
+      rescue Exception => e
+         @report.ReportException(e, false, @sodatest)
+         data = nil
+      ensure
+      end
+
+      return data
+   end
+   private :ProcessSodaTestFile
+
+###############################################################################
+# CheckTest -- function
+#     This function checks a soda test against the SodaElements.xml file to
+#     ensure that the tests is not using unsupported XML.
+#
+# Input:
+#     sodadata: This is an array of hashes from ProcessSodaTestFile().
+#     supported: This is the hash of the SodaElements.xml file.
+#
+# Results:
+#     None.
+#
+###############################################################################
+   def CheckTest(sodadata, supported)
+    
+      sodadata.each do |test_hash|
+         if (!test_hash.key?('do'))
+            @report.ReportFailure("Failed to find expected test do "+
+               "element for test: #{file}, line: #{test_hash['line_number']}"+
+               "!\n")
+            next
+         end
+
+         test_element = test_hash['do']
+         next if (test_element == "comment")
+         test_hash.delete('do')
+
+         if (!supported.key?("#{test_element}"))
+            @report.ReportFailure("Failed to find a supported Soda"+
+               " element for: '#{test_element}', line: "+
+               "#{test_hash['line_number']}!\n")
+               $ERROR_COUNT += 1
+            next
+         end
+
+         if (test_hash.key?('children'))
+            result = CheckTest(test_hash['children'], supported)
+            test_hash.delete('children')
+         end
+
+         test_hash.each do |test_key, test_value|
+            found_accessor = false
+            found_soda_accrssor = false
+
+            next if (test_key =~ /line_number/)
+            
+            supported[test_element]['accessor_attributes'].each do |acc|
+               if (test_key == acc)
+                  found_accessor = true
+                  break
+               end
+            end
+
+            supported[test_element]['soda_attributes'].each do |acc|
+               if (acc.kind_of?(String))
+                  if (test_key == acc)
+                     found_soda_accrssor = true
+                     break
+                  end
+               elsif (acc.kind_of?(Hash))
+                  if (acc.key?("#{test_key}"))
+                     acc[test_key].each do |action|
+                        if (test_value == action)
+                           found_soda_accrssor = true
+                           break
+                        end
+                     end
+
+                     if (!found_soda_accrssor)
+                        @report.ReportFailure("Faild to find supported action"+
+                        " for Soda element: '#{test_element}', attribte: "+
+                           "'#{test_key}', action: '#{test_value}', line:"+
+                           " #{test_hash['line_number']}!\n")
+
+                           $ERROR_COUNT += 1
+                        break
+                     end
+                  end
+               end
+            end
+
+            if ( (found_accessor != true) && (found_soda_accrssor != true) )
+               @report.ReportFailure("(!)Error: Failed to find supported "+
+                  "accessor: '#{test_key}'"+
+                  " for Soda element: '#{test_element}', line: "+
+                  "#{test_hash['line_number']}!\n")
+
+               $ERROR_COUNT += 1
+            end
+            
+         end
+      end
+   end
+   private :CheckTest
+
+###############################################################################
+# CheckFileformat -- method
+#     This function checks to make sure that the test file format is not DOS.
+#
+# Input:
+#     file: the file to check.
+#
+# Output:
+#     returns -1 on error, else 0 on success.
+#
+###############################################################################
+   def CheckFileformat(file)
+      err = 0
+
+      begin 
+         fd = File.open(file, "r")
+         line = fd.readline()
+         fd.close()
+
+         if (line =~ /\r\n$/)
+            @report.ReportFailure("File is in DOS format!\n")
+            err += 1
+         end
+      rescue Exception => e
+         @report.ReportException(e, false, @sodatest)
+         err += 1
+      ensure
+      end
+
+      err = -1 if (err > 0)
+
+      return err
+   end
+
+end
+
+