X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=glib%2Fgtester-report;h=5bf076ce28b405bd8989ba5ce940b60bb3bf42fc;hb=2a53b4d0e2c98a14aedf31e38f0ad1fb2e8fe26f;hp=f426826fc830211d5a47771c4a4e0456e3acf5fc;hpb=8acddd1ab4f1fb827f90c40c9fdf075dd3ceea91;p=platform%2Fupstream%2Fglib.git

diff --git a/glib/gtester-report b/glib/gtester-report
index f426826..5bf076c 100755
--- a/glib/gtester-report
+++ b/glib/gtester-report
@@ -14,10 +14,20 @@
 # Lesser General Public License for more details.
 #
 # You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the
-# Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-# Boston, MA 02111-1307, USA.
+# License along with this library; if not, see <http://www.gnu.org/licenses/>.
+import datetime
+import optparse
 import sys, re, xml.dom.minidom
+
+try:
+    import subunit
+    from subunit import iso8601
+    from testtools.content import Content, ContentType
+    mime_utf8 = ContentType('text', 'plain', {'charset': 'utf8'})
+except ImportError:
+    subunit = None
+
+
 pkginstall_configvars = {
   #@PKGINSTALL_CONFIGVARS_IN24LINES@ # configvars are substituted upon script installation
 }
@@ -69,6 +79,7 @@ def html_indent_string (n):
     string += uncollapsible_space
   return string
 
+# TestBinary object, instantiated per test binary in the log file
 class TestBinary:
   def __init__ (self, name):
     self.name = name
@@ -79,6 +90,7 @@ class TestBinary:
     self.file = '???'
     self.random_seed = ''
 
+# base class to handle processing/traversion of XML nodes
 class TreeProcess:
   def __init__ (self):
     self.nest_level = 0
@@ -101,23 +113,35 @@ class TreeProcess:
       self.trampoline (child)
     self.nest_level += 1
 
+# test report reader, this class collects some statistics and merges duplicate test binary runs
 class ReportReader (TreeProcess):
   def __init__ (self):
     TreeProcess.__init__ (self)
     self.binary_names = []
     self.binaries = {}
     self.last_binary = None
+    self.info = {}
   def binary_list (self):
     lst = []
     for name in self.binary_names:
       lst += [ self.binaries[name] ]
     return lst
+  def get_info (self):
+    return self.info
+  def handle_info (self, node):
+    dn = find_child (node, 'package')
+    self.info['package'] = node_as_text (dn)
+    dn = find_child (node, 'version')
+    self.info['version'] = node_as_text (dn)
+    dn = find_child (node, 'revision')
+    if dn is not None:
+        self.info['revision'] = node_as_text (dn)
   def handle_testcase (self, node):
     self.last_binary.testcases += [ node ]
     result = attribute_as_text (node, 'result', 'status')
     if result == 'success':
       self.last_binary.success_cases += 1
-    if bool (attribute_as_text (node, 'skipped')):
+    if bool (int (attribute_as_text (node, 'skipped') + '0')):
       self.last_binary.skipped_cases += 1
   def handle_text (self, node):
     pass
@@ -141,7 +165,25 @@ class ReportReader (TreeProcess):
       self.last_binary.random_seed = node_as_text (rseed)
     self.process_children (node)
 
-class ReportWriter (TreeProcess):
+
+class ReportWriter(object):
+    """Base class for reporting."""
+
+    def __init__(self, binary_list):
+        self.binaries = binary_list
+
+    def _error_text(self, node):
+        """Get a string representing the error children of node."""
+        rlist = list_children(node, 'error')
+        txt = ''
+        for enode in rlist:
+            txt += node_as_text (enode)
+            if txt and txt[-1] != '\n':
+                txt += '\n'
+        return txt
+
+
+class HTMLReportWriter(ReportWriter):
   # Javascript/CSS snippet to toggle element visibility
   cssjs = r'''
   <style type="text/css" media="screen">
@@ -164,11 +206,8 @@ class ReportWriter (TreeProcess):
     }
   }
   message_array = Array();
-  function view_testlog (wname, file, random_seed, tcase, msgid) {
+  function view_testlog (wname, file, random_seed, tcase, msgtitle, msgid) {
       txt = message_array[msgid];
-      txt = txt.replace (/&/g, "&amp;");
-      txt = txt.replace (/</g, "&lt;");
-      txt = txt.replace (/>/g, "&gt;");
       var w = window.open ("", // URI
                            wname,
                            "resizable,scrollbars,status,width=790,height=400");
@@ -176,7 +215,7 @@ class ReportWriter (TreeProcess):
       doc.write ("<h2>File: " + file + "</h2>\n");
       doc.write ("<h3>Case: " + tcase + "</h3>\n");
       doc.write ("<strong>Random Seed:</strong> <code>" + random_seed + "</code> <br /><br />\n");
-      doc.write ("<strong>Output: </strong><br />\n");
+      doc.write ("<strong>" + msgtitle + "</strong><br />\n");
       doc.write ("<pre>");
       doc.write (txt);
       doc.write ("</pre>\n");
@@ -185,9 +224,9 @@ class ReportWriter (TreeProcess):
   }
   --></script>
   '''
