Updating Layout test analyzer to add control to show issue detail or not.

media/tools/layout_tests/layouttest_analyzer.py

 #!/usr/bin/env python
-# Copyright (c) 2011 The Chromium Authors. All rights reserved.
+# Copyright (c) 2012 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.
 
 """Main functions for the Layout Test Analyzer module."""
 
 import csv
 from datetime import datetime
 import optparse
 import os
 import sys
 import time
 
+import layouttest_analyzer_helpers
 import layouttests
-import layouttest_analyzer_helpers
+
 from test_expectations import TestExpectations
 from trend_graph import TrendGraph
 
 # Predefined result directory.
 DEFAULT_RESULT_DIR = 'result'
 DEFAULT_ANNO_FILE = os.path.join('anno', 'anno.csv')
 DEFAULT_GRAPH_FILE = os.path.join('graph', 'graph.html')
 DEFAULT_STATS_CSV_FILENAME = 'stats.csv'
 DEFAULT_ISSUES_CSV_FILENAME = 'issues.csv'
 # Predefined result files for debug.
@@ skipping 39 matching lines @@
                            dest='test_group_file_location',
                            help=('Location of the test group file; '
                                  'file is expected to be in CSV format '
                                  'and lists all test name patterns. '
                                  'When this option is not specified, '
                                  'the value of --test-group-name is used '
                                  'for a test name pattern.'),
                            default=None)
   option_parser.add_option('-x', '--test-group-name',
                            dest='test_group_name',
-                           help='A name of test group. Either '
-                                '--test_group_file_location or this option '
-                                'needs to be specified.')
+                           help=('A name of test group. Either '
+                                 '--test_group_file_location or this option '
+                                 'needs to be specified.'))
   option_parser.add_option('-d', '--result-directory-location',
                            dest='result_directory_location',
                            help=('Name of result directory location '
                                  '(default to %default).'),
                            default=DEFAULT_RESULT_DIR)
   option_parser.add_option('-b', '--email-appended-text-file-location',
                            dest='email_appended_text_file_location',
                            help=('File location of the email appended text. '
                                  'The text is appended in the status email. '
                                  '(default to %default and no text is '
                                  'appended in that case).'),
                            default=None)
   option_parser.add_option('-c', '--email-only-change-mode',
                            dest='email_only_change_mode',
                            help=('With this mode, email is sent out '
                                  'only when there is a change in the '
                                  'analyzer result compared to the previous '
                                  'result (off by default)'),
                            action='store_true', default=False)
   option_parser.add_option('-q', '--dashboard-file-location',
                            dest='dashboard_file_location',
                            help=('Location of dashboard file. The results are '
                                  'not reported to the dashboard if this '
                                  'option is not specified.'))
+  option_parser.add_option('-z', '--issue-detail-mode',
+                           dest='issue_detail_mode',
+                           help=('With this mode, email includes issue details '
+                                 '(links to the flakiness dashboard)'
+                                 ' (off by default)'),
+                           action='store_true', default=False)
   return option_parser.parse_args()[0]
 
 
 def GetCurrentAndPreviousResults(debug, test_group_file_location,
                                  test_group_name, result_directory_location):
   """Get current and the latest previous analyzer results.
 
   In debug mode, they are read from predefined files. In non-debug mode,
   current analyzer results are dynamically obtained from Webkit SVN and
   the latest previous result is read from the corresponding file.
@@ skipping 40 matching lines @@
         test_group_name += '/'
       parent_location_list = [test_group_name]
       filter_names = None
       recursion = True
     layouttests_object = layouttests.LayoutTests(
         parent_location_list=parent_location_list, recursion=recursion,
         filter_names=filter_names)
     analyzer_result_map = layouttest_analyzer_helpers.AnalyzerResultMap(
         layouttests_object.JoinWithTestExpectation(TestExpectations()))
     result = layouttest_analyzer_helpers.FindLatestResult(
-                 result_directory_location)
+        result_directory_location)
     if result:
       (prev_time, prev_analyzer_result_map) = result
     else:
       prev_time = None
       prev_analyzer_result_map = None
   else:
     analyzer_result_map = layouttest_analyzer_helpers.AnalyzerResultMap.Load(
         CURRENT_RESULT_FILE_FOR_DEBUG)
     prev_time = PREV_TIME_FOR_DEBUG
     prev_analyzer_result_map = (
@@ skipping 36 matching lines @@
       print 'cannot open email appended text file %s. Skipping.' % (
           email_appended_text_file_location)
     else:
       appended_text_to_email = ''.join(file_object.readlines())
       file_object.close()
   return (anno_map, appended_text_to_email)
 
 
 def SendEmail(prev_time, prev_analyzer_result_map, analyzer_result_map,
               anno_map, appended_text_to_email, email_only_change_mode, debug,
-              receiver_email_address, test_group_name):
+              receiver_email_address, test_group_name, issue_detail_mode):
   """Send result status email.
 
   Args:
     prev_time: the previous time string that is compared against.
     prev_analyzer_result_map: previous analyzer result map. Please refer to
         layouttest_analyzer_helpers.AnalyzerResultMap.
     analyzer_result_map: current analyzer result map. Please refer to
         layouttest_analyzer_helpers.AnalyzerResultMap.
     anno_map: a dictionary that maps bug names to their annotations.
     appended_text_to_email: the text string to append to the status email.
     email_only_change_mode: please refer to |options|.
     debug: please refer to |options|.
     receiver_email_address: please refer to |options|.
     test_group_name: please refer to |options|.
