Merge pull request #6 from conan-io/hotfix/fuzzy-patch

Support fuzzy patch

Author: lasote

patch_ng.py

@@ -31,7 +31,7 @@
 from __future__ import print_function
 
 __author__ = "Conan.io <info@conan.io>"
-__version__ = "1.17.1"
+__version__ = "1.17.2"
 __license__ = "MIT"
 __url__ = "https://github.com/conan-io/python-patch"
 
@@ -82,11 +82,12 @@ def tostr(b):
 # Logging is controlled by logger named after the
 # module name (e.g. 'patch' for patch_ng.py module)
 
-logger = logging.getLogger(__name__)
+logger = logging.getLogger("patch_ng")
 
 debug = logger.debug
 info = logger.info
 warning = logger.warning
+error = logger.error
 
 class NullHandler(logging.Handler):
   """ Copied from Python 2.7 to avoid getting
@@ -305,16 +306,6 @@ def __init__(self):
     self.desc=''
     self.text=[]
 
-#  def apply(self, estream):
-#    """ write hunk data into enumerable stream
-#        return strings one by one until hunk is
-#        over
-#
-#        enumerable stream are tuples (lineno, line)
-#        where lineno starts with 0
-#    """
-#    pass
-
 
 class Patch(object):
   """ Patch for a single file.
@@ -966,9 +957,12 @@ def strip_path(self, path, base_path, strip=0):
 
 
 
-  def apply(self, strip=0, root=None):
+  def apply(self, strip=0, root=None, fuzz=False):
     """ Apply parsed patch, optionally stripping leading components
         from file paths. `root` parameter specifies working dir.
