extdiff: preserve execute-bit across copies (issue1562)

Bug report and test by Mads Kiilerich <[e-mail]>

hgext/extdiff.py

@@ -1,230 +1,233
 # extdiff.py - external diff program support for mercurial
 #
 # Copyright 2006 Vadim Gelfer <[e-mail]>
 #
 # This software may be used and distributed according to the terms
 # of the GNU General Public License, incorporated herein by reference.
 
 '''
 The `extdiff' Mercurial extension allows you to use external programs
 to compare revisions, or revision with working dir.  The external diff
 programs are called with a configurable set of options and two
 non-option arguments: paths to directories containing snapshots of
 files to compare.
 
 To enable this extension:
 
   [extensions]
   hgext.extdiff =
 
 The `extdiff' extension also allows to configure new diff commands, so
 you do not need to type "hg extdiff -p kdiff3" always.
 
   [extdiff]
   # add new command that runs GNU diff(1) in 'context diff' mode
   cdiff = gdiff -Nprc5
   ## or the old way:
   #cmd.cdiff = gdiff
   #opts.cdiff = -Nprc5
 
   # add new command called vdiff, runs kdiff3
   vdiff = kdiff3
 
   # add new command called meld, runs meld (no need to name twice)
   meld =
 
   # add new command called vimdiff, runs gvimdiff with DirDiff plugin
   #(see http://www.vim.org/scripts/script.php?script_id=102)
   # Non english user, be sure to put "let g:DirDiffDynamicDiffText = 1" in
   # your .vimrc
   vimdiff = gvim -f '+next' '+execute "DirDiff" argv(0) argv(1)'
 
 You can use -I/-X and list of file or directory names like normal
 "hg diff" command.  The `extdiff' extension makes snapshots of only
 needed files, so running the external diff program will actually be
 pretty fast (at least faster than having to compare the entire tree).
 '''
 
 from mercurial.i18n import _
 from mercurial.node import short
 from mercurial import cmdutil, util, commands
 import os, shlex, shutil, tempfile
 
 def snapshot(ui, repo, files, node, tmproot):
     '''snapshot files as of some revision
     if not using snapshot, -I/-X does not work and recursive diff
     in tools like kdiff3 and meld displays too many files.'''
     dirname = os.path.basename(repo.root)
     if dirname == "":
         dirname = "root"
     if node is not None:
         dirname = '%s.%s' % (dirname, short(node))
     base = os.path.join(tmproot, dirname)
     os.mkdir(base)
     if node is not None:
         ui.note(_('making snapshot of %d files from rev %s\n') %
                 (len(files), short(node)))
     else:
         ui.note(_('making snapshot of %d files from working dir\n') %
             (len(files)))
-        
+    wopener = util.opener(base)
     fns_and_mtime = []
     ctx = repo[node]
     for fn in files:
         wfn = util.pconvert(fn)
         if not wfn in ctx:
             # skipping new file after a merge ?
             continue
         ui.note('  %s\n' % wfn)
         dest = os.path.join(base, wfn)
