Add runnable target for e2e test CDK stacks (#60)

Author: pcholakov

Diff for: .gitignore

@@ -1,6 +1,8 @@
 .idea
+.zed
 *.js
-!jest.config.js
+*.sh
+!jest.config*.js
 !test/handlers/handler.js
 *.d.ts
 node_modules

Diff for: jest.config.base.js

@@ -0,0 +1,6 @@
+module.exports = {
+  testEnvironment: "node",
+  transform: {
+    "^.+\\.tsx?$": "ts-jest",
+  },
+};

Diff for: jest.config.e2e.js

@@ -0,0 +1,8 @@
+const baseConfig = require("./jest.config.base");
+
+module.exports = {
+  ...baseConfig,
+  roots: ["<rootDir>/test"],
+  testMatch: ["<rootDir>/test/e2e/**/*.e2e.ts"],
+  testTimeout: 600_000,
+};

Diff for: jest.config.js

@@ -1,8 +1,9 @@
+const baseConfig = require("./jest.config.base");
+
 module.exports = {
-  testEnvironment: "node",
+  ...baseConfig,
   roots: ["<rootDir>/test"],
-  testMatch: ["**/*.test.ts"],
-  transform: {
-    "^.+\\.tsx?$": "ts-jest",
-  },
+  testMatch: ["<rootDir>/test/**/*.test.ts"],
+  // Exclude E2E tests
+  testPathIgnorePatterns: ["/node_modules/", "/test/e2e/"],
 };

Diff for: package-lock.json

@@ -20,7 +20,8 @@
     "prebundle": "rm -rf dist",
     "postbundle": "cd dist && zip -r index.zip index.js*",
     "watch": "tsc -w",
-    "test": "jest",
+    "test": "jest --config jest.config.js",
+    "test:e2e": "npx tsx test/handlers/build.mts && jest --config jest.config.e2e.js",
     "lint": "npx prettier --check .",
     "cdk": "cdk"
   },
@@ -37,7 +38,8 @@
     "source-map-support": "^0.5.21",
     "ts-jest": "^29.2.5",
     "tsx": "^4.19.2",
-    "typescript": "^5.7.0"
+    "typescript": "^5.7.0",
+    "zx": "^8.3.2"
   },
   "peerDependencies": {
     "@aws-sdk/client-secrets-manager": "^3.637.0",

Diff for: package.json

@@ -0,0 +1,11 @@
+## Restate CDK e2e tests
+
+The CDK stacks in this directory serve a dual purpose of providing usage examples, and validation targets during development.
+
+Some of these are wrapped in e2e tests you can run with:
+
+```shell
+npm run test:e2e
+```
+
+To run the automated e2e tests, you'll generally need valid AWS or Restate Cloud credentials. To speed things up you can set `RETAIN_STACK=true`.

Diff for: test/e2e/README.md

@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) 2023-2025 - Restate Software, Inc., Restate GmbH
+ *
+ * This file is part of the Restate SDK for Node.js/TypeScript,
+ * which is released under the MIT license.
+ *
+ * You can find a copy of the license in file LICENSE in the root
+ * directory of this repository or package, or at
+ * https://github.com/restatedev/cdk/blob/main/LICENSE
+ */
+
+import { $, cd, path } from "zx";
+
+export interface CdkStackProps {
+  stackName: string;
+  cdkAppPath: string;
+}
+
+interface StackOutput {
+  OutputKey: string;
+  OutputValue: string;
+  Description?: string;
+}
+
+export async function createStack(config: CdkStackProps): Promise<Record<string, string>> {
+  const retainStack = new Boolean(process.env["RETAIN_STACK"]).valueOf();
+
+  cd(path.resolve(__dirname));
+  await $`npx cdk --app 'npx tsx ${config.cdkAppPath}' deploy \
+          --context stack_name="${config.stackName}" \
+          --output "cdk.${config.stackName}.out" \
+          --require-approval never \
+          ${retainStack ? "--no-rollback" : ""}`.timeout("575s");
+
+  const result =
+    await $`aws cloudformation describe-stacks --stack-name "${config.stackName}" --query 'Stacks[0].Outputs'`;
+
+  const outputs: StackOutput[] = JSON.parse(result.stdout);
+  return outputs.reduce(
+    (acc, output) => ({
+      ...acc,
+      [output.OutputKey]: output.OutputValue,
+    }),
+    {},
+  );
+}
+
+export async function destroyStackAsync(stackName: string) {
+  const retainStack = new Boolean(process.env["RETAIN_STACK"]).valueOf();
+
+  if (retainStack) {
+    console.log(`Retaining stack "${stackName}"`);
+  } else {
+    console.log(`Asynchronously deleting stack "${stackName}"...`);
+    await $`aws cloudformation delete-stack --stack-name "${stackName}"`;
+  }
+}
+
+export async function destroyStack(config: CdkStackProps) {
+  const retainStack = new Boolean(process.env["RETAIN_STACK"]).valueOf();
+
+  if (retainStack) {
+    console.log(`Retaining stack "${config.stackName}"`);
+  } else {
+    await $`npx cdk --app 'npx tsx ${config.cdkAppPath}' destroy \
+      --context stack_name=${config.stackName} \
+      --output "cdk.${config.stackName}.out" \
+      --force`.timeout("595s");
+  }
+}

