plum-e2e 1.0.0

package/backend/services/testService.js

@@ -0,0 +1,70 @@
+/*
+ * This file is part of Plum.
+ *
+ * Plum is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Plum is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Plum. If not, see https://www.gnu.org/licenses/.
+ */
+
+const fs = require('fs');
+const path = require('path');
+
+const FEATURES_DIR = path.join(__dirname, '../tests/features');
+
+const getTestSuites = () => {
+	const suites = [];
+
+	const files = fs.readdirSync(FEATURES_DIR).filter((file) => file.endsWith('.feature'));
+
+	files.forEach((file) => {
+		const content = fs.readFileSync(path.join(FEATURES_DIR, file), 'utf8');
+
+		let suiteName = '';
+		let suiteTags = [];
+		const tests = [];
+
+		// Suites Tag Extractor
+		const featureMatch = content.match(/Feature:\s*(.+)/);
+		if (featureMatch) {
+			suiteName = featureMatch[1].trim();
+		}
+
+		const suiteTagsMatch = content.match(/^(@[^\n]+)/m);
+		if (suiteTagsMatch) {
+			suiteTags = suiteTagsMatch[0].split(/\s+/).filter((tag) => tag.trim() !== ''); // Remove empty elements
+		}
+
+		// Test Cases Tag Extractor
+		const scenarioMatches = [...content.matchAll(/(@[^\n]+)\s*Scenario:\s*(.+)/g)];
+		scenarioMatches.forEach((match) => {
+			const tags = match[1].split(/\s+/).filter((tag) => tag.trim() !== ''); // Remove empty elements
+			const scenarioText = match[2].trim();
+
+			if (tags.length === 0) return; // Skip if there are no valid tags
+
+			const testId = tags.shift(); // Extract the first tag as testId
+
+			tests.push({
+				id: tags.length > 0 ? [testId, ...tags] : testId, // Ensure testId is correctly structured
+				testCase: scenarioText
+			});
+		});
+
+		if (suiteName && tests.length) {
+			suites.push({ suiteName, suiteId: suiteTags.length > 1 ? suiteTags : suiteTags[0], tests });
+		}
+	});
+
+	return { suites };
+};
+
+module.exports = { getTestSuites };

package/backend/websockets/socketHandler.js

@@ -0,0 +1,46 @@
+/*
+ * This file is part of Plum.
+ *
+ * Plum is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Plum is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Plum. If not, see https://www.gnu.org/licenses/.
+ */
+
+const { spawn } = require('child_process');
+
+const socketHandler = (io) => {
+	io.on('connection', (socket) => {
+		console.log('WebSocket connection established');
+		socket.on('run-test', (testID) => {
+			const tag = testID ? `${testID}` : '';
+
+			const testProcess = spawn('npm', ['run', 'test'], {
+				env: { ...process.env, TAG: tag, TRIGGER: 'manual-trigger' }
+			});
+
+			testProcess.stdout.on('data', (data) => {
+				socket.emit('log', data.toString());
+			});
+
+			testProcess.stderr.on('data', (data) => {
+				socket.emit('log', `[ERROR] ${data.toString()}`);
+			});
+
+			testProcess.on('close', (code) => {
+				socket.emit('log', `Test finished with code ${code}`);
+				socket.emit('done');
+			});
+		});
+	});
+};
+
+module.exports = socketHandler;

package/bin/plum.js

