##// END OF EJS Templates
wireprotov2: implement commands as a generator of objects...
wireprotov2: implement commands as a generator of objects Previously, wire protocol version 2 inherited version 1's model of having separate types to represent the results of different wire protocol commands. As I implemented more powerful commands in future commits, I found I was using a common pattern of returning a special type to hold a generator. This meant the command function required a closure to do most of the work. That made logic flow more difficult to follow. I also noticed that many commands were effectively a sequence of objects to be CBOR encoded. I think it makes sense to define version 2 commands as generators. This way, commands can simply emit the data structures they wish to send to the client. This eliminates the need for a closure in command functions and removes encoding from the bodies of commands. As part of this commit, the handling of response objects has been moved into the serverreactor class. This puts the reactor in the driver's seat with regards to CBOR encoding and error handling. Having error handling in the function that emits frames is particularly important because exceptions in that function can lead to things getting in a bad state: I'm fairly certain that uncaught exceptions in the frame generator were causing deadlocks. I also introduced a dedicated error type for explicit error reporting in command handlers. This will be used in subsequent commits. There's still a bit of work to be done here, especially around formalizing the error handling "protocol." I've added yet another TODO to track this so we don't forget. Test output changed because we're using generators and no longer know we are at the end of the data until we hit the end of the generator. This means we can't emit the end-of-stream flag until we've exhausted the generator. Hence the introduction of 0-sized end-of-stream frames. Differential Revision: https://phab.mercurial-scm.org/D4472

File last commit:

r36787:3fff6f30 default
r39595:07b58266 default
Show More
test-releasenotes-parsing.t
202 lines | 4.4 KiB | text/troff | Tads3Lexer
/ tests / test-releasenotes-parsing.t
#require fuzzywuzzy
$ cat >> $HGRCPATH << EOF
> [extensions]
> releasenotes=
> EOF
Bullet point with a single item spanning a single line
$ hg debugparsereleasenotes - << EOF
> New Features
> ============
>
> * Bullet point item with a single line
> EOF
section: feature
bullet point:
paragraph: Bullet point item with a single line
Bullet point that spans multiple lines.
$ hg debugparsereleasenotes - << EOF
> New Features
> ============
>
> * Bullet point with a paragraph
> that spans multiple lines.
> EOF
section: feature
bullet point:
paragraph: Bullet point with a paragraph that spans multiple lines.
$ hg debugparsereleasenotes - << EOF
> New Features
> ============
>
> * Bullet point with a paragraph
> that spans multiple lines.
>
> And has an empty line between lines too.
> With a line cuddling that.
> EOF
section: feature
bullet point:
paragraph: Bullet point with a paragraph that spans multiple lines.
paragraph: And has an empty line between lines too. With a line cuddling that.
Multiple bullet points. With some entries being multiple lines.
$ hg debugparsereleasenotes - << EOF
> New Features
> ============
>
> * First bullet point. It has a single line.
>
> * Second bullet point.
> It consists of multiple lines.
>
> * Third bullet point. It has a single line.
> EOF
section: feature
bullet point:
paragraph: First bullet point. It has a single line.
bullet point:
paragraph: Second bullet point. It consists of multiple lines.
bullet point:
paragraph: Third bullet point. It has a single line.
Bullet point without newline between items
$ hg debugparsereleasenotes - << EOF
> New Features
> ============
>
> * First bullet point
> * Second bullet point
> And it has multiple lines
> * Third bullet point
> * Fourth bullet point
> EOF
section: feature
bullet point:
paragraph: First bullet point
bullet point:
paragraph: Second bullet point And it has multiple lines
bullet point:
paragraph: Third bullet point
bullet point:
paragraph: Fourth bullet point
Sub-section contents are read
$ hg debugparsereleasenotes - << EOF
> New Features
> ============
>
> First Feature
> -------------
>
> This is the first new feature that was implemented.
>
> And a second paragraph about it.
>
> Second Feature
> --------------
>
> This is the second new feature that was implemented.
>
> Paragraph two.
>
> Paragraph three.
> EOF
section: feature
subsection: First Feature
paragraph: This is the first new feature that was implemented.
paragraph: And a second paragraph about it.
subsection: Second Feature
paragraph: This is the second new feature that was implemented.
paragraph: Paragraph two.
paragraph: Paragraph three.
Multiple sections are read
$ hg debugparsereleasenotes - << EOF
> New Features
> ============
>
> * Feature 1
> * Feature 2
>
> Bug Fixes
> =========
>
> * Fix 1
> * Fix 2
> EOF
section: feature
bullet point:
paragraph: Feature 1
bullet point:
paragraph: Feature 2
section: fix
bullet point:
paragraph: Fix 1
bullet point:
paragraph: Fix 2
Mixed sub-sections and bullet list
$ hg debugparsereleasenotes - << EOF
> New Features
> ============
>
> Feature 1
> ---------
>
> Some words about the first feature.
>
> Feature 2
> ---------
>
> Some words about the second feature.
> That span multiple lines.
>
> Other Changes
> -------------
>
> * Bullet item 1
> * Bullet item 2
> EOF
section: feature
subsection: Feature 1
paragraph: Some words about the first feature.
subsection: Feature 2
paragraph: Some words about the second feature. That span multiple lines.
bullet point:
paragraph: Bullet item 1
bullet point:
paragraph: Bullet item 2
Warn user in case of unexpected block while parsing
$ hg init relnotes-warn
$ cd relnotes-warn
$ touch feature1
$ hg -q commit -A -l - << EOF
> commit 1
>
> .. feature::
>
> new feature added.
> some words about the feature.
> EOF
$ hg releasenote -r .
changeset a4251905c440: unexpected block in release notes directive feature
New Features
============
* new feature added. some words about the feature.
$ cd ..