patch.py now returns -1 on failure

techtonik · techtonik · commit af95e62ef4be · 2010-12-13T23:51:06.000Z
Patch.apply() returns True on success

* Suggested by: Wladimir J. van der Laan (laanwj)

Update issue 14
Now it is possible to detect if patching of any file is failed.
diff --git a/patch.py b/patch.py
@@ -13,7 +13,7 @@
 """
 
 __author__ = "techtonik.rainforce.org"
-__version__ = "10.11"
+__version__ = "10.12"
 
 import copy
 import logging
@@ -403,19 +403,24 @@ def lineno(self):
 
 
   def apply(self):
-    """ apply parsed patch """
+    """ apply parsed patch
+        return True on success
+    """
 
     total = len(self.source)
+    errors = 0
     for fileno, filename in enumerate(self.source):
 
       f2patch = filename
       if not exists(f2patch):
         f2patch = self.target[fileno]
         if not exists(f2patch):
           warning("source/target file does not exist\n--- %s\n+++ %s" % (filename, f2patch))
+          errors += 1
           continue
       if not isfile(f2patch):
         warning("not a file - %s" % f2patch)
+        errors += 1
         continue
       filename = f2patch
 
@@ -448,7 +453,14 @@ def apply(self):
             info(" hunk no.%d doesn't match source file at line %d" % (hunkno+1, lineno))
             info("  expected: %s" % hunkfind[hunklineno])
             info("  actual  : %s" % line.rstrip("\r\n"))
-            # file may be already patched, but we will check other hunks anyway
+            # not counting this as error, because file may already be patched.
+            # check if file is already patched is done after the number of
+            # invalid hunks if found
+            # TODO: check hunks against source/target file in one pass
+            #   API - check(stream, srchunks, tgthunks)
+            #           return tuple (srcerrs, tgterrs)
+
+            # continue to check other hunks for completeness
             hunkno += 1
             if hunkno < len(self.hunks[fileno]):
               hunk = self.hunks[fileno][hunkno]
@@ -471,6 +483,7 @@ def apply(self):
       else:
         if hunkno < len(self.hunks[fileno]):
           warning("premature end of source file %s at hunk %d" % (filename, hunkno+1))
+          errors += 1
 
       f2fp.close()
 
@@ -479,6 +492,7 @@ def apply(self):
           warning("already patched  %s" % filename)
         else:
           warning("source file is different - %s" % filename)
+          errors += 1
       if canpatch:
         backupname = filename+".orig"
         if exists(backupname):
@@ -490,13 +504,15 @@ def apply(self):
             info("successfully patched %d/%d:\t %s" % (fileno+1, total, filename))
             unlink(backupname)
           else:
+            errors += 1
             warning("error patching file %s" % filename)
             shutil.copy(filename, filename+".invalid")
             warning("invalid version is saved to %s" % filename+".invalid")
             # todo: proper rejects
             shutil.move(backupname, filename)
 
     # todo: check for premature eof
+    return (errors == 0)
 
 
   def can_patch(self, filename):
@@ -682,7 +698,7 @@ def _get_file_idx(self, filename, source=None):
 
   patch = fromfile(patchfile)
   #pprint(patch)
-  patch.apply()
+  patch.apply() or sys.exit(-1)
 
   # todo: document and test line ends handling logic - patch.py detects proper line-endings
   #       for inserted hunks and issues a warning if patched file has incosistent line ends
diff --git a/tests/data/failing/reporting.patch b/tests/data/failing/reporting.patch
@@ -0,0 +1,14 @@
+Index: upload.py
+===================================================================
+--- upload.py	(revision 623)
++++ upload.py	(working copy)
+@@ -393,6 +393,9 @@
+ ##           elif e.code >= 500 and e.code < 600:
+ ##             # Server Error - try again.
+ ##             continue
++          elif e.code == 404:
++            ErrorExit("Error: RPC call to %s failed with status 404\n"
++              "Check upload server is valid - %s" % (request_path, self.host))
+           else:
+             raise
+     finally:
diff --git a/tests/data/failing/upload.py b/tests/data/failing/upload.py
diff --git a/tests/run_tests.py b/tests/run_tests.py
@@ -176,30 +176,30 @@ def tearDown(self):
         os.chdir(self.save_cwd)
 
     def test_patched_multiline(self):
-        pto = patch.fromfile(join(tests_dir, "01uni_multi.patch"))
+        pto = patch.fromfile("01uni_multi.patch")
         os.chdir(join(tests_dir, "01uni_multi.to"))
         self.assert_(pto.can_patch("updatedlg.cpp"))
 
     def test_can_patch_single_source(self):
-        pto2 = patch.fromfile(join(tests_dir, "02uni_newline.patch"))
+        pto2 = patch.fromfile("02uni_newline.patch")
         self.assert_(pto2.can_patch("02uni_newline.from"))
 
     def test_can_patch_fails_on_target_file(self):
-        pto3 = patch.fromfile(join(tests_dir, "03trail_fname.patch"))
+        pto3 = patch.fromfile("03trail_fname.patch")
         self.assertEqual(None, pto3.can_patch("03trail_fname.to"))
         self.assertEqual(None, pto3.can_patch("not_in_source.also"))
    
     def test_multiline_false_on_other_file(self):
-        pto = patch.fromfile(join(tests_dir, "01uni_multi.patch"))
+        pto = patch.fromfile("01uni_multi.patch")
         os.chdir(join(tests_dir, "01uni_multi.from"))
         self.assertFalse(pto.can_patch("updatedlg.cpp"))
 
     def test_single_false_on_other_file(self):
-        pto3 = patch.fromfile(join(tests_dir, "03trail_fname.patch"))
+        pto3 = patch.fromfile("03trail_fname.patch")
         self.assertFalse(pto3.can_patch("03trail_fname.from"))
 
     def test_can_patch_checks_source_filename_even_if_target_can_be_patched(self):
-        pto2 = patch.fromfile(join(tests_dir, "04can_patch.patch"))
+        pto2 = patch.fromfile("04can_patch.patch")
         self.assertFalse(pto2.can_patch("04can_patch.to"))
 
 # ----------------------------------------------------------------------------
@@ -222,8 +222,34 @@ def test_header_for_second_file_in_svn_diff(self):
         pto = patch.fromfile(join(tests_dir, "01uni_multi.patch"))
         self.assertEqual(pto.header[1][:25], 'Index: updatedlg.h\r\n=====')
 
-# ----------------------------------------------------------------------------
+class TestPatchApply(unittest.TestCase):
+    def setUp(self):
+        self.save_cwd = os.getcwdu()
+        self.tmpdir = mkdtemp(prefix=self.__class__.__name__)
+        os.chdir(self.tmpdir)
+
+    def tearDown(self):
+        os.chdir(self.save_cwd)
+        shutil.rmtree(self.tmpdir)
+
+    def tmpcopy(self, filenames):
+        """copy file(s) from test_dir to self.tmpdir"""
+        for f in filenames:
+          shutil.copy(join(tests_dir, f), self.tmpdir)
 
+    def test_apply_returns_false_of_failure(self):
+        self.tmpcopy(['data/failing/reporting.patch',
+                      'data/failing/upload.py'])
+        pto = patch.fromfile('reporting.patch')
+        self.assertFalse(pto.apply())
+
+    def test_apply_returns_true_on_success(self):
+        self.tmpcopy(['03trail_fname.patch',
+                      '03trail_fname.from'])
+        pto = patch.fromfile('03trail_fname.patch')
+        self.assert_(pto.apply())
+
+# ----------------------------------------------------------------------------
 
 if __name__ == '__main__':
     unittest.main()
