annotate tests/test-journal-share.t @ 49000:dd6b67d5c256 stable

rust: fix unsound `OwningDirstateMap`

As per the previous patch, `OwningDirstateMap` is unsound. Self-referential
structs are difficult to implement correctly in Rust since the compiler is
free to move structs around as much as it wants to. They are also very rarely
needed in practice, so the state-of-the-art on how they should be done within
the Rust rules is still a bit new.

The crate `ouroboros` is an attempt at providing a safe way (in the Rust sense)
of declaring self-referential structs. It is getting a lot attention and was
improved very quickly when soundness issues were found in the past: rather than
relying on our own (limited) review circle, we might as well use the de-facto
common crate to fix this problem. This will give us a much better chance of
finding issues should any new ones be discovered as well as the benefit of
fewer `unsafe` APIs of our own.

I was starting to think about how I would present a safe API to the old struct
but soon realized that the callback-based approach was already done in
`ouroboros`, along with a lot more care towards refusing incorrect structs.

In short: we don't return a mutable reference to the `DirstateMap` anymore, we
expect users of its API to pass a `FnOnce` that takes the map as an argument.
This allows our `OwningDirstateMap` to control the input and output lifetimes
of the code that modifies it to prevent such issues.

Changing to `ouroboros` meant changing every API with it, but it is relatively
low churn in the end. It correctly identified the example buggy modification of
`copy_map_insert` outlined in the previous patch as violating the borrow rules.

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

#testcases safe normal

#if safe
  $ echo "[format]"         >> $HGRCPATH
  $ echo "exp-share-safe = True" >> $HGRCPATH
#endif

Journal extension test: tests the share extension support

  $ cat >> testmocks.py << EOF
  > # mock out procutil.getuser() and util.makedate() to supply testable values
  > import os
  > from mercurial import util
  > from mercurial.utils import procutil
  > def mockgetuser():
  >     return b'foobar'
  > 
  > def mockmakedate():
  >     filename = os.path.join(os.environ['TESTTMP'], 'testtime')
  >     try:
  >         with open(filename, 'rb') as timef:
  >             time = float(timef.read()) + 1
  >     except IOError:
  >         time = 0.0
  >     with open(filename, 'wb') as timef:
  >         timef.write(str(time))
  >     return (time, 0)
  > 
  > procutil.getuser = mockgetuser
  > util.makedate = mockmakedate
  > EOF

  $ cat >> $HGRCPATH << EOF
  > [extensions]
  > journal=
  > share=
  > testmocks=`pwd`/testmocks.py
  > [remotenames]
  > rename.default=remote
  > EOF

  $ hg init repo
  $ cd repo
  $ hg bookmark bm
  $ touch file0
  $ hg commit -Am file0-added
  adding file0
  $ hg journal --all
  previous locations of the working copy and bookmarks:
  0fd3805711f9  .         commit -Am file0-added
  0fd3805711f9  bm        commit -Am file0-added

A shared working copy initially receives the same bookmarks and working copy

  $ cd ..
  $ hg share repo shared1
  updating working directory
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ cd shared1
  $ hg journal --all
  previous locations of the working copy and bookmarks:
  0fd3805711f9  .         share repo shared1

unless you explicitly share bookmarks

  $ cd ..
  $ hg share --bookmarks repo shared2
  updating working directory
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ cd shared2
  $ hg journal --all
  previous locations of the working copy and bookmarks:
  0fd3805711f9  .         share --bookmarks repo shared2
  0fd3805711f9  bm        commit -Am file0-added

Moving the bookmark in the original repository is only shown in the repository
that shares bookmarks

  $ cd ../repo
  $ touch file1
  $ hg commit -Am file1-added
  adding file1
  $ cd ../shared1
  $ hg journal --all
  previous locations of the working copy and bookmarks:
  0fd3805711f9  .         share repo shared1
  $ cd ../shared2
  $ hg journal --all
  previous locations of the working copy and bookmarks:
  4f354088b094  bm        commit -Am file1-added
  0fd3805711f9  .         share --bookmarks repo shared2
  0fd3805711f9  bm        commit -Am file0-added

But working copy changes are always 'local'

  $ cd ../repo
  $ hg up 0
  0 files updated, 0 files merged, 1 files removed, 0 files unresolved
  (leaving bookmark bm)
  $ hg journal --all
  previous locations of the working copy and bookmarks:
  0fd3805711f9  .         up 0
  4f354088b094  .         commit -Am file1-added
  4f354088b094  bm        commit -Am file1-added
  0fd3805711f9  .         commit -Am file0-added
  0fd3805711f9  bm        commit -Am file0-added
  $ cd ../shared2
  $ hg journal --all
  previous locations of the working copy and bookmarks:
  4f354088b094  bm        commit -Am file1-added
  0fd3805711f9  .         share --bookmarks repo shared2
  0fd3805711f9  bm        commit -Am file0-added
  $ hg up tip
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ hg up 0
  0 files updated, 0 files merged, 1 files removed, 0 files unresolved
  $ hg journal
  previous locations of '.':
  0fd3805711f9  up 0
  4f354088b094  up tip
  0fd3805711f9  share --bookmarks repo shared2

Unsharing works as expected; the journal remains consistent

  $ cd ../shared1
  $ hg unshare
  $ hg journal --all
  previous locations of the working copy and bookmarks:
  0fd3805711f9  .         share repo shared1
  $ cd ../shared2
  $ hg unshare
  $ hg journal --all
  previous locations of the working copy and bookmarks:
  0fd3805711f9  .         up 0
  4f354088b094  .         up tip
  4f354088b094  bm        commit -Am file1-added
  0fd3805711f9  .         share --bookmarks repo shared2
  0fd3805711f9  bm        commit -Am file0-added

New journal entries in the source repo no longer show up in the other working copies

  $ cd ../repo
  $ hg bookmark newbm -r tip
  $ hg journal newbm
  previous locations of 'newbm':
  4f354088b094  bookmark newbm -r tip
  $ cd ../shared2
  $ hg journal newbm
  previous locations of 'newbm':
  no recorded locations

This applies for both directions

  $ hg bookmark shared2bm -r tip
  $ hg journal shared2bm
  previous locations of 'shared2bm':
  4f354088b094  bookmark shared2bm -r tip
  $ cd ../repo
  $ hg journal shared2bm
  previous locations of 'shared2bm':
  no recorded locations