feat: add e2e test suite (#235)

Until now, whilst some of the unit tests execute specific pieces of
generated code using the `node:vm` module, and the integration tests
check that typescript is happy to build the code, we haven't had very
comprehensive end-to-end tests in the repo.

This has meant manually checking changes in other (mostly private)
projects, which is a bit of a pain and not very transparent.

This PR aims to add end to end tests that actually run a koa service,
and make calls to it using a generated client. Coverage will be
relatively low to begin with and iteratively improved on over time.

It will hopefully also serve as a decent sample of what a service using
this project might look like.

Author: mnahkies

.gitattributes

@@ -3,5 +3,6 @@
 packages/openapi-code-generater/src/core/schemas/openapi-3.0-specification-validator.js binary
 packages/openapi-code-generater/src/core/schemas/openapi-3.1-specification-validator.js binary
 integration-tests/*/src/generated/** linguist-generated=true
+e2e/src/generated/** linguist-generated=true
 integration-tests-definitions/** linguist-vendored=true
 yarn.lock linguist-generated=true

.github/workflows/ci.yml

@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [20.x]
+        node-version: [20.x, 22.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
@@ -51,6 +51,11 @@ jobs:
       - run: yarn integration:generate
       - run: yarn integration:validate
 
+      - run: yarn workspace e2e clean
+      - run: yarn workspace e2e generate
+      - run: yarn workspace e2e build
+      - run: yarn workspace e2e test
+
       - name: Check for uncommitted changes
         run: ./scripts/assert-clean-working-directory.sh
 

biome.json

@@ -12,6 +12,7 @@
     "ignore": [
       "integration-tests/**/*",
       "integration-tests-definitions/**/*",
+      "e2e/src/generated/**/*",
       "schemas/*.json",
       "packages/*/package.json",
       "package.json"
@@ -42,6 +43,7 @@
       "packages/openapi-code-generator/src/core/schemas/openapi-3.1-specification-validator.js",
       "integration-tests/**/*",
       "integration-tests-definitions/**/*",
+      "e2e/src/generated/**/*",
       "schemas/*.json",
       "packages/*/package.json",
       "package.json"

e2e/jest.config.js

@@ -0,0 +1,12 @@
+const base = require("../jest.base")
+const {name: displayName} = require("./package.json")
+
+/**
+ * @type { import('@jest/types').Config.ProjectConfig }
+ */
+const config = {
+  ...base,
+  displayName,
+}
+
+module.exports = config

e2e/openapi.yaml

@@ -0,0 +1,57 @@
+openapi: "3.0.0"
+info:
+  title: E2E Tests for @nahkies/openapi-code-generator
+  version: "0.0.1"
+tags:
+  - name: validation
+paths:
+  /validation/numbers/random-number:
+    get:
+      tags:
+        - validation
+      parameters:
+        - name: max
+          in: query
+          schema:
+            type: number
+            minimum: 1
+            default: 10
+        - name: min
+          in: query
+          schema:
+            type: number
+            minimum: 0
+            default: 0
+        - name: forbidden
+          in: query
+          schema:
+            type: array
+            items:
+              type: number
+              format: int
+      responses:
+        200:
+          description: success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/RandomNumber'
+
+components:
+  schemas:
+    RandomNumber:
+      type: object
+      properties:
+        result:
+          type: number
+        params:
+          type: object
+          properties:
+            min:
+              type: number
+            max:
+              type: number
+            forbidden:
+              type: array
+              items:
+                type: number

e2e/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "e2e",
+  "version": "0.0.1",
+  "main": "./dist/index.js",
+  "author": "Michael Nahkies",
+  "license": "MIT",
+  "private": true,
+  "scripts": {
+    "clean": "rm -rf ./dist && rm -rf ./src/generated",
+    "generate": "./scripts/generate.sh",
+    "build": "tsc -p ./tsconfig.json",
+    "test": "jest",
+    "start": "node ./dist/index.js"
+  },
+  "dependencies": {
+    "@koa/router": "^12.0.1",
+    "@nahkies/typescript-koa-runtime": "*",
+    "koa": "^2.15.3",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@nahkies/openapi-code-generator": "*",
+    "@types/koa": "^2.15.0",
+    "@types/koa__router": "^12.0.4",
+    "jest": "^30.0.0-alpha.6",
+    "typescript": "~5.5.4"
+  }
+}

e2e/scripts/generate.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+echo $PWD
+
+yarn openapi-code-generator \
+  --input ./openapi.yaml \
+  --output ./src/generated \
+  --template typescript-koa \
+  --schema-builder zod \
+  --extract-inline-schemas \
+  --grouping-strategy first-tag
+
+yarn openapi-code-generator \
+  --input ./openapi.yaml \
+  --output ./src/generated/client \
+  --template typescript-fetch \
+  --schema-builder zod \
+  --extract-inline-schemas \
+  --grouping-strategy first-tag \