subrepo: handle svn externals and meta changes (issue1982)

- Detect changes to meta on regular and external entries
- Do not try to commit external entries

mercurial/subrepo.py

@@ -1,342 +1,360 b''
 # subrepo.py - sub-repository handling for Mercurial
 #
 # Copyright 2006, 2007 Matt Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 import errno, os, re, xml.dom.minidom
 from i18n import _
 import config, util, node, error
 hg = None
 
 nullstate = ('', '', 'empty')
 
 def state(ctx):
     p = config.config()
     def read(f, sections=None, remap=None):
         if f in ctx:
             p.parse(f, ctx[f].data(), sections, remap, read)
         else:
             raise util.Abort(_("subrepo spec file %s not found") % f)
 
     if '.hgsub' in ctx:
         read('.hgsub')
 
     rev = {}
     if '.hgsubstate' in ctx:
         try:
             for l in ctx['.hgsubstate'].data().splitlines():
                 revision, path = l.split(" ", 1)
                 rev[path] = revision
         except IOError, err:
             if err.errno != errno.ENOENT:
                 raise
 
     state = {}
     for path, src in p[''].items():
         kind = 'hg'
         if src.startswith('['):
             if ']' not in src:
                 raise util.Abort(_('missing ] in subrepo source'))
             kind, src = src.split(']', 1)
             kind = kind[1:]
         state[path] = (src, rev.get(path, ''), kind)
 
     return state
 
 def writestate(repo, state):
     repo.wwrite('.hgsubstate',
                 ''.join(['%s %s\n' % (state[s][1], s)
                          for s in sorted(state)]), '')
 
 def submerge(repo, wctx, mctx, actx):
     # working context, merging context, ancestor context
     if mctx == actx: # backwards?
         actx = wctx.p1()
     s1 = wctx.substate
     s2 = mctx.substate
     sa = actx.substate
     sm = {}
 
     repo.ui.debug("subrepo merge %s %s %s\n" % (wctx, mctx, actx))
 
     def debug(s, msg, r=""):
         if r:
             r = "%s:%s:%s" % r
         repo.ui.debug("  subrepo %s: %s %s\n" % (s, msg, r))
 
     for s, l in s1.items():
         if wctx != actx and wctx.sub(s).dirty():
             l = (l[0], l[1] + "+")
         a = sa.get(s, nullstate)
         if s in s2:
             r = s2[s]
             if l == r or r == a: # no change or local is newer
                 sm[s] = l
                 continue
             elif l == a: # other side changed
                 debug(s, "other changed, get", r)
                 wctx.sub(s).get(r)
                 sm[s] = r
             elif l[0] != r[0]: # sources differ
                 if repo.ui.promptchoice(
                     _(' subrepository sources for %s differ\n'
                       'use (l)ocal source (%s) or (r)emote source (%s)?')
                       % (s, l[0], r[0]),
                       (_('&Local'), _('&Remote')), 0):
                     debug(s, "prompt changed, get", r)
                     wctx.sub(s).get(r)
                     sm[s] = r
             elif l[1] == a[1]: # local side is unchanged
                 debug(s, "other side changed, get", r)
                 wctx.sub(s).get(r)
                 sm[s] = r
             else:
                 debug(s, "both sides changed, merge with", r)
                 wctx.sub(s).merge(r)
                 sm[s] = l
         elif l == a: # remote removed, local unchanged
             debug(s, "remote removed, remove")
             wctx.sub(s).remove()
         else:
             if repo.ui.promptchoice(
                 _(' local changed subrepository %s which remote removed\n'
                   'use (c)hanged version or (d)elete?') % s,
                 (_('&Changed'), _('&Delete')), 0):
                 debug(s, "prompt remove")
                 wctx.sub(s).remove()
 
     for s, r in s2.items():
         if s in s1:
             continue
         elif s not in sa:
             debug(s, "remote added, get", r)
             mctx.sub(s).get(r)
             sm[s] = r
         elif r != sa[s]:
             if repo.ui.promptchoice(
                 _(' remote changed subrepository %s which local removed\n'
                   'use (c)hanged version or (d)elete?') % s,
                 (_('&Changed'), _('&Delete')), 0) == 0:
                 debug(s, "prompt recreate", r)
                 wctx.sub(s).get(r)
                 sm[s] = r
 
     # record merged .hgsubstate
     writestate(repo, sm)
 
 def _abssource(repo, push=False):
     if hasattr(repo, '_subparent'):
         source = repo._subsource
         if source.startswith('/') or '://' in source:
             return source
         parent = _abssource(repo._subparent)
         if '://' in parent:
             if parent[-1] == '/':
                 parent = parent[:-1]
             return parent + '/' + source
         return os.path.join(parent, repo._subsource)
     if push and repo.ui.config('paths', 'default-push'):
         return repo.ui.config('paths', 'default-push', repo.root)
     return repo.ui.config('paths', 'default', repo.root)
 
 def subrepo(ctx, path):
     # subrepo inherently violates our import layering rules
     # because it wants to make repo objects from deep inside the stack
     # so we manually delay the circular imports to not break
     # scripts that don't use our demand-loading
     global hg
     import hg as h
     hg = h
 
     util.path_auditor(ctx._repo.root)(path)
     state = ctx.substate.get(path, nullstate)
     if state[2] not in types:
         raise util.Abort(_('unknown subrepo type %s') % t)
     return types[state[2]](ctx, path, state[:2])
 
 # subrepo classes need to implement the following methods:
 # __init__(self, ctx, path, state)
 # dirty(self): returns true if the dirstate of the subrepo
 #   does not match current stored state
 # commit(self, text, user, date): commit the current changes
 #   to the subrepo with the given log message. Use given
 #   user and date if possible. Return the new state of the subrepo.
 # remove(self): remove the subrepo (should verify the dirstate
 #   is not dirty first)
 # get(self, state): run whatever commands are needed to put the
 #   subrepo into this state
 # merge(self, state): merge currently-saved state with the new state.
 # push(self, force): perform whatever action is analagous to 'hg push'
 #   This may be a no-op on some systems.
 
 class hgsubrepo(object):
     def __init__(self, ctx, path, state):
         self._path = path
         self._state = state
         r = ctx._repo
         root = r.wjoin(path)
         if os.path.exists(os.path.join(root, '.hg')):
             self._repo = hg.repository(r.ui, root)
         else:
             util.makedirs(root)
             self._repo = hg.repository(r.ui, root, create=True)
             f = file(os.path.join(root, '.hg', 'hgrc'), 'w')
             f.write('[paths]\ndefault = %s\n' % state[0])
             f.close()
         self._repo._subparent = r
         self._repo._subsource = state[0]
 
     def dirty(self):
         r = self._state[1]
         if r == '':
             return True
         w = self._repo[None]
         if w.p1() != self._repo[r]: # version checked out changed
             return True
         return w.dirty() # working directory changed
 
     def commit(self, text, user, date):
         self._repo.ui.debug("committing subrepo %s\n" % self._path)
         n = self._repo.commit(text, user, date)
         if not n:
             return self._repo['.'].hex() # different version checked out
         return node.hex(n)
 
     def remove(self):
         # we can't fully delete the repository as it may contain
         # local-only history
         self._repo.ui.note(_('removing subrepo %s\n') % self._path)
         hg.clean(self._repo, node.nullid, False)
 
     def _get(self, state):
         source, revision, kind = state
         try:
             self._repo.lookup(revision)
         except error.RepoError:
             self._repo._subsource = source
             self._repo.ui.status(_('pulling subrepo %s\n') % self._path)
             srcurl = _abssource(self._repo)
             other = hg.repository(self._repo.ui, srcurl)
             self._repo.pull(other)
 
     def get(self, state):
         self._get(state)
         source, revision, kind = state
         self._repo.ui.debug("getting subrepo %s\n" % self._path)
         hg.clean(self._repo, revision, False)
 
     def merge(self, state):
         self._get(state)
         cur = self._repo['.']
         dst = self._repo[state[1]]
         anc = dst.ancestor(cur)
         if anc == cur:
             self._repo.ui.debug("updating subrepo %s\n" % self._path)
             hg.update(self._repo, state[1])
         elif anc == dst:
             self._repo.ui.debug("skipping subrepo %s\n" % self._path)
         else:
             self._repo.ui.debug("merging subrepo %s\n" % self._path)
             hg.merge(self._repo, state[1], remind=False)
 
     def push(self, force):
         # push subrepos depth-first for coherent ordering
         c = self._repo['']
         subs = c.substate # only repos that are committed
         for s in sorted(subs):
             c.sub(s).push(force)
 
         self._repo.ui.status(_('pushing subrepo %s\n') % self._path)
         dsturl = _abssource(self._repo, True)
         other = hg.repository(self._repo.ui, dsturl)
         self._repo.push(other, force)
 
 class svnsubrepo(object):
     def __init__(self, ctx, path, state):
         self._path = path
         self._state = state
         self._ctx = ctx
         self._ui = ctx._repo.ui
 
     def _svncommand(self, commands):
         cmd = ['svn'] + commands + [self._path]
         cmd = [util.shellquote(arg) for arg in cmd]
         cmd = util.quotecommand(' '.join(cmd))
         env = dict(os.environ)
         # Avoid localized output, preserve current locale for everything else.
         env['LC_MESSAGES'] = 'C'
         write, read, err = util.popen3(cmd, env=env, newlines=True)
         retdata = read.read()
         err = err.read().strip()
         if err:
             raise util.Abort(err)
         return retdata
 
     def _wcrev(self):
         output = self._svncommand(['info', '--xml'])
         doc = xml.dom.minidom.parseString(output)
         entries = doc.getElementsByTagName('entry')
         if not entries:
             return 0
         return int(entries[0].getAttribute('revision') or 0)
 
