tests/test-check-shbang.t
author Manuel Jacob <me@manueljacob.de>
Mon, 11 Jul 2022 01:51:20 +0200
branchstable
changeset 49378 094a5fa3cf52
parent 43692 2d8d4e08c493
child 49948 37de1a154472
permissions -rw-r--r--
procutil: make stream detection in make_line_buffered more correct and strict In make_line_buffered(), we don’t want to wrap the stream if we know that lines get flushed to the underlying raw stream already. Previously, the heuristic was too optimistic. It assumed that any stream which is not an instance of io.BufferedIOBase doesn’t need wrapping. However, there are buffered streams that aren’t instances of io.BufferedIOBase, like Mercurial’s own winstdout. The new logic is different in two ways: First, only for the check, if unwraps any combination of WriteAllWrapper and winstdout. Second, it skips wrapping the stream only if it is an instance of io.RawIOBase (or already wrapped). If it is an instance of io.BufferedIOBase, it gets wrapped. In any other case, the function raises an exception. This ensures that, if an unknown stream is passed or we add another wrapper in the future, we don’t wrap the stream if it’s already line buffered or not wrap the stream if it’s not line buffered. In fact, this was already helpful during development of this change. Without it, I possibly would have forgot that WriteAllWrapper needs to be ignored for the check, leading to unnecessary wrapping if stdout is unbuffered. The alternative would have been to always wrap unknown streams. However, I don’t think that anyone would benefit from being less strict. We can expect streams from the standard library to be subclassing either io.RawIOBase or io.BufferedIOBase, so running Mercurial in the standard way should not regress by this change. Py2exe might replace sys.stdout and sys.stderr, but that currently breaks Mercurial anyway and also these streams don’t claim to be interactive, so this function is not called for them.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
28879
8c1759a2bdf4 tests: add new test for #! shebang lines
timeless <timeless@mozdev.org>
parents: 27569
diff changeset
     1
#require test-repo
27569
b3eba79b7e04 tests: add test-check-execute.t
timeless <timeless@mozdev.org>
parents:
diff changeset
     2
29219
3c9066ed557c tests: silence test-repo obsolete warning
timeless <timeless@mozdev.org>
parents: 28879
diff changeset
     3
  $ . "$TESTDIR/helpers-testrepo.sh"
27569
b3eba79b7e04 tests: add test-check-execute.t
timeless <timeless@mozdev.org>
parents:
diff changeset
     4
  $ cd "`dirname "$TESTDIR"`"
b3eba79b7e04 tests: add test-check-execute.t
timeless <timeless@mozdev.org>
parents:
diff changeset
     5
28879
8c1759a2bdf4 tests: add new test for #! shebang lines
timeless <timeless@mozdev.org>
parents: 27569
diff changeset
     6
look for python scripts that do not use /usr/bin/env
27569
b3eba79b7e04 tests: add test-check-execute.t
timeless <timeless@mozdev.org>
parents:
diff changeset
     7
33204
ddd65b4f3ae6 tests: alias syshg and syshgenv so they can be switched conditionally
Yuya Nishihara <yuya@tcha.org>
parents: 33116
diff changeset
     8
  $ testrepohg files 'set:grep(r"^#!.*?python") and not grep(r"^#!/usr/bi{1}n/env python") - **/*.t'
27569
b3eba79b7e04 tests: add test-check-execute.t
timeless <timeless@mozdev.org>
parents:
diff changeset
     9
  [1]
b3eba79b7e04 tests: add test-check-execute.t
timeless <timeless@mozdev.org>
parents:
diff changeset
    10
32939
cad62cb3c84c tests: enforce use of $PYTHON in tests
Augie Fackler <augie@google.com>
parents: 29515
diff changeset
    11
In tests, enforce $PYTHON and *not* /usr/bin/env python or similar:
33204
ddd65b4f3ae6 tests: alias syshg and syshgenv so they can be switched conditionally
Yuya Nishihara <yuya@tcha.org>
parents: 33116
diff changeset
    12
  $ testrepohg files 'set:grep(r"#!.*?python") and **/*.t' \
32939
cad62cb3c84c tests: enforce use of $PYTHON in tests
Augie Fackler <augie@google.com>
parents: 29515
diff changeset
    13
  > -X tests/test-check-execute.t \
43692
2d8d4e08c493 tests: verify that Python scripts are blackened
Gregory Szorc <gregory.szorc@gmail.com>
parents: 33204
diff changeset
    14
  > -X tests/test-check-format.t \
32939
cad62cb3c84c tests: enforce use of $PYTHON in tests
Augie Fackler <augie@google.com>
parents: 29515
diff changeset
    15
  > -X tests/test-check-module-imports.t \
cad62cb3c84c tests: enforce use of $PYTHON in tests
Augie Fackler <augie@google.com>
parents: 29515
diff changeset
    16
  > -X tests/test-check-pyflakes.t \
cad62cb3c84c tests: enforce use of $PYTHON in tests
Augie Fackler <augie@google.com>
parents: 29515
diff changeset
    17
  > -X tests/test-check-shbang.t
cad62cb3c84c tests: enforce use of $PYTHON in tests
Augie Fackler <augie@google.com>
parents: 29515
diff changeset
    18
  [1]
cad62cb3c84c tests: enforce use of $PYTHON in tests
Augie Fackler <augie@google.com>
parents: 29515
diff changeset
    19
cad62cb3c84c tests: enforce use of $PYTHON in tests
Augie Fackler <augie@google.com>
parents: 29515
diff changeset
    20
The above exclusions are because they're looking for files that
cad62cb3c84c tests: enforce use of $PYTHON in tests
Augie Fackler <augie@google.com>
parents: 29515
diff changeset
    21
contain Python but don't end in .py - please avoid adding more.
cad62cb3c84c tests: enforce use of $PYTHON in tests
Augie Fackler <augie@google.com>
parents: 29515
diff changeset
    22
28879
8c1759a2bdf4 tests: add new test for #! shebang lines
timeless <timeless@mozdev.org>
parents: 27569
diff changeset
    23
look for shell scripts that do not use /bin/sh
27569
b3eba79b7e04 tests: add test-check-execute.t
timeless <timeless@mozdev.org>
parents:
diff changeset
    24
33204
ddd65b4f3ae6 tests: alias syshg and syshgenv so they can be switched conditionally
Yuya Nishihara <yuya@tcha.org>
parents: 33116
diff changeset
    25
  $ testrepohg files 'set:grep(r"^#!.*/bi{1}n/sh") and not grep(r"^#!/bi{1}n/sh")'
27569
b3eba79b7e04 tests: add test-check-execute.t
timeless <timeless@mozdev.org>
parents:
diff changeset
    26
  [1]