Add error handling to validate expectation names.

chrome/test/functional/ispy/common/ispy_utils.py

 # Copyright 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 managing I-Spy test results in Google Cloud Storage."""
 
 import collections
 import itertools
 import json
 import os
 import sys
 
 import image_tools
 
 
+_INVALID_EXPECTATION_CHARS = ['/', '\\', ' ', '"', '\'']
+
+
+def IsValidExpectationName(expectationName):

[craigdh, 2013/12/03 00:30:50]

return any(c in _INVALID_EXPECTATION_CHARS for c in expectation_name)

[craigdh, 2013/12/03 00:30:50]

expectationName -> expectation_name

[baxley, 2013/12/03 00:53:16]

Done.

[baxley, 2013/12/03 00:53:16]

Done.

+  for char in _INVALID_EXPECTATION_CHARS:
+    if expectationName.find(char) != -1:
+      return False
+  return True
+
+
 def GetExpectationPath(expectation, file_name=''):
   """Get the path to a test file in the given test run and expectation.
 
   Args:
     expectation: name of the expectation.
     file_name: name of the file.
 
   Returns:
     the path as a string relative to the bucket.
   """
@@ skipping 63 matching lines @@
   def GenerateExpectation(self, expectation, images):
     """Creates and uploads an expectation to GS from a set of images and name.
 
     This method generates a mask from the uploaded images, then
       uploads the mask and first of the images to GS as a expectation.
 
     Args:
       expectation: name for this expectation, any existing expectation with the
         name will be replaced.
       images: a list of RGB encoded PIL.Images
+
+    Raises:
+      ValueError: if the expectation name is invalid.
     """
+    if not IsValidExpectationName(expectation):
+      raise ValueError("Expectation contains an illegal value: %s." %
+                       str(_INVALID_EXPECTATION_CHARS))
+
     mask = image_tools.InflateMask(image_tools.CreateMask(images), 7)
     self.UploadImage(
         GetExpectationPath(expectation, 'expected.png'), images[0])
     self.UploadImage(GetExpectationPath(expectation, 'mask.png'), mask)
 
   def PerformComparison(self, test_run, expectation, actual):
     """Runs an image comparison, and uploads discrepancies to GS.
 
     Args:
       test_run: the name of the test_run.
       expectation: the name of the expectation to use for comparison.
       actual: an RGB-encoded PIL.Image that is the actual result.
 
     Raises:
       cloud_bucket.NotFoundError: if the given expectation is not found.
+      ValueError: if the expectation name is invalid.
     """
+    if not IsValidExpectationName(expectation):
+      raise ValueError("Expectation name contains an illegal character: %s." %
+                       str(_INVALID_EXPECTATION_CHARS))
+
     expectation_tuple = self.GetExpectation(expectation)
     if not image_tools.SameImage(
         actual, expectation_tuple.expected, mask=expectation_tuple.mask):
       self.UploadImage(
           GetFailurePath(test_run, expectation, 'actual.png'), actual)
       diff, diff_pxls = image_tools.VisualizeImageDifferences(
           expectation_tuple.expected, actual, mask=expectation_tuple.mask)
       self.UploadImage(GetFailurePath(test_run, expectation, 'diff.png'), diff)
       self.cloud_bucket.UploadFile(
           GetFailurePath(test_run, expectation, 'info.txt'),
@@ skipping 65 matching lines @@
       self.cloud_bucket.RemoveFile(path)
 
   def GenerateExpectationPinkOut(self, expectation, images, pint_out, rgb):
     """Uploads an ispy-test to GS with the pink_out workaround.
 
     Args:
       expectation: the name of the expectation to be uploaded.
       images: a json encoded list of base64 encoded png images.
       pink_out: an image.
       RGB: a json list representing the RGB values of a color to mask out.
+
+    Raises:
+      ValueError: if expectation name is invalid.
     """
+    if not IsValidExpectationName(expectation):
+      raise ValueError("Expectation name contains an illegal character: %s." %
+                       str(_INVALID_EXPECTATION_CHARS))
+
     # convert the pink_out into a mask
     black = (0, 0, 0, 255)
     white = (255, 255, 255, 255)
     pink_out.putdata(
         [black if px == (rgb[0], rgb[1], rgb[2], 255) else white
          for px in pink_out.getdata()])
     mask = image_tools.CreateMask(images)
     mask = image_tools.InflateMask(image_tools.CreateMask(images), 7)
     combined_mask = image_tools.AddMasks([mask, pink_out])
     self.UploadImage(GetExpectationPath(expectation, 'expected.png'), images[0])
@@ skipping 42 matching lines @@
 
     Args:
       prefix: the prefix to filter files in GS by.
 
     Returns:
       a list containing urls to all objects that started with
          the prefix.
     """
     return self.cloud_bucket.GetAllPaths(prefix)