feat(tests): refactor E2E tests to use dedicated test data directory and update paths

JasonKrik · JasonKrik · commit ec1be60ef353 · 2025-06-05T18:50:28.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -58,6 +58,7 @@ services/backend/persistent_data/*
 
 # Test files
 services/backend/tests/.test-context.json
+services/backend/tests/e2e/test-data/*.db
 
 ._*.ts
 ._*.vue
diff --git a/services/backend/database/deploystack.test.db b/services/backend/database/deploystack.test.db
diff --git a/services/backend/jest.config.js b/services/backend/jest.config.js
@@ -1,7 +1,7 @@
 module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
-  testMatch: ['**/tests/**/*.test.ts'],
+  testMatch: ['**/tests/e2e/**/*.test.ts'],
   moduleNameMapper: {
     '^@src/(.*)$': '<rootDir>/src/$1',
   },
diff --git a/services/backend/src/routes/db/setup.ts b/services/backend/src/routes/db/setup.ts
@@ -30,8 +30,9 @@ async function setupDbHandler(
     // Determine DB path based on environment
     const isTestEnv = process.env.NODE_ENV === 'test';
     const sqliteDbFileName = isTestEnv ? 'deploystack.test.db' : 'deploystack.db';
-    // dbPath should be relative to services/backend, and the actual db file is usually in a 'database' subfolder
-    const sqliteDbPath = `database/${sqliteDbFileName}`; 
+    // dbPath should be relative to services/backend
+    // For tests, use the test-data directory; for production, use the database directory
+    const sqliteDbPath = isTestEnv ? `tests/e2e/test-data/${sqliteDbFileName}` : `database/${sqliteDbFileName}`;
 
     if (clientRequestBody.type === DatabaseType.SQLite) {
       internalConfigObject = { type: DatabaseType.SQLite, dbPath: sqliteDbPath };
diff --git a/services/backend/test.md b/services/backend/test.md
@@ -54,9 +54,9 @@ npm run test:backend
 This command will:
 
 1. Trigger Jest to find and execute all `*.e2e.test.ts` files within the `services/backend/tests/` directory.
-2. Execute a global setup script (`services/backend/tests/globalSetup.ts`) before any tests run. This script:
+2. Execute a global setup script (`services/backend/tests/e2e/globalSetup.ts`) before any tests run. This script:
    - Sets necessary environment variables for testing (e.g., `NODE_ENV=test`, a specific test port, a test encryption secret).
-   - Clears any existing test database files (`persistent_data/database/deploystack.db` and `persistent_data/db.selection.json`) to ensure a clean state.
+   - Clears any existing test database files from `tests/e2e/test-data/` and `persistent_data/` directories to ensure a clean state.
    - Programmatically starts the backend server on a dedicated test port.
 3. Run the tests.
 4. Execute a global teardown script (`services/backend/tests/globalTeardown.ts`) after all tests complete. This script stops the backend server.
@@ -109,7 +109,7 @@ When adding new E2E tests:
   - Ensures the test database file does not exist before setup.
   - Calls `POST /api/db/setup` with `{"type": "sqlite"}`.
   - Verifies the API response indicates successful setup initiation.
-  - Checks that the SQLite database file (`persistent_data/database/deploystack.db`) is created.
+  - Checks that the SQLite database file is created in the test data directory (`tests/e2e/test-data/deploystack.test.db`).
   - Calls `GET /api/db/status` and verifies the response shows `configured: true`, `initialized: true`, and `dialect: "sqlite"`.
   - Validates global settings initialization without errors.
   - Confirms all migrations are applied successfully.
diff --git a/services/backend/tests/e2e/1-setup.e2e.test.ts b/services/backend/tests/e2e/1-setup.e2e.test.ts
@@ -5,8 +5,8 @@ import * as path from 'path';
 import { getTestContext } from './testContext';
 
 // __dirname is services/backend/tests/e2e
-const APP_BACKEND_ROOT = path.join(__dirname, '..', '..'); // Resolves to services/backend/
-const DB_FILE_PATH = path.join(APP_BACKEND_ROOT, 'database', 'deploystack.test.db'); // Path where the app creates the db
+const TEST_DATA_DIR = path.join(__dirname, 'test-data'); // Resolves to services/backend/tests/e2e/test-data
+const DB_FILE_PATH = path.join(TEST_DATA_DIR, 'deploystack.test.db'); // Path where the app creates the test db
 
 describe('POST /api/db/setup and GET /api/db/status (E2E)', () => {
   let server: FastifyInstance;
diff --git a/services/backend/tests/e2e/2-user-registration.e2e.test.ts b/services/backend/tests/e2e/2-user-registration.e2e.test.ts
@@ -5,8 +5,8 @@ import * as path from 'path';
 import { getTestContext, updateTestContext } from './testContext';
 
 // __dirname is services/backend/tests/e2e
-const APP_BACKEND_ROOT = path.join(__dirname, '..', '..'); // Resolves to services/backend/
-const DB_FILE_PATH = path.join(APP_BACKEND_ROOT, 'database', 'deploystack.test.db'); // Path where the app creates the db
+const TEST_DATA_DIR = path.join(__dirname, 'test-data'); // Resolves to services/backend/tests/e2e/test-data
+const DB_FILE_PATH = path.join(TEST_DATA_DIR, 'deploystack.test.db'); // Path where the app creates the test db
 
 describe('User Registration E2E Tests', () => {
   let server: FastifyInstance;
diff --git a/services/backend/tests/e2e/3-email-login.e2e.test.ts b/services/backend/tests/e2e/3-email-login.e2e.test.ts
@@ -5,8 +5,8 @@ import * as path from 'path';
 import { getTestContext, updateTestContext } from './testContext';
 
 // __dirname is services/backend/tests/e2e
-const APP_BACKEND_ROOT = path.join(__dirname, '..', '..'); // Resolves to services/backend/
-const DB_FILE_PATH = path.join(APP_BACKEND_ROOT, 'database', 'deploystack.test.db'); // Path where the app creates the db
+const TEST_DATA_DIR = path.join(__dirname, 'test-data'); // Resolves to services/backend/tests/e2e/test-data
+const DB_FILE_PATH = path.join(TEST_DATA_DIR, 'deploystack.test.db'); // Path where the app creates the test db
 
 describe('Email Login and Logout E2E Tests', () => {
   let server: FastifyInstance;
diff --git a/services/backend/tests/e2e/4-global-settings-check.e2e.test.ts b/services/backend/tests/e2e/4-global-settings-check.e2e.test.ts
@@ -59,7 +59,7 @@ async function getDefinedCoreSettingKeys(): Promise<string[]> {
 describe('Global Settings Initialization Check', () => {
   // __dirname is services/backend/tests/e2e
   const APP_BACKEND_ROOT = path.join(__dirname, '..', '..'); // Resolves to services/backend/
-  const dbPath = path.join(APP_BACKEND_ROOT, 'database', 'deploystack.test.db'); // Correct path
+  const dbPath = path.join(__dirname, 'test-data', 'deploystack.test.db'); // Correct path for test data
   let db: Database.Database;
 
   beforeAll(() => {
diff --git a/services/backend/tests/e2e/5-global-settings-api-access.e2e.test.ts b/services/backend/tests/e2e/5-global-settings-api-access.e2e.test.ts
@@ -6,7 +6,7 @@ import { getTestContext } from './testContext';
 
 // __dirname is services/backend/tests/e2e
 const APP_BACKEND_ROOT = path.join(__dirname, '..', '..'); // Resolves to services/backend/
-const DB_FILE_PATH = path.join(APP_BACKEND_ROOT, 'database', 'deploystack.test.db'); // Path where the app creates the db
+const DB_FILE_PATH = path.join(__dirname, 'test-data', 'deploystack.test.db'); // Path where the app creates the test db
 
 describe('Global Settings Access Control E2E Tests', () => {
   let server: FastifyInstance;
diff --git a/services/backend/tests/e2e/6-global-settings-helpers.e2e.test.ts b/services/backend/tests/e2e/6-global-settings-helpers.e2e.test.ts
@@ -8,7 +8,7 @@ import { initializeDatabase } from '../../src/db';
 
 // __dirname is services/backend/tests/e2e
 const APP_BACKEND_ROOT = path.join(__dirname, '..', '..'); // Resolves to services/backend/
-const DB_FILE_PATH = path.join(APP_BACKEND_ROOT, 'database', 'deploystack.test.db'); // Path where the app creates the db
+const DB_FILE_PATH = path.join(__dirname, 'test-data', 'deploystack.test.db'); // Path where the app creates the test db
 
 describe('Global Settings Helper Methods E2E Tests', () => {
   let server: FastifyInstance;
diff --git a/services/backend/tests/e2e/globalSetup.ts b/services/backend/tests/e2e/globalSetup.ts
@@ -24,20 +24,19 @@ export default async function globalSetup() {
     await fs.ensureDir(PERSISTENT_DATA_PATH); // Ensure persistent_data directory itself exists
     console.log(`[TEST_SETUP_DEBUG] Ensured directory exists: ${PERSISTENT_DATA_PATH}`);
 
-    // Define path to the actual database file and its directory
-    const APP_BACKEND_ROOT = path.join(__dirname, '..', '..'); // services/backend/
-    const ACTUAL_DB_DIR = path.join(APP_BACKEND_ROOT, 'database');
-    const ACTUAL_DB_FILE = path.join(ACTUAL_DB_DIR, 'deploystack.test.db');
+    // Define path to the test database file and its directory
+    const TEST_DATA_DIR = path.join(__dirname, 'test-data'); // services/backend/tests/e2e/test-data
+    const TEST_DB_FILE = path.join(TEST_DATA_DIR, 'deploystack.test.db');
 
-    // Clean up the actual database file if it exists from a previous run
-    if (await fs.pathExists(ACTUAL_DB_FILE)) {
-      await fs.remove(ACTUAL_DB_FILE);
-      console.log(`[TEST_SETUP_DEBUG] Removed actual database file: ${ACTUAL_DB_FILE}`);
+    // Clean up the test database file if it exists from a previous run
+    if (await fs.pathExists(TEST_DB_FILE)) {
+      await fs.remove(TEST_DB_FILE);
+      console.log(`[TEST_SETUP_DEBUG] Removed test database file: ${TEST_DB_FILE}`);
     }
     
-    // Ensure the actual database directory exists
-    await fs.ensureDir(ACTUAL_DB_DIR);
-    console.log(`[TEST_SETUP_DEBUG] Ensured actual database directory exists: ${ACTUAL_DB_DIR}`);
+    // Ensure the test data directory exists
+    await fs.ensureDir(TEST_DATA_DIR);
+    console.log(`[TEST_SETUP_DEBUG] Ensured test data directory exists: ${TEST_DATA_DIR}`);
 
     // IMPORTANT: The /api/db/setup endpoint, called by the first test,
     // will be responsible for creating db.selection.test.json and the actual
diff --git a/services/backend/tests/e2e/globalTeardown.ts b/services/backend/tests/e2e/globalTeardown.ts
@@ -1,11 +1,39 @@
 // globalTeardown.ts
 import { FastifyInstance } from 'fastify';
+import * as fs from 'fs-extra';
+import * as path from 'path';
 
 export default async function globalTeardown() {
   const server = global.__TEST_SERVER__ as FastifyInstance | undefined;
 
-  if (server) {
-    await server.close();
-    console.log('\nTest server stopped.');
+  try {
+    // Close the test server
+    if (server) {
+      await server.close();
+      console.log('\nTest server stopped.');
+    }
+
+    // Clean up test database and related files
+    const APP_BACKEND_ROOT = path.join(__dirname, '..', '..'); // services/backend/
+    const TEST_DATA_DIR = path.join(__dirname, 'test-data'); // services/backend/tests/e2e/test-data
+    const TEST_DB_FILE = path.join(TEST_DATA_DIR, 'deploystack.test.db');
+    const PERSISTENT_DATA_PATH = path.join(APP_BACKEND_ROOT, 'persistent_data');
+
+    // Remove test database file if it exists
+    if (await fs.pathExists(TEST_DB_FILE)) {
+      await fs.remove(TEST_DB_FILE);
+      console.log(`[TEST_TEARDOWN_DEBUG] Removed test database file: ${TEST_DB_FILE}`);
+    }
+
+    // Clean up persistent_data directory used for tests
+    if (await fs.pathExists(PERSISTENT_DATA_PATH)) {
+      await fs.remove(PERSISTENT_DATA_PATH);
+      console.log(`[TEST_TEARDOWN_DEBUG] Removed test persistent data directory: ${PERSISTENT_DATA_PATH}`);
+    }
+
+    console.log('Test cleanup completed successfully.');
+  } catch (error) {
+    console.error('Error during test teardown:', error);
+    // Don't throw the error to avoid masking test results
   }
 }
diff --git a/services/backend/tests/e2e/test-data/.gitkeep b/services/backend/tests/e2e/test-data/.gitkeep
