test: improve assertion messages (#1572)

Author: kuhe

Makefile

@@ -11,7 +11,6 @@ generate-protocol-tests:
 	./gradlew :smithy-typescript-protocol-test-codegen:build
 	rm -rf ./private/smithy-rpcv2-cbor
 	cp -r ./smithy-typescript-protocol-test-codegen/build/smithyprojections/smithy-typescript-protocol-test-codegen/smithy-rpcv2-cbor/typescript-codegen ./private/smithy-rpcv2-cbor
-	cp ./packages/core/vitest.config.ts ./private/smithy-rpcv2-cbor/vitest.config.js
 	node ./scripts/post-protocol-test-codegen
 	npx prettier --write ./private/smithy-rpcv2-cbor
 	yarn

private/smithy-rpcv2-cbor/package.json

@@ -10,7 +10,8 @@
     "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
     "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo || exit 0",
     "prepack": "yarn run clean && yarn run build",
-    "merged": "echo \"this is merged from user configuration.\""
+    "merged": "echo \"this is merged from user configuration.\"",
+    "test": "yarn g:vitest run --passWithNoTests"
   },
   "main": "./dist-cjs/index.js",
   "types": "./dist-types/index.d.ts",
@@ -51,7 +52,8 @@
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "^3.0.0",
-    "typescript": "~5.2.2"
+    "typescript": "~5.2.2",
+    "vitest": "2.1.8"
   },
   "engines": {
     "node": ">=18.0.0"

private/smithy-rpcv2-cbor/test/functional/rpcv2cbor.spec.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from "vite";
+
+export default defineConfig({
+  test: {
+    include: ["**/*.spec.ts"],
+    globals: true,
+  },
+});

private/smithy-rpcv2-cbor/vite.config.js

@@ -234,6 +234,8 @@ private void initializeWriterIfNeeded() {
             writer.addDependency(TypeScriptDependency.PROTOCOL_HTTP);
             // Add the template to each generated test.
             writer.write(IoUtils.readUtf8Resource(getClass(), "protocol-test-stub.ts"));
+            writer.addImport("test", "it", TypeScriptDependency.VITEST);
+            writer.addImport("expect", null, TypeScriptDependency.VITEST);
         }
     }
 