+    issue_detail_mode: please refer to |options|.
 
   Returns:
     a tuple of the following:
         result_change: a boolean indicating whether there is a change in the
             result compared with the latest past result.
         diff_map: please refer to
             layouttest_analyzer_helpers.SendStatusEmail().
         simple_rev_str: a simple version of revision string that is sent in
             the email.
         rev: the latest revision number for the given test group.
         rev_date: the latest revision date for the given test group.
         email_content:  email content string (without
             |appended_text_to_email|) that will be shown on the dashboard.
   """
   rev = ''
   rev_date = ''
   email_content = ''
   if prev_analyzer_result_map:
     diff_map = analyzer_result_map.CompareToOtherResultMap(
         prev_analyzer_result_map)
     result_change = (any(diff_map['whole']) or any(diff_map['skip']) or
-                        any(diff_map['nonskip']))
+                     any(diff_map['nonskip']))
     # Email only when |email_only_change_mode| is False or there
     # is a change in the result compared to the last result.
     simple_rev_str = ''
     if not email_only_change_mode or result_change:
       prev_time_in_float = datetime.strptime(prev_time, '%Y-%m-%d-%H')
       prev_time_in_float = time.mktime(prev_time_in_float.timetuple())
       if debug:
         cur_time_in_float = datetime.strptime(CUR_TIME_FOR_DEBUG,
                                               '%Y-%m-%d-%H')
         cur_time_in_float = time.mktime(cur_time_in_float.timetuple())
       else:
         cur_time_in_float = time.time()
       (rev_str, simple_rev_str, rev, rev_date) = (
           layouttest_analyzer_helpers.GetRevisionString(prev_time_in_float,
                                                         cur_time_in_float,
                                                         diff_map))
-      email_content = analyzer_result_map.ConvertToString(prev_time, diff_map,
-                                                          anno_map)
+      email_content = analyzer_result_map.ConvertToString(prev_time,
+                                                          diff_map,
+                                                          anno_map,
+                                                          issue_detail_mode)
       if receiver_email_address:
         layouttest_analyzer_helpers.SendStatusEmail(
             prev_time, analyzer_result_map, diff_map, anno_map,
             receiver_email_address, test_group_name,
             appended_text_to_email, email_content, rev_str,
             email_only_change_mode)
     if simple_rev_str:
       simple_rev_str = '\'' + simple_rev_str + '\''
     else:
       simple_rev_str = 'undefined'  # GViz uses undefined for NONE.
@@ skipping 111 matching lines @@
   escaped_tg_name = test_group_name.replace('/', '_')
   for tg in ['whole', 'skip', 'nonskip']:
     file_name = os.path.join(
         os.path.dirname(dashboard_file_location),
         escaped_tg_name + '_' + tg + '.html')
     file_object = open(file_name, 'wb')
     file_object.write('<table border="1">')
     sorted_testnames = data_map[tg][0].keys()
     sorted_testnames.sort()
     for testname in sorted_testnames:
-      file_object.write(('<tr><td><a href="%s">%s</a></td>'
-                         '<td><a href="%s">dashboard</a></td>'
-                         '<td>%s</td></tr>') % (
-          layouttest_root_path + testname, testname,
-          ('http://test-results.appspot.com/dashboards/'
-           'flakiness_dashboard.html#tests=%s') % testname,
-          data_map[tg][0][testname]))
+      file_object.write((
+          '<tr><td><a href="%s">%s</a></td><td><a href="%s">dashboard</a>'
+          '</td><td>%s</td></tr>') % (
+              layouttest_root_path + testname, testname,
+              ('http://test-results.appspot.com/dashboards/'
+               'flakiness_dashboard.html#tests=%s') % testname,
+              data_map[tg][0][testname]))
     file_object.write('</table>')
     file_object.close()
   email_content_with_link = ''
   if email_content:
     file_name = os.path.join(os.path.dirname(dashboard_file_location),
                              escaped_tg_name + '_email.html')
     file_object = open(file_name, 'wb')
     file_object.write(email_content)
     file_object.close()
     email_content_with_link = '<a href="%s_email.html">info</a>' % (
@@ skipping 29 matching lines @@
                                    options.test_group_file_location,
                                    options.test_group_name,
                                    options.result_directory_location))
   (anno_map, appended_text_to_email) = ReadEmailInformation(
       options.bug_annotation_file_location,
       options.email_appended_text_file_location)
   (result_change, diff_map, simple_rev_str, rev, rev_date, email_content) = (
       SendEmail(prev_time, prev_analyzer_result_map, analyzer_result_map,
                 anno_map, appended_text_to_email,
                 options.email_only_change_mode, options.debug,
-                options.receiver_email_address, options.test_group_name))
+                options.receiver_email_address, options.test_group_name,
+                options.issue_detail_mode))
 
   # Create CSV texts and save them for bug spreadsheet.
   (stats, issues_txt) = analyzer_result_map.ConvertToCSVText(
       start_time.strftime('%Y-%m-%d-%H'))
   file_object = open(os.path.join(options.result_directory_location,
                                   DEFAULT_STATS_CSV_FILENAME), 'wb')
   file_object.write(stats)
   file_object.close()
   file_object = open(os.path.join(options.result_directory_location,
                                   DEFAULT_ISSUES_CSV_FILENAME), 'wb')
@@ skipping 12 matching lines @@
     # Report the result to dashboard.
     if options.dashboard_file_location:
       UpdateDashboard(options.dashboard_file_location, options.test_group_name,
                       data_map, layouttests.DEFAULT_LAYOUTTEST_LOCATION, rev,
                       rev_date, options.receiver_email_address,
                       email_content)
 
 
 if '__main__' == __name__:
   main()