-  def __init__ (self, binary_list):
-    TreeProcess.__init__ (self)
-    self.binaries = binary_list
+  def __init__ (self, info, binary_list):
+    ReportWriter.__init__(self, binary_list)
+    self.info = info
     self.bcounter = 0
     self.tcounter = 0
     self.total_tcounter = 0
@@ -199,10 +238,14 @@ class ReportWriter (TreeProcess):
     sys.stdout.write (message)
     if message:
       self.lastchar = message[-1]
+  def handle_info (self):
+    self.oprint ('<h3>Package: %(package)s, version: %(version)s</h3>\n' % self.info)
+    if self.info['revision']:
+        self.oprint ('<h5>Report generated from: %(revision)s</h5>\n' % self.info)
   def handle_text (self, node):
     self.oprint (node.nodeValue)
   def handle_testcase (self, node, binary):
-    skipped = bool (attribute_as_text (node, 'skipped'))
+    skipped = bool (int (attribute_as_text (node, 'skipped') + '0'))
     if skipped:
       return            # skipped tests are uninteresting for HTML reports
     path = attribute_as_text (node, 'path')
@@ -216,18 +259,34 @@ class ReportWriter (TreeProcess):
       duration = '-'    # ignore bogus durations
     self.oprint ('<tr id="b%u_t%u_" keywords="%s all" class="HiddenSection">\n' % (self.bcounter, self.tcounter, result))
     self.oprint ('<td>%s %s</td> <td align="right">%s</td> \n' % (html_indent_string (4), path, duration))
+    perflist = list_children (node, 'performance')
     if result != 'success':
-      rlist = list_children (node, 'error')
-      txt = ''
-      for enode in rlist:
-        txt += node_as_text (enode)
-        if txt and txt[-1] != '\n':
-          txt += '\n'
+      txt = self._error_text(node)
       txt = re.sub (r'"', r'\\"', txt)
       txt = re.sub (r'\n', r'\\n', txt)
+      txt = re.sub (r'&', r'&amp;', txt)
+      txt = re.sub (r'<', r'&lt;', txt)
       self.oprint ('<script language="javascript" type="text/javascript">message_array["b%u_t%u_"] = "%s";</script>\n' % (self.bcounter, self.tcounter, txt))
-      self.oprint ('<td align="center"><a href="javascript:view_testlog (\'%s\', \'%s\', \'%s\', \'%s\', \'b%u_t%u_\')">Output</a></td>\n' %
-                   ('TestOutputWindow', binary.file, binary.random_seed, path, self.bcounter, self.tcounter))
+      self.oprint ('<td align="center"><a href="javascript:view_testlog (\'%s\', \'%s\', \'%s\', \'%s\', \'Output:\', \'b%u_t%u_\')">Details</a></td>\n' %
+                   ('TestResultWindow', binary.file, binary.random_seed, path, self.bcounter, self.tcounter))
+    elif perflist:
+      presults = []
+      for perf in perflist:
+        pmin = bool (int (attribute_as_text (perf, 'minimize')))
+        pmax = bool (int (attribute_as_text (perf, 'maximize')))
+        pval = float (attribute_as_text (perf, 'value'))
+        txt = node_as_text (perf)
+        txt = re.sub (r'&', r'&amp;', txt)
+        txt = re.sub (r'<', r'&gt;', txt)
+        txt = '<strong>Performance(' + (pmin and '<em>minimized</em>' or '<em>maximized</em>') + '):</strong> ' + txt.strip() + '<br />\n'
+        txt = re.sub (r'"', r'\\"', txt)
+        txt = re.sub (r'\n', r'\\n', txt)
+        presults += [ (pval, txt) ]
+      presults.sort()
+      ptxt = ''.join ([e[1] for e in presults])
+      self.oprint ('<script language="javascript" type="text/javascript">message_array["b%u_t%u_"] = "%s";</script>\n' % (self.bcounter, self.tcounter, ptxt))
+      self.oprint ('<td align="center"><a href="javascript:view_testlog (\'%s\', \'%s\', \'%s\', \'%s\', \'Test Results:\', \'b%u_t%u_\')">Details</a></td>\n' %
+                   ('TestResultWindow', binary.file, binary.random_seed, path, self.bcounter, self.tcounter))
     else:
       self.oprint ('<td align="center">-</td>\n')
     self.oprint ('<td align="right" %s>%s</td>\n' % (rcolor, result))