@@ -466,7 +468,6 @@ private void writeHttpResponseAssertions(HttpMalformedResponseDefinition respons
         writer.write("expect(r.statusCode).toBe($L);", responseDefinition.getCode());
         responseDefinition.getHeaders().forEach((header, value) -> {
             header = header.toLowerCase();
-            writer.write("expect(r.headers[$S]).toBeDefined();", header);
             writer.write("expect(r.headers[$S]).toBe($S);", header, value);
         });
         writer.write("");
@@ -484,11 +485,20 @@ private void writeHttpResponseAssertions(HttpMalformedResponseDefinition respons
 
     private void writeHttpQueryAssertions(HttpRequestTestCase testCase) {
         testCase.getRequireQueryParams().forEach(requiredQueryParam ->
-                writer.write("expect(r.query[$S]).toBeDefined();", requiredQueryParam));
+            writer.write("""
+                expect(
+                  r.query[$1S],
+                  `Query key $1S should have been defined in $${JSON.stringify(r.query)}`
+                ).toBeDefined();""", requiredQueryParam)
+        );
         writer.write("");
 
         testCase.getForbidQueryParams().forEach(forbidQueryParam ->
-                writer.write("expect(r.query[$S]).toBeUndefined();", forbidQueryParam));
+            writer.write("""
+                expect(
+                  r.query[$1S],
+                  `Query key $1S should have been undefined in $${JSON.stringify(r.query)}`
+                ).toBeUndefined();""", forbidQueryParam));
         writer.write("");
 
         List<String> explicitQueryValues = testCase.getQueryParams();
@@ -506,25 +516,31 @@ private void writeHttpQueryAssertions(HttpRequestTestCase testCase) {
 
     private void writeHttpHeaderAssertions(HttpMessageTestCase testCase) {
         testCase.getRequireHeaders().forEach(requiredHeader -> {
-            writer.write("expect(r.headers[$S]).toBeDefined();", requiredHeader.toLowerCase());
+            writer.write("""
+                expect(
+                    r.headers[$1S],
+                    `Header key $1S should have been defined in $${JSON.stringify(r.headers)}`
+                ).toBeDefined();""", requiredHeader.toLowerCase());
         });
         writer.write("");
 
         testCase.getForbidHeaders().forEach(forbidHeader ->
-                writer.write("expect(r.headers[$S]).toBeUndefined();", forbidHeader.toLowerCase()));
+            writer.write("""
+            expect(
+              r.headers[$1S],
+              `Header key $1S should have been undefined in $${JSON.stringify(r.headers)}`
+            ).toBeUndefined();""", forbidHeader.toLowerCase()));
         writer.write("");
 
         testCase.getHeaders().forEach((header, value) -> {
             header = header.toLowerCase();
-            writer.write("expect(r.headers[$S]).toBeDefined();", header);
             writer.write("expect(r.headers[$S]).toBe($S);", header, value);
         });
         writer.write("");
     }
 
     private void writeHttpHostAssertion(HttpRequestTestCase testCase) {
         testCase.getResolvedHost().ifPresent(resolvedHost -> {
-            writer.write("expect(r.headers[\"host\"]).toBeDefined();");
             writer.write("expect(r.headers[\"host\"]).toBe($S);", resolvedHost);
             writer.write("");
         });
@@ -540,7 +556,7 @@ private void writeHttpBodyAssertions(String body, String mediaType, boolean isCl
         }
 
         // Fast fail if we don't have a body.
-        writer.write("expect(r.body).toBeDefined();");
+        writer.write("expect(r.body, `Body was undefined.`).toBeDefined();");
 
         // Otherwise load a media type specific comparator and do a comparison.
         String comparatorInvoke = registerBodyComparatorStub(mediaType);
@@ -566,7 +582,7 @@ private void writeHttpBodyAssertions(String body, String mediaType, boolean isCl
 
     private void writeHttpBodyMessageAssertion(String messageRegex, String mediaType) {
         // Fast fail if we don't have a body.
-        writer.write("expect(r.body).toBeDefined();");
+        writer.write("expect(r.body, `Body was undefined`).toBeDefined();");
 
         // Otherwise load a media type specific matcher
         String comparatorInvoke = registerMessageRegexStub(mediaType);
@@ -825,7 +841,7 @@ private void writeResponseTestSetup(OperationShape operation, HttpResponseTestCa
     private void writeResponseAssertions(Shape operationOrError, HttpResponseTestCase testCase) {
         writer.write("expect(r['$$metadata'].httpStatusCode).toBe($L);", testCase.getCode());
 
-        writeReponseParamAssertions(operationOrError, testCase);
+        writeResponseParamAssertions(operationOrError, testCase);
     }
 
     private void writeRequestParamAssertions(OperationShape operation, HttpRequestTestCase testCase) {
@@ -859,7 +875,7 @@ private void writeRequestParamAssertions(OperationShape operation, HttpRequestTe
         }
     }
 
-    private void writeReponseParamAssertions(Shape operationOrError, HttpResponseTestCase testCase) {
+    private void writeResponseParamAssertions(Shape operationOrError, HttpResponseTestCase testCase) {
         ObjectNode params = testCase.getParams();
         if (!params.isEmpty()) {
             StructureShape testOutputShape;
@@ -917,7 +933,11 @@ private void writeParamAssertions(
 
         // Perform parameter comparisons.
         writer.openBlock("Object.keys(paramsToValidate).forEach(param => {", "});", () -> {
-            writer.write("expect(r[param]).toBeDefined();");
+            writer.write("""
+            expect(
+                r[param],
+                `The output field $${param} should have been defined in $${JSON.stringify(r, null, 2)}`
+            ).toBeDefined();""");
             if (hasStreamingPayloadBlob) {
                 writer.openBlock("if (param === $S) {", "} else {", payloadBinding.get().getMemberName(), () ->
                         writer.write("""

private/smithy-rpcv2-cbor/vitest.config.js

@@ -2986,6 +2986,7 @@ __metadata:
     rimraf: "npm:^3.0.0"
     tslib: "npm:^2.6.2"
     typescript: "npm:~5.2.2"
+    vitest: "npm:2.1.8"
   languageName: unknown
   linkType: soft