upload SKP renderings that did not match expectations

slave/skia_slave_scripts/flavor_utils/default_build_step_utils.py

 # Copyright (c) 2013 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.
 
 """ Utilities for generic build steps. """
 
 import errno
 import os
 import shutil
 import sys
 
 from utils import file_utils
 from utils import shell_utils
 
 
 class DeviceDirs(object):
   def __init__(self, perf_data_dir, gm_actual_dir, gm_expected_dir,
                resource_dir, skimage_in_dir, skimage_expected_dir,
-               skimage_out_dir, skp_dir, skp_perf_dir, skp_out_dir, tmp_dir):
+               skimage_out_dir, skp_dir, skp_perf_dir,
+               playback_actual_images_dir, playback_actual_summaries_dir,
+               playback_expected_summaries_dir, tmp_dir):
     self._perf_data_dir = perf_data_dir
     self._gm_actual_dir = gm_actual_dir
     self._gm_expected_dir = gm_expected_dir
     self._resource_dir = resource_dir
     self._skimage_in_dir = skimage_in_dir
     self._skimage_expected_dir = skimage_expected_dir
     self._skimage_out_dir = skimage_out_dir
     self._skp_dir = skp_dir
     self._skp_perf_dir = skp_perf_dir
-    self._skp_out_dir = skp_out_dir
+    self._playback_actual_images_dir = playback_actual_images_dir
+    self._playback_actual_summaries_dir = playback_actual_summaries_dir
+    self._playback_expected_summaries_dir = playback_expected_summaries_dir
     self._tmp_dir = tmp_dir
 
   def GMActualDir(self):
-    return  self._gm_actual_dir
+    """Holds images and JSON summary written out by the 'gm' tool."""
+    return self._gm_actual_dir
 
   def GMExpectedDir(self):
+    """Holds expectations JSON summary read by the 'gm' tool."""
     return self._gm_expected_dir
 
   def PerfDir(self):
     return self._perf_data_dir
 
+  def PlaybackActualImagesDir(self):
+    """Holds image files written out by the 'render_pictures' tool."""
+    return self._playback_actual_images_dir
+
+  def PlaybackActualSummariesDir(self):
+    """Holds actual-result JSON summaries written by 'render_pictures' tool."""
+    return self._playback_actual_summaries_dir
+
+  def PlaybackExpectedSummariesDir(self):
+    """Holds expected-result JSON summaries read by 'render_pictures' tool."""
+    return self._playback_expected_summaries_dir
+
   def ResourceDir(self):
     return self._resource_dir
 
   def SKImageInDir(self):
     return self._skimage_in_dir
 
   def SKImageExpectedDir(self):
     return self._skimage_expected_dir
 
   def SKImageOutDir(self):
     return self._skimage_out_dir
 
   def SKPDir(self):
+    """Holds SKP files that are consumed by RenderSKPs and BenchPictures."""
     return self._skp_dir
 
   def SKPPerfDir(self):
     return self._skp_perf_dir
 
-  def SKPOutDir(self):
-    return self._skp_out_dir
-
   def TmpDir(self):
     return self._tmp_dir
 
 
 class DefaultBuildStepUtils:
   """ Utilities to be used by subclasses of BuildStep.
 
   The methods in this class define how certain high-level functions should work.
   Each build step flavor should correspond to a subclass of BuildStepUtils which
   may override any of these functions as appropriate for that flavor.
@@ skipping 27 matching lines @@
     """ Read the contents of a file on the associated device. Subclasses should
     override this method with one appropriate for reading the contents of a file
     on the device side. """
     with open(filepath) as f:
       return f.read()
 
   def CopyDirectoryContentsToDevice(self, host_dir, device_dir):
     """ Copy the contents of a host-side directory to a clean directory on the
     device side. Subclasses should override this method with one appropriate for
     copying the contents of a host-side directory to a clean device-side
-    directory."""
+    directory.
+
+    TODO(epoger): Clarify the description a bit: this method does not expect
+    device_dir to be an empty directory before it is called.  Implementations
+    of this method for other device types create an empty directory at
+    device_dir as the first step.
+    """
     # For "normal" builders who don't have an attached device, we expect
     # host_dir and device_dir to be the same.
     if host_dir != device_dir:
       raise ValueError('For builders who do not have attached devices, copying '
                        'from host to device is undefined and only allowed if '
                        'host_dir and device_dir are the same.')
 
   def CopyDirectoryContentsToHost(self, device_dir, host_dir):
     """ Copy the contents of a device-side directory to a clean directory on the
     host side. Subclasses should override this method with one appropriate for
@@ skipping 83 matching lines @@
     make_cmd = 'make'
     if os.name == 'nt':
       make_cmd = 'make.bat'
     shell_utils.run([make_cmd, 'clean'])
 
   def PreRun(self):
     """ Preprocessing step to run before the BuildStep itself. """
     pass
 
   def GetDeviceDirs(self):
-    """ Set the directories which will be used by the BuildStep. """
+    """ Set the directories which will be used by the BuildStep.
+
+    In the case of DefaultBuildStepUtils, host_dirs and device_dirs are the
+    same, which is why CopyDirectoryContentsToDevice() is a no-op.
+    """
     return DeviceDirs(
         perf_data_dir=self._step.perf_data_dir,
         # TODO(epoger): Instead, set gm_actual_dir to self._step._gm_actual_dir
         # and remove os.path.join() with self._builder_name in postrender.py ?
         # (CopyDirectoryContentsToHost fails if the paths are different when
         # host==device, so why not just make them inherently equal?)
         gm_actual_dir=os.path.join(os.pardir, os.pardir, 'gm', 'actual'),
         gm_expected_dir=os.path.join(os.pardir, os.pardir, 'gm', 'expected'),
         resource_dir=self._step.resource_dir,
         skimage_in_dir=self._step.skimage_in_dir,
         skimage_expected_dir=self._step.skimage_expected_dir,
         skimage_out_dir=self._step.skimage_out_dir,
         skp_dir=self._step.skp_dir,
         skp_perf_dir=self._step.perf_data_dir,
-        skp_out_dir=self._step.skp_out_dir,
+        playback_actual_images_dir=self._step.playback_actual_images_dir,
+        playback_actual_summaries_dir=self._step.playback_actual_summaries_dir,
+        playback_expected_summaries_dir=(
+            self._step.playback_expected_summaries_dir),
         tmp_dir=os.path.join(os.pardir, 'tmp'))