Improve error message in patch application failure.

checkout.py

 # coding=utf8
 # 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.
 """Manages a project checkout.
 
 Includes support for svn, git-svn and git.
 """
 
 import ConfigParser
@@ skipping 31 matching lines @@
         settings[k.strip()] = v.strip()
     finally:
       settings_file.close()
   except IOError:
     return None
   return settings.get(key, None)
 
 
 class PatchApplicationFailed(Exception):
   """Patch failed to be applied."""
-  def __init__(self, filename, status):
-    super(PatchApplicationFailed, self).__init__(filename, status)
-    self.filename = filename
+  def __init__(self, p, status):
+    super(PatchApplicationFailed, self).__init__(p, status)
+    self.patch = p
     self.status = status
 
+  @property
+  def filename(self):
+    if self.patch:
+      return self.patch.filename
+
+  def __str__(self):
+    out = []
+    if self.filename:
+      out.append('Failed to apply patch for %s:' % self.filename)
+    if self.status:
+      out.append(self.status)
+    return '\n'.join(out)
+
 
 class CheckoutBase(object):
   # Set to None to have verbose output.
   VOID = subprocess2.VOID
 
   def __init__(self, root_dir, project_name, post_processors):
     """
     Args:
       post_processor: list of lambda(checkout, patches) to call on each of the
                       modified files.
@@ skipping 66 matching lines @@
             os.makedirs(full_dir)
 
           filepath = os.path.join(self.project_path, p.filename)
           if p.is_binary:
             with open(filepath, 'wb') as f:
               f.write(p.get())
           else:
             if p.source_filename:
               if not p.is_new:
                 raise PatchApplicationFailed(
-                    p.filename,
+                    p,
                     'File has a source filename specified but is not new')
               # Copy the file first.
               if os.path.isfile(filepath):
                 raise PatchApplicationFailed(
-                    p.filename, 'File exist but was about to be overwriten')
+                    p, 'File exist but was about to be overwriten')
               shutil.copy2(
                   os.path.join(self.project_path, p.source_filename), filepath)
             if p.diff_hunks:
               stdout = subprocess2.check_output(
                   ['patch', '-u', '--binary', '-p%s' % p.patchlevel],
                   stdin=p.get(False),
                   stderr=subprocess2.STDOUT,
                   cwd=self.project_path)
             elif p.is_new and not os.path.exists(filepath):
               # There is only a header. Just create the file.
               open(filepath, 'w').close()
         for post in post_processors:
           post(self, p)
       except OSError, e:
-        raise PatchApplicationFailed(p.filename, '%s%s' % (stdout, e))
+        raise PatchApplicationFailed(p, '%s%s' % (stdout, e))
       except subprocess.CalledProcessError, e:
         raise PatchApplicationFailed(
-            p.filename, '%s%s' % (stdout, getattr(e, 'stdout', None)))
+            p, '%s%s' % (stdout, getattr(e, 'stdout', None)))
 
   def commit(self, commit_message, user):
     """Stubbed out."""
     raise NotImplementedError('RawCheckout can\'t commit')
 
 
 class SvnConfig(object):
   """Parses a svn configuration file."""
   def __init__(self, svn_config_dir=None):
     super(SvnConfig, self).__init__()
@@ skipping 123 matching lines @@
                 ['add', dir_to_create, '--force'], credentials=False)
 
           filepath = os.path.join(self.project_path, p.filename)
           if p.is_binary:
             with open(filepath, 'wb') as f:
               f.write(p.get())
           else:
             if p.source_filename:
               if not p.is_new:
                 raise PatchApplicationFailed(
-                    p.filename,
+                    p,
                     'File has a source filename specified but is not new')
               # Copy the file first.
               if os.path.isfile(filepath):
                 raise PatchApplicationFailed(
-                    p.filename, 'File exist but was about to be overwriten')
+                    p, 'File exist but was about to be overwriten')
               self._check_output_svn(
                   [
                     'copy',
                     os.path.join(self.project_path, p.source_filename),
                     filepath
                   ])
             if p.diff_hunks:
               cmd = ['patch', '-p%s' % p.patchlevel, '--forward', '--force']
               stdout += subprocess2.check_output(
                   cmd, stdin=p.get(False), cwd=self.project_path)
@@ skipping 14 matching lines @@
               for value in values.split(';'):
                 if '=' not in value:
                   params = [value, '*']
                 else:
                   params = value.split('=', 1)
                 stdout += self._check_output_svn(
                     ['propset'] + params + [p.filename], credentials=False)
         for post in post_processors:
           post(self, p)
       except OSError, e:
-        raise PatchApplicationFailed(p.filename, '%s%s' % (stdout, e))
+        raise PatchApplicationFailed(p, '%s%s' % (stdout, e))
       except subprocess.CalledProcessError, e:
         raise PatchApplicationFailed(
-            p.filename,
+            p,
             'While running %s;\n%s%s' % (
               ' '.join(e.cmd), stdout, getattr(e, 'stdout', '')))
 
   def commit(self, commit_message, user):
     logging.info('Committing patch for %s' % user)
     assert self.commit_user
     assert isinstance(commit_message, unicode)
     handle, commit_filename = tempfile.mkstemp(text=True)
     try:
       # Shouldn't assume default encoding is UTF-8. But really, if you are using
@@ skipping 132 matching lines @@
             # handled.
             if not prop[0] in (
                 'svn:eol-style', 'svn:executable', 'svn:mime-type'):
               raise patch.UnsupportedPatchFormat(
                   p.filename,
                   'Cannot apply svn property %s to file %s.' % (
                         prop[0], p.filename))
         for post in post_processors:
           post(self, p)
       except OSError, e:
-        raise PatchApplicationFailed(p.filename, '%s%s' % (stdout, e))
+        raise PatchApplicationFailed(p, '%s%s' % (stdout, e))
       except subprocess.CalledProcessError, e:
         raise PatchApplicationFailed(
-            p.filename, '%s%s' % (stdout, getattr(e, 'stdout', None)))
+            p, '%s%s' % (stdout, getattr(e, 'stdout', None)))
     # Once all the patches are processed and added to the index, commit the
     # index.
     self._check_call_git(['commit', '-m', 'Committed patch'])
     # TODO(maruel): Weirdly enough they don't match, need to investigate.
     #found_files = self._check_output_git(
     #    ['diff', 'master', '--name-only']).splitlines(False)
     #assert sorted(patches.filenames) == sorted(found_files), (
     #    sorted(out), sorted(found_files))
 
   def commit(self, commit_message, user):
@@ skipping 233 matching lines @@
         user, message))
     return 'FAKE'
 
   @property
   def project_name(self):
     return self.checkout.project_name
 
   @property
   def project_path(self):
     return self.checkout.project_path