view tests/test-mq-qpush-fail.t @ 25757:4d1382fd96ff

context: write dirstate out explicitly at the end of markcommitted

To detect change of a file without redundant comparison of file
content, dirstate recognizes a file as certainly clean, if:

  (1) it is already known as "normal",
  (2) dirstate entry for it has valid (= not "-1") timestamp, and
  (3) mode, size and timestamp of it on the filesystem are as same as
      ones expected in dirstate

This works as expected in many cases, but doesn't in the corner case
that changing a file keeps mode, size and timestamp of it on the
filesystem.

The timetable below shows steps in one of typical such situations:

  ---- ----------------------------------- ----------------
                                           timestamp of "f"
                                           ----------------
                                           dirstate   file-
  time          action                     mem  file  system
  ---- ----------------------------------- ---- ----- -----
   *                                             ***    ***
       - 'hg transplant REV1 REV2 ...'
         - transplanting REV1
           ....
   N
           - change "f", but keep size                   N
             (via 'patch.patch()')
           - 'dirstate.normal("f")'          N   ***
             (via 'repo.commit()')

         - transplanting REV2
           - change "f", but keep size                   N
             (via 'patch.patch()')
           - aborted while patching
  N+1
         - release wlock
           - 'dirstate.write()'              N    N      N

       - 'hg status' shows "r1" as "clean"   N    N      N
  ---- ----------------------------------- ---- ----- -----

The most important point is that 'dirstate.write()' is executed at N+1
or later. This causes writing dirstate timestamp N of "f" out
successfully. If it is executed at N, 'parsers.pack_dirstate()'
replaces timestamp N with "-1" before actual writing dirstate out.

This issue can occur when 'hg transplant' satisfies conditions below:

  - multiple revisions to be transplanted change the same file
  - those revisions don't change mode and size of the file, and
  - the 2nd or later revision of them fails after changing the file

The root cause of this issue is that files are changed without
flushing in-memory dirstate changes via 'repo.commit()' (even though
omitting 'dirstate.normallookup()' on files changed by 'patch.patch()'
for efficiency also causes this issue).

To detect changes of files correctly, this patch writes in-memory
dirstate changes out explicitly after marking files as clean in
'committablectx.markcommitted()', which is invoked via
'repo.commit()'.

After this change, timetable is changed as below:

  ---- ----------------------------------- ----------------
                                           timestamp of "f"
                                           ----------------
                                           dirstate   file-
  time          action                     mem  file  system
  ---- ----------------------------------- ---- ----- -----
   *                                             ***    ***
       - 'hg transplant REV1 REV2 ...'
         - transplanting REV1
           ....
   N
           - change "f", but keep size                   N
             (via 'patch.patch()')
           - 'dirstate.normal("f")'          N    ***
             (via 'repo.commit()')
       ----------------------------------- ---- ----- -----
           - 'dirsttate.write()'            -1    -1
       ----------------------------------- ---- ----- -----
         - transplanting REV2
           - change "f", but keep size                   N
             (via 'patch.patch()')
           - aborted while patching
  N+1
         - release wlock
           - 'dirstate.write()'              -1   -1     N

       - 'hg status' shows "r1" as "clean"   -1   -1     N
  ---- ----------------------------------- ---- ----- -----

To reproduce this issue in tests certainly, this patch emulates some
timing critical actions as below:

  - change "f" at N

    'patch.patch()' with 'fakepatchtime.py' explicitly changes mtime
    of patched files to "2000-01-01 00:00" (= N).

  - 'dirstate.write()' via 'repo.commit()' at N

    'fakedirstatewritetime.py' forces 'pack_dirstate()' to use
    "2000-01-01 00:00" as "now", only if 'pack_dirstate()' is invoked
    via 'committablectx.markcommitted()'.

  - 'dirstate.write()' via releasing wlock at N+1 (or "not at N")

    'pack_dirstate()' via releasing wlock uses actual timestamp at
    runtime as "now", and it should be different from the "2000-01-01
    00:00" of "f".

BTW, this patch doesn't test cases below, even though 'patch.patch()'
is used similarly in these cases:

  1. failure of 'hg import' or 'hg qpush'

  2. success of 'hg import', 'hg qpush' or 'hg transplant'