-        destdir = os.path.dirname(dest)
-        if not os.path.isdir(destdir):
-            os.makedirs(destdir)
-        data = repo.wwritedata(wfn, ctx[wfn].data())
-        open(dest, 'wb').write(data)
+        fctx = ctx[wfn]
+        data = repo.wwritedata(wfn, fctx.data())
+        if 'l' in fctx.flags():
+            wopener.symlink(data, wfn)
+        else:
+            wopener(wfn, 'w').write(data)
+            if 'x' in fctx.flags():
+                util.set_flags(dest, False, True)
         if node is None:
             fns_and_mtime.append((dest, repo.wjoin(fn), os.path.getmtime(dest)))
     return dirname, fns_and_mtime
 
 def dodiff(ui, repo, diffcmd, diffopts, pats, opts):
     '''Do the actuall diff:
 
     - copy to a temp structure if diffing 2 internal revisions
     - copy to a temp structure if diffing working revision with
       another one and more than 1 file is changed
     - just invoke the diff for a single file in the working dir
     '''
 
     revs = opts.get('rev')
     change = opts.get('change')
 
     if revs and change:
         msg = _('cannot specify --rev and --change at the same time')
         raise util.Abort(msg)
     elif change:
         node2 = repo.lookup(change)
         node1 = repo[node2].parents()[0].node()
     else:
         node1, node2 = cmdutil.revpair(repo, revs)
 
     matcher = cmdutil.match(repo, pats, opts)
     modified, added, removed = repo.status(node1, node2, matcher)[:3]
     if not (modified or added or removed):
         return 0
 
     tmproot = tempfile.mkdtemp(prefix='extdiff.')
     dir2root = ''
     try:
         # Always make a copy of node1
         dir1 = snapshot(ui, repo, modified + removed, node1, tmproot)[0]
         changes = len(modified) + len(removed) + len(added)
 
         # If node2 in not the wc or there is >1 change, copy it
         if node2 or changes > 1:
             dir2, fns_and_mtime = snapshot(ui, repo, modified + added, node2, tmproot)
         else:
             # This lets the diff tool open the changed file directly
             dir2 = ''
             dir2root = repo.root
             fns_and_mtime = []
 
         # If only one change, diff the files instead of the directories
         if changes == 1 :
             if len(modified):
                 dir1 = os.path.join(dir1, util.localpath(modified[0]))
                 dir2 = os.path.join(dir2root, dir2, util.localpath(modified[0]))
             elif len(removed) :
                 dir1 = os.path.join(dir1, util.localpath(removed[0]))
                 dir2 = os.devnull
             else:
                 dir1 = os.devnull
                 dir2 = os.path.join(dir2root, dir2, util.localpath(added[0]))
 
         cmdline = ('%s %s %s %s' %
                    (util.shellquote(diffcmd), ' '.join(diffopts),
                     util.shellquote(dir1), util.shellquote(dir2)))
         ui.debug(_('running %r in %s\n') % (cmdline, tmproot))
         util.system(cmdline, cwd=tmproot)
 
         for copy_fn, working_fn, mtime in fns_and_mtime:
             if os.path.getmtime(copy_fn) != mtime:
                 ui.debug(_('file changed while diffing. '
                          'Overwriting: %s (src: %s)\n') % (working_fn, copy_fn))
                 util.copyfile(copy_fn, working_fn)
 
         return 1
     finally:
         ui.note(_('cleaning up temp directory\n'))
         shutil.rmtree(tmproot)
 
 def extdiff(ui, repo, *pats, **opts):
     '''use external program to diff repository (or selected files)
 
     Show differences between revisions for the specified files, using
     an external program.  The default program used is diff, with
     default options "-Npru".
 
     To select a different program, use the -p option.  The program
     will be passed the names of two directories to compare.  To pass
     additional options to the program, use the -o option.  These will
     be passed before the names of the directories to compare.
 
     When two revision arguments are given, then changes are
     shown between those revisions. If only one revision is
     specified then that revision is compared to the working
     directory, and, when no revisions are specified, the
     working directory files are compared to its parent.'''
     program = opts['program'] or 'diff'
     if opts['program']:
         option = opts['option']
     else:
         option = opts['option'] or ['-Npru']
     return dodiff(ui, repo, program, option, pats, opts)
 
 cmdtable = {
     "extdiff":
     (extdiff,
      [('p', 'program', '', _('comparison program to run')),
       ('o', 'option', [], _('pass option to comparison program')),
       ('r', 'rev', [], _('revision')),
       ('c', 'change', '', _('change made by revision')),
      ] + commands.walkopts,
      _('hg extdiff [OPT]... [FILE]...')),
     }
 
 def uisetup(ui):
     for cmd, path in ui.configitems('extdiff'):
         if cmd.startswith('cmd.'):
             cmd = cmd[4:]
             if not path: path = cmd
             diffopts = ui.config('extdiff', 'opts.' + cmd, '')
             diffopts = diffopts and [diffopts] or []
         elif cmd.startswith('opts.'):
             continue
         else:
             # command = path opts
             if path:
                 diffopts = shlex.split(path)
                 path = diffopts.pop(0)
             else:
                 path, diffopts = cmd, []
         def save(cmd, path, diffopts):
             '''use closure to save diff command to use'''
             def mydiff(ui, repo, *pats, **opts):
                 return dodiff(ui, repo, path, diffopts, pats, opts)
             mydiff.__doc__ = '''use %(path)s to diff repository (or selected files)
 
             Show differences between revisions for the specified
             files, using the %(path)s program.
 
             When two revision arguments are given, then changes are
             shown between those revisions. If only one revision is
             specified then that revision is compared to the working
             directory, and, when no revisions are specified, the
             working directory files are compared to its parent.''' % {
                 'path': util.uirepr(path),
                 }
             return mydiff
         cmdtable[cmd] = (save(cmd, path, diffopts),
                          cmdtable['extdiff'][1][1:],
                          _('hg %s [OPTION]... [FILE]...') % cmd)

