Added sorting functionality to HTML tables on coverage dashboard.

tools/code_coverage/croc_html.py

 # 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.
 
 """Crocodile HTML output."""
 
 import os
 import shutil
 import time
 import xml.dom
@@ skipping 175 matching lines @@
   def AddSectionHeader(self, table, caption, itemtype, is_file=False):
     """Adds a section header to the coverage table.
 
     Args:
       table: Table to add rows to.
       caption: Caption for section, if not None.
       itemtype: Type of items in this section, if not None.
       is_file: Are items in this section files?
     """
 
+    caption = None

[John Grabowski, 2012/06/26 21:45:29]

This is odd.  caption is a param, which you force to a specific value.  Maybe
better to make the caller pass None to do what you want?

[pshenoy, 2012/06/29 18:23:07]

Sorry. I did this for testing purpose and forgot to remove. Done.

     if caption is not None:
-      table.E('tr').E('td', e_class='secdesc', colspan=8).Text(caption)
+      table.E('tr').E('th', e_class='secdesc', colspan=8).Text(caption)
 
     sec_hdr = table.E('tr')
 
     if itemtype is not None:
-      sec_hdr.E('td', e_class='section').Text(itemtype)
+      sec_hdr.E('th', e_class='section').Text(itemtype)
 
-    sec_hdr.E('td', e_class='section').Text('Coverage')
-    sec_hdr.E('td', e_class='section', colspan=3).Text(
+    sec_hdr.E('th', e_class='section').Text('Coverage')
+    sec_hdr.E('th', e_class='section', colspan=3).Text(
         'Lines executed / instrumented / missing')
 
-    graph = sec_hdr.E('td', e_class='section')
+    graph = sec_hdr.E('th', e_class='section')
     graph.E('span', style='color:#00FF00').Text('exe')
     graph.Text(' / ')
     graph.E('span', style='color:#FFFF00').Text('inst')
     graph.Text(' / ')
     graph.E('span', style='color:#FF0000').Text('miss')
 
     if is_file:
-      sec_hdr.E('td', e_class='section').Text('Language')
-      sec_hdr.E('td', e_class='section').Text('Group')
+      sec_hdr.E('th', e_class='section').Text('Language')
+      sec_hdr.E('th', e_class='section').Text('Group')
     else:
-      sec_hdr.E('td', e_class='section', colspan=2)
+      sec_hdr.E('th', e_class='section', colspan=2)
 
   def AddItem(self, table, itemname, stats, attrs, link=None):
     """Adds a bar graph to the element.  This is a series of <td> elements.
 
     Args:
       table: Table to add item to.
       itemname: Name of item.
       stats: Stats object.
       attrs: Attributes dictionary; if None, no attributes will be printed.
       link: Destination for itemname hyperlink, if not None.
@@ skipping 121 matching lines @@
 
     if cov_dir.dirpath:
       title = 'Coverage for ' + cov_dir.dirpath + '/'
       f = self.CreateHtmlDoc(cov_dir.dirpath + '/index.html', title)
     else:
       title = 'Coverage summary'
       f = self.CreateHtmlDoc('index.html', title)
 
     body = f.body
 
+    dirs = [''] + cov_dir.dirpath.split('/')
+    num_dirs = len(dirs)
+    sort_jsfile = '../' * (num_dirs - 1) + 'sorttable.js'
+    script = body.E('script', src=sort_jsfile)
+    body.E('/script')
+
     # Write header section
     if cov_dir.dirpath:
       self.AddCaptionForSubdir(body, cov_dir.dirpath)
     else:
       body.E('h2').Text(title)
 
-    table = body.E('table')
-
+    table = body.E('table', e_class='sortable')
+    table.E('h3').Text('Coverage by Group')
     # Coverage by group
     self.AddSectionHeader(table, 'Coverage by Group', 'Group')
 
     for group in sorted(cov_dir.stats_by_group):
       self.AddItem(table, group, cov_dir.stats_by_group[group], None)
 
+    table = body.E('table', e_class='sortable')
+    table.E('h3').Text('Subdirectories')
     # List subdirs
     if cov_dir.subdirs:
       self.AddSectionHeader(table, 'Subdirectories', 'Subdirectory')
 
       for d in sorted(cov_dir.subdirs):
         self.AddItem(table, d + '/', cov_dir.subdirs[d].stats_by_group['all'],
                      None, link=d + '/index.html')
 
+    table = body.E('table', e_class='sortable')
+    table.E('h3').Text('Files in This Directory')
     # List files
     if cov_dir.files:
       self.AddSectionHeader(table, 'Files in This Directory', 'Filename',
                             is_file=True)
 
       for filename in sorted(cov_dir.files):
         cov_file = cov_dir.files[filename]
         self.AddItem(table, filename, cov_file.stats, cov_file.attrs,
                      link=filename + '.html')
 
     body.E('p', e_class='time').Text(self.time_string)
     f.Write()
 
   def WriteRoot(self):
     """Writes the files in the output root."""
     # Find ourselves
     src_dir = os.path.split(self.WriteRoot.func_code.co_filename)[0]
 
     # Files to copy into output root
     copy_files = [
         'croc.css',
+        'sorttable.js',
     ]
 
     # Copy files from our directory into the output directory
     for copy_file in copy_files:
       print '  Copying %s' % copy_file
       shutil.copyfile(os.path.join(src_dir, copy_file),
                       os.path.join(self.output_root, copy_file))
 
   def Write(self):
     """Writes HTML output."""
@@ skipping 11 matching lines @@
 
       # Write this subdir
       self.WriteSubdir(cov_dir)
 
       # Write files in this subdir
       for cov_file in cov_dir.files.itervalues():
         self.WriteFile(cov_file)
 
     # Write files in root directory
     self.WriteRoot()