view tests/test-show-stack.t @ 46607:e9901d01d135

revlog: add a mechanism to verify expected file position before appending

If someone uses `hg debuglocks`, or some non-hg process writes to the .hg
directory without respecting the locks, or if the repo's on a networked
filesystem, it's possible for the revlog code to write out corrupted data.

The form of this corruption can vary depending on what data was written and how
that happened. We are in the "networked filesystem" case (though I've had users
also do this to themselves with the "`hg debuglocks`" scenario), and most often
see this with the changelog. What ends up happening is we produce two items
(let's call them rev1 and rev2) in the .i file that have the same linkrev,
baserev, and offset into the .d file, while the data in the .d file is appended
properly. rev2's compressed_size is accurate for rev2, but when we go to
decompress the data in the .d file, we use the offset that's recorded in the
index file, which is the same as rev1, and attempt to decompress
rev2.compressed_size bytes of rev1's data. This usually does not succeed. :)

When using inline data, this also fails, though I haven't investigated why too
closely. This shows up as a "patch decode" error. I believe what's happening
there is that we're basically ignoring the offset field, getting the data
properly, but since baserev != rev, it thinks this is a delta based on rev
(instead of a full text) and can't actually apply it as such.

For now, I'm going to make this an optional component and default it to entirely
off. I may increase the default severity of this in the future, once I've
enabled it for my users and we gain more experience with it. Luckily, most of my
users have a versioned filesystem and can roll back to before the corruption has
been written, it's just a hassle to do so and not everyone knows how (so it's a
support burden). Users on other filesystems will not have that luxury, and this
can cause them to have a corrupted repository that they are unlikely to know how
to resolve, and they'll see this as a data-loss event. Refusing to create the
corruption is a much better user experience.

This mechanism is not perfect. There may be false-negatives (racy writes that
are not detected). There should not be any false-positives (non-racy writes that
are detected as such). This is not a mechanism that makes putting a repo on a
networked filesystem "safe" or "supported", just *less* likely to cause
corruption.

Differential Revision: https://phab.mercurial-scm.org/D9952

  $ cat >> $HGRCPATH << EOF
  > [extensions]
  > show =
  > EOF

  $ hg init repo0
  $ cd repo0

Empty repo / no checkout results in error

  $ hg show stack
  abort: stack view only available when there is a working directory
  [255]

Stack displays single draft changeset as root revision

  $ echo 0 > foo
  $ hg -q commit -A -m 'commit 0'
  $ hg show stack
    @  9f17 commit 0

Stack displays multiple draft changesets

  $ echo 1 > foo
  $ hg commit -m 'commit 1'
  $ echo 2 > foo
  $ hg commit -m 'commit 2'
  $ echo 3 > foo
  $ hg commit -m 'commit 3'
  $ echo 4 > foo
  $ hg commit -m 'commit 4'
  $ hg show stack
    @  2737 commit 4
    o  d1a6 commit 3
    o  128c commit 2
    o  181c commit 1
    o  9f17 commit 0

Public parent of draft base is displayed, separated from stack

  $ hg phase --public -r 0
  $ hg show stack
    @  2737 commit 4
    o  d1a6 commit 3
    o  128c commit 2
    o  181c commit 1
   /   (stack base)
  o  9f17 commit 0

  $ hg phase --public -r 1
  $ hg show stack
    @  2737 commit 4
    o  d1a6 commit 3
    o  128c commit 2
   /   (stack base)
  o  181c commit 1

Draft descendants are shown

  $ hg -q up 2
  $ hg show stack
    o  2737 commit 4
    o  d1a6 commit 3
    @  128c commit 2
   /   (stack base)
  o  181c commit 1

  $ hg -q up 3
  $ hg show stack
    o  2737 commit 4
    @  d1a6 commit 3
    o  128c commit 2
   /   (stack base)
  o  181c commit 1

working dir on public changeset should display special message

  $ hg -q up 1
  $ hg show stack
  (empty stack; working directory parent is a published changeset)

Branch point in descendants displayed at top of graph

  $ hg -q up 3
  $ echo b > foo
  $ hg commit -m 'commit 5 (new dag branch)'
  created new head
  $ hg -q up 2
  $ hg show stack
   \ /  (multiple children)
    |
    o  d1a6 commit 3
    @  128c commit 2
   /   (stack base)
  o  181c commit 1

  $ cd ..

Base is stopped at merges

  $ hg init merge-base
  $ cd merge-base
  $ echo 0 > foo
  $ hg -q commit -A -m initial
  $ echo h1 > foo
  $ hg commit -m 'head 1'
  $ hg -q up 0
  $ echo h2 > foo
  $ hg -q commit -m 'head 2'
  $ hg phase --public -r 0:tip
  $ hg -q up 1
  $ hg merge -t :local 2
  0 files updated, 1 files merged, 0 files removed, 0 files unresolved
  (branch merge, don't forget to commit)
  $ hg commit -m 'merge heads'

TODO doesn't yet handle case where wdir is a draft merge

  $ hg show stack
    @  8ee9 merge heads
   /   (stack base)
  o  5947 head 1

  $ echo d1 > foo
  $ hg commit -m 'draft 1'
  $ echo d2 > foo
  $ hg commit -m 'draft 2'

  $ hg show stack
    @  430d draft 2
    o  787b draft 1
   /   (stack base)
  o  8ee9 merge heads

  $ cd ..

Now move on to stacks when there are more commits after the base branchpoint

  $ hg init public-rebase
  $ cd public-rebase
  $ echo 0 > foo
  $ hg -q commit -A -m 'base'
  $ hg phase --public -r .
  $ echo d1 > foo
  $ hg commit -m 'draft 1'
  $ echo d2 > foo
  $ hg commit -m 'draft 2'
  $ hg -q up 0
  $ echo 1 > foo
  $ hg commit -m 'new 1'
  created new head
  $ echo 2 > foo
  $ hg commit -m 'new 2'
  $ hg -q up 2

Newer draft heads don't impact output

  $ hg show stack
    @  eaff draft 2
    o  2b21 draft 1
   /   (stack base)
  o  b66b base

Newer public heads are rendered

  $ hg phase --public -r '::tip'

  $ hg show stack
    o  baa4 new 2
   /    (2 commits ahead)
  :
  :    (stack head)
  : @  eaff draft 2
  : o  2b21 draft 1
  :/   (stack base)
  o  b66b base

If rebase is available, we show a hint how to rebase to that head

  $ hg --config extensions.rebase= show stack
    o  baa4 new 2
   /    (2 commits ahead; hg rebase --source 2b21 --dest baa4)
  :
  :    (stack head)
  : @  eaff draft 2
  : o  2b21 draft 1
  :/   (stack base)
  o  b66b base

Similar tests but for multiple heads

  $ hg -q up 0
  $ echo h2 > foo
  $ hg -q commit -m 'new head 2'
  $ hg phase --public -r .
  $ hg -q up 2

  $ hg show stack
    o  baa4 new 2
   /    (2 commits ahead)
  : o  9a84 new head 2
  :/    (1 commits ahead)
  :
  :    (stack head)
  : @  eaff draft 2
  : o  2b21 draft 1
  :/   (stack base)
  o  b66b base

  $ hg --config extensions.rebase= show stack
    o  baa4 new 2
   /    (2 commits ahead; hg rebase --source 2b21 --dest baa4)
  : o  9a84 new head 2
  :/    (1 commits ahead; hg rebase --source 2b21 --dest 9a84)
  :
  :    (stack head)
  : @  eaff draft 2
  : o  2b21 draft 1
  :/   (stack base)
  o  b66b base