view tests/test-rename.t @ 44950:f9734b2d59cc

py3: make stdout line-buffered if connected to a TTY

Status messages that are to be shown on the terminal should be written to the
file descriptor before anything further is done, to keep the user updated.

One common way to achieve this is to make stdout line-buffered if it is
connected to a TTY. This is done on Python 2 (except on Windows, where libc,
which the CPython 2 streams depend on, does not properly support this).

Python 3 rolls it own I/O streams. On Python 3, buffered binary streams can't be
set line-buffered. The previous code (added in 227ba1afcb65) incorrectly
assumed that on Python 3, pycompat.stdout (sys.stdout.buffer) is already
line-buffered. However the interpreter initializes it with a block-buffered
stream or an unbuffered stream (when the -u option or the PYTHONUNBUFFERED
environment variable is set), never with a line-buffered stream.

One example where the current behavior is unacceptable is when running
`hg pull https://www.mercurial-scm.org/repo/hg` on Python 3, where the line
"pulling from https://www.mercurial-scm.org/repo/hg" does not appear on the
terminal before the hg process blocks while waiting for the server.

Various approaches to fix this problem are possible, including:

1. Weaken the contract of procutil.stdout to not give any guarantees about
   buffering behavior. In this case, users of procutil.stdout need to be
   changed to do enough flushes. In particular,
  1. either ui must insert enough flushes for ui.write() and friends, or
  2. ui.write() and friends get split into flushing and fully buffered
     methods, or
  3. users of ui.write() and friends must flush explicitly.
2. Make stdout unbuffered.
3. Make stdout line-buffered. Since Python 3 does not natively support that for
   binary streams, we must implement it ourselves.

(2.) is problematic because using unbuffered I/O changes the performance
characteristics significantly compared to line-buffered (which is used on
Python 2) and this would be a regression.

(1.2.) and (1.3) are a substantial amount of work. It’s unclear whether the
added complexity would be justified, given that raw performance doesn’t matter
that much when writing to a terminal much faster than the user could read it.

(1.1.) pushes complexity into the ui class instead of separating the concern of
how stdout is buffered. Other users of procutil.stdout would still need to take
care of the flushes.

This patch implements (3.). The general performance considerations are very
similar to (1.1.). The extra method invocation and method forwarding add a
little more overhead if the class is used. In exchange, it doesn’t add overhead
if not used.


For the benchmarks, I compared the previous implementation (incorrect on Python
3), (1.1.), (3.) and (2.). The command was chosen so that the streams were
configured as if they were writing to a TTY, but actually write to a pager,
which is also the default:
HGRCPATH=/dev/null python3 ./hg --cwd ~/vcs/mozilla-central --time --pager yes --config pager.pager='cat > /dev/null' status --all

previous:
time: real 7.880 secs (user 7.290+0.050 sys 0.580+0.170)
time: real 7.830 secs (user 7.220+0.070 sys 0.590+0.140)
time: real 7.800 secs (user 7.210+0.050 sys 0.570+0.170)

(1.1.) using Yuya Nishihara’s patch:
time: real 9.860 secs (user 8.670+0.350 sys 1.160+0.830)
time: real 9.540 secs (user 8.430+0.370 sys 1.100+0.770)
time: real 9.830 secs (user 8.630+0.370 sys 1.180+0.840)

(3.) using this patch:
time: real 9.580 secs (user 8.480+0.350 sys 1.090+0.770)
time: real 9.670 secs (user 8.480+0.330 sys 1.170+0.860)
time: real 9.640 secs (user 8.500+0.350 sys 1.130+0.810)

(2.) using a previous patch by me:
time: real 10.480 secs (user 8.850+0.720 sys 1.590+1.500)
time: real 10.490 secs (user 8.750+0.750 sys 1.710+1.470)
time: real 10.240 secs (user 8.600+0.700 sys 1.590+1.510)


As expected, there’s no difference on Python 2, as exactly the same code paths
are used:

previous:
time: real 6.950 secs (user 5.870+0.330 sys 1.070+0.770)
time: real 7.040 secs (user 6.040+0.360 sys 0.980+0.750)
time: real 7.070 secs (user 5.950+0.360 sys 1.100+0.760)

this patch:
time: real 7.010 secs (user 5.900+0.390 sys 1.070+0.730)
time: real 7.000 secs (user 5.850+0.350 sys 1.120+0.760)
time: real 7.000 secs (user 5.790+0.380 sys 1.170+0.710)

  $ hg init
  $ mkdir d1 d1/d11 d2
  $ echo d1/a > d1/a
  $ echo d1/ba > d1/ba
  $ echo d1/a1 > d1/d11/a1
  $ echo d1/b > d1/b
  $ echo d2/b > d2/b
  $ hg add d1/a d1/b d1/ba d1/d11/a1 d2/b
  $ hg commit -m "1"