Case (1) above doesn't cause this kind of issue, because:

  - if patching is aborted by conflicts, changed files are committed

    changed files are marked as CLEAN, even though they are partially
    patched.

  - otherwise, dirstate are fully restored by 'dirstateguard'

    For example in timetable above, timestamp of "f" in .hg/dirstate
    is restored to -1 (or less than N), and subsequent 'hg status' can
    detect changes correctly.

Case (2) always causes 'repo.status()' invocation via 'repo.commit()'
just after changing files inside same wlock scope.

  ---- ----------------------------------- ----------------
                                           timestamp of "f"
                                           ----------------
                                           dirstate   file-
  time          action                     mem  file  system
  ---- ----------------------------------- ---- ----- -----
  N                                              ***   ***
       - make file "f" clean                            N

       - execute 'hg foobar'
         ....
         - 'dirstate.normal("f")'           N    ***
           (e.g. via dirty check
            or previous 'repo.commit()')

         - change "f", but keep size                    N
         - 'repo.status()' (*1)
           (via 'repo.commit()')
  ---- ----------------------------------- ---- ----- -----

At a glance, 'repo.status()' at (*1) seems to cause similar issue (=
"changed files are treated as clean"), but actually doesn't.

'dirstate._lastnormaltime' should be N at (*1) above, because
'dirstate.normal()' via dirty check is finished at N.

Therefore, "f" changed at N (= 'dirstate._lastnormaltime') is forcibly
treated as "unsure" at (*1), and changes are detected as expected (see
'dirstate.status()' for detail).

If 'hg import' is executed with '--no-commit', 'repo.status()' isn't
invoked just after changing files inside same wlock scope.

But preceding 'dirstate.normal()' is invoked inside another wlock
scope via 'cmdutil.bailifchanged()', and in-memory changes should be
flushed at the end of that scope.

Therefore, timestamp N of clean "f" should be replaced by -1, if
'dirstate.write()' is invoked at N. It means that condition of this
issue isn't satisfied.

Test that qpush cleans things up if it doesn't complete

  $ echo "[extensions]" >> $HGRCPATH
  $ echo "mq=" >> $HGRCPATH
  $ hg init repo
  $ cd repo
  $ echo foo > foo
  $ hg ci -Am 'add foo'
  adding foo
  $ touch untracked-file
  $ echo 'syntax: glob' > .hgignore
  $ echo '.hgignore' >> .hgignore
  $ hg qinit

test qpush on empty series

  $ hg qpush
  no patches in series
  $ hg qnew patch1
  $ echo >> foo
  $ hg qrefresh -m 'patch 1'
  $ hg qnew patch2
  $ echo bar > bar
  $ hg add bar
  $ hg qrefresh -m 'patch 2'
  $ hg qnew --config 'mq.plain=true' -U bad-patch
  $ echo >> foo
  $ hg qrefresh
  $ hg qpop -a
  popping bad-patch
  popping patch2
  popping patch1
  patch queue now empty
  $ $PYTHON -c 'print "\xe9"' > message
  $ cat .hg/patches/bad-patch >> message
  $ mv message .hg/patches/bad-patch
  $ cat > $TESTTMP/wrapplayback.py <<EOF
  > import os
  > from mercurial import extensions, transaction
  > def wrapplayback(orig,
  >                  journal, report, opener, vfsmap, entries, backupentries,
  >                  unlink=True):
  >     orig(journal, report, opener, vfsmap, entries, backupentries, unlink)
  >     # Touching files truncated at "transaction.abort" causes
  >     # forcible re-loading invalidated filecache properties
  >     # (including repo.changelog)
  >     for f, o, _ignore in entries:
  >         if o or not unlink:
  >             os.utime(opener.join(f), (0.0, 0.0))
  > def extsetup(ui):
  >     extensions.wrapfunction(transaction, '_playback', wrapplayback)
  > EOF
  $ hg qpush -a --config extensions.wrapplayback=$TESTTMP/wrapplayback.py  && echo 'qpush succeeded?!'
  applying patch1
  applying patch2
  applying bad-patch
  transaction abort!
  rollback completed
  cleaning up working directory...done
  abort: decoding near '\xe9': 'ascii' codec can't decode byte 0xe9 in position 0: ordinal not in range(128)! (esc)
  [255]
  $ hg parents
  changeset:   0:bbd179dfa0a7
  tag:         tip
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  summary:     add foo
  

