chore: more testing examples

Author: lmammino

10-testing/15-integration-test/README.md

@@ -1,11 +1,36 @@
-# 13-unit-test-mock-other-modules
+# 15-integration-test
 
-Demonstrates how to mock internal or third-party modules
+Demonstrates how create an integration test
+
+## Dependencies
+
+This example requires you to install some third-party dependencies from npm.
+
+If you have `pnpm` installed, you can do that with:
+
+```bash
+pnpm install
+```
+
+Alternatively, if you prefer to use another package manager, make sure to delete
+the `pnpm-lock.yaml` file before using it.
+
+If you want to use `npm`, you can run:
+
+```bash
+npm install
+```
+
+If you want to use `yarn`, you can run:
+
+```bash
+yarn install
+```
 
 ## Run
 
 To run the example launch:
 
 ```
-node --test  --experimental-test-module-mocks
+node --test
 ```

10-testing/15-integration-test/package.json

@@ -1,7 +1,7 @@
 {
-  "name": "13-unit-test-mock-other-modules",
+  "name": "15-integration-test",
   "version": "1.0.0",
-  "description": "Demonstrates how to mock internal or third-party modules",
+  "description": "Demonstrates how create an integration test",
   "type": "module",
   "scripts": {},
   "engines": {

10-testing/16-integration-test-http/.gitignore

@@ -0,0 +1 @@
+data/**/*.sqlite

10-testing/16-integration-test-http/README.md

@@ -0,0 +1,87 @@
+# 16-integration-test-http
+
+Demonstrates how to create an integration test for an HTTP server using Fastify.
+
+## Dependencies
+
+This example requires you to install some third-party dependencies from npm.
+
+If you have `pnpm` installed, you can do that with:
+
+```bash
+pnpm install
+```
+
+Alternatively, if you prefer to use another package manager, make sure to delete
+the `pnpm-lock.yaml` file before using it.
+
+If you want to use `npm`, you can run:
+
+```bash
+npm install
+```
+
+If you want to use `yarn`, you can run:
+
+```bash
+yarn install
+```
+
+## Run
+
+To run the example launch:
+
+```
+node --test
+```
+
+## Try the app
+
+Start the webserver with:
+
+```bash
+node server.js
+```
+
+This will make the server available at `http://localhost:3000/`
+
+You can now create a new event with a request like the following:
+
+```bash
+curl \ 
+  -X POST \ 
+  -H 'Content-Type: application/json' \ 
+  -d '{"name":"sample event", "totalSeats": 22}' \ 
+  http://localhost:3000/events
+```
+
+This should return a 201 Created response with the event id in the body, for
+example:
+
+```json
+{
+  "success":true,
+  "eventId":"21cd8fdf-95e5-4253-9ca4-7291c63f25e7"
+}⏎
+```
+
+Now you can create reservations for the event with a request like the following
+(make sure to update the event id in the URL):
+
+```bash
+curl \
+  -X POST \
+  -H 'Content-Type: application/json' \
+  -d '{"userId": "John"}' \
+  http://localhost:3000/events/21cd8fdf-95e5-4253-9ca4-7291c63f25e7/reservations
+```
+
+If the reservation is successful, you should get a 201 Created response with the
+reservation id in the body, for example:
+
+```json
+{
+  "success": true,
+  "reservationId": "21cd8fdf-95e5-4253-9ca4-7291c63f25e7"
+}
+```

10-testing/16-integration-test-http/app.js

@@ -0,0 +1,13 @@
+import Fastify from 'fastify'
+import { bookEventRoute } from './routes/bookEvent.js'
+import { createEventRoute } from './routes/createEvent.js'
+
+export async function createApp(db) {
+  const app = Fastify()
+  app.decorate('db', db)
+
+  await app.register(bookEventRoute)
+  await app.register(createEventRoute)
+
+  return app
+}

10-testing/16-integration-test-http/booking.int.test.js

@@ -0,0 +1,65 @@
+import assert from 'node:assert/strict'
+import { suite, test } from 'node:test'
+import { createApp } from './app.js'
+import { DbClient } from './dbClient.js'
+import { createTables } from './dbSetup.js'
+
+suite('Booking integration tests', { concurrency: true }, () => {
+  test('Reserving a seat works until full', async () => {
+    const db = new DbClient(':memory:')
+    await createTables(db)
+    const app = await createApp(db)
+
+    const createEventResponse = await app.inject({
+      method: 'POST',
+      url: '/events',
+      payload: { name: 'Event 1', totalSeats: 2 },
+    })
+    assert.equal(createEventResponse.statusCode, 201)
+    const eventData = createEventResponse.json()
+    const reserveUrl = `/events/${eventData.eventId}/reservations`
+
+    const res1 = await app.inject({
+      method: 'POST',
+      url: reserveUrl,
+      payload: { userId: 'u1' },
+    })
+    assert.equal(res1.statusCode, 201)
+
+    const res2 = await app.inject({
+      method: 'POST',
+      url: reserveUrl,
+      payload: { userId: 'u2' },
+    })
+    assert.equal(res2.statusCode, 201)
+
+    const res3 = await app.inject({
+      method: 'POST',
+      url: reserveUrl,
+      payload: { userId: 'u3' },
+    })
+    assert.equal(res3.statusCode, 403)
+    assert.deepEqual(await res3.json(), { error: 'Event is fully booked' })
+
+    await db.close()
+    await app.close()
+  })
+
+  test('Returns 404 if event does not exist', async () => {
+    const db = new DbClient(':memory:')
+    await createTables(db)
+    const app = await createApp(db)
+
+    const res = await app.inject({
+      method: 'POST',
+      url: '/events/unknown/reservations',
+      payload: { userId: 'u1' },
+    })
+
+    assert.equal(res.statusCode, 404)
+    assert.deepEqual(await res.json(), { error: 'Event not found' })
+
+    await db.close()
+    await app.close()
+  })
+})

10-testing/16-integration-test-http/booking.js

@@ -0,0 +1,37 @@
+import { randomUUID } from 'node:crypto'
+
+export async function reserveSeat(db, eventId, userId) {
+  const [event] = await db.query('SELECT * FROM events WHERE id = ?', [eventId])
+  if (!event) {
+    throw new Error('Event not found')
+  }
+
+  const existing = await db.query(
+    // biome-ignore lint/nursery/noSecrets: <explanation>
+    'SELECT COUNT(*) AS count FROM reservations WHERE eventId = ?',
+    [eventId]
+  )
+
+  if (existing[0].count >= event.totalSeats) {
+    throw new Error('Event is fully booked')
+  }
+
+  const reservationId = randomUUID()
+
+  await db.query(
+    'INSERT INTO reservations (id, eventId, userId) VALUES (?, ?, ?)',
+    [reservationId, eventId, userId]
+  )
+
+  return reservationId
+}
+
+export async function createEvent(db, name, totalSeats) {
+  const eventId = randomUUID()
+  await db.query('INSERT INTO events (id, name, totalSeats) VALUES (?, ?, ?)', [
+    eventId,
+    name,
+    totalSeats,
+  ])
+  return eventId
+}

10-testing/16-integration-test-http/data/.gitkeep

@@ -0,0 +1,37 @@
+import { open } from 'sqlite'
+import sqlite3 from 'sqlite3'
+
+export class DbClient {
+  #dbPath
+  #db
+
+  constructor(dbPath) {
+    this.#dbPath = dbPath
+    this.#db = null
+  }
+
+  async #connect() {
+    if (this.#db) {
+      return this.#db
+    }
+
+    this.#db = await open({
+      filename: this.#dbPath,
+      driver: sqlite3.Database,
+    })
+
+    return this.#db
+  }
+
+  async query(sql, params = {}) {
+    const db = await this.#connect()
+    return db.all(sql, params)
+  }
+
+  async close() {
+    if (this.#db) {
+      await this.#db.close()
+      this.#db = null
+    }
+  }
+}

10-testing/16-integration-test-http/dbClient.js

@@ -0,0 +1,18 @@
+export async function createTables(db) {
+  await db.query(`
+    CREATE TABLE IF NOT EXISTS events (
+      id TEXT PRIMARY KEY,
+      name TEXT NOT NULL,
+      totalSeats INTEGER NOT NULL
+    )
+  `)
+
+  await db.query(`
+    CREATE TABLE IF NOT EXISTS reservations (
+      id TEXT PRIMARY KEY,
+      eventId TEXT NOT NULL,
+      userId TEXT NOT NULL,
+      UNIQUE(eventId, userId)
+    )
+  `)
+}