rename a single file

  $ hg rename d1/d11/a1 d2/c
  $ hg --config ui.portablefilenames=abort rename d1/a d1/con.xml
  abort: filename contains 'con', which is reserved on Windows: d1/con.xml
  [255]
  $ hg sum
  parent: 0:9b4b6e7b2c26 tip
   1
  branch: default
  commit: 1 renamed
  update: (current)
  phases: 1 draft
  $ hg status -C
  A d2/c
    d1/d11/a1
  R d1/d11/a1
  $ hg update -C
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm d2/c

rename a single file using absolute paths

  $ hg rename `pwd`/d1/d11/a1 `pwd`/d2/c
  $ hg status -C
  A d2/c
    d1/d11/a1
  R d1/d11/a1
  $ hg update -C
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm d2/c

rename --after a single file

  $ mv d1/d11/a1 d2/c
  $ hg rename --after d1/d11/a1 d2/c
  $ hg status -C
  A d2/c
    d1/d11/a1
  R d1/d11/a1
  $ hg update -C
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm d2/c

rename --after a single file when src and tgt already tracked

  $ mv d1/d11/a1 d2/c
  $ hg addrem -s 0
  removing d1/d11/a1
  adding d2/c
  $ hg rename --after d1/d11/a1 d2/c
  $ hg status -C
  A d2/c
    d1/d11/a1
  R d1/d11/a1
  $ hg update -C
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm d2/c

rename --after a single file to a nonexistent target filename

  $ hg rename --after d1/a dummy
  d1/a: not recording move - dummy does not exist
  [1]

move a single file to an existing directory

  $ hg rename d1/d11/a1 d2
  $ hg status -C
  A d2/a1
    d1/d11/a1
  R d1/d11/a1
  $ hg update -C
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm d2/a1

move --after a single file to an existing directory

  $ mv d1/d11/a1 d2
  $ hg rename --after d1/d11/a1 d2
  $ hg status -C
  A d2/a1
    d1/d11/a1
  R d1/d11/a1
  $ hg update -C
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm d2/a1

rename a file using a relative path

  $ (cd d1/d11; hg rename ../../d2/b e)
  $ hg status -C
  A d1/d11/e
    d2/b
  R d2/b
  $ hg update -C
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm d1/d11/e

rename --after a file using a relative path

  $ (cd d1/d11; mv ../../d2/b e; hg rename --after ../../d2/b e)
  $ hg status -C
  A d1/d11/e
    d2/b
  R d2/b
  $ hg update -C
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm d1/d11/e

rename directory d1 as d3

  $ hg rename d1/ d3
  moving d1/a to d3/a
  moving d1/b to d3/b
  moving d1/ba to d3/ba
  moving d1/d11/a1 to d3/d11/a1
  $ hg status -C
  A d3/a
    d1/a
  A d3/b
    d1/b
  A d3/ba
    d1/ba
  A d3/d11/a1
    d1/d11/a1
  R d1/a
  R d1/b
  R d1/ba
  R d1/d11/a1
  $ hg update -C
  4 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm -rf d3

rename --after directory d1 as d3

  $ mv d1 d3
  $ hg rename --after d1 d3
  moving d1/a to d3/a
  moving d1/b to d3/b
  moving d1/ba to d3/ba
  moving d1/d11/a1 to d3/d11/a1
  $ hg status -C
  A d3/a
    d1/a
  A d3/b
    d1/b
  A d3/ba
    d1/ba
  A d3/d11/a1
    d1/d11/a1
  R d1/a
  R d1/b
  R d1/ba
  R d1/d11/a1
  $ hg update -C
  4 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm -rf d3

move a directory using a relative path

  $ (cd d2; mkdir d3; hg rename ../d1/d11 d3)
  moving ../d1/d11/a1 to d3/d11/a1
  $ hg status -C
  A d2/d3/d11/a1
    d1/d11/a1
  R d1/d11/a1
  $ hg update -C
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm -rf d2/d3

move --after a directory using a relative path

  $ (cd d2; mkdir d3; mv ../d1/d11 d3; hg rename --after ../d1/d11 d3)
  moving ../d1/d11/a1 to d3/d11/a1
  $ hg status -C
  A d2/d3/d11/a1
    d1/d11/a1
  R d1/d11/a1
  $ hg update -C
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm -rf d2/d3