-    def _wcclean(self):
+    def _wcchanged(self):
+        """Return (changes, extchanges) where changes is True
+        if the working directory was changed, and extchanges is
+        True if any of these changes concern an external entry.
+        """
         output = self._svncommand(['status', '--xml'])
+        externals, changes = [], []
         doc = xml.dom.minidom.parseString(output)
-        for s in doc.getElementsByTagName('wc-status'):
-            st = s.getAttribute('item')
-            if st and st != 'unversioned':
-                return False
-            props = s.getAttribute('props')
-            if props and props != 'none':
-                return False
-        return True
+        for e in doc.getElementsByTagName('entry'):
+            s = e.getElementsByTagName('wc-status')
+            if not s:
+                continue
+            item = s[0].getAttribute('item')
+            props = s[0].getAttribute('props')
+            path = e.getAttribute('path')
+            if item == 'external':
+                externals.append(path)
+            if (item not in ('', 'normal', 'unversioned', 'external')
+                or props not in ('', 'none')):
+                changes.append(path)
+        for path in changes:
+            for ext in externals:
+                if path == ext or path.startswith(ext + os.sep):
+                    return True, True
+        return bool(changes), False
 
     def dirty(self):
-        if self._wcrev() == self._state[1] and self._wcclean():
+        if self._wcrev() == self._state[1] and not self._wcchanged()[0]:
             return False
         return True
 
     def commit(self, text, user, date):
         # user and date are out of our hands since svn is centralized