test corrupt status file
  $ hg qpush
  applying patch1
  now at: patch1
  $ cp .hg/patches/status .hg/patches/status.orig
  $ hg qpop
  popping patch1
  patch queue now empty
  $ cp .hg/patches/status.orig .hg/patches/status
  $ hg qpush
  abort: working directory revision is not qtip
  [255]
  $ rm .hg/patches/status .hg/patches/status.orig


bar should be gone; other unknown/ignored files should still be around

  $ hg status -A
  ? untracked-file
  I .hgignore
  C foo

preparing qpush of a missing patch

  $ hg qpop -a
  no patches applied
  $ hg qpush
  applying patch1
  now at: patch1
  $ rm .hg/patches/patch2

now we expect the push to fail, but it should NOT complain about patch1

  $ hg qpush
  applying patch2
  unable to read patch2
  now at: patch1
  [1]

preparing qpush of missing patch with no patch applied

  $ hg qpop -a
  popping patch1
  patch queue now empty
  $ rm .hg/patches/patch1

qpush should fail the same way as below

  $ hg qpush
  applying patch1
  unable to read patch1
  [1]

Test qpush to a patch below the currently applied patch.

  $ hg qq -c guardedseriesorder
  $ hg qnew a
  $ hg qguard +block
  $ hg qnew b
  $ hg qnew c

  $ hg qpop -a
  popping c
  popping b
  popping a
  patch queue now empty

try to push and pop while a is guarded

  $ hg qpush a
  cannot push 'a' - guarded by '+block'
  [1]
  $ hg qpush -a
  applying b
  patch b is empty
  applying c
  patch c is empty
  now at: c

now try it when a is unguarded, and we're at the top of the queue

  $ hg qapplied -v
  0 G a
  1 A b
  2 A c
  $ hg qsel block
  $ hg qpush b
  abort: cannot push to a previous patch: b
  [255]
  $ hg qpush a
  abort: cannot push to a previous patch: a
  [255]

and now we try it one more time with a unguarded, while we're not at the top of the queue

  $ hg qpop b
  popping c
  now at: b
  $ hg qpush a
  abort: cannot push to a previous patch: a
  [255]

test qpop --force and backup files

  $ hg qpop -a
  popping b
  patch queue now empty
  $ hg qq --create force
  $ echo a > a
  $ echo b > b
  $ echo c > c
  $ hg ci -Am add a b c
  $ echo a >> a
  $ hg rm b
  $ hg rm c
  $ hg qnew p1
  $ echo a >> a
  $ echo bb > b
  $ hg add b
  $ echo cc > c
  $ hg add c
  $ hg qpop --force --verbose
  saving current version of a as a.orig
  saving current version of b as b.orig
  saving current version of c as c.orig
  popping p1
  patch queue now empty
  $ hg st
  ? a.orig
  ? b.orig
  ? c.orig
  ? untracked-file
  $ cat a.orig
  a
  a
  a
  $ cat b.orig
  bb
  $ cat c.orig
  cc

test qpop --force --no-backup

  $ hg qpush
  applying p1
  now at: p1
  $ rm a.orig
  $ echo a >> a
  $ hg qpop --force --no-backup --verbose
  popping p1
  patch queue now empty
  $ test -f a.orig && echo 'error: backup with --no-backup'
  [1]

test qpop --keep-changes

  $ hg qpush
  applying p1
  now at: p1
  $ hg qpop --keep-changes --force
  abort: cannot use both --force and --keep-changes
  [255]
  $ echo a >> a
  $ hg qpop --keep-changes
  abort: local changes found, refresh first
  [255]
  $ hg revert -qa a
  $ rm a
  $ hg qpop --keep-changes
  abort: local changes found, refresh first
  [255]
  $ hg rm -A a
  $ hg qpop --keep-changes
  abort: local changes found, refresh first
  [255]
  $ hg revert -qa a
  $ echo b > b
  $ hg add b
  $ hg qpop --keep-changes
  abort: local changes found, refresh first
  [255]
  $ hg forget b
  $ echo d > d
  $ hg add d
  $ hg qpop --keep-changes
  popping p1
  patch queue now empty
  $ hg forget d
  $ rm d