move directory d1/d11 to an existing directory d2 (removes empty d1)

  $ hg rename d1/d11/ d2
  moving d1/d11/a1 to d2/d11/a1
  $ hg status -C
  A d2/d11/a1
    d1/d11/a1
  R d1/d11/a1
  $ hg update -C
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm -rf d2/d11

move directories d1 and d2 to a new directory d3

  $ mkdir d3
  $ hg rename d1 d2 d3
  moving d1/a to d3/d1/a
  moving d1/b to d3/d1/b
  moving d1/ba to d3/d1/ba
  moving d1/d11/a1 to d3/d1/d11/a1
  moving d2/b to d3/d2/b
  $ hg status -C
  A d3/d1/a
    d1/a
  A d3/d1/b
    d1/b
  A d3/d1/ba
    d1/ba
  A d3/d1/d11/a1
    d1/d11/a1
  A d3/d2/b
    d2/b
  R d1/a
  R d1/b
  R d1/ba
  R d1/d11/a1
  R d2/b
  $ hg update -C
  5 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm -rf d3

move --after directories d1 and d2 to a new directory d3

  $ mkdir d3
  $ mv d1 d2 d3
  $ hg rename --after d1 d2 d3
  moving d1/a to d3/d1/a
  moving d1/b to d3/d1/b
  moving d1/ba to d3/d1/ba
  moving d1/d11/a1 to d3/d1/d11/a1
  moving d2/b to d3/d2/b
  $ hg status -C
  A d3/d1/a
    d1/a
  A d3/d1/b
    d1/b
  A d3/d1/ba
    d1/ba
  A d3/d1/d11/a1
    d1/d11/a1
  A d3/d2/b
    d2/b
  R d1/a
  R d1/b
  R d1/ba
  R d1/d11/a1
  R d2/b
  $ hg update -C
  5 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm -rf d3

move everything under directory d1 to existing directory d2, do not
overwrite existing files (d2/b)

  $ hg rename d1/* d2
  d2/b: not overwriting - file already committed
  ('hg rename --force' to replace the file by recording a rename)
  moving d1/d11/a1 to d2/d11/a1
  [1]
  $ hg status -C
  A d2/a
    d1/a
  A d2/ba
    d1/ba
  A d2/d11/a1
    d1/d11/a1
  R d1/a
  R d1/ba
  R d1/d11/a1
  $ diff -u d1/b d2/b
  --- d1/b	* (glob)
  +++ d2/b	* (glob)
  @@ * (glob)
  -d1/b
  +d2/b
  [1]
  $ hg update -C
  3 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm d2/a d2/ba d2/d11/a1

attempt to move one file into a non-existent directory

  $ hg rename d1/a dx/
  abort: destination dx/ is not a directory
  [255]
  $ hg status -C
  $ hg update -C
  0 files updated, 0 files merged, 0 files removed, 0 files unresolved

attempt to move potentially more than one file into a non-existent directory

  $ hg rename 'glob:d1/**' dx
  abort: with multiple sources, destination must be an existing directory
  [255]

move every file under d1 to d2/d21

  $ mkdir d2/d21
  $ hg rename 'glob:d1/**' d2/d21
  moving d1/a to d2/d21/a
  moving d1/b to d2/d21/b
  moving d1/ba to d2/d21/ba
  moving d1/d11/a1 to d2/d21/a1
  $ hg status -C
  A d2/d21/a
    d1/a
  A d2/d21/a1
    d1/d11/a1
  A d2/d21/b
    d1/b
  A d2/d21/ba
    d1/ba
  R d1/a
  R d1/b
  R d1/ba
  R d1/d11/a1
  $ hg update -C
  4 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm -rf d2/d21

move --after some files under d1 to d2/d21

  $ mkdir d2/d21
  $ mv d1/a d1/d11/a1 d2/d21
  $ hg rename --after 'glob:d1/**' d2/d21
  moving d1/a to d2/d21/a
  d1/b: not recording move - d2/d21/b does not exist
  d1/ba: not recording move - d2/d21/ba does not exist
  moving d1/d11/a1 to d2/d21/a1
  [1]
  $ hg status -C
  A d2/d21/a
    d1/a
  A d2/d21/a1
    d1/d11/a1
  R d1/a
  R d1/d11/a1
  $ hg update -C
  2 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm -rf d2/d21

move every file under d1 starting with an 'a' to d2/d21 (regexp)

  $ mkdir d2/d21
  $ hg rename 're:d1/([^a][^/]*/)*a.*' d2/d21
  moving d1/a to d2/d21/a
  moving d1/d11/a1 to d2/d21/a1
  $ hg status -C
  A d2/d21/a
    d1/a
  A d2/d21/a1
    d1/d11/a1
  R d1/a
  R d1/d11/a1
  $ hg update -C
  2 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm -rf d2/d21

