Move handshake prose tests from spec into prose test file (#1714)

Author: baileympearson

source/mongodb-handshake/handshake.md

@@ -452,78 +452,6 @@ limit:
 Additionally, implementers are encouraged to place high priority information about the platform earlier in the string,
 in order to avoid possible truncating of those details.
 
-## Test Plan
-
-Drivers that capture values for `client.env` should test that a connection and hello command succeeds in the presence of
-the following sets of environment variables:
-
-1. Valid AWS
-
-    | Environment Variable              | Value              |
-    | --------------------------------- | ------------------ |
-    | `AWS_EXECUTION_ENV`               | `AWS_Lambda_java8` |
-    | `AWS_REGION`                      | `us-east-2`        |
-    | `AWS_LAMBDA_FUNCTION_MEMORY_SIZE` | `1024`             |
-
-2. Valid Azure
-
-    | Environment Variable       | Value  |
-    | -------------------------- | ------ |
-    | `FUNCTIONS_WORKER_RUNTIME` | `node` |
-
-3. Valid GCP
-
-    | Environment Variable   | Value         |
-    | ---------------------- | ------------- |
-    | `K_SERVICE`            | `servicename` |
-    | `FUNCTION_MEMORY_MB`   | `1024`        |
-    | `FUNCTION_TIMEOUT_SEC` | `60`          |
-    | `FUNCTION_REGION`      | `us-central1` |
-
-4. Valid Vercel
-
-    | Environment Variable | Value  |
-    | -------------------- | ------ |
-    | `VERCEL`             | `1`    |
-    | `VERCEL_REGION`      | `cdg1` |
-
-5. Invalid - multiple providers
-
-    | Environment Variable       | Value              |
-    | -------------------------- | ------------------ |
-    | `AWS_EXECUTION_ENV`        | `AWS_Lambda_java8` |
-    | `FUNCTIONS_WORKER_RUNTIME` | `node`             |
-
-6. Invalid - long string
-
-    | Environment Variable | Value                  |
-    | -------------------- | ---------------------- |
-    | `AWS_EXECUTION_ENV`  | `AWS_Lambda_java8`     |
-    | `AWS_REGION`         | `a` repeated 512 times |
-
-7. Invalid - wrong types
-
-    | Environment Variable              | Value              |
-    | --------------------------------- | ------------------ |
-    | `AWS_EXECUTION_ENV`               | `AWS_Lambda_java8` |
-    | `AWS_LAMBDA_FUNCTION_MEMORY_SIZE` | `big`              |
-
-8. Invalid - `AWS_EXECUTION_ENV` does not start with `"AWS_Lambda_"`
-
-    | Environment Variable | Value |
-    | -------------------- | ----- |
-    | `AWS_EXECUTION_ENV`  | `EC2` |
-
-9. Valid container and FaaS provider. This test MUST verify that both the container metadata and the AWS Lambda metadata
-    is present in `client.env`.
-
-    | Environment Variable              | Value              |
-    | --------------------------------- | ------------------ |
-    | `AWS_EXECUTION_ENV`               | `AWS_Lambda_java8` |
-    | `AWS_REGION`                      | `us-east-2`        |
-    | `AWS_LAMBDA_FUNCTION_MEMORY_SIZE` | `1024`             |
-    | `KUBERNETES_SERVICE_HOST`         | `1`                |
-
 ## Motivation For Change
 
 Being able to annotate individual connections with custom data will allow users and sysadmins to easily correlate events
@@ -606,6 +534,7 @@ support the `hello` command, the `helloOk: true` argument is ignored and the leg
 
 ## Changelog
 
+- 2024-11-05: Move handshake prose tests from spec file to prose test file.
 - 2024-10-09: Clarify that FaaS and container metadata must both be populated when both are present.
 - 2024-08-16: Migrated from reStructuredText to Markdown.
 - 2019-11-13: Added section about supporting wrapping libraries

source/mongodb-handshake/tests/README.md

@@ -2,7 +2,79 @@
 
 ## Prose Tests
 
-### Test that the driver accepts an arbitrary auth mechanism
+### Test 1: Test that environment metadata is properly captured
+
+Drivers that capture values for `client.env` should test that a connection and hello command succeeds in the presence of
+the following sets of environment variables:
+
+1. Valid AWS
+
+    | Environment Variable              | Value              |
+    | --------------------------------- | ------------------ |
+    | `AWS_EXECUTION_ENV`               | `AWS_Lambda_java8` |
+    | `AWS_REGION`                      | `us-east-2`        |
+    | `AWS_LAMBDA_FUNCTION_MEMORY_SIZE` | `1024`             |
+
+2. Valid Azure
+
+    | Environment Variable       | Value  |
+    | -------------------------- | ------ |
+    | `FUNCTIONS_WORKER_RUNTIME` | `node` |
+
+3. Valid GCP
+
+    | Environment Variable   | Value         |
+    | ---------------------- | ------------- |
+    | `K_SERVICE`            | `servicename` |
+    | `FUNCTION_MEMORY_MB`   | `1024`        |
+    | `FUNCTION_TIMEOUT_SEC` | `60`          |
+    | `FUNCTION_REGION`      | `us-central1` |
+
+4. Valid Vercel
+
+    | Environment Variable | Value  |
+    | -------------------- | ------ |
+    | `VERCEL`             | `1`    |
+    | `VERCEL_REGION`      | `cdg1` |
+
+5. Invalid - multiple providers
+
+    | Environment Variable       | Value              |
+    | -------------------------- | ------------------ |
+    | `AWS_EXECUTION_ENV`        | `AWS_Lambda_java8` |
+    | `FUNCTIONS_WORKER_RUNTIME` | `node`             |
+
+6. Invalid - long string
+
+    | Environment Variable | Value                  |
+    | -------------------- | ---------------------- |
+    | `AWS_EXECUTION_ENV`  | `AWS_Lambda_java8`     |
+    | `AWS_REGION`         | `a` repeated 512 times |
+
+7. Invalid - wrong types
+
+    | Environment Variable              | Value              |
+    | --------------------------------- | ------------------ |
+    | `AWS_EXECUTION_ENV`               | `AWS_Lambda_java8` |
+    | `AWS_LAMBDA_FUNCTION_MEMORY_SIZE` | `big`              |
+
+8. Invalid - `AWS_EXECUTION_ENV` does not start with `"AWS_Lambda_"`
+
+    | Environment Variable | Value |
+    | -------------------- | ----- |
+    | `AWS_EXECUTION_ENV`  | `EC2` |
+
+9. Valid container and FaaS provider. This test MUST verify that both the container metadata and the AWS Lambda metadata
+    is present in `client.env`.
+
+    | Environment Variable              | Value              |
+    | --------------------------------- | ------------------ |
+    | `AWS_EXECUTION_ENV`               | `AWS_Lambda_java8` |
+    | `AWS_REGION`                      | `us-east-2`        |
+    | `AWS_LAMBDA_FUNCTION_MEMORY_SIZE` | `1024`             |
+    | `KUBERNETES_SERVICE_HOST`         | `1`                |
+
+### Test 2: Test that the driver accepts an arbitrary auth mechanism
 
 1. Mock the server response in a way that `saslSupportedMechs` array in the `hello` command response contains an
     arbitrary string.