+        :param strip: Strip patch path
+        :param root: Folder to apply the patch
+        :param fuzz: Accept fuzzy patches
         return True on success
     """
     items = []
@@ -1018,11 +1012,11 @@ def apply(self, strip=0, root=None):
       filenameo, filenamen = self.findfiles(old, new)
 
       if not filenameo or not filenamen:
-        warning("source/target file does not exist:\n  --- %s\n  +++ %s" % (old, new))
+        error("source/target file does not exist:\n  --- %s\n  +++ %s" % (old, new))
         errors += 1
         continue
       if not isfile(filenameo):
-        warning("not a file - %s" % filenameo)
+        error("not a file - %s" % filenameo)
         errors += 1
         continue
 
@@ -1049,28 +1043,31 @@ def apply(self, strip=0, root=None):
           # todo \ No newline at end of file
 
         # check hunks in source file
-        if lineno+1 < hunk.startsrc+len(hunkfind)-1:
+        if lineno+1 < hunk.startsrc+len(hunkfind):
           if line.rstrip(b"\r\n") == hunkfind[hunklineno]:
-            hunklineno+=1
+            hunklineno += 1
           else:
-            info("file %d/%d:\t %s" % (i+1, total, filenamen))
-            info(" hunk no.%d doesn't match source file at line %d" % (hunkno+1, lineno+1))
-            info("  expected: %s" % hunkfind[hunklineno])
-            info("  actual  : %s" % line.rstrip(b"\r\n"))
-            # 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(p.hunks):
-              hunk = p.hunks[hunkno]
-              continue
+            warning("file %d/%d:\t %s" % (i+1, total, filenamen))
+            warning(" hunk no.%d doesn't match source file at line %d" % (hunkno+1, lineno+1))
+            warning("  expected: %s" % hunkfind[hunklineno])
+            warning("  actual  : %s" % line.rstrip(b"\r\n"))
+            if fuzz:
+              hunklineno += 1
             else:
-              break
+              # 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(p.hunks):
+                hunk = p.hunks[hunkno]
+                continue
+              else:
+                break
 
         # check if processed line is the last line
         if len(hunkfind) == 0 or lineno+1 == hunk.startsrc+len(hunkfind)-1:
@@ -1086,7 +1083,7 @@ def apply(self, strip=0, root=None):
               break
       else:
         if hunkno < len(p.hunks):
-          warning("premature end of source file %s at hunk %d" % (filenameo, hunkno+1))
+          error("premature end of source file %s at hunk %d" % (filenameo, hunkno+1))
           errors += 1
 
       f2fp.close()
@@ -1095,8 +1092,11 @@ def apply(self, strip=0, root=None):
         if self._match_file_hunks(filenameo, p.hunks):
           warning("already patched  %s" % filenameo)
         else:
-          warning("source file is different - %s" % filenameo)
-          errors += 1
+          if fuzz:
+            warning("source file is different - %s" % filenameo)
+          else:
+            error("source file is different - %s" % filenameo)
+            errors += 1
       if canpatch:
         backupname = filenamen+b".orig"
         if exists(backupname):
@@ -1247,8 +1247,9 @@ def get_line():
           continue
         else:
           if not hline.startswith(b"+"):
-            get_line()
+            yield get_line()
             srclineno += 1
+            continue
           line2write = hline[1:]
           # detect if line ends are consistent in source file
           if sum([bool(lineends[x]) for x in lineends]) == 1:
@@ -1310,6 +1311,7 @@ def main():
                                            help="strip N path components from filenames")
   opt.add_option("--revert", action="store_true",
                                            help="apply patch in reverse order (unpatch)")
+  opt.add_option("-f", "--fuzz", action="store_true", dest="fuzz", help="Accept fuuzzy patches")
   (options, args) = opt.parse_args()
 
   if not args and sys.argv[-1:] != ['--']:
@@ -1344,11 +1346,15 @@ def main():
     print(patch.diffstat())
     sys.exit(0)
 
+  if not patch:
+    error("Could not parse patch")
+    sys.exit(-1)
+
   #pprint(patch)
   if options.revert:
     patch.revert(options.strip, root=options.directory) or sys.exit(-1)
   else:
-    patch.apply(options.strip, root=options.directory) or sys.exit(-1)
+    patch.apply(options.strip, root=options.directory, fuzz=options.fuzz) or sys.exit(-1)
 
   # todo: document and test line ends handling logic - patch_ng.py detects proper line-endings
   #       for inserted hunks and issues a warning if patched file has incosistent line ends

tests/07google_code_wiki.from

@@ -84,4 +84,4 @@ How to create your own I/O Spyder plugins:
 
 == Other Spyder plugins ==
 
-See the example of the `pylint` third-party plugin in Spyder v2.0.
+See the example of the `pylint` third-party plugin in Spyder v2.0.

tests/10fuzzy/10fuzzy.patch

@@ -0,0 +1,9 @@
+diff --git a/Jamroot b/Jamroot
+index a6981dd..0c08f09 100644
+--- a/Jamroot
++++ b/Jamroot
+@@ -1,3 +1,4 @@
+ X
+ YYYY
++V
+ W

tests/10fuzzy/Jamroot

@@ -0,0 +1,3 @@
+X
+Y
+Z

tests/10fuzzy/[result]/Jamroot

@@ -0,0 +1,4 @@
+X
+Y
+V
+Z

tests/10fuzzyafter/10fuzzyafter.patch

@@ -0,0 +1,9 @@
+diff --git a/Jamroot b/Jamroot
+index a6981dd..0c08f09 100644
+--- a/Jamroot
++++ b/Jamroot
+@@ -1,3 +1,4 @@
+ X
+ Y
++V
+ W

tests/10fuzzyafter/Jamroot

@@ -0,0 +1,3 @@
+X
+Y
+Z

tests/10fuzzyafter/[result]/Jamroot

@@ -0,0 +1,4 @@
+X
+Y
+V
+Z

tests/10fuzzybefore/10fuzzybefore.patch

@@ -0,0 +1,9 @@
+diff --git a/Jamroot b/Jamroot
+index a6981dd..0c08f09 100644
+--- a/Jamroot
++++ b/Jamroot
+@@ -1,3 +1,4 @@
+ T
+ YYYY
++V
+ Z

tests/10fuzzybefore/Jamroot

@@ -0,0 +1,3 @@
+X
+Y
+Z

tests/10fuzzybefore/[result]/Jamroot

@@ -0,0 +1,4 @@
+X
+Y
+V
+Z

tests/run_tests.py

@@ -151,11 +151,12 @@ def _run_test(self, testname):
       patch_tool = join(dirname(TESTS), "patch_ng.py")
       save_cwd = getcwdu()
       os.chdir(tmpdir)
+      extra = "-f" if "10fuzzy" in testname else ""
       if verbose:
-        cmd = '%s %s "%s"' % (sys.executable, patch_tool, patch_file)
+        cmd = '%s %s %s "%s"' % (sys.executable, patch_tool, extra, patch_file)
         print("\n"+cmd)
       else:
-        cmd = '%s %s -q "%s"' % (sys.executable, patch_tool, patch_file)
+        cmd = '%s %s -q %s "%s"' % (sys.executable, patch_tool, extra, patch_file)
       ret = os.system(cmd)
       assert ret == 0, "Error %d running test %s" % (ret, testname)
       os.chdir(save_cwd)
@@ -424,6 +425,27 @@ def test_delete_file(self):
         pto.apply(strip=0, root=treeroot)
         self.assertFalse(os.path.exists(os.path.join(treeroot, 'deleted')))
 
+    def test_fuzzy_patch_both(self):
+        treeroot = join(self.tmpdir, 'rootparent')
+        shutil.copytree(join(TESTS, '10fuzzy'), treeroot)
+        pto = patch_ng.fromfile(join(TESTS, '10fuzzy/10fuzzy.patch'))
+        self.assertTrue(pto.apply(root=treeroot, fuzz=True))
+        self.assertFalse(pto.apply(root=treeroot, fuzz=False))
+
+    def test_fuzzy_patch_before(self):
+        treeroot = join(self.tmpdir, 'rootparent')
+        shutil.copytree(join(TESTS, '10fuzzybefore'), treeroot)
+        pto = patch_ng.fromfile(join(TESTS, '10fuzzybefore/10fuzzybefore.patch'))
+        self.assertTrue(pto.apply(root=treeroot, fuzz=True))
+        self.assertFalse(pto.apply(root=treeroot, fuzz=False))
+
+    def test_fuzzy_patch_after(self):
+        treeroot = join(self.tmpdir, 'rootparent')
+        shutil.copytree(join(TESTS, '10fuzzyafter'), treeroot)
+        pto = patch_ng.fromfile(join(TESTS, '10fuzzyafter/10fuzzyafter.patch'))
+        self.assertTrue(pto.apply(root=treeroot, fuzz=True))
+        self.assertFalse(pto.apply(root=treeroot, fuzz=False))
+
 
 class TestHelpers(unittest.TestCase):
     # unittest setting