attempt to overwrite an existing file

  $ echo "ca" > d1/ca
  $ hg rename d1/ba d1/ca
  d1/ca: not overwriting - file exists
  ('hg rename --after' to record the rename)
  [1]
  $ hg status -C
  ? d1/ca
  $ hg update -C
  0 files updated, 0 files merged, 0 files removed, 0 files unresolved

forced overwrite of an existing file

  $ echo "ca" > d1/ca
  $ hg rename --force d1/ba d1/ca
  $ hg status -C
  A d1/ca
    d1/ba
  R d1/ba
  $ hg update -C
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm d1/ca

attempt to overwrite an existing broken symlink

#if symlink
  $ ln -s ba d1/ca
  $ hg rename --traceback d1/ba d1/ca
  d1/ca: not overwriting - file exists
  ('hg rename --after' to record the rename)
  [1]
  $ hg status -C
  ? d1/ca
  $ hg update -C
  0 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm d1/ca

replace a symlink with a file

  $ ln -s ba d1/ca
  $ hg rename --force d1/ba d1/ca
  $ hg status -C
  A d1/ca
    d1/ba
  R d1/ba
  $ hg update -C
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm d1/ca
#endif

do not copy more than one source file to the same destination file

  $ mkdir d3
  $ hg rename d1/* d2/* d3
  moving d1/d11/a1 to d3/d11/a1
  d3/b: not overwriting - d2/b collides with d1/b
  [1]
  $ hg status -C
  A d3/a
    d1/a
  A d3/b
    d1/b
  A d3/ba
    d1/ba
  A d3/d11/a1
    d1/d11/a1
  R d1/a
  R d1/b
  R d1/ba
  R d1/d11/a1
  $ hg update -C
  4 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm -rf d3

move a whole subtree with "hg rename ."

  $ mkdir d3
  $ (cd d1; hg rename . ../d3)
  moving a to ../d3/d1/a
  moving b to ../d3/d1/b
  moving ba to ../d3/d1/ba
  moving d11/a1 to ../d3/d1/d11/a1
  $ hg status -C
  A d3/d1/a
    d1/a
  A d3/d1/b
    d1/b
  A d3/d1/ba
    d1/ba
  A d3/d1/d11/a1
    d1/d11/a1
  R d1/a
  R d1/b
  R d1/ba
  R d1/d11/a1
  $ hg update -C
  4 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm -rf d3

move a whole subtree with "hg rename --after ."

  $ mkdir d3
  $ mv d1/* d3
  $ (cd d1; hg rename --after . ../d3)
  moving a to ../d3/a
  moving b to ../d3/b
  moving ba to ../d3/ba
  moving d11/a1 to ../d3/d11/a1
  $ hg status -C
  A d3/a
    d1/a
  A d3/b
    d1/b
  A d3/ba
    d1/ba
  A d3/d11/a1
    d1/d11/a1
  R d1/a
  R d1/b
  R d1/ba
  R d1/d11/a1
  $ hg update -C
  4 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm -rf d3

move the parent tree with "hg rename .."

  $ (cd d1/d11; hg rename .. ../../d3)
  moving ../a to ../../d3/a
  moving ../b to ../../d3/b
  moving ../ba to ../../d3/ba
  moving a1 to ../../d3/d11/a1
  $ hg status -C
  A d3/a
    d1/a
  A d3/b
    d1/b
  A d3/ba
    d1/ba
  A d3/d11/a1
    d1/d11/a1
  R d1/a
  R d1/b
  R d1/ba
  R d1/d11/a1
  $ hg update -C
  4 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm -rf d3

skip removed files

  $ hg remove d1/b
  $ hg rename d1 d3
  moving d1/a to d3/a
  moving d1/ba to d3/ba
  moving d1/d11/a1 to d3/d11/a1
  $ hg status -C
  A d3/a
    d1/a
  A d3/ba
    d1/ba
  A d3/d11/a1
    d1/d11/a1
  R d1/a
  R d1/b
  R d1/ba
  R d1/d11/a1
  $ hg update -C
  4 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm -rf d3

transitive rename

  $ hg rename d1/b d1/bb
  $ hg rename d1/bb d1/bc
  $ hg status -C
  A d1/bc
    d1/b
  R d1/b
  $ hg update -C
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm d1/bc

transitive rename --after

  $ hg rename d1/b d1/bb
  $ mv d1/bb d1/bc
  $ hg rename --after d1/bb d1/bc
  $ hg status -C
  A d1/bc
    d1/b
  R d1/b
  $ hg update -C
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm d1/bc

  $ echo "# idempotent renames (d1/b -> d1/bb followed by d1/bb -> d1/b)"
  # idempotent renames (d1/b -> d1/bb followed by d1/bb -> d1/b)
  $ hg rename d1/b d1/bb
  $ echo "some stuff added to d1/bb" >> d1/bb
  $ hg rename d1/bb d1/b
  $ hg status -C
  M d1/b
  $ hg update -C
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved

overwriting with renames (issue1959)

  $ hg rename d1/a d1/c
  $ hg rename d1/b d1/a
  $ hg status -C
  M d1/a
    d1/b
  A d1/c
    d1/a
  R d1/b
  $ hg diff --git
  diff --git a/d1/a b/d1/a
  --- a/d1/a
  +++ b/d1/a
  @@ -1,1 +1,1 @@
  -d1/a
  +d1/b
  diff --git a/d1/b b/d1/b
  deleted file mode 100644
  --- a/d1/b
  +++ /dev/null
  @@ -1,1 +0,0 @@
  -d1/b
  diff --git a/d1/a b/d1/c
  copy from d1/a
  copy to d1/c
  $ hg update -C
  2 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm d1/c # The file was marked as added, so 'hg update' action  was 'forget'

check illegal path components

  $ hg rename d1/d11/a1 .hg/foo
  abort: path contains illegal component: .hg/foo
  [255]
  $ hg status -C
  $ hg rename d1/d11/a1 ../foo
  abort: ../foo not under root '$TESTTMP'
  [255]
  $ hg status -C

  $ mv d1/d11/a1 .hg/foo
  $ hg rename --after d1/d11/a1 .hg/foo
  abort: path contains illegal component: .hg/foo
  [255]
  $ hg status -C
  ! d1/d11/a1
  $ hg update -C
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm .hg/foo

  $ hg rename d1/d11/a1 .hg
  abort: path contains illegal component: .hg/a1
  [255]
  $ hg --config extensions.largefiles= rename d1/d11/a1 .hg
  The fsmonitor extension is incompatible with the largefiles extension and has been disabled. (fsmonitor !)
  abort: path contains illegal component: .hg/a1
  [255]
  $ hg status -C
  $ hg rename d1/d11/a1 ..
  abort: ../a1 not under root '$TESTTMP'
  [255]
  $ hg --config extensions.largefiles= rename d1/d11/a1 ..
  The fsmonitor extension is incompatible with the largefiles extension and has been disabled. (fsmonitor !)
  abort: ../a1 not under root '$TESTTMP'
  [255]
  $ hg status -C

  $ mv d1/d11/a1 .hg
  $ hg rename --after d1/d11/a1 .hg
  abort: path contains illegal component: .hg/a1
  [255]
  $ hg status -C
  ! d1/d11/a1
  $ hg update -C
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ rm .hg/a1

  $ (cd d1/d11; hg rename ../../d2/b ../../.hg/foo)
  abort: path contains illegal component: .hg/foo
  [255]
  $ hg status -C
  $ (cd d1/d11; hg rename ../../d2/b ../../../foo)
  abort: ../../../foo not under root '$TESTTMP'
  [255]
  $ hg status -C

check that stat information such as mtime is preserved on rename - it's unclear
whether the `touch` and `stat` commands are portable, so we mimic them using
python.  Not all platforms support precision of even one-second granularity, so
we allow a rather generous fudge factor here; 1234567890 is 2009, and the
primary thing we care about is that it's not the machine's current time;
hopefully it's really unlikely for a machine to have such a broken clock that
this test fails. :)

  $ mkdir mtime
Create the file (as empty), then update its mtime and atime to be 1234567890.
  >>> import os
  >>> filename = "mtime/f"
  >>> mtime = 1234567890
  >>> open(filename, "w").close()
  >>> os.utime(filename, (mtime, mtime))
  $ hg ci -qAm 'add mtime dir'
"hg cp" does not preserve the mtime, so it should be newer than the 2009
timestamp.
  $ hg cp -q mtime mtime_cp
  >>> from __future__ import print_function
  >>> import os
  >>> filename = "mtime_cp/f"
  >>> print(os.stat(filename).st_mtime < 1234567999)
  False
"hg mv" preserves the mtime, so it should be ~equal to the 2009 timestamp
(modulo some fudge factor due to not every system supporting 1s-level
precision).
  $ hg mv -q mtime mtime_mv
  >>> from __future__ import print_function
  >>> import os
  >>> filename = "mtime_mv/f"
  >>> print(os.stat(filename).st_mtime < 1234567999)
  True