test: add e2e test for quickstart command (#699)

* test: add e2e test for quickstart command

* fix: exit code

* test: update test coverage

---------

Co-authored-by: Gergely Békési <gergely.bekesi@ethswarm.org>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: 3 people

.github/workflows/tests-e2e.yaml

@@ -0,0 +1,29 @@
+name: Tests (End-to-end)
+
+on:
+  push:
+    branches:
+      - 'master'
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  tests-e2e:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 24.x
+
+      - name: Install local dependencies
+        run: npm ci
+
+      - name: Tests
+        run: npm run test.e2e
+

jest-e2e.config.ts

@@ -0,0 +1,32 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/en/configuration.html
+ */
+import type { Config } from '@jest/types'
+import { Dates } from 'cafe-utility'
+
+export default (): Config.InitialOptions => {
+  return {
+    collectCoverage: false,
+    forceExit: true,
+
+    // Run tests from one or more projects
+    projects: [
+      {
+        preset: 'ts-jest',
+        displayName: 'node',
+        testEnvironment: 'node',
+        testRegex: 'test/e2e/.*\\.spec\\.ts',
+      },
+    ] as unknown[] as string[], // bad types
+
+    // The root directory that Jest should scan for tests and modules within
+    rootDir: 'test',
+
+    // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+    testPathIgnorePatterns: ['/node_modules/'],
+
+    // Increase timeout since we have long running cryptographic functions
+    testTimeout: Dates.minutes(6),
+  }
+}

jest.config.ts

@@ -75,7 +75,7 @@ export default async (): Promise<Config.InitialOptions> => {
     rootDir: 'test',
 
     // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-    testPathIgnorePatterns: ['/node_modules/'],
+    testPathIgnorePatterns: ['/node_modules/', '/test/e2e/'],
 
     // Increase timeout since we have long running cryptographic functions
     testTimeout: Dates.minutes(6),

package.json

@@ -26,6 +26,7 @@
     "prepare": "npm run build",
     "build": "rimraf dist && tsc",
     "test": "jest --config=jest.config.ts",
+    "test.e2e": "jest --config=jest-e2e.config.ts",
     "test:coverage": "jest --config=jest.config.ts --coverage",
     "check": "tsc --project tsconfig.test.json",
     "start": "ts-node src/index.ts",

test/e2e/quickstart-e2e.spec.ts

@@ -0,0 +1,35 @@
+import inquirer from 'inquirer'
+import { mkdirSync, rmSync } from 'fs'
+import { describeCommand, invokeTestCli } from '../utility'
+import { spawn } from 'child_process'
+
+describeCommand('Test Quickstart command end-to-end', ({ hasMessageContaining, getLastMessage }) => {
+  it('should run through the quickstart flow', async () => {
+    mkdirSync('./tmp')
+
+    const originalCwd = process.cwd()
+    process.chdir('./tmp')
+    jest.spyOn(inquirer, 'prompt').mockResolvedValueOnce({ value: 'ultra-light' })
+    await invokeTestCli(['quickstart'])
+    process.chdir(originalCwd)
+    expect(getLastMessage()).toContain('./bee start --config=bee.yaml')
+
+    const sleep = (ms: number) => new Promise(r => setTimeout(r, ms))
+    const node = spawn('./bee', ['start', '--config=bee.yaml'], { cwd: './tmp' })
+    try {
+      await (async () => {
+        for (let i = 0; i < 30; i++) {
+          await invokeTestCli(['status'])
+
+          if (hasMessageContaining('[OK]')) return
+          await sleep(1000)
+        }
+        throw new Error('Node did not start in time')
+      })()
+    } finally {
+      node.kill('SIGINT')
+      await new Promise(resolve => node.on('exit', resolve))
+      rmSync('./tmp', { recursive: true, force: true })
+    }
+  })
+})