Add support for generating HTTP protocol tests

This commit adds support for generating protocol tests based on the
`smithy.test#httpRequestTests` and `smithy.test#httpResponseTests`
traits. Any service that has these traits will have a file generated
in ./tests/functional named after the protocol that is being tested.
These generated tests use the `jest` library and its expect/fail
methods, along with custom mock handlers for testing the requests
and responses.

A custom node/shape visitor is needed to handle TS specific output
typing in the generated code. This handles properly generating Date
types, booleans, sets, and more.

Individual body comparators are included as stubs to be added when
the specific `bodyMediaType` they support are encountered. Some new
dependencies are added when handling query, form-urlencoded, or XML
components.

Author: kstich

README.md

@@ -18,7 +18,7 @@ are as follows:
 
    ```kotlin
    plugins {
-       id("software.amazon.smithy").version("0.3.0")
+       id("software.amazon.smithy").version("0.4.3")
    }
 
    dependencies {

smithy-typescript-codegen-test/build.gradle.kts

@@ -19,7 +19,7 @@ extra["moduleName"] = "software.amazon.smithy.typescript.codegen.test"
 tasks["jar"].enabled = false
 
 plugins {
-    id("software.amazon.smithy").version("0.4.1")
+    id("software.amazon.smithy").version("0.4.3")
 }
 
 repositories {
@@ -29,4 +29,5 @@ repositories {
 
 dependencies {
     implementation(project(":smithy-typescript-codegen"))
+    implementation("software.amazon.smithy:smithy-protocol-test-traits:0.9.7")
 }

smithy-typescript-codegen-test/model/main.smithy

@@ -1,6 +1,9 @@
 $version: "0.4.0"
 namespace example.weather
 
+use smithy.test#httpRequestTests
+use smithy.test#httpResponseTests
+
 /// Provides weather forecasts.
 @protocols([{name: "aws.rest-json-1.1"}])
 @paginated(inputToken: "nextToken", outputToken: "nextToken", pageSize: "pageSize")
@@ -39,6 +42,58 @@ operation GetCity {
     errors: [NoSuchResource]
 }
 
+// Tests that HTTP protocol tests are generated.
+apply GetCity @httpRequestTests([
+    {
+        id: "WriteGetCityAssertions",
+        documentation: "Does something",
+        protocol: "aws.rest-json-1.1",
+        method: "GET",
+        uri: "/cities/123",
+        body: "",
+        params: {
+            cityId: "123"
+        }
+    }
+])
+
+apply GetCity @httpResponseTests([
+    {
+        id: "WriteGetCityResponseAssertions",
+        documentation: "Does something",
+        protocol: "aws.rest-json-1.1",
+        code: 200,
+        body: """
+            {
+                "name": "Seattle",
+                "coordinates": {
+                    "latitude": 12.34,
+                    "longitude": -56.78
+                },
+                "city": {
+                    "cityId": "123",
+                    "name": "Seattle",
+                    "number": "One",
+                    "case": "Upper"
+                }
+            }""",
+        bodyMediaType: "application/json",
+        params: {
+            name: "Seattle",
+            coordinates: {
+                latitude: 12.34,
+                longitude: -56.78
+            },
+            city: {
+                cityId: "123",
+                name: "Seattle",
+                number: "One",
+                case: "Upper"
+            }
+        }
+    }
+])
+
 /// The input used to get a city.
 structure GetCityInput {
     // "cityId" provides the identifier for the resource and
@@ -80,6 +135,25 @@ structure NoSuchResource {
     message: String,
 }
 
+apply NoSuchResource @httpResponseTests([
+    {
+        id: "WriteNoSuchResourceAssertions",
+        documentation: "Does something",
+        protocol: "aws.rest-json-1.1",
+        code: 404,
+        body: """
+            {
+                "resourceType": "City",
+                "message": "Your custom message"
+            }""",
+        bodyMediaType: "application/json",
+        params: {
+            resourceType: "City",
+            message: "Your custom message"
+        }
+    }
+])
+
 // The paginated trait indicates that the operation may
 // return truncated results.
 @readonly
@@ -90,6 +164,22 @@ operation ListCities {
     output: ListCitiesOutput
 }
 
+apply ListCities @httpRequestTests([
+    {
+        id: "WriteListCitiesAssertions",
+        documentation: "Does something",
+        protocol: "aws.rest-json-1.1",
+        method: "GET",
+        uri: "/cities",
+        body: "",
+        queryParams: ["pageSize=50"],
+        forbidQueryParams: ["nextToken"],
+        params: {
+            pageSize: 50
+        }
+    }
+])
+
 structure ListCitiesInput {
     @httpQuery("nextToken")
     nextToken: String,

smithy-typescript-codegen-test/smithy-build.json

@@ -6,6 +6,7 @@
             "targetNamespace": "Weather",
             "package": "weather",
             "packageVersion": "0.0.1",
+            "protocol": "aws.rest-json-1.1",
             "packageJson": {
                 "license": "Apache-2.0"
             }

smithy-typescript-codegen/build.gradle.kts

@@ -19,4 +19,5 @@ extra["moduleName"] = "software.amazon.smithy.typescript.codegen"
 
 dependencies {
     api("software.amazon.smithy:smithy-codegen-core:0.9.7")
+    implementation("software.amazon.smithy:smithy-protocol-test-traits:0.9.7")
 }

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CodegenVisitor.java

@@ -171,8 +171,10 @@ void execute() {
         }
 
         // Generate index for client.
-        IndexGenerator.writeIndex(
-                settings, model, symbolProvider, fileManifest);
+        IndexGenerator.writeIndex(settings, model, symbolProvider, fileManifest);
+
+        // Generate protocol tests IFF found in the model.
+        new HttpProtocolTestGenerator(settings, model, symbolProvider, writers).run();
 
         // Write each pending writer.
         LOGGER.fine("Flushing TypeScript writers");