test qpush --force and backup files

  $ echo a >> a
  $ hg qnew p2
  $ echo b >> b
  $ echo d > d
  $ echo e > e
  $ hg add d e
  $ hg rm c
  $ hg qnew p3
  $ hg qpop -a
  popping p3
  popping p2
  patch queue now empty
  $ echo a >> a
  $ echo b1 >> b
  $ echo d1 > d
  $ hg add d
  $ echo e1 > e
  $ hg qpush -a --force --verbose
  applying p2
  saving current version of a as a.orig
  patching file a
  committing files:
  a
  committing manifest
  committing changelog
  applying p3
  saving current version of b as b.orig
  saving current version of d as d.orig
  patching file b
  patching file c
  patching file d
  file d already exists
  1 out of 1 hunks FAILED -- saving rejects to file d.rej
  patching file e
  file e already exists
  1 out of 1 hunks FAILED -- saving rejects to file e.rej
  patch failed to apply
  committing files:
  b
  committing manifest
  committing changelog
  patch failed, rejects left in working directory
  errors during apply, please fix and refresh p3
  [2]
  $ cat a.orig
  a
  a
  $ cat b.orig
  b
  b1
  $ cat d.orig
  d1

test qpush --force --no-backup

  $ hg revert -qa
  $ hg qpop -a
  popping p3
  popping p2
  patch queue now empty
  $ echo a >> a
  $ rm a.orig
  $ hg qpush --force --no-backup --verbose
  applying p2
  patching file a
  committing files:
  a
  committing manifest
  committing changelog
  now at: p2
  $ test -f a.orig && echo 'error: backup with --no-backup'
  [1]

test qgoto --force --no-backup

  $ hg qpop
  popping p2
  patch queue now empty
  $ echo a >> a
  $ hg qgoto --force --no-backup p2 --verbose
  applying p2
  patching file a
  committing files:
  a
  committing manifest
  committing changelog
  now at: p2
  $ test -f a.orig && echo 'error: backup with --no-backup'
  [1]

test qpush --keep-changes

  $ hg qpush --keep-changes --force
  abort: cannot use both --force and --keep-changes
  [255]
  $ hg qpush --keep-changes --exact
  abort: cannot use --exact and --keep-changes together
  [255]
  $ echo b >> b
  $ hg qpush --keep-changes
  applying p3
  abort: conflicting local changes found
  (did you forget to qrefresh?)
  [255]
  $ rm b
  $ hg qpush --keep-changes
  applying p3
  abort: conflicting local changes found
  (did you forget to qrefresh?)
  [255]
  $ hg rm -A b
  $ hg qpush --keep-changes
  applying p3
  abort: conflicting local changes found
  (did you forget to qrefresh?)
  [255]
  $ hg revert -aq b
  $ echo d > d
  $ hg add d
  $ hg qpush --keep-changes
  applying p3
  abort: conflicting local changes found
  (did you forget to qrefresh?)
  [255]
  $ hg forget d
  $ rm d
  $ hg qpop
  popping p2
  patch queue now empty
  $ echo b >> b
  $ hg qpush -a --keep-changes
  applying p2
  applying p3
  abort: conflicting local changes found
  (did you forget to qrefresh?)
  [255]
  $ hg qtop
  p2
  $ hg parents --template "{rev} {desc}\n"
  2 imported patch p2
  $ hg st b
  M b
  $ cat b
  b
  b

test qgoto --keep-changes

  $ hg revert -aq b
  $ rm e
  $ hg qgoto --keep-changes --force p3
  abort: cannot use both --force and --keep-changes
  [255]
  $ echo a >> a
  $ hg qgoto --keep-changes p3
  applying p3
  now at: p3
  $ hg st a
  M a
  $ hg qgoto --keep-changes p2
  popping p3
  now at: p2
  $ hg st a
  M a

test mq.keepchanges setting

  $ hg --config mq.keepchanges=1 qpush
  applying p3
  now at: p3
  $ hg st a
  M a
  $ hg --config mq.keepchanges=1 qpop
  popping p3
  now at: p2
  $ hg st a
  M a
  $ hg --config mq.keepchanges=1 qgoto p3
  applying p3
  now at: p3
  $ hg st a
  M a
  $ echo b >> b
  $ hg --config mq.keepchanges=1 qpop --force
  popping p3
  now at: p2
  $ hg st b
  $ hg --config mq.keepchanges=1 qpush --exact
  abort: local changes found, refresh first
  [255]
  $ hg revert -qa a
  $ hg qpop
  popping p2
  patch queue now empty
  $ echo a >> a
  $ hg --config mq.keepchanges=1 qpush --force
  applying p2
  now at: p2
  $ hg st a

  $ cd ..