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

media/tools/layout_tests/layouttests.py

-# 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.
 
 """Layout tests module that is necessary for the layout analyzer.
 
 Layout tests are stored in Webkit SVN and LayoutTestCaseManager collects these
 layout test cases (including description).
 """
 
 import copy
 import csv
 import locale
-import pysvn
 import re
 import sys
 import urllib2
 
+import pysvn
 
 # Webkit SVN root location.
 DEFAULT_LAYOUTTEST_LOCATION = (
     'http://svn.webkit.org/repository/webkit/trunk/LayoutTests/')
 
 # When parsing the test HTML file and finding the test description,
 # this script tries to find the test description using sentences
 # starting with these keywords. This is adhoc but it is the only way
 # since there is no standard for writing test description.
 KEYWORDS_FOR_TEST_DESCRIPTION = ['This test', 'Tests that', 'Test ']
@@ skipping 33 matching lines @@
     if layouttest_root_path.startswith('http://'):
       name_map = self.GetLayoutTestNamesFromSVN(parent_location_list,
                                                 layouttest_root_path,
                                                 recursion)
     else:
       # TODO(imasaki): support other forms such as CSV for reading test names.
       pass
     self.name_map = copy.copy(name_map)
     if filter_names:
       # Filter names.
-      for lt_name in name_map.keys():
+      for lt_name in name_map.iterkeys():
         match = False
         for filter_name in filter_names:
           if re.search(filter_name, lt_name):
             match = True
             break
         if not match:
           del self.name_map[lt_name]
     # We get description only for the filtered names.
-    for lt_name in self.name_map.keys():
+    for lt_name in self.name_map.iterkeys():
       self.name_map[lt_name] = LayoutTests.GetTestDescriptionFromSVN(lt_name)
 
   @staticmethod
   def ExtractTestDescription(txt):
     """Extract the description description from test code in HTML.
 
     Currently, we have 4 rules described in the code below.
     (This example falls into rule 1):
       <p>
       This tests the intrinsic size of a video element is the default
@@ skipping 11 matching lines @@
           test description is not found.
     """
     # (1) Try to find test description that contains keywords such as
     #     'test that' and surrounded by p tag.
     #     This is the most common case.
     for keyword in KEYWORDS_FOR_TEST_DESCRIPTION:
       # Try to find <p> and </p>.
       pattern = r'<p>(.*' + keyword + '.*)</p>'
       matches = re.search(pattern, txt)
       if matches is not None:
-          return matches.group(1).strip()
+        return matches.group(1).strip()
 
     # (2) Try to find it by using more generic keywords such as 'PASS' etc.
     for keyword in KEYWORD_FOR_TEST_DESCRIPTION_FAIL_SAFE:
       # Try to find new lines.
       pattern = r'\n(.*' + keyword + '.*)\n'
       matches = re.search(pattern, txt)
       if matches is not None:
-          # Remove 'p' tag.
-          text = matches.group(1).strip()
-          return text.replace('<p>', '').replace('</p>', '')
+        # Remove 'p' tag.
+        text = matches.group(1).strip()
+        return text.replace('<p>', '').replace('</p>', '')
 
     # (3) Try to find it by using HTML tag such as title.
     for tag in TAGS_FOR_TEST_DESCRIPTION:
       pattern = r'<' + tag + '>(.*)</' + tag + '>'
       matches = re.search(pattern, txt)
       if matches is not None:
-          return matches.group(1).strip()
+        return matches.group(1).strip()
 
     # (4) Try to find it by using test description and remove 'p' tag.
     for keyword in KEYWORDS_FOR_TEST_DESCRIPTION:
       # Try to find <p> and </p>.
       pattern = r'\n(.*' + keyword + '.*)\n'
       matches = re.search(pattern, txt)
       if matches is not None:
-          # Remove 'p' tag.
-          text = matches.group(1).strip()
-          return text.replace('<p>', '').replace('</p>', '')
+        # Remove 'p' tag.
+        text = matches.group(1).strip()
+        return text.replace('<p>', '').replace('</p>', '')
 
     # (5) cannot find test description using existing rules.
     return 'UNKNOWN'
 
   @staticmethod
   def GetLayoutTestNamesFromSVN(parent_location_list,
                                 layouttest_root_path, recursion):
     """Get LayoutTest names from Webkit SVN.
 
     Args:
@@ skipping 26 matching lines @@
     return name_map
 
   @staticmethod
   def GetLayoutTestNamesFromCSV(csv_file_path):
     """Get layout test names from CSV file.
 
     Args:
       csv_file_path: the path for the CSV file containing test names (including
           regular expression patterns). The CSV file content has one column and
           each row contains a test name.
+
+    Returns:
+       a list of test names in string.
     """
     file_object = file(csv_file_path, 'r')
     reader = csv.reader(file_object)
     names = [row[0] for row in reader]
     file_object.close()
     return names
 
   @staticmethod
   def GetParentDirectoryList(names):
     """Get parent directory list from test names.
 
     Args:
       names: a list of test names. The test names also have path information as
           well (e.g., media/video-zoom.html).
+
+    Returns:
+      a list of parent directories for the given test names.
     """
     pd_map = {}
     for name in names:
       p_dir = name[0:name.rfind('/') + 1]
       pd_map[p_dir] = True
     return list(pd_map.iterkeys())
 
   def JoinWithTestExpectation(self, test_expectations):
     """Join layout tests with the test expectation file using test name as key.
 
@@ skipping 44 matching lines @@
       try:
         resp = urllib2.urlopen(url)
       except urllib2.HTTPError:
         # Some files with different languages cause this exception.
         # Return an empty description in this case.
         return ''
       if resp.code == 200:
         return LayoutTests.ExtractTestDescription(resp.read())
       raise urllib2.URLError(
           'Fail to get layout test HTML file from %s.' % url)