tests/test-extdiff

@@ -1,45 +1,66
 #!/bin/sh
 
 echo "[extensions]" >> $HGRCPATH
 echo "extdiff=" >> $HGRCPATH
 
 hg init a
 cd a
 echo a > a
 echo b > b
 hg add
 # should diff cloned directories
 hg extdiff -o -r $opt
 
 echo "[extdiff]" >> $HGRCPATH
 echo "cmd.falabala=echo" >> $HGRCPATH
 echo "opts.falabala=diffing" >> $HGRCPATH
 
 hg falabala
 
 hg help falabala
 
 hg ci -d '0 0' -mtest1
 
 echo b >> a
 hg ci -d '1 0' -mtest2
 
 # should diff cloned files directly
 hg falabala -r 0:1
 
 # test diff during merge
-hg update 0
+hg update -C 0
 echo c >> c
 hg add c
 hg ci -m "new branch" -d '1 0'
 hg merge 1
 # should diff cloned file against wc file
 hg falabala > out
 # cleanup the output since the wc is a tmp directory
 sed  's:\(.* \).*\(\/test-extdiff\):\1[tmp]\2:' out
 # test --change option
 hg ci -d '2 0' -mtest3
 hg falabala -c 1
 # check diff are made from the first parent
 hg falabala -c 3 || echo "diff-like tools yield a non-zero exit code"
 #hg log
+
+echo
+echo '% test extdiff of multiple files in tmp dir:'
+hg update -C 0 > /dev/null
+echo changed > a
+echo changed > b
+chmod +x b
+echo '% diff in working directory, before'
+hg diff --git
+echo '% edit with extdiff -p'
+# prepare custom diff/edit tool
+cat > differ.sh << EOT
+#!/bin/sh
+sleep 1 # avoid unchanged-timestamp problems
+echo edited >> a/a
+echo edited >> a/b
+EOT
+chmod +x differ.sh
+hg extdiff -p `pwd`/differ.sh # will change to /tmp/extdiff.TMP and populate directories a.TMP and a and start tool
+echo '% diff in working directory, after'
+hg diff --git

tests/test-extdiff.out

@@ -1,36 +1,71
 adding a
 adding b
 Only in a: a
 Only in a: b
 diffing a.000000000000 a
 hg falabala [OPTION]... [FILE]...
 
 use 'echo' to diff repository (or selected files)
 
             Show differences between revisions for the specified
             files, using the 'echo' program.
 
             When two revision arguments are given, then changes are
             shown between those revisions. If only one revision is
             specified then that revision is compared to the working
             directory, and, when no revisions are specified, the
             working directory files are compared to its parent.
 
 options:
 
  -o --option   pass option to comparison program
  -r --rev      revision
  -c --change   change made by revision
  -I --include  include names matching the given patterns
  -X --exclude  exclude names matching the given patterns
 
 use "hg -v help falabala" to show global options
 diffing a.8a5febb7f867/a a.34eed99112ab/a
 1 files updated, 0 files merged, 0 files removed, 0 files unresolved
 created new head
 1 files updated, 0 files merged, 0 files removed, 0 files unresolved
 (branch merge, don't forget to commit)
 diffing a.2a13a4d2da36/a [tmp]/test-extdiff/a/a
 diffing a.8a5febb7f867/a a.34eed99112ab/a
 diffing a.2a13a4d2da36/a a.46c0e4daeb72/a
 diff-like tools yield a non-zero exit code
+
+% test extdiff of multiple files in tmp dir:
+% diff in working directory, before
+diff --git a/a b/a
+--- a/a
++++ b/a
+@@ -1,1 +1,1 @@
+-a
++changed
+diff --git a/b b/b
+old mode 100644
+new mode 100755
+--- a/b
++++ b/b
+@@ -1,1 +1,1 @@
+-b
++changed
+% edit with extdiff -p
+% diff in working directory, after
+diff --git a/a b/a
+--- a/a
++++ b/a
+@@ -1,1 +1,2 @@
+-a
++changed
++edited
+diff --git a/b b/b
+old mode 100644
+new mode 100755
+--- a/b
++++ b/b
+@@ -1,1 +1,2 @@
+-b
++changed
++edited