-        if self._wcclean():
+        changed, extchanged = self._wcchanged()
+        if not changed:
             return self._wcrev()
+        if extchanged:
+            # Do not try to commit externals
+            raise util.Abort(_('cannot commit svn externals'))
         commitinfo = self._svncommand(['commit', '-m', text])
         self._ui.status(commitinfo)
         newrev = re.search('Committed revision ([\d]+).', commitinfo)
         if not newrev:
             raise util.Abort(commitinfo.splitlines()[-1])
         newrev = newrev.groups()[0]
         self._ui.status(self._svncommand(['update', '-r', newrev]))
         return newrev
 
     def remove(self):
         if self.dirty():
             self._repo.ui.warn(_('not removing repo %s because '
                                  'it has changes.\n' % self._path))
             return
         self._repo.ui.note('removing subrepo %s\n' % self._path)
         shutil.rmtree(self._ctx.repo.join(self._path))
 
     def get(self, state):
         status = self._svncommand(['checkout', state[0], '--revision', state[1]])
         if not re.search('Checked out revision [\d]+.', status):
             raise util.Abort(status.splitlines()[-1])
         self._ui.status(status)
 
     def merge(self, state):
         old = int(self._state[1])
         new = int(state[1])
         if new > old:
             self.get(state)
 
     def push(self, force):
         # nothing for svn
         pass
 
 types = {
     'hg': hgsubrepo,
     'svn': svnsubrepo,
     }

tests/test-subrepo-svn

@@ -1,78 +1,106 b''
 #!/bin/sh
 
 "$TESTDIR/hghave" svn || exit 80
 
 fix_path()
 {
     tr '\\' /
 }
 
 escapedwd=`pwd | fix_path`
 # SVN wants all paths to start with a slash. Unfortunately,
 # Windows ones don't. Handle that.
 expr $escapedwd : "\/" > /dev/null
 if [ $? -ne 0 ]; then
     escapedwd='/'$escapedwd
 fi
 filterpath="sed s|$escapedwd|/root|"
 
 echo % create subversion repo
 
 SVNREPO="file://$escapedwd/svn-repo"
 WCROOT="`pwd`/svn-wc"
 svnadmin create svn-repo
 svn co $SVNREPO svn-wc
 cd svn-wc
-echo alpha > alpha
-svn add alpha
+mkdir src
+echo alpha > src/alpha
+svn add src
+mkdir externals
+echo other > externals/other
+svn add externals
 svn ci -m 'Add alpha'
