Bolt handshake v2 (#641)

Adds test for the handshake manifest, additionally moves tests on bolt 4.1 to bolt 4.2, as drivers are dropping 4.1 from the handshake.

Co-authored-by: MaxAake <[email protected]>
Co-authored-by: Dmitriy Tverdiakov <[email protected]>

Author: 3 people

boltstub/README.md

@@ -24,7 +24,17 @@ The following options are available:
    Furthermore, with `!: AUTO GOODBYE`, the driver can reach the end of the script at any point which greatly decreases the usefulness of asserting a full script playthrough (i.e. successful Stubserver shutdown). Instead, use auto lines (see further down).
  * `!: BOLT ${BOLT VERSION}` **(required)**  
    Configure the Bolt version the server is speaking.  
-   E.g., `!: BOLT 4.0` or `!: BOLT 4`
+   E.g., `!: BOLT 4.0` or `!: BOLT 4`  
+   The bolt maximum handshake version (non-manifest, manifest vX) is chosen automatically based on the specified Bolt version.
+   Previous versions might also be accepted mirroring the behavior of the Neo4j server.
+   For Bolt handshake version 2 (requires Bolt version 5.7+), feature flags can be specified following the protocol version.
+   They're to be specified in raw hex bytes and must be a valid varint encoded integer.
+   The server expects the client to opt into all feature flags offered.  
+   E.g., `!: BOLT 5.7 FF 01` (sending feature flags 1 through 7 and 14)
+ * `!: HANDSHAKE_MANIFEST ${MANIFEST VERSION}`  
+   E.g., `!: HANDSHAKE_MANIFEST 1`  
+   Force the bolt version to be negotiated using the specified manifest version.
+   `0` indicates non-manifest negotiation.
  * `!: ALLOW RESTART`  
    By default, the server shuts itself down as soon as the end of the script is reached or the client sends an unexpected message.
    If this bang line is part of the head, the server will allow a new connection every time the script has successfully been played through until the end with the previous connection.
@@ -39,6 +49,11 @@ The following options are available:
    By default the server automatically performs a handshake (incl. protocol version negotiation) with the client upon connection (https://7687.org/bolt/bolt-protocol-handshake-specification.html).
    This bang line allows for overwriting the response of the server that normally contains the protocol version which the server wants to speak with the client.  
    E.g. `!: HANDSHAKE FF 00 00 01`
+ * `!: HANDSHAKE_RESPONSE ${HEX BYTES}`
+   This field requires `!: HANDSKE ${HEX BYTES}` to be present.
+   It's main purpose is to facilitate Bolt handshake v2 overwrites.
+   The data (`${HEX BYTES}`) will be expected to be received from the client after the server has sent the handshake data specified in `!: HANDSHAKE ${HEX BYTES}`.  
+   E.g. `!: HANDSHAKE 00 00 01 FF 00 00 00 07 05 00` and `!: HANDSHAKE_RESPONSE 00 00 07 05`
  * `!: HANDSHAKE_DELAY ${DELAY_IN_S}`
     Wait for `${DELAY_IN_S}` (can be int or float) seconds before sending the handshake response.
  * `!: PY ${ARBITRATY PYTHON CODE}`  

boltstub/__init__.py

@@ -214,8 +214,11 @@ class BoltActor:
     def __init__(self, script: Script, wire, eval_context: EvalContext):
         self.script = script
         self.channel = Channel(
-            wire, script.context.bolt_version, log_cb=self.log,
+            wire, script.context.bolt_version, script.context.bolt_features,
+            log_cb=self.log,
+            handshake_manifest=script.context.handshake_manifest,
             handshake_data=self.script.context.handshake,
+            handshake_response_data=self.script.context.handshake_response,
             handshake_delay=self.script.context.handshake_delay,
             eval_context=eval_context,
         )