##// END OF EJS Templates
debugcommands: add debugwireproto command...
debugcommands: add debugwireproto command We currently don't have a low-level mechanism for sending arbitrary wire protocol commands. Having a generic and robust mechanism for sending wire protocol commands, examining wire data, etc would make it vastly easier to test the wire protocol and debug server operation. This is a problem I've wanted a solution for numerous times, especially recently as I've been hacking on a new version of the wire protocol. This commit establishes a `hg debugwireproto` command for sending data to a peer. The command invents a mini language for specifying actions to take. This will enable a lot of flexibility for issuing commands and testing variations for how commands are sent. Right now, we only support low-level raw sends and receives. These are probably the least valuable commands to intended users of this command. But they are the most useful commands to implement to bootstrap the feature (I've chosen to reimplement test-ssh-proto.t using this command to prove its usefulness). My eventual goal of `hg debugwireproto` is to allow calling wire protocol commands with a human-friendly interface. Essentially, people can type in a command name and arguments and `hg debugwireproto` will figure out how to send that on the wire. I'd love to eventually be able to save the server's raw response to a file. This would allow us to e.g. call "getbundle" wire protocol commands easily. test-ssh-proto.t has been updated to use the new command in lieu of piping directly to a server process. As part of the transition, test behavior improved. Before, we piped all request data to the server at once. Now, we have explicit control over the ordering of operations. e.g. we can send one command, receive its response, then send another command. This will allow us to more robustly test race conditions, buffering behavior, etc. There were some subtle changes in test behavior. For example, previous behavior would often send trailing newlines to the server. The new mechanism doesn't treat literal newlines specially and requires newlines be escaped in the payload. Because the new logging code is very low level, it is easy to introduce race conditions in tests. For example, the number of bytes returned by a read() may vary depending on load. This is why tests make heavy use of "readline" for consuming data: the result of that operation should be deterministic and not subject to race conditions. There are still some uses of "readavailable." However, those are only for reading from stderr. I was able to reproduce timing issues with my system under load when using "readavailable" globally. But if I "readline" to grab stdout, "readavailable" appears to work deterministically for stderr. I think this is because the server writes to stderr first. As long as the OS delivers writes to pipes in the same order they were made, this should work. If there are timing issues, we can introduce a mechanism to readline from stderr. Differential Revision: https://phab.mercurial-scm.org/D2392

File last commit:

r36545:72e48785 default
r36545:72e48785 default
Show More
test-ssh-proto.t
1254 lines | 34.2 KiB | text/troff | Tads3Lexer
$ cat >> $HGRCPATH << EOF
> [ui]
> ssh = $PYTHON "$TESTDIR/dummyssh"
> [devel]
> debug.peer-request = true
> [extensions]
> sshprotoext = $TESTDIR/sshprotoext.py
> EOF
$ hg init server
$ cd server
$ echo 0 > foo
$ hg -q add foo
$ hg commit -m initial
A no-op connection performs a handshake
$ hg debugwireproto --localssh << EOF
> EOF
creating ssh peer from handshake results
Raw peers don't perform any activity
$ hg debugwireproto --localssh --peer raw << EOF
> EOF
using raw connection to peer
$ hg debugwireproto --localssh --peer ssh1 << EOF
> EOF
creating ssh peer for wire protocol version 1
$ hg debugwireproto --localssh --peer ssh2 << EOF
> EOF
creating ssh peer for wire protocol version 2
Test a normal behaving server, for sanity
$ cd ..
$ hg --debug debugpeer ssh://user@dummy/server
running * "*/tests/dummyssh" 'user@dummy' 'hg -R server serve --stdio' (glob) (no-windows !)
running * "*\tests/dummyssh" "user@dummy" "hg -R server serve --stdio" (glob) (windows !)
devel-peer-request: hello
sending hello command
devel-peer-request: between
devel-peer-request: pairs: 81 bytes
sending between command
remote: 384
remote: capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN
remote: 1
url: ssh://user@dummy/server
local: no
pushable: yes
Server should answer the "hello" command in isolation
$ hg -R server debugwireproto --localssh --peer raw << EOF
> raw
> hello\n
> readline
> readline
> EOF
using raw connection to peer
i> write(6) -> None:
i> hello\n
o> readline() -> 4:
o> 384\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
`hg debugserve --sshstdio` works
$ cd server
$ hg debugserve --sshstdio << EOF
> hello
> EOF
384
capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN
I/O logging works
$ hg debugserve --sshstdio --logiofd 1 << EOF
> hello
> EOF
o> write(4) -> None:
o> 384\n
o> write(384) -> None:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
384
capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN
o> flush() -> None
$ hg debugserve --sshstdio --logiofile $TESTTMP/io << EOF
> hello
> EOF
384
capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN
$ cat $TESTTMP/io
o> write(4) -> None:
o> 384\n
o> write(384) -> None:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
o> flush() -> None
$ cd ..
>=0.9.1 clients send a "hello" + "between" for the null range as part of handshake.
Server should reply with capabilities and should send "1\n\n" as a successful
reply with empty response to the "between".
$ hg -R server debugwireproto --localssh --peer raw << EOF
> raw
> hello\n
> readline
> readline
> raw
> between\n
> pairs 81\n
> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
> readline
> readline
> EOF
using raw connection to peer
i> write(6) -> None:
i> hello\n
o> readline() -> 4:
o> 384\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
i> write(98) -> None:
i> between\n
i> pairs 81\n
i> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
o> readline() -> 2:
o> 1\n
o> readline() -> 1:
o> \n
SSH banner is not printed by default, ignored by clients
$ SSHSERVERMODE=banner hg debugpeer ssh://user@dummy/server
url: ssh://user@dummy/server
local: no
pushable: yes
--debug will print the banner
$ SSHSERVERMODE=banner hg --debug debugpeer ssh://user@dummy/server
running * "*/tests/dummyssh" 'user@dummy' 'hg -R server serve --stdio' (glob) (no-windows !)
running * "*\tests/dummyssh" "user@dummy" "hg -R server serve --stdio" (glob) (windows !)
devel-peer-request: hello
sending hello command
devel-peer-request: between
devel-peer-request: pairs: 81 bytes
sending between command
remote: banner: line 0
remote: banner: line 1
remote: banner: line 2
remote: banner: line 3
remote: banner: line 4
remote: banner: line 5
remote: banner: line 6
remote: banner: line 7
remote: banner: line 8
remote: banner: line 9
remote: 384
remote: capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN
remote: 1
url: ssh://user@dummy/server
local: no
pushable: yes
And test the banner with the raw protocol
$ SSHSERVERMODE=banner hg -R server debugwireproto --localssh --peer raw << EOF
> raw
> hello\n
> readline
> readline
> readline
> readline
> readline
> readline
> readline
> readline
> readline
> readline
> readline
> readline
> raw
> between\n
> pairs 81\n
> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
> readline
> readline
> EOF
using raw connection to peer
i> write(6) -> None:
i> hello\n
o> readline() -> 15:
o> banner: line 0\n
o> readline() -> 15:
o> banner: line 1\n
o> readline() -> 15:
o> banner: line 2\n
o> readline() -> 15:
o> banner: line 3\n
o> readline() -> 15:
o> banner: line 4\n
o> readline() -> 15:
o> banner: line 5\n
o> readline() -> 15:
o> banner: line 6\n
o> readline() -> 15:
o> banner: line 7\n
o> readline() -> 15:
o> banner: line 8\n
o> readline() -> 15:
o> banner: line 9\n
o> readline() -> 4:
o> 384\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
i> write(98) -> None:
i> between\n
i> pairs 81\n
i> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
o> readline() -> 2:
o> 1\n
o> readline() -> 1:
o> \n
Connecting to a <0.9.1 server that doesn't support the hello command.
The client should refuse, as we dropped support for connecting to such
servers.
$ SSHSERVERMODE=no-hello hg --debug debugpeer ssh://user@dummy/server
running * "*/tests/dummyssh" 'user@dummy' 'hg -R server serve --stdio' (glob) (no-windows !)
running * "*\tests/dummyssh" "user@dummy" "hg -R server serve --stdio" (glob) (windows !)
devel-peer-request: hello
sending hello command
devel-peer-request: between
devel-peer-request: pairs: 81 bytes
sending between command
remote: 0
remote: 1
abort: no suitable response from remote hg!
[255]
Sending an unknown command to the server results in an empty response to that command
$ hg -R server debugwireproto --localssh --peer raw << EOF
> raw
> pre-hello\n
> readline
> raw
> hello\n
> readline
> raw
> between\n
> pairs 81\n
> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
> readline
> readline
> EOF
using raw connection to peer
i> write(10) -> None:
i> pre-hello\n
o> readline() -> 2:
o> 0\n
i> write(6) -> None:
i> hello\n
o> readline() -> 4:
o> 384\n
i> write(98) -> None:
i> between\n
i> pairs 81\n
i> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
o> readline() -> 2:
o> 1\n
$ hg --config sshpeer.mode=extra-handshake-commands --config sshpeer.handshake-mode=pre-no-args --debug debugpeer ssh://user@dummy/server
running * "*/tests/dummyssh" 'user@dummy' 'hg -R server serve --stdio' (glob) (no-windows !)
running * "*\tests/dummyssh" "user@dummy" "hg -R server serve --stdio" (glob) (windows !)
sending no-args command
devel-peer-request: hello
sending hello command
devel-peer-request: between
devel-peer-request: pairs: 81 bytes
sending between command
remote: 0
remote: 384
remote: capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN
remote: 1
url: ssh://user@dummy/server
local: no
pushable: yes
Send multiple unknown commands before hello
$ hg -R server debugwireproto --localssh --peer raw << EOF
> raw
> unknown1\n
> readline
> raw
> unknown2\n
> readline
> raw
> unknown3\n
> readline
> raw
> hello\n
> readline
> readline
> raw
> between\n
> pairs 81\n
> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
> readline
> readline
> EOF
using raw connection to peer
i> write(9) -> None:
i> unknown1\n
o> readline() -> 2:
o> 0\n
i> write(9) -> None:
i> unknown2\n
o> readline() -> 2:
o> 0\n
i> write(9) -> None:
i> unknown3\n
o> readline() -> 2:
o> 0\n
i> write(6) -> None:
i> hello\n
o> readline() -> 4:
o> 384\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
i> write(98) -> None:
i> between\n
i> pairs 81\n
i> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
o> readline() -> 2:
o> 1\n
o> readline() -> 1:
o> \n
$ hg --config sshpeer.mode=extra-handshake-commands --config sshpeer.handshake-mode=pre-multiple-no-args --debug debugpeer ssh://user@dummy/server
running * "*/tests/dummyssh" 'user@dummy' 'hg -R server serve --stdio' (glob) (no-windows !)
running * "*\tests/dummyssh" "user@dummy" "hg -R server serve --stdio" (glob) (windows !)
sending unknown1 command
sending unknown2 command
sending unknown3 command
devel-peer-request: hello
sending hello command
devel-peer-request: between
devel-peer-request: pairs: 81 bytes
sending between command
remote: 0
remote: 0
remote: 0
remote: 384
remote: capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN
remote: 1
url: ssh://user@dummy/server
local: no
pushable: yes
Send an unknown command before hello that has arguments
$ cd server
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> with-args\n
> foo 13\n
> value for foo\n
> bar 13\n
> value for bar\n
> readline
> readline
> readline
> readline
> readline
> raw
> hello\n
> readline
> readline
> raw
> between\n
> pairs 81\n
> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
> readline
> readline
> EOF
using raw connection to peer
i> write(52) -> None:
i> with-args\n
i> foo 13\n
i> value for foo\n
i> bar 13\n
i> value for bar\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
i> write(6) -> None:
i> hello\n
o> readline() -> 4:
o> 384\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
i> write(98) -> None:
i> between\n
i> pairs 81\n
i> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
o> readline() -> 2:
o> 1\n
o> readline() -> 1:
o> \n
Send an unknown command having an argument that looks numeric
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> unknown\n
> foo 1\n
> 0\n
> readline
> readline
> readline
> raw
> hello\n
> readline
> readline
> raw
> between\n
> pairs 81\n
> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
> readline
> readline
> EOF
using raw connection to peer
i> write(16) -> None:
i> unknown\n
i> foo 1\n
i> 0\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
i> write(6) -> None:
i> hello\n
o> readline() -> 4:
o> 384\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
i> write(98) -> None:
i> between\n
i> pairs 81\n
i> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
o> readline() -> 2:
o> 1\n
o> readline() -> 1:
o> \n
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> unknown\n
> foo 1\n
> 1\n
> readline
> readline
> readline
> raw
> hello\n
> readline
> readline
> raw
> between\n
> pairs 81\n
> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
> readline
> readline
> EOF
using raw connection to peer
i> write(16) -> None:
i> unknown\n
i> foo 1\n
i> 1\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
i> write(6) -> None:
i> hello\n
o> readline() -> 4:
o> 384\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
i> write(98) -> None:
i> between\n
i> pairs 81\n
i> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
o> readline() -> 2:
o> 1\n
o> readline() -> 1:
o> \n
When sending a dict argument value, it is serialized to
"<arg> <item count>" followed by "<key> <len>\n<value>" for each item
in the dict.
Dictionary value for unknown command
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> unknown\n
> dict 3\n
> key1 3\n
> foo\n
> key2 3\n
> bar\n
> key3 3\n
> baz\n
> readline
> readline
> readline
> readline
> readline
> readline
> readline
> readline
> raw
> hello\n
> readline
> readline
> EOF
using raw connection to peer
i> write(48) -> None:
i> unknown\n
i> dict 3\n
i> key1 3\n
i> foo\n
i> key2 3\n
i> bar\n
i> key3 3\n
i> baz\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
i> write(6) -> None:
i> hello\n
o> readline() -> 4:
o> 384\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
Incomplete dictionary send
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> unknown\n
> dict 3\n
> key1 3\n
> foo\n
> readline
> readline
> readline
> readline
> EOF
using raw connection to peer
i> write(26) -> None:
i> unknown\n
i> dict 3\n
i> key1 3\n
i> foo\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
Incomplete value send
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> unknown\n
> dict 3\n
> key1 3\n
> fo
> readline
> readline
> readline
> EOF
using raw connection to peer
i> write(24) -> None:
i> unknown\n
i> dict 3\n
i> key1 3\n
i> fo
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
Send a command line with spaces
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> unknown withspace\n
> readline
> raw
> hello\n
> readline
> readline
> raw
> between\n
> pairs 81\n
> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
> readline
> readline
> EOF
using raw connection to peer
i> write(18) -> None:
i> unknown withspace\n
o> readline() -> 2:
o> 0\n
i> write(6) -> None:
i> hello\n
o> readline() -> 4:
o> 384\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
i> write(98) -> None:
i> between\n
i> pairs 81\n
i> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
o> readline() -> 2:
o> 1\n
o> readline() -> 1:
o> \n
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> unknown with multiple spaces\n
> readline
> raw
> hello\n
> readline
> readline
> raw
> between\n
> pairs 81\n
> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
> readline
> EOF
using raw connection to peer
i> write(29) -> None:
i> unknown with multiple spaces\n
o> readline() -> 2:
o> 0\n
i> write(6) -> None:
i> hello\n
o> readline() -> 4:
o> 384\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
i> write(98) -> None:
i> between\n
i> pairs 81\n
i> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
o> readline() -> 2:
o> 1\n
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> unknown with spaces\n
> key 10\n
> some value\n
> readline
> readline
> readline
> raw
> hello\n
> readline
> readline
> raw
> between\n
> pairs 81\n
> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
> readline
> readline
> EOF
using raw connection to peer
i> write(38) -> None:
i> unknown with spaces\n
i> key 10\n
i> some value\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
i> write(6) -> None:
i> hello\n
o> readline() -> 4:
o> 384\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
i> write(98) -> None:
i> between\n
i> pairs 81\n
i> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
o> readline() -> 2:
o> 1\n
o> readline() -> 1:
o> \n
Send an unknown command after the "between"
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> hello\n
> readline
> readline
> raw
> between\n
> pairs 81\n
> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000unknown
> readline
> readline
> EOF
using raw connection to peer
i> write(6) -> None:
i> hello\n
o> readline() -> 4:
o> 384\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
i> write(105) -> None:
i> between\n
i> pairs 81\n
i> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000unknown
o> readline() -> 2:
o> 1\n
o> readline() -> 1:
o> \n
And one with arguments
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> hello\n
> between\n
> pairs 81\n
> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
> readline
> readline
> readline
> readline
> raw
> unknown\n
> foo 5\n
> \nvalue\n
> bar 3\n
> baz\n
> readline
> readline
> readline
> EOF
using raw connection to peer
i> write(104) -> None:
i> hello\n
i> between\n
i> pairs 81\n
i> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
o> readline() -> 4:
o> 384\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
o> readline() -> 2:
o> 1\n
o> readline() -> 1:
o> \n
i> write(31) -> None:
i> unknown\n
i> foo 5\n
i> \n
i> value\n
i> bar 3\n
i> baz\n
o> readline() -> 2:
o> 0\n
o> readline() -> 2:
o> 0\n
o> readline() -> 0:
Send a valid command before the handshake
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> heads\n
> readline
> raw
> hello\n
> between\n
> pairs 81\n
> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
> readline
> readline
> readline
> readline
> EOF
using raw connection to peer
i> write(6) -> None:
i> heads\n
o> readline() -> 3:
o> 41\n
i> write(104) -> None:
i> hello\n
i> between\n
i> pairs 81\n
i> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
o> readline() -> 41:
o> 68986213bd4485ea51533535e3fc9e78007a711f\n
o> readline() -> 4:
o> 384\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
o> readline() -> 2:
o> 1\n
And a variation that doesn't send the between command
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> heads\n
> readline
> raw
> hello\n
> readline
> readline
> EOF
using raw connection to peer
i> write(6) -> None:
i> heads\n
o> readline() -> 3:
o> 41\n
i> write(6) -> None:
i> hello\n
o> readline() -> 41:
o> 68986213bd4485ea51533535e3fc9e78007a711f\n
o> readline() -> 4:
o> 384\n
Send an upgrade request to a server that doesn't support that command
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> upgrade 2e82ab3f-9ce3-4b4e-8f8c-6fd1c0e9e23a proto=irrelevant1%2Cirrelevant2\n
> readline
> raw
> hello\n
> between\n
> pairs 81\n
> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
> readline
> readline
> readline
> readline
> EOF
using raw connection to peer
i> write(77) -> None:
i> upgrade 2e82ab3f-9ce3-4b4e-8f8c-6fd1c0e9e23a proto=irrelevant1%2Cirrelevant2\n
o> readline() -> 2:
o> 0\n
i> write(104) -> None:
i> hello\n
i> between\n
i> pairs 81\n
i> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
o> readline() -> 4:
o> 384\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
o> readline() -> 2:
o> 1\n
o> readline() -> 1:
o> \n
$ cd ..
$ hg --config experimental.sshpeer.advertise-v2=true --debug debugpeer ssh://user@dummy/server
running * "*/tests/dummyssh" 'user@dummy' 'hg -R server serve --stdio' (glob) (no-windows !)
running * "*\tests/dummyssh" "user@dummy" "hg -R server serve --stdio" (glob) (windows !)
sending upgrade request: * proto=exp-ssh-v2-0001 (glob)
devel-peer-request: hello
sending hello command
devel-peer-request: between
devel-peer-request: pairs: 81 bytes
sending between command
remote: 0
remote: 384
remote: capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN
remote: 1
url: ssh://user@dummy/server
local: no
pushable: yes
Enable version 2 support on server. We need to do this in hgrc because we can't
use --config with `hg serve --stdio`.
$ cat >> server/.hg/hgrc << EOF
> [experimental]
> sshserver.support-v2 = true
> EOF
Send an upgrade request to a server that supports upgrade
$ cd server
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> upgrade this-is-some-token proto=exp-ssh-v2-0001\n
> hello\n
> between\n
> pairs 81\n
> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
> readline
> readline
> readline
> EOF
using raw connection to peer
i> write(153) -> None:
i> upgrade this-is-some-token proto=exp-ssh-v2-0001\n
i> hello\n
i> between\n
i> pairs 81\n
i> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
o> readline() -> 44:
o> upgraded this-is-some-token exp-ssh-v2-0001\n
o> readline() -> 4:
o> 383\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
$ cd ..
$ hg --config experimental.sshpeer.advertise-v2=true --debug debugpeer ssh://user@dummy/server
running * "*/tests/dummyssh" 'user@dummy' 'hg -R server serve --stdio' (glob) (no-windows !)
running * "*\tests/dummyssh" "user@dummy" "hg -R server serve --stdio" (glob) (windows !)
sending upgrade request: * proto=exp-ssh-v2-0001 (glob)
devel-peer-request: hello
sending hello command
devel-peer-request: between
devel-peer-request: pairs: 81 bytes
sending between command
protocol upgraded to exp-ssh-v2-0001
remote: capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN
url: ssh://user@dummy/server
local: no
pushable: yes
Verify the peer has capabilities
$ hg --config experimental.sshpeer.advertise-v2=true --debug debugcapabilities ssh://user@dummy/server
running * "*/tests/dummyssh" 'user@dummy' 'hg -R server serve --stdio' (glob) (no-windows !)
running * "*\tests/dummyssh" "user@dummy" "hg -R server serve --stdio" (glob) (windows !)
sending upgrade request: * proto=exp-ssh-v2-0001 (glob)
devel-peer-request: hello
sending hello command
devel-peer-request: between
devel-peer-request: pairs: 81 bytes
sending between command
protocol upgraded to exp-ssh-v2-0001
remote: capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN
Main capabilities:
batch
branchmap
$USUAL_BUNDLE2_CAPS_SERVER$
changegroupsubset
getbundle
known
lookup
pushkey
streamreqs=generaldelta,revlogv1
unbundle=HG10GZ,HG10BZ,HG10UN
unbundlehash
Bundle2 capabilities:
HG20
bookmarks
changegroup
01
02
digests
md5
sha1
sha512
error
abort
unsupportedcontent
pushraced
pushkey
hgtagsfnodes
listkeys
phases
heads
pushkey
remote-changegroup
http
https
Command after upgrade to version 2 is processed
$ cd server
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> upgrade this-is-some-token proto=exp-ssh-v2-0001\n
> hello\n
> between\n
> pairs 81\n
> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
> readline
> readline
> readline
> raw
> hello\n
> readline
> readline
> EOF
using raw connection to peer
i> write(153) -> None:
i> upgrade this-is-some-token proto=exp-ssh-v2-0001\n
i> hello\n
i> between\n
i> pairs 81\n
i> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
o> readline() -> 44:
o> upgraded this-is-some-token exp-ssh-v2-0001\n
o> readline() -> 4:
o> 383\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
i> write(6) -> None:
i> hello\n
o> readline() -> 4:
o> 384\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
Multiple upgrades is not allowed
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> upgrade this-is-some-token proto=exp-ssh-v2-0001\n
> hello\n
> between\n
> pairs 81\n
> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
> readline
> readline
> readline
> raw
> upgrade another-token proto=irrelevant\n
> hello\n
> readline
> readavailable
> EOF
using raw connection to peer
i> write(153) -> None:
i> upgrade this-is-some-token proto=exp-ssh-v2-0001\n
i> hello\n
i> between\n
i> pairs 81\n
i> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
o> readline() -> 44:
o> upgraded this-is-some-token exp-ssh-v2-0001\n
o> readline() -> 4:
o> 383\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
i> write(45) -> None:
i> upgrade another-token proto=irrelevant\n
i> hello\n
o> readline() -> 1:
o> \n
e> read(-1) -> 42:
e> cannot upgrade protocols multiple times\n
e> -\n
Malformed upgrade request line (not exactly 3 space delimited tokens)
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> upgrade\n
> readline
> EOF
using raw connection to peer
i> write(8) -> None:
i> upgrade\n
o> readline() -> 2:
o> 0\n
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> upgrade token\n
> readline
> EOF
using raw connection to peer
i> write(14) -> None:
i> upgrade token\n
o> readline() -> 2:
o> 0\n
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> upgrade token foo=bar extra-token\n
> readline
> EOF
using raw connection to peer
i> write(34) -> None:
i> upgrade token foo=bar extra-token\n
o> readline() -> 2:
o> 0\n
Upgrade request to unsupported protocol is ignored
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> upgrade this-is-some-token proto=unknown1,unknown2\n
> readline
> raw
> hello\n
> readline
> readline
> raw
> between\n
> pairs 81\n
> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
> readline
> readline
> EOF
using raw connection to peer
i> write(51) -> None:
i> upgrade this-is-some-token proto=unknown1,unknown2\n
o> readline() -> 2:
o> 0\n
i> write(6) -> None:
i> hello\n
o> readline() -> 4:
o> 384\n
o> readline() -> 384:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
i> write(98) -> None:
i> between\n
i> pairs 81\n
i> 0000000000000000000000000000000000000000-0000000000000000000000000000000000000000
o> readline() -> 2:
o> 1\n
o> readline() -> 1:
o> \n
Upgrade request must be followed by hello + between
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> upgrade token proto=exp-ssh-v2-0001\n
> invalid\n
> readline
> readavailable
> EOF
using raw connection to peer
i> write(44) -> None:
i> upgrade token proto=exp-ssh-v2-0001\n
i> invalid\n
o> readline() -> 1:
o> \n
e> read(-1) -> 46:
e> malformed handshake protocol: missing hello\n
e> -\n
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> upgrade token proto=exp-ssh-v2-0001\n
> hello\n
> invalid\n
> readline
> readavailable
> EOF
using raw connection to peer
i> write(50) -> None:
i> upgrade token proto=exp-ssh-v2-0001\n
i> hello\n
i> invalid\n
o> readline() -> 1:
o> \n
e> read(-1) -> 48:
e> malformed handshake protocol: missing between\n
e> -\n
$ hg debugwireproto --localssh --peer raw << EOF
> raw
> upgrade token proto=exp-ssh-v2-0001\n
> hello\n
> between\n
> invalid\n
> readline
> readavailable
> EOF
using raw connection to peer
i> write(58) -> None:
i> upgrade token proto=exp-ssh-v2-0001\n
i> hello\n
i> between\n
i> invalid\n
o> readline() -> 1:
o> \n
e> read(-1) -> 49:
e> malformed handshake protocol: missing pairs 81\n
e> -\n