@@ -246,16 +305,21 @@ class ReportWriter (TreeProcess):
       erlink = 'href="javascript:toggle_display (\'ResultTable\', \'tr\', \'b%u_\', \'failed\')"' % self.bcounter
     if binary.success_cases:
       oklink = 'href="javascript:toggle_display (\'ResultTable\', \'tr\', \'b%u_\', \'success\')"' % self.bcounter
-    self.oprint ('<a %s>ER</a>\n' % erlink)
-    self.oprint ('<a %s>OK</a>\n' % oklink)
-    self.oprint ('</td>\n')
-    perc = binary.success_cases * 100.0 / real_cases
-    pcolor = {
-      100 : 'bgcolor="lightgreen"',
-      0   : 'bgcolor="red"',
-    }.get (int (perc), 'bgcolor="yellow"')
-    self.oprint ('<td align="right" %s>%.2f%%</td>\n' % (pcolor, perc))
-    self.oprint ('</tr>\n')
+    if real_cases != 0:
+	self.oprint ('<a %s>ER</a>\n' % erlink)
+	self.oprint ('<a %s>OK</a>\n' % oklink)
+	self.oprint ('</td>\n')
+	perc = binary.success_cases * 100.0 / real_cases
+	pcolor = {
+	  100 : 'bgcolor="lightgreen"',
+	  0   : 'bgcolor="red"',
+	}.get (int (perc), 'bgcolor="yellow"')
+	self.oprint ('<td align="right" %s>%.2f%%</td>\n' % (pcolor, perc))
+	self.oprint ('</tr>\n')
+    else:
+	self.oprint ('Empty\n')
+	self.oprint ('</td>\n')
+	self.oprint ('</tr>\n')
     for tc in binary.testcases:
       self.handle_testcase (tc, binary)
   def handle_totals (self):
@@ -264,7 +328,10 @@ class ReportWriter (TreeProcess):
                  (self.bcounter, self.total_tcounter, self.total_fcounter, self.total_tcounter - self.total_fcounter))
     self.oprint ('<td align="right">%f</td>\n' % self.total_duration)
     self.oprint ('<td align="center">-</td>\n')
