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 176 matching lines @@
     """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?
     """
 
     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')
+    self.AddSectionHeader(table, None, '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')
+      self.AddSectionHeader(table, None, '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',
+      self.AddSectionHeader(table, None, '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 = [

[John Grabowski, 2012/07/10 17:37:14]

since only one file each, can you
copy_files = ['croc.css']
?

(for both)

[pshenoy, 2012/07/10 18:02:22]

I thought it is a good idea to maintain a separate list for third party files in
case we add more third party files in future. What do you think?

[John Grabowski, 2012/07/10 18:08:19]

that's fine but still do this

copy_files = ['croc.css']
third_party_files = ['sorttable.js']

No need to = [
  'on three lines'
]

[pshenoy, 2012/07/10 18:22:23]

Done.

         'croc.css',
     ]
+    # Third_party files to copy into output root
+    third_party_files = [
+        '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))
+    # Copy third party files from third_party directory into
+    # the output directory
+    src_dir = os.path.join(src_dir, 'third_party')
+    for third_party_file in third_party_files:
+      print '  Copying %s' % third_party_file
+      shutil.copyfile(os.path.join(src_dir, third_party_file),
+                      os.path.join(self.output_root, third_party_file))
 
   def Write(self):
     """Writes HTML output."""
 
     print 'Writing HTML to %s...' % self.output_root
 
     # Loop through the tree and write subdirs, breadth-first
     # TODO: switch to depth-first and sort values - makes nicer output?
     todo = [self.cov.tree]
     while todo:
       cov_dir = todo.pop(0)
 
       # Append subdirs to todo list
       todo += cov_dir.subdirs.values()
 
       # 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()