@@ -0,0 +1,188 @@
+#!/usr/bin/env node
+/*
+ * This file is part of Plum.
+ *
+ * Plum is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Plum is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Plum. If not, see https://www.gnu.org/licenses/.
+ */
+
+import { execSync } from 'child_process';
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import fse from 'fs-extra';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const command = process.argv[2];
+const plumRoot = path.resolve(__dirname, '..');
+const userTestsPath = path.join(process.cwd(), 'tests');
+const scaffoldTestsPath = path.join(plumRoot, 'backend', '_scaffold');
+const overrideFilePath = path.join(plumRoot, 'docker-compose.override.yml');
+
+// Paths for .env file
+const rootEnvPath = path.join(process.cwd(), '.env');
+const backendEnvPath = path.join(plumRoot, 'backend', '.env');
+
+// Function to create the .env file with default values NOTE: DO NOT FORMAT envContent
+function createEnvFile() {
+	const envFilePath = path.join(process.cwd(), '.env');
+
+	// Check if .env file already exists
+	if (fs.existsSync(envFilePath)) {
+		copyEnvFile();
+		console.log('⚠️ .env file already exists. Syncing .env file...\n');
+		return; // Exit if file exists
+	}
+
+	// Default content for .env file
+	const envContent = `BASE_URL=https://www.saucedemo.com/v1/
+IS_HEADLESS=false
+`;
+
+	// Write the content to the .env file
+	fs.writeFileSync(envFilePath, envContent, 'utf8');
+	console.log('✅ .env file created with default values.\n');
+}
+
+// Function to copy .env file from root to backend
+function copyEnvFile() {
+	try {
+		if (fs.existsSync(rootEnvPath)) {
+			fse.copySync(rootEnvPath, backendEnvPath);
+			console.log('.env file copied to the backend folder.\n');
+		} else {
+			console.log('.env file not found in the root directory.\n');
+		}
+	} catch (err) {
+		console.error('Error copying .env file:', err);
+	}
+}
+
+/* -----------------------------------------------------
+ *                    Commands
+ *  Description:
+ * 		Main command line interface for Plum. Use
+ * 		"plum <command>" to run the desired command.
+ * ------------------------------------------------------ */
+switch (command) {
+	case 'init':
+		console.log('--------------------------------------');
+		console.log('🟣  Initializing Plum...\n');
+
+		if (fs.existsSync(userTestsPath)) {
+			console.log('⚠️  A `tests/` folder already exists.\n');
+		} else {
+			console.log('🧪 Creating test scaffold...\n');
+			fse.copySync(scaffoldTestsPath, userTestsPath);
+			console.log('✅ `tests/` initialized with example files.\n');
+		}
+
+		// Create .env file with default values
+		createEnvFile();
+		console.log(
+			'🟣  Plum is now ready!\n\n Scaffold test cases are included in the `tests/` folder.\n For more information about Cucumber, visit: https://cucumber.io/\n\n - To start the server, run:\n `plum start` \n\n - If you are developing locally, run:\n `plum local <@tag/blank if you want to run all tests>`'
+		);
+		console.log('--------------------------------------');
+		break;
+
+	case 'start':
+		console.log('--------------------------------------');
+		console.log('🚀 Running plum via Docker Compose...');
+
+		// Copy .env file from root to backend
+		copyEnvFile();
+
+		// Convert Windows paths to safe format
+		const userTestsAbs = path.resolve(process.cwd(), 'tests').replace(/\\/g, '/');
+		const userModulesAbs = path.resolve(process.cwd(), 'node_modules').replace(/\\/g, '/');
+
+		// Generate docker-compose.override.yml
+		const overrideYAML = [
+			'services:',
+			'  backend:',
+			'    volumes:',
+			`      - "${userTestsAbs}:/app/tests"`,
+			`      - "${userModulesAbs}:/app/tests/node_modules"`
+		].join('\n');
+
+		fs.writeFileSync(overrideFilePath, overrideYAML + '\n', 'utf8');
+		console.log('✅ docker-compose.override.yml written');
+
+		// Run docker compose
+		execSync('docker compose up', {
+			cwd: plumRoot,
+			stdio: 'inherit'
+		});
+		console.log('--------------------------------------');
+		break;
+
+	case 'local': {
+		console.log('--------------------------------------\n');
+		console.log('🚀 Running Plum locally...');
+
+		// Copy .env file from root to backend
+		copyEnvFile();
+
+		const tagArg = process.argv[3]; // This is your tag, like @test-1
+		const userTestsPath = path.resolve(process.cwd(), 'tests');
+		const backendTestsPath = path.join(plumRoot, 'backend', 'tests');
+
+		// Copy user tests into backend
+		if (fs.existsSync(userTestsPath)) {
+			console.log('📦 Syncing your tests...');
+			fse.copySync(userTestsPath, backendTestsPath);
+		} else {
+			console.log('⚠️  No `tests/` folder found in the user directory.');
+		}
+
+		// Run npm install
+		console.log('--------------------------------------\n');
+		console.log('Running `npm install`...');
+
+		execSync('npm install', {
+			cwd: path.join(plumRoot, 'backend'),
+			stdio: 'inherit'
+		});
+
+		console.log('Running `npx playwright install`...');
+
+		execSync('npx playwright install', {
+			cwd: path.join(plumRoot, 'backend'),
+			stdio: 'inherit'
+		});
+
+		// Run the tests with the tag filter, only if a tag is provided
+		console.log('--------------------------------------\n');
+		console.log('Running `npm run test` with:');
+		console.log('TAG =', tagArg ?? '');
+		console.log('TRIGGER =', 'command-line-trigger');
+
+		execSync('npm run test', {
+			cwd: path.join(plumRoot, 'backend'),
+			stdio: 'inherit',
+			env: {
+				...process.env,
+				TAG: tagArg ?? '',
+				TRIGGER: 'command-line-trigger'
+			}
+		});
+		console.log('--------------------------------------');
+		break;
+	}
+
+	default:
+		console.log('--------------------------------------');
+		console.log('Usage: plum <init|start|local>');
+		console.log('--------------------------------------');
+}

package/docker-compose.yml

@@ -0,0 +1,41 @@
+#
+# This file is part of Plum.
+#
+# Plum is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Plum is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Plum. If not, see https://www.gnu.org/licenses/.
+#
+
+services:
+  backend:
+    build: ./backend
+    ports:
+      - '3001:3001'
+    volumes:
+      - ./backend/reports:/app/reports
+      - ./backend/config:/app/config
+      - ./backend/tests:/app/tests:rw
+    networks:
+      - app-network
+
+  frontend:
+    build: ./frontend
+    ports:
+      - '5173:5173'
+    depends_on:
+      - backend
+    networks:
+      - app-network
+
+networks:
+  app-network:
+    driver: bridge

package/frontend/Dockerfile

@@ -0,0 +1,26 @@
+#
+# This file is part of Plum.
+#
+# Plum is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Plum is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Plum. If not, see https://www.gnu.org/licenses/.
+#
+
+FROM node:18-alpine
+WORKDIR /app
+
+COPY package.json package-lock.json ./
+RUN npm install
+
+COPY . .
+EXPOSE 5173
+CMD ["npm", "run", "dev", "--", "--host"]

package/frontend/jsconfig.json

@@ -0,0 +1,13 @@
+{
+	"extends": "./.svelte-kit/tsconfig.json",
+	"compilerOptions": {
+		"allowJs": true,
+		"checkJs": false,
+		"moduleResolution": "bundler"
+	}
+	// Path aliases are handled by https://svelte.dev/docs/kit/configuration#alias
+	// except $lib which is handled by https://svelte.dev/docs/kit/configuration#files
+	//
+	// If you want to overwrite includes/excludes, make sure to copy over the relevant includes/excludes
+	// from the referenced tsconfig.json - TypeScript does not merge them in
+}