+svn up
+cat > extdef <<EOF
+externals -r1 $SVNREPO/externals
+EOF
+svn propset -F extdef svn:externals src
+svn ci -m 'Setting externals'
 cd ..
 
 echo % create hg repo
 mkdir sub
 cd sub
 hg init t
 cd t
 
 echo % first revision, no sub
 echo a > a
 hg ci -Am0
 
 echo % add first svn sub
-echo "s = [svn]$SVNREPO" >> .hgsub
-svn co --quiet $SVNREPO s
+echo "s = [svn]$SVNREPO/src" >> .hgsub
+svn co --quiet $SVNREPO/src s
 hg add .hgsub
 hg ci -m1
 echo % debugsub
 hg debugsub | $filterpath
 
 echo
 echo % change file in svn and hg, commit
 echo a >> a
 echo alpha >> s/alpha
 hg commit -m 'Message!'
 hg debugsub | $filterpath
 
 echo
 echo a > s/a
 echo % should be empty despite change to s/a
 hg st
 
 echo
 echo % add a commit from svn
-cd "$WCROOT"
+cd "$WCROOT"/src
 svn up
 echo xyz >> alpha
+svn propset svn:mime-type 'text/xml' alpha
 svn ci -m 'amend a from svn'
-cd ../sub/t
+cd ../../sub/t
+
 echo % this commit from hg will fail
 echo zzz >> s/alpha
 hg ci -m 'amend alpha from hg'
+svn revert -q s/alpha
+
+echo % this commit fails because of meta changes
+svn propset svn:mime-type 'text/html' s/alpha
+hg ci -m 'amend alpha from hg'
+svn revert -q s/alpha
+
+echo % this commit fails because of externals changes
+echo zzz > s/externals/other
+hg ci -m 'amend externals from hg'
+svn revert -q s/externals/other
+
+echo % this commit fails because of externals meta changes
+svn propset svn:mime-type 'text/html' s/externals/other
+hg ci -m 'amend externals from hg'
+svn revert -q s/externals/other
 
 echo
 echo % clone
 cd ..
 hg clone t tc | fix_path
 cd tc
 echo % debugsub in clone
 hg debugsub | $filterpath

tests/test-subrepo-svn.out

@@ -1,48 +1,87 b''
 % create subversion repo
 Checked out revision 0.
-A         alpha
-Adding         alpha
-Transmitting file data .
+A         src
+A         src/alpha
+A         externals
+A         externals/other
+Adding         externals
+Adding         externals/other
+Adding         src
+Adding         src/alpha
+Transmitting file data ..
 Committed revision 1.
+At revision 1.
+property 'svn:externals' set on 'src'
+Sending        src
+
+Committed revision 2.
 % create hg repo
 % first revision, no sub
 adding a
 % add first svn sub
 committing subrepository s
 % debugsub
 path s
- source   file:///root/svn-repo
- revision 1
+ source   file:///root/svn-repo/src
+ revision 2
 
 % change file in svn and hg, commit
 committing subrepository s
 Sending        s/alpha
 Transmitting file data .
-Committed revision 2.
-At revision 2.
+Committed revision 3.
+
+Fetching external item into 's/externals'
+External at revision 1.
+
+At revision 3.
 path s
- source   file:///root/svn-repo
- revision 2
+ source   file:///root/svn-repo/src
+ revision 3
 
 % should be empty despite change to s/a
 
 % add a commit from svn
 U    alpha
-Updated to revision 2.
-Sending        alpha
+
+Fetching external item into 'externals'
+A    externals/other
+Updated external to revision 1.
+
+Updated to revision 3.
+property 'svn:mime-type' set on 'alpha'
+Sending        src/alpha
 Transmitting file data .
-Committed revision 3.
+Committed revision 4.
 % this commit from hg will fail
 committing subrepository s
 abort: svn: Commit failed (details follow):
-svn: File '/alpha' is out of date
+svn: File '/src/alpha' is out of date
+% this commit fails because of meta changes
+property 'svn:mime-type' set on 's/alpha'
+committing subrepository s
+abort: svn: Commit failed (details follow):
+svn: File '/src/alpha' is out of date
+% this commit fails because of externals changes
+committing subrepository s
+abort: cannot commit svn externals
+% this commit fails because of externals meta changes
+property 'svn:mime-type' set on 's/externals/other'
+committing subrepository s
+abort: cannot commit svn externals
 
 % clone
 updating to branch default
 A    s/alpha
-Checked out revision 2.
+ U   s
+
+Fetching external item into 's/externals'
+A    s/externals/other
+Checked out external at revision 1.
+
+Checked out revision 3.
 3 files updated, 0 files merged, 0 files removed, 0 files unresolved
 % debugsub in clone
 path s
- source   file:///root/svn-repo
- revision 2
+ source   file:///root/svn-repo/src
+ revision 3