End to end test example

.github/workflows/pre-release.yml

@@ -42,6 +42,10 @@ jobs:
         if: github.event.inputs.sdkTypescriptVersion != ''
         run: npm --prefix typescript run verify --workspaces
 
+      - name: "Test typescript-end-to-end-testing example"
+        working-directory: ./typescript/end-to-end-testing
+        run: npm ci && npm run proto && npm run test
+
       # Setup Java
       - uses: actions/setup-java@v3
         if: github.event.inputs.sdkJavaVersion != ''

.github/workflows/release.yml

@@ -31,6 +31,7 @@ jobs:
             typescript-hello-world-lambda.zip
             typescript-hello-world-lambda-cdk.zip
             typescript-dynamic-workflow-executor.zip
+            typescript-end-to-end-testing.zip
             java-hello-world-http.zip
             java-hello-world-lambda.zip
             java-food-ordering.zip

.github/workflows/test.yml

@@ -80,3 +80,7 @@ jobs:
 
       - run: npm ci --prefix typescript
       - run: npm run --prefix typescript -ws verify
+
+      - name: "Test typescript-end-to-end-testing example"
+        working-directory: ./typescript/end-to-end-testing
+        run: npm ci && npm run proto && npm run test

README.md

@@ -68,6 +68,11 @@ wget https://github.com/restatedev/examples/releases/latest/download/kotlin-hell
 wget https://github.com/restatedev/examples/releases/latest/download/typescript-payment-api.zip && unzip typescript-payment-api.zip -d typescript-payment-api && rm typescript-payment-api.zip
 ```
 
+[End-to-end testing](typescript/end-to-end-testing): Example of how to test Restate services end-to-end
+```shell
+wget https://github.com/restatedev/examples/releases/latest/download/typescript-end-to-end-testing.zip && unzip typescript-end-to-end-testing.zip -d typescript-end-to-end-testing && rm typescript-end-to-end-testing.zip
+```
+
 ## Applications
 
 ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)

scripts/prepare_release_zip.sh

@@ -26,6 +26,7 @@ create_release_zip kotlin hello-world-lambda-cdk
 
 create_release_zip typescript hello-world-lambda
 create_release_zip typescript hello-world-lambda-cdk
+create_release_zip typescript end-to-end-testing
 create_release_zip typescript ecommerce-store
 create_release_zip typescript food-ordering
 create_release_zip typescript payment-api

typescript/end-to-end-testing/.gitignore

@@ -0,0 +1,5 @@
+**/node_modules
+**/dist
+**/.vscode
+**/.idea
+**/generated

typescript/end-to-end-testing/README.md

@@ -0,0 +1,27 @@
+# Typescript End to End service test example
+
+Restate is a system for easily building resilient applications using **distributed durable RPC & async/await**.
+
+This example shows how to test Restate services by deploying Restate with [TestContainers](https://node.testcontainers.org/). It is loosely based on the [Typescript gRPC template](https://github.com/restatedev/node-template-generator#grpc-variant).
+
+## Download the example
+
+```shell
+wget https://github.com/restatedev/examples/releases/latest/download/typescript-end-to-end-testing.zip && unzip typescript-end-to-end-testing.zip -d typescript-end-to-end-testing && rm typescript-end-to-end-testing.zip
+```
+
+## Run
+
+Install the dependencies and run the `buf` code generation first:
+
+```shell
+npm install & npm run proto
+```
+
+Now you can run the tests:
+
+```shell
+npm run test
+```
+
+If you are encountering errors, try to pull the latest docker image: `docker pull docker.io/restatedev/restate:latest`.

typescript/end-to-end-testing/jest.config.js

@@ -0,0 +1,9 @@
+module.exports = {
+  roots: ["<rootDir>/test"],
+  testMatch: ["**/?(*.)+(spec|test).+(ts|tsx|js)"],
+  transform: {
+    "^.+\\.(ts|tsx)$": "ts-jest",
+  },
+  preset: "ts-jest",
+  testEnvironment: "node",
+};