Diff for: test/e2e/cdk-util.ts

@@ -1,33 +1,32 @@
 /*
- * Copyright (c) 2024 - Restate Software, Inc., Restate GmbH
+ * Copyright (c) 2023-2025 - Restate Software, Inc., Restate GmbH
  *
  * This file is part of the Restate SDK for Node.js/TypeScript,
  * which is released under the MIT license.
  *
  * You can find a copy of the license in file LICENSE in the root
  * directory of this repository or package, or at
- * https://github.com/restatedev/sdk-typescript/blob/main/LICENSE
+ * https://github.com/restatedev/cdk/blob/main/LICENSE
  */
 
 import * as cdk from "aws-cdk-lib";
+import * as ec2 from "aws-cdk-lib/aws-ec2";
 import * as lambda from "aws-cdk-lib/aws-lambda";
 import * as logs from "aws-cdk-lib/aws-logs";
-import "source-map-support/register";
-
 import { ServiceDeployer, SingleNodeRestateDeployment } from "../../lib/restate-constructs";
-import * as ec2 from "aws-cdk-lib/aws-ec2";
 
-// Deploy with: npx cdk --app 'npx tsx single-node-ec2.e2e.ts' deploy --context vpc_id=...
+// Deploy with: npx cdk --app 'npx tsx ec2-simple-stack.ts' deploy --context vpc_id=...
 const app = new cdk.App();
-const stack = new cdk.Stack(app, "e2e-RestateSingleNode", {
+const stackName = app.node.tryGetContext("stack_name") ?? "e2e-RestateSingleNode";
+const stack = new cdk.Stack(app, stackName, {
   env: {
     account: process.env.CDK_DEFAULT_ACCOUNT,
     region: process.env.CDK_DEFAULT_REGION,
   },
 });
 
 const handler: lambda.Function = new lambda.Function(stack, "Service", {
-  runtime: lambda.Runtime.NODEJS_LATEST,
+  runtime: lambda.Runtime.NODEJS_22_X,
   code: lambda.Code.fromAsset("../handlers/dist/"),
   handler: "bundle.handler",
 });
@@ -55,8 +54,8 @@ const environment = new SingleNodeRestateDeployment(stack, "Restate", {
 // Safer option: add the deployer to the VPC + security group
 const deployer = new ServiceDeployer(stack, "ServiceDeployer", {
   vpc: environment.vpc,
-  allowPublicSubnet: true, // necessary to deploy to a public subnet - it's ok, deployer doesn't need the internet
-  securityGroups: [environment.adminSecurityGroup],
+  allowPublicSubnet: true, // necessary to deploy to a public VPC subnet - no internet access but we don't need it
+  securityGroups: [environment.adminSecurityGroup], // the admin SG can access the admin port 9070
   removalPolicy: cdk.RemovalPolicy.DESTROY,
   entry: "../../dist/register-service-handler/index.js", // only needed for in-tree tests
 });