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.
#require fuzzywuzzy
$ cat >> $HGRCPATH << EOF
> [extensions]
> releasenotes=
> EOF
$ hg init simple-repo
$ cd simple-repo
A fix directive from commit message is added to release notes
$ touch fix1
$ hg -q commit -A -l - << EOF
> commit 1
>
> .. fix::
>
> Fix from commit message.
> EOF
$ cat >> $TESTTMP/single-fix-bullet << EOF
> Bug Fixes
> =========
>
> * Fix from release notes.
> EOF
$ hg releasenotes -r . $TESTTMP/single-fix-bullet
$ cat $TESTTMP/single-fix-bullet
Bug Fixes
=========
* Fix from release notes.
* Fix from commit message.
Processing again ignores the already added bullet.
$ hg releasenotes -r . $TESTTMP/single-fix-bullet
$ cat $TESTTMP/single-fix-bullet
Bug Fixes
=========
* Fix from release notes.
* Fix from commit message.
$ cd ..
Sections are unioned
$ hg init subsections
$ cd subsections
$ touch fix1
$ hg -q commit -A -l - << EOF
> Commit 1
>
> .. feature:: Commit Message Feature
>
> This describes a feature from a commit message.
> EOF
$ cat >> $TESTTMP/single-feature-section << EOF
> New Features
> ============
>
> Notes Feature
> -------------
>
> This describes a feature from a release notes file.
> EOF
$ hg releasenotes -r . $TESTTMP/single-feature-section
$ cat $TESTTMP/single-feature-section
New Features
============
Notes Feature
-------------
This describes a feature from a release notes file.
Commit Message Feature
----------------------
This describes a feature from a commit message.
Doing it again won't add another section
$ hg releasenotes -r . $TESTTMP/single-feature-section
Commit Message Feature already exists in feature section; ignoring
$ cat $TESTTMP/single-feature-section
New Features
============
Notes Feature
-------------
This describes a feature from a release notes file.
Commit Message Feature
----------------------
This describes a feature from a commit message.
$ cd ..
Bullets from rev merge with those from notes file.
$ hg init bullets
$ cd bullets
$ touch fix1
$ hg -q commit -A -l - << EOF
> commit 1
>
> .. fix::
>
> this is fix1.
> EOF
$ touch fix2
$ hg -q commit -A -l - << EOF
> commit 2
>
> .. fix::
>
> this is fix2.
> EOF
$ hg releasenotes -r 'all()' $TESTTMP/relnotes-bullet-problem
$ cat $TESTTMP/relnotes-bullet-problem
Bug Fixes
=========
* this is fix1.
* this is fix2.
$ touch fix3
$ hg -q commit -A -l - << EOF
> commit 3
>
> .. fix::
>
> this is fix3.
> EOF
$ hg releasenotes -r . $TESTTMP/relnotes-bullet-problem
$ cat $TESTTMP/relnotes-bullet-problem
Bug Fixes
=========
* this is fix1.
* this is fix2.
* this is fix3.
$ cd ..
Ignores commit messages containing issueNNNN based on issue number.
$ hg init simple-fuzzrepo
$ cd simple-fuzzrepo
$ touch fix1
$ hg -q commit -A -l - << EOF
> commit 1
>
> .. fix::
>
> Resolved issue4567.
> EOF
$ cat >> $TESTTMP/issue-number-notes << EOF
> Bug Fixes
> =========
>
> * Fixed issue1234 related to XYZ.
>
> * Fixed issue4567 related to ABC.
>
> * Fixed issue3986 related to PQR.
> EOF
$ hg releasenotes -r . $TESTTMP/issue-number-notes
"issue4567" already exists in notes; ignoring
$ cat $TESTTMP/issue-number-notes
Bug Fixes
=========
* Fixed issue1234 related to XYZ.
* Fixed issue4567 related to ABC.
* Fixed issue3986 related to PQR.
$ cd ..
Adds short commit messages (words < 10) without
comparison unless there is an exact match.
$ hg init tempdir
$ cd tempdir
$ touch feature1
$ hg -q commit -A -l - << EOF
> commit 1
>
> .. feature::
>
> Adds a new feature 1.
> EOF
$ hg releasenotes -r . $TESTTMP/short-sentence-notes
$ touch feature2
$ hg -q commit -A -l - << EOF
> commit 2
>
> .. feature::
>
> Adds a new feature 2.
> EOF
$ hg releasenotes -r . $TESTTMP/short-sentence-notes
$ cat $TESTTMP/short-sentence-notes
New Features
============
* Adds a new feature 1.
* Adds a new feature 2.
$ cd ..
Ignores commit messages based on fuzzy comparison.
$ hg init fuzznotes
$ cd fuzznotes
$ touch fix1
$ hg -q commit -A -l - << EOF
> commit 1
>
> .. fix::
>
> This is a fix with another line.
> And it is a big one.
> EOF
$ cat >> $TESTTMP/fuzz-ignore-notes << EOF
> Bug Fixes
> =========
>
> * Fixed issue4567 by improving X.
>
> * This is the first line. This is next line with one newline.
>
> This is another line written after two newlines. This is going to be a big one.
>
> * This fixes another problem.
> EOF
$ hg releasenotes -r . $TESTTMP/fuzz-ignore-notes
"This is a fix with another line. And it is a big one." already exists in notes file; ignoring
$ cat $TESTTMP/fuzz-ignore-notes
Bug Fixes
=========
* Fixed issue4567 by improving X.
* This is the first line. This is next line with one newline.
This is another line written after two newlines. This is going to be a big
one.
* This fixes another problem.