feat(experimentalIdentityAndAuth): add @httpApiKeyAuth integration …

…tests

packages/experimental-identity-and-auth/src/integration/httpApiKeyAuth.integ.spec.ts

@@ -0,0 +1,100 @@
+import {
+  HttpApiKeyAuthServiceClient,
+  OnlyHttpApiKeyAuthCommand,
+  OnlyHttpApiKeyAuthOptionalCommand,
+  SameAsServiceCommand,
+} from "@smithy/identity-and-auth-http-api-key-auth-service";
+import { requireRequestsFrom } from "@smithy/util-test";
+
+describe("@httpApiKeyAuth integration tests", () => {
+  // TODO(experimentalIdentityAndAuth): should match `HttpApiKeyAuthService` `@httpApiKeyAuth` trait
+  const MOCK_API_KEY_NAME = "Authorization";
+  const MOCK_API_KEY_SCHEME = "ApiKey";
+  const MOCK_API_KEY = "APIKEY_123";
+
+  // Arbitrary mock endpoint (`requireRequestsFrom()` intercepts network requests)
+  const MOCK_ENDPOINT = "https://foo.bar";
+
+  describe("Operation requires `@httpApiKeyAuth`", () => {
+    it("Request is thrown when `apiKey` is not configured", async () => {
+      const client = new HttpApiKeyAuthServiceClient({
+        endpoint: MOCK_ENDPOINT,
+      });
+      requireRequestsFrom(client).toMatch({});
+      await expect(client.send(new OnlyHttpApiKeyAuthCommand({}))).rejects.toThrow(
+        "HttpAuthScheme `smithy.api#httpApiKeyAuth` did not have an IdentityProvider configured."
+      );
+    });
+
+    it("Request is signed given configured `apiKey`", async () => {
+      const client = new HttpApiKeyAuthServiceClient({
+        endpoint: MOCK_ENDPOINT,
+        apiKey: async () => ({
+          apiKey: MOCK_API_KEY,
+        }),
+      });
+      requireRequestsFrom(client).toMatch({
+        headers: {
+          [MOCK_API_KEY_NAME]: `${MOCK_API_KEY_SCHEME} ${MOCK_API_KEY}`,
+        },
+      });
+      await client.send(new OnlyHttpApiKeyAuthCommand({}));
+    });
+  });
+
+  describe("Operation has `@httpApiKeyAuth` and `@optionalAuth`", () => {
+    it("Request is NOT thrown and NOT signed when `apiKey` is not configured", async () => {
+      const client = new HttpApiKeyAuthServiceClient({
+        endpoint: MOCK_ENDPOINT,
+      });
+      requireRequestsFrom(client).toMatch({
+        headers: {
+          [MOCK_API_KEY_NAME]: (value) => expect(value).toBeUndefined(),
+        },
+      });
+      await client.send(new OnlyHttpApiKeyAuthOptionalCommand({}));
+    });
+
+    it("Request is signed given configured `apiKey`", async () => {
+      const client = new HttpApiKeyAuthServiceClient({
+        endpoint: MOCK_ENDPOINT,
+        apiKey: async () => ({
+          apiKey: MOCK_API_KEY,
+        }),
+      });
+      requireRequestsFrom(client).toMatch({
+        headers: {
+          [MOCK_API_KEY_NAME]: `${MOCK_API_KEY_SCHEME} ${MOCK_API_KEY}`,
+        },
+      });
+      await client.send(new OnlyHttpApiKeyAuthOptionalCommand({}));
+    });
+  });
+
+  describe("Service has `@httpApiKeyAuth`", () => {
+    it("Request is thrown when `apiKey` is not configured", async () => {
+      const client = new HttpApiKeyAuthServiceClient({
+        endpoint: MOCK_ENDPOINT,
+      });
+      requireRequestsFrom(client).toMatch({});
+      await expect(client.send(new SameAsServiceCommand({}))).rejects.toThrow(
+        "HttpAuthScheme `smithy.api#httpApiKeyAuth` did not have an IdentityProvider configured."
+      );
+    });
+
+    it("Request is signed given configured `apiKey`", async () => {
+      const client = new HttpApiKeyAuthServiceClient({
+        endpoint: MOCK_ENDPOINT,
+        apiKey: async () => ({
+          apiKey: MOCK_API_KEY,
+        }),
+      });
+      requireRequestsFrom(client).toMatch({
+        headers: {
+          [MOCK_API_KEY_NAME]: `${MOCK_API_KEY_SCHEME} ${MOCK_API_KEY}`,
+        },
+      });
+      await client.send(new SameAsServiceCommand({}));
+    });
+  });
+});

scripts/build-generated-test-packages.js

@@ -29,6 +29,13 @@ const weatherSsdkDir = path.join(
     "typescript-ssdk-codegen"
 )
 
+// TODO(experimentalIdentityAndAuth): add `@httpApiKeyAuth` client for integration tests
+const httpApiKeyAuthClientDir = path.join(
+    codegenTestDir,
+    "identity-and-auth-http-api-key-auth",
+    "typescript-codegen"
+);
+
 const nodeModulesDir = path.join(root, "node_modules");
 
 const buildAndCopyToNodeModules = async (packageName, codegenDir, nodeModulesDir) => {
@@ -51,6 +58,8 @@ const buildAndCopyToNodeModules = async (packageName, codegenDir, nodeModulesDir
   try {
     await buildAndCopyToNodeModules("weather", weatherClientDir, nodeModulesDir);
     await buildAndCopyToNodeModules("weather-ssdk", weatherSsdkDir, nodeModulesDir);
+    // TODO(experimentalIdentityAndAuth): add `@httpApiKeyAuth` client for integration tests
+    await buildAndCopyToNodeModules("@smithy/identity-and-auth-http-api-key-auth-service", httpApiKeyAuthClientDir, nodeModulesDir);
  } catch (e) {
     console.log(e);
     process.exit(1);

smithy-typescript-codegen-test/model/identity-and-auth/httpApiKeyAuth/HttpApiKeyAuthService.smithy

@@ -0,0 +1,27 @@
+$version: "2.0"
+
+namespace identity.auth.httpApiKeyAuth
+
+use common#fakeProtocol
+
+@fakeProtocol
+@httpApiKeyAuth(scheme: "ApiKey", name: "Authorization", in: "header")
+service HttpApiKeyAuthService {
+    operations: [
+        OnlyHttpApiKeyAuth
+        OnlyHttpApiKeyAuthOptional
+        SameAsService
+    ]
+}
+
+@http(method: "GET", uri: "/OnlyHttpApiKeyAuth")
+@auth([httpApiKeyAuth])
+operation OnlyHttpApiKeyAuth {}
+
+@http(method: "GET", uri: "/OnlyHttpApiKeyAuthOptional")
+@auth([httpApiKeyAuth])
+@optionalAuth
+operation OnlyHttpApiKeyAuthOptional {}
+
+@http(method: "GET", uri: "/SameAsService")
+operation SameAsService {}

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

@@ -52,6 +52,29 @@
                     }
                 }
             }
+        },
+        "identity-and-auth-http-api-key-auth": {
+            "transforms": [
+                {
+                    "name": "includeServices",
+                    "args": {
+                        "services": ["identity.auth.httpApiKeyAuth#HttpApiKeyAuthService"]
+                    }
+                }
+            ],
+            "plugins": {
+                "typescript-codegen": {
+                    "service": "identity.auth.httpApiKeyAuth#HttpApiKeyAuthService",
+                    "targetNamespace": "HttpApiKeyAuthService",
+                    "package": "@smithy/identity-and-auth-http-api-key-auth-service",
+                    "packageVersion": "0.0.1",
+                    "packageJson": {
+                        "license": "Apache-2.0",
+                        "private": true
+                    },
+                    "experimentalIdentityAndAuth": true
+                }
+            }
         }
     },
     "plugins": {