-    perc = (self.total_tcounter - self.total_fcounter) * 100.0 / self.total_tcounter
+    if self.total_tcounter != 0:
+        perc = (self.total_tcounter - self.total_fcounter) * 100.0 / self.total_tcounter
+    else:
+        perc = 0.0
     pcolor = {
       100 : 'bgcolor="lightgreen"',
       0   : 'bgcolor="red"',
@@ -278,6 +345,7 @@ class ReportWriter (TreeProcess):
     self.oprint ('</head>\n')
     self.oprint ('<body>\n')
     self.oprint ('<h2>GTester Unit Test Report</h2>\n')
+    self.handle_info ()
     self.oprint ('<table id="ResultTable" width="100%" border="1">\n<tr>\n')
     self.oprint ('<th>Program / Testcase </th>\n')
     self.oprint ('<th style="width:8em">Duration (sec)</th>\n')
@@ -291,45 +359,132 @@ class ReportWriter (TreeProcess):
     self.oprint ('</body>\n')
     self.oprint ('</html>\n')
 
-def parse_files_and_args ():
-  from sys import argv, stdin
-  files = []
-  arg_iter = sys.argv[1:].__iter__()
-  rest = len (sys.argv) - 1
-  for arg in arg_iter:
-    rest -= 1
-    if arg == '--help' or arg == '-h':
-      print_help ()
-      sys.exit (0)
-    elif arg == '--version' or arg == '-v':
-      print_help (False)
-      sys.exit (0)
-    else:
-      files = files + [ arg ]
-  return files
-
-def print_help (with_help = True):
-  import os
-  print "gtester-report (GLib utils) version", pkginstall_configvars.get ('glib-version', '0.0-uninstalled')
-  if not with_help:
-    return
-  print "Usage: %s [OPTIONS] <gtester-log.xml>" % os.path.basename (sys.argv[0])
-  print "Generate HTML reports from the XML log files generated by gtester."
-  print "Options:"
-  print "  --help, -h                print this help message"
-  print "  --version, -v             print version info"
+
+class SubunitWriter(ReportWriter):
+    """Reporter to output a subunit stream."""
+
+    def printout(self):
+        reporter = subunit.TestProtocolClient(sys.stdout)
+        for binary in self.binaries:
+            for tc in binary.testcases:
+                test = GTestCase(tc, binary)
+                test.run(reporter)
+
+
+class GTestCase(object):
+    """A representation of a gtester test result as a pyunit TestCase."""
+
+    def __init__(self, case, binary):
+        """Create a GTestCase for case 'case' from binary program 'binary'."""
+        self._case = case
+        self._binary = binary
+        # the name of the case - e.g. /dbusmenu/glib/objects/menuitem/props_boolstr
+        self._path = attribute_as_text(self._case, 'path')
+
+    def id(self):
+        """What test is this? Returns the gtester path for the testcase."""
+        return self._path
+
+    def _get_details(self):
+        """Calculate a details dict for the test - attachments etc."""
+        details = {}
+        result = attribute_as_text(self._case, 'result', 'status')
+        details['filename'] = Content(mime_utf8, lambda:[self._binary.file])
+        details['random_seed'] = Content(mime_utf8,
+            lambda:[self._binary.random_seed])
+        if self._get_outcome() == 'addFailure':
+            # Extract the error details. Skips have no details because its not
+            # skip like unittest does, instead the runner just bypasses N test.
+            txt = self._error_text(self._case)
+            details['error'] = Content(mime_utf8, lambda:[txt])
+        if self._get_outcome() == 'addSuccess':
+            # Sucessful tests may have performance metrics.
+            perflist = list_children(self._case, 'performance')
+            if perflist:
+                presults = []
+                for perf in perflist:
+                    pmin = bool (int (attribute_as_text (perf, 'minimize')))
+                    pmax = bool (int (attribute_as_text (perf, 'maximize')))
+                    pval = float (attribute_as_text (perf, 'value'))
+                    txt = node_as_text (perf)
+                    txt = 'Performance(' + (pmin and 'minimized' or 'maximized'
+                        ) + '): ' + txt.strip() + '\n'
+                    presults += [(pval, txt)]
+                presults.sort()
+                perf_details = [e[1] for e in presults]
+                details['performance'] = Content(mime_utf8, lambda:perf_details)
+        return details
+
+    def _get_outcome(self):
+        if int(attribute_as_text(self._case, 'skipped') + '0'):
+            return 'addSkip'
+        outcome = attribute_as_text(self._case, 'result', 'status')
+        if outcome == 'success':
+            return 'addSuccess'
+        else:
+            return 'addFailure'
+
+    def run(self, result):
+        time = datetime.datetime.utcnow().replace(tzinfo=iso8601.Utc())
+        result.time(time)
+        result.startTest(self)
+        try:
+            outcome = self._get_outcome()
+            details = self._get_details()
+            # Only provide a duration IFF outcome == 'addSuccess' - the main
+            # parser claims bogus results otherwise: in that case emit time as
+            # zero perhaps.
+            if outcome == 'addSuccess':
+                duration = float(node_as_text(self._case, 'duration'))
+                duration = duration * 1000000
+                timedelta = datetime.timedelta(0, 0, duration)
+                time = time + timedelta
+                result.time(time)
+            getattr(result, outcome)(self, details=details)
+        finally:
+            result.stopTest(self)
+
+
+
+# main program handling
+def parse_opts():
+    """Parse program options.
+
+    :return: An options object and the program arguments.
+    """
+    parser = optparse.OptionParser()
+    parser.version =  pkginstall_configvars.get ('glib-version', '0.0-uninstalled')
+    parser.usage = "%prog [OPTIONS] <gtester-log.xml>"
+    parser.description = "Generate HTML reports from the XML log files generated by gtester."
+    parser.epilog = "gtester-report (GLib utils) version %s."% (parser.version,)
+    parser.add_option("-v", "--version", action="store_true", dest="version", default=False,
+        help="Show program version.")
+    parser.add_option("-s", "--subunit", action="store_true", dest="subunit", default=False,
+        help="Output subunit [See https://launchpad.net/subunit/"
+            " Needs python-subunit]")
+    options, files = parser.parse_args()
+    if options.version:
+        print parser.epilog
+        return None, None
+    if len(files) != 1:
+        parser.error("Must supply a log file to parse.")
+    if options.subunit and subunit is None:
+        parser.error("python-subunit is not installed.")
+    return options, files
+
 
 def main():
-  from sys import argv, stdin
-  files = parse_files_and_args()
-  if len (files) != 1:
-    print_help (True)
-    sys.exit (1)
+  options, files = parse_opts()
+  if options is None:
+    return 0
   xd = xml.dom.minidom.parse (files[0])
   rr = ReportReader()
   rr.trampoline (xd)
-  rw = ReportWriter (rr.binary_list())
-  rw.printout()
+  if not options.subunit:
+      HTMLReportWriter(rr.get_info(), rr.binary_list()).printout()
+  else:
+      SubunitWriter(rr.get_info(), rr.binary_list()).printout()
+
 
 if __name__ == '__main__':
   main()