Support CSV output format for analyzer results.

media/tools/layout_tests/layouttest_analyzer_helpers.py

 #!/usr/bin/python
 # Copyright (c) 2011 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Helper functions for the layout test analyzer."""
 
 from datetime import datetime
 from email.mime.multipart import MIMEMultipart
 from email.mime.text import MIMEText
 import fileinput
 import os
 import pickle
+import re
 import smtplib
 import socket
 import sys
 import time
 import urllib
 
 from bug import Bug
 from test_expectations_history import TestExpectationsHistory
 
 
@@ skipping 101 matching lines @@
       ValueEror when the number of tests in test group "whole" is equal or less
           than that of "skip".
     """
     delta = len(self.result_map['whole'].keys()) - (
         len(self.result_map['skip'].keys()))
     if delta <= 0:
       raise ValueError('The number of tests in test group "whole" is equal or '
                        'less than that of "skip"')
     return 100 - len(self.result_map['nonskip'].keys()) * 100 / delta
 
+  def ConvertToCSVText(self, current_time):
+   """Convert result_map into stats and issues text in CSV format.

[dennis_jeffrey, 2011/11/11 00:01:36]

'result_map' --> |self.result_map|

[imasaki1, 2011/11/11 00:25:52]

Done.

+
+   Both are used for inputs for Google spreadsheet.

[dennis_jeffrey, 2011/11/11 00:01:36]

nit: 'for inputs' --> 'as inputs'

[imasaki1, 2011/11/11 00:25:52]

Done.

+
+   Args:
+     current_time: a string shows current time (e.g, 2011-11-08-16)

[dennis_jeffrey, 2011/11/11 00:01:36]

current_time: a string depicting a time in year-month-day-hour
    format (e.g., 2011-11-08-16).

[imasaki1, 2011/11/11 00:25:52]

Done.

+
+   Returns:
+     a tuple of stats and issues_txt
+        stats: analyzer result in CSV format that shows:
+          (current_time, the number of tests, the number of skipped tests,
+           the number of failing tests)
+          For example,
+            "2011-11-10-15,204,22,12"
+        issues_txt: issues listed in CSV format that shows:

[dennis_jeffrey, 2011/11/11 00:01:36]

Could this include information for multiple issues?  If so, maybe we could give
an example with 2 issues at line 155 down below.

[imasaki1, 2011/11/11 00:25:52]

Done.

+          (BUGWK or BUGCR, bug number, the test expectation entry,
+           the name of the test)
+          For example,
+            "71543,TIMEOUT PASS,media/media-element-play-after-eos.html,"

[dennis_jeffrey, 2011/11/11 00:01:36]

This example seems to be missing the "BUGWK"/"BUGCR" at the front, as described
in line 152 above.

[imasaki1, 2011/11/11 00:25:52]

Done.

+   """
+   stats = ','.join([current_time, str(len(self.result_map['whole'].keys())),
+                    str(len(self.result_map['skip'].keys())),

[dennis_jeffrey, 2011/11/11 00:01:36]

nit: indent this by 1 more space.

[imasaki1, 2011/11/11 00:25:52]

Done.

+                   str(len(self.result_map['nonskip'].keys()))])

[dennis_jeffrey, 2011/11/11 00:01:36]

nit: indent this by 2 more spaces

[imasaki1, 2011/11/11 00:25:52]

Done.

+   issues_txt = ''
+   for (bug_txt, test_info_list) in (

[dennis_jeffrey, 2011/11/11 00:01:36]

I believe the parens are unnecessary in '(bug_txt, test_info_list)'

[imasaki1, 2011/11/11 00:25:52]

Done.

+     self.GetListOfBugsForNonSkippedTests().iteritems()):

[dennis_jeffrey, 2011/11/11 00:01:36]

nit: indent this by 2 more spaces

[imasaki1, 2011/11/11 00:25:52]

Done.

+     matches = re.match(r'(BUG(CR|WK))(\d+)', bug_txt)
+     bug_prefix = ''

[dennis_jeffrey, 2011/11/11 00:01:36]

nit: 'bug_prefix' --> 'bug_suffix', since it's the 'CR' or the 'WK' part after
the 'BUG'

[imasaki1, 2011/11/11 00:25:52]

Done.

+     bug_no = ''
+     if matches:
+       bug_prefix = matches.group(1)
+       bug_no = matches.group(3)
+     issues_txt += bug_prefix + ',' + bug_no + ','
+     for test_info in test_info_list:
+       (test_name, te_info) = test_info

[dennis_jeffrey, 2011/11/11 00:01:36]

no need for parentheses here

[imasaki1, 2011/11/11 00:25:52]

Done.

+       issues_txt += ' '.join(te_info.keys()) + ',' + test_name + ','
+     issues_txt += '\n'
+   return (stats, issues_txt)

[dennis_jeffrey, 2011/11/11 00:01:36]

no need for parentheses here

[imasaki1, 2011/11/11 00:25:52]

Done.

+
   def ConvertToString(self, prev_time, diff_map, bug_anno_map):
     """Convert this result to HTML display for email.
 
     Args:
       prev_time: the previous time string that are compared against.
       diff_map: the compared map generated by |CompareResultMaps()|.
       bug_anno_map: a annotation map where keys are bug names and values are
           annotations for the bug.
 
     Returns:
       a analyzer result string in HTML format.
     """
-    return_str = ('<b>Statistics (Diff Compared to %s):</b><ul>'
-           '<li>The number of tests: %d (%s)</li>'
-           '<li>The number of failing skipped tests: %d (%s)</li>'
-           '<li>The number of failing non-skipped tests: %d (%s)</li>'
-           '<li>Passing rate: %d %%</li></ul>') % (
-               prev_time, len(self.result_map['whole'].keys()),
-               AnalyzerResultMap.GetDiffString(diff_map['whole'], 'whole'),
-               len(self.result_map['skip'].keys()),
-               AnalyzerResultMap.GetDiffString(diff_map['skip'], 'skip'),
-               len(self.result_map['nonskip'].keys()),
-               AnalyzerResultMap.GetDiffString(diff_map['nonskip'],
-                                               'nonskip'),
-               self.GetPassingRate())
+    return_str = ''
+    if diff_map:
+      return_str += ('<b>Statistics (Diff Compared to %s):</b><ul>'
+             '<li>The number of tests: %d (%s)</li>'
+             '<li>The number of failing skipped tests: %d (%s)</li>'
+             '<li>The number of failing non-skipped tests: %d (%s)</li>'
+             '<li>Passing rate: %d %%</li></ul>') % (
+                 prev_time, len(self.result_map['whole'].keys()),
+                 AnalyzerResultMap.GetDiffString(diff_map['whole'], 'whole'),
+                 len(self.result_map['skip'].keys()),
+                 AnalyzerResultMap.GetDiffString(diff_map['skip'], 'skip'),
+                 len(self.result_map['nonskip'].keys()),
+                 AnalyzerResultMap.GetDiffString(diff_map['nonskip'],
+                                                 'nonskip'),
+                 self.GetPassingRate())
     return_str += '<b>Current issues about failing non-skipped tests:</b>'
     for (bug_txt, test_info_list) in (
         self.GetListOfBugsForNonSkippedTests().iteritems()):
       if not bug_txt in bug_anno_map:
         bug_anno_map[bug_txt] = '<font color="red">Needs investigation!</font>'
       return_str += '<ul>%s (%s)' % (Bug(bug_txt), bug_anno_map[bug_txt])
       for test_info in test_info_list:
         (test_name, te_info) = test_info
         gpu_link = ''
         if 'GPU' in te_info:
@@ skipping 78 matching lines @@
         if 'Bugs' in te_info:
           for bug in te_info['Bugs']:
             if bug not in bug_map:
               bug_map[bug] = []
             bug_map[bug].append((name, main_te_info))
     return bug_map
 
 
 def SendStatusEmail(prev_time, analyzer_result_map, diff_map,
                     bug_anno_map, receiver_email_address, test_group_name,
-                    appended_text_to_email, email_content, rev_str):
+                    appended_text_to_email, email_content, rev_str,
+                    email_only_change_mode):
   """Send status email.
 
   Args:
     prev_time: the date string such as '2011-10-09-11'. This format has been
         used in this analyzer.
     analyzer_result_map: current analyzer result.
     diff_map: a map that has 'whole', 'skip' and 'nonskip' as keys.
         The values of the map are the result of |GetDiffBetweenMaps()|.
         The element has two lists of test cases. One (with index 0) is for
         test names that are in the current result but NOT in the previous
         result. The other (with index 1) is for test names that are in the
         previous results but NOT in the current result.
          For example (test expectation information is omitted for
          simplicity),
            comp_result_map['whole'][0] = ['foo1.html']
            comp_result_map['whole'][1] = ['foo2.html']
          This means that current result has 'foo1.html' but it is NOT in the
          previous result. This also means the previous result has 'foo2.html'
          but it is NOT in the current result.
     bug_anno_map: bug annotation map where bug name and annotations are
         stored.
     receiver_email_address: receiver's email address.
     test_group_name: string representing the test group name (e.g., 'media').
     appended_text_to_email: a text which is appended at the end of the status
         email.
     email_content: an email content string that will be shown on the dashboard.
     rev_str: a revision string that contains revision information that is sent
         out in the status email. It is obtained by calling
         |GetRevisionString()|.
+    email_only_change_mode: please refer to |options|.
   """
   if rev_str:
     email_content += '<br><b>Revision Information:</b>'
     email_content += rev_str
   localtime = time.asctime(time.localtime(time.time()))
+  change_str = ''
+  if email_only_change_mode:
+    change_str = 'Status Change'

[dennis_jeffrey, 2011/11/11 00:01:36]

add a space right after the 'e' at the end of this string (see the related
comment at line 341 down below; these comments make sure there are no extra
spaces in the subject line in the event that change_str is the empty string).

[imasaki1, 2011/11/11 00:25:52]

Done.

+  subject = 'Layout Test Analyzer Result %s (%s): %s' % (change_str,

[dennis_jeffrey, 2011/11/11 00:01:36]

remove the space right after the first '%s'

[imasaki1, 2011/11/11 00:25:52]

Done.

+                                                         test_group_name,
+                                                         localtime)
   # TODO(imasaki): remove my name from here.
-  subject = 'Layout Test Analyzer Result (%s): %s' % (test_group_name,
-                                                      localtime)
   SendEmail('imasaki@chromium.org', [receiver_email_address],
             subject, email_content + appended_text_to_email)
 
 
 def GetRevisionString(prev_time, current_time, diff_map):
   """Get a string for revision information during the specified time period.
 
   Args:
     prev_time: the previous time as a floating point number expressed
         in seconds since the epoch, in UTC.
@@ skipping 189 matching lines @@
           list2 = map2[name]['te_info']
           te_diff = [item for item in list1 if not item in list2]
           if te_diff:
               name_list.append((name, te_diff))
       else:
         name_list.append((name, value1))
     return name_list
 
   return (GetDiffBetweenMapsHelper(map1, map2, lookIntoTestExpectationInfo),
           GetDiffBetweenMapsHelper(map2, map1, lookIntoTestExpectationInfo))