plum-e2e 1.0.0

package/backend/package.json

@@ -0,0 +1,29 @@
+{
+	"name": "plum-backend",
+	"version": "1.0.0",
+	"main": "index.js",
+	"scripts": {
+		"create-env": "node services/envService.js",
+		"test": "node config/scripts/run-tests.js"
+	},
+	"keywords": [],
+	"author": "",
+	"license": "ISC",
+	"devDependencies": {
+		"@playwright/test": "^1.50.1",
+		"@types/node": "^22.13.1",
+		"cross-env": "^7.0.3",
+		"cucumber-html-reporter": "^7.2.0"
+	},
+	"dependencies": {
+		"@cucumber/cucumber": "^11.2.0",
+		"chai": "^4.3.6",
+		"chai-soft-assert": "^0.0.5",
+		"cors": "^2.8.5",
+		"dotenv": "^16.4.7",
+		"express": "^4.21.2",
+		"node-cron": "^3.0.3",
+		"playwright": "^1.50.1",
+		"socket.io": "^4.8.1"
+	}
+}

package/backend/playwright.config.js

@@ -0,0 +1,97 @@
+/*
+ * 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/.
+ */
+
+// @ts-check
+import { defineConfig, devices } from '@playwright/test';
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// import dotenv from 'dotenv';
+// import path from 'path';
+// dotenv.config({ path: path.resolve(__dirname, '.env') });
+
+/**
+ * @see https://playwright.dev/docs/test-configuration
+ */
+export default defineConfig({
+	testDir: './tests',
+	/* Run tests in files in parallel */
+	fullyParallel: true,
+	/* Fail the build on CI if you accidentally left test.only in the source code. */
+	forbidOnly: !!process.env.CI,
+	/* Retry on CI only */
+	retries: process.env.CI ? 2 : 0,
+	/* Opt out of parallel tests on CI. */
+	workers: process.env.CI ? 1 : undefined,
+	/* Reporter to use. See https://playwright.dev/docs/test-reporters */
+	reporter: 'html',
+	/* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+	use: {
+		/* Base URL to use in actions like `await page.goto('/')`. */
+		// baseURL: 'http://127.0.0.1:3000',
+
+		/* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+		trace: 'on-first-retry'
+	},
+
+	/* Configure projects for major browsers */
+	projects: [
+		{
+			name: 'chromium',
+			use: { ...devices['Desktop Chrome'] }
+		},
+
+		{
+			name: 'firefox',
+			use: { ...devices['Desktop Firefox'] }
+		},
+
+		{
+			name: 'webkit',
+			use: { ...devices['Desktop Safari'] }
+		}
+
+		/* Test against mobile viewports. */
+		// {
+		//   name: 'Mobile Chrome',
+		//   use: { ...devices['Pixel 5'] },
+		// },
+		// {
+		//   name: 'Mobile Safari',
+		//   use: { ...devices['iPhone 12'] },
+		// },
+
+		/* Test against branded browsers. */
+		// {
+		//   name: 'Microsoft Edge',
+		//   use: { ...devices['Desktop Edge'], channel: 'msedge' },
+		// },
+		// {
+		//   name: 'Google Chrome',
+		//   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
+		// },
+	]
+
+	/* Run your local dev server before starting the tests */
+	// webServer: {
+	//   command: 'npm run start',
+	//   url: 'http://127.0.0.1:3000',
+	//   reuseExistingServer: !process.env.CI,
+	// },
+});

package/backend/routes/cron.routes.js

@@ -0,0 +1,127 @@
+/*
+ * 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 express = require('express');
+const router = express.Router();
+const cronService = require('../services/cronService');
+
+/* -----------------------------------------------------
+ *                   Get Cron Jobs
+ *  Description:
+ * 		- Get all cron jobs from config/cron-jobs.json
+ * ------------------------------------------------------ */
+router.get('/', (req, res) => {
+	try {
+		const cronJobs = cronService.getAllCronJobs();
+		res.json({ cronJobs });
+	} catch (error) {
+		console.error('Error fetching cron jobs:', error);
+		res.status(500).json({ error: 'Failed to fetch cron jobs' });
+	}
+});
+
+/* -----------------------------------------------------
+ *                    Create Cron Job
+ *  Description:
+ * 		Add a new cron job to config/cron-jobs.json
+ *  Params:
+ * 		- cronExpression:
+ * 			e.g. "* * * * *"
+ * 			https://www.baeldung.com/cron-expressions
+ * 		- taskName:
+ * 			the unique identifier
+ * 		- tags:
+ * 			cucumber tag you want to run when cron job
+ * 			is triggered.
+ * ------------------------------------------------------ */
+router.post('/', (req, res) => {
+	try {
+		const { cronExpression, taskName, tags } = req.body;
+		if (!cronExpression || !taskName || !tags) {
+			return res.status(400).json({ error: 'Missing required fields' });
+		}
+
+		cronService.addCronJob(req.body);
+		res.json({
+			message: `Cron job ${taskName} added with tags: ${tags}`,
+			taskName,
+			cronExpression
+		});
+	} catch (error) {
+		console.error('Error adding cron job:', error);
+		res.status(500).json({ error: 'Failed to add cron job' });
+	}
+});
+
+/* -----------------------------------------------------
+ *                    Edit Cron Job
+ *  Description:
+ * 		Edit an existing cron job from
+ * 		config/cron-jobs.json
+ *  Params:
+ * 		- taskName:
+ * 			the unique identifier
+ * 		- cronExpression:
+ * 			e.g. "* * * * *"
+ * 			https://www.baeldung.com/cron-expressions
+ * 		- tags:
+ * 			cucumber tag you want to run when cron job
+ * 			is triggered.
+ * ------------------------------------------------------ */
+router.put('/:taskName', (req, res) => {
+	try {
+		const { taskName } = req.params;
+		const { cronExpression, tags } = req.body;
+
+		if (!cronExpression || !tags) {
+			return res.status(400).json({ error: 'Missing required fields' });
+		}
+
+		const updatedCronJob = cronService.updateCronJob(taskName, req.body); // Assuming this is a function to update the cron job
+		res.json({
+			message: `Cron job ${taskName} updated`,
+			taskName,
+			cronExpression,
+			tags: updatedCronJob.tags
+		});
+	} catch (error) {
+		console.error('Error updating cron job:', error);
+		res.status(500).json({ error: 'Failed to update cron job' });
+	}
+});
+
+/* -----------------------------------------------------
+ *                    Delete Cron Job
+ *  Description:
+ * 		Delete cron job from config/cron-jobs.json
+ * 		by taskName
+ *  Params:
+ * 		- taskName:
+ * 			the unique identifier
+ * ------------------------------------------------------ */
+router.delete('/:taskName', (req, res) => {
+	try {
+		const { taskName } = req.params;
+		cronService.removeCronJob(taskName);
+		res.json({ message: `Cron job ${taskName} deleted` });
+	} catch (error) {
+		console.error('Error deleting cron job:', error);
+		res.status(500).json({ error: 'Failed to delete cron job' });
+	}
+});
+
+module.exports = router;

package/backend/routes/reports.routes.js

@@ -0,0 +1,42 @@
+/*
+ * 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 express = require('express');
+const router = express.Router();
+const reportService = require('../services/reportService');
+
+/* -----------------------------------------------------
+ *                    Get Reports
+ *  Description:
+ * 		Get all reports from reports/
+ * ------------------------------------------------------ */
+router.get('/', (req, res) => {
+	const reports = reportService.getAllReports();
+	res.json({ reports });
+});
+
+/* -----------------------------------------------------
+ *                  Get Latest Report
+ *  Description:
+ * 		Get latest report
+ * ------------------------------------------------------ */
+router.get('/latest', (req, res) => {
+	const latestReport = reportService.getLatestReport();
+	res.json({ latestReport });
+});
+
+module.exports = router;

package/backend/routes/schedules.routes.js

@@ -0,0 +1,32 @@
+/*
+ * 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 express = require('express');
+const router = express.Router();
+const scheduleService = require('../services/scheduleService');
+
+/* -----------------------------------------------------
+ *                    Get Schedules
+ *  Description:
+ * 		Get all schedules from schedules/
+ * ------------------------------------------------------ */
+router.get('/', (req, res) => {
+	const schedules = scheduleService.getAllSchedules();
+	res.json({ schedules });
+});
+
+module.exports = router;

package/backend/routes/tests.routes.js

@@ -0,0 +1,33 @@
+/*
+ * 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 express = require('express');
+const router = express.Router();
+const testService = require('../services/testService');
+
+/* -----------------------------------------------------
+ *                   Get all tests
+ *  Description:
+ * 		Gets all suites and its own test cases in
+ * 		 features/
+ * ------------------------------------------------------ */
+router.get('/', (req, res) => {
+	const suites = testService.getTestSuites();
+	res.json({ suites });
+});
+
+module.exports = router;

package/backend/server.js

@@ -0,0 +1,39 @@
+/*
+ * 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 http = require('http');
+const { Server } = require('socket.io');
+const app = require('./app');
+const socketHandler = require('./websockets/socketHandler.js');
+const server = http.createServer(app);
+const io = new Server(server, { cors: { origin: '*' } });
+const path = require('path');
+const fs = require('fs');
+
+// Always point to the mounted tests directory
+const testsDir = path.resolve(process.cwd(), 'tests');
+
+if (!fs.existsSync(testsDir)) {
+	console.error('❌ No tests folder found at /app/tests');
+	process.exit(1);
+}
+
+console.log('📂 Loading tests from:', testsDir);
+
+socketHandler(io);
+
+server.listen(3001, () => console.log('Backend running on port 3001'));

package/backend/services/cronService.js

@@ -0,0 +1,127 @@
+/*
+ * 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 cron = require('node-cron');
+const { spawn } = require('child_process');
+
+const CRON_JOBS_FILE = path.join(__dirname, '../config/cron-jobs.json');
+let cronJobs = {};
+
+const loadCronJobs = () => {
+	if (fs.existsSync(CRON_JOBS_FILE)) {
+		cronJobs = JSON.parse(fs.readFileSync(CRON_JOBS_FILE, 'utf8'));
+
+		// Schedule all loaded cron jobs and store only necessary data in memory
+		Object.keys(cronJobs).forEach((taskName) => {
+			const { cronExpression, tags } = cronJobs[taskName];
+			const scheduledCronJob = cron.schedule(cronExpression, () => {
+				console.log(`Running new task: ${taskName}`);
+
+				const task = spawn('npm', ['run', 'test'], {
+					env: { ...process.env, TAG: tags, TRIGGER: taskName }
+				});
+
+				task.stdout.on('data', (data) => console.log(data.toString()));
+				task.stderr.on('data', (data) => console.error(data.toString()));
+				task.on('close', (code) => console.log(`Task ${taskName} finished with code ${code}`));
+			});
+
+			// Store the reference to the cron job only in memory
+			cronJobs[taskName].cronJob = scheduledCronJob;
+		});
+	}
+};
+
+const saveCronJobs = () => {
+	// Save only cron job data (not the reference to the cron job object) to the file
+	const cronJobsData = Object.keys(cronJobs).reduce((acc, taskName) => {
+		const { cronExpression, tags } = cronJobs[taskName];
+		acc[taskName] = { cronExpression, tags }; // Exclude the cronJob reference
+		return acc;
+	}, {});
+
+	fs.writeFileSync(CRON_JOBS_FILE, JSON.stringify(cronJobsData, null, 2), 'utf8');
+};
+
+const getAllCronJobs = () =>
+	Object.keys(cronJobs).map((taskName) => ({
+		taskName,
+		cronExpression: cronJobs[taskName].cronExpression,
+		tags: cronJobs[taskName].tags
+	}));
+
+const addCronJob = ({ cronExpression, taskName, tags }) => {
+	if (!cronExpression || !taskName || !tags) {
+		return { status: 400, message: 'Missing required parameters' };
+	}
+
+	cronJobs[taskName] = { cronExpression, tags };
+	saveCronJobs();
+	loadCronJobs(); // Re-load and schedule the new cron job
+	return { status: 201, message: `Cron job ${taskName} added` };
+};
+
+const removeCronJob = (taskName) => {
+	if (!cronJobs[taskName]) {
+		return { status: 404, message: `Cron job ${taskName} not found` };
+	}
+
+	// Stop the cron job before removing
+	cronJobs[taskName].cronJob.stop();
+
+	delete cronJobs[taskName];
+	saveCronJobs();
+	loadCronJobs(); // Re-load and re-schedule cron jobs without the removed one
+	return { status: 200, message: `Cron job ${taskName} deleted` };
+};
+
+const updateCronJob = (taskName, { cronExpression, tags }) => {
+	if (!cronJobs[taskName]) {
+		return { status: 404, message: `Cron job ${taskName} not found` };
+	}
+
+	// Stop the old cron job
+	cronJobs[taskName].cronJob.stop();
+
+	// Update the cron job with new values
+	cronJobs[taskName] = { cronExpression, tags };
+
+	// Reschedule the updated cron job and store the reference
+	const scheduledCronJob = cron.schedule(cronExpression, () => {
+		console.log(`Running updated task: ${taskName}`);
+
+		const task = spawn('npm', ['run', 'test'], {
+			env: { ...process.env, TAG: tags, TRIGGER: taskName }
+		});
+
+		task.stdout.on('data', (data) => console.log(data.toString()));
+		task.stderr.on('data', (data) => console.error(data.toString()));
+		task.on('close', (code) => console.log(`Task ${taskName} finished with code ${code}`));
+	});
+
+	// Store the new cron job reference in memory
+	cronJobs[taskName].cronJob = scheduledCronJob;
+
+	saveCronJobs(); // Save the updated cron jobs to file (excluding cron job references)
+	return { status: 200, message: `Cron job ${taskName} updated` };
+};
+
+loadCronJobs(); // Initial load and scheduling of cron jobs
+
+module.exports = { getAllCronJobs, addCronJob, removeCronJob, updateCronJob };

package/backend/services/envService.js

@@ -0,0 +1,43 @@
+/*
+ * 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');
+
+/* -----------------------------------------------------
+ *                   .env Generator
+ *  Description:
+ * 		If .env file doesn't exist, this will create
+ * 		a .env file in root with sauce demo's base URL
+ * ------------------------------------------------------ */
+const envPath = path.join(__dirname, '../.env');
+
+if (!fs.existsSync(envPath)) {
+	const envContent = 'BASE_URL=https://www.saucedemo.com/v1/\nIS_HEADLESS=false';
+	fs.writeFileSync(envPath, envContent);
+	console.log('.env file created in the root directory');
+} else {
+	let envContent = fs.readFileSync(envPath, 'utf8');
+
+	if (!envContent.includes('IS_HEADLESS=')) {
+		envContent += '\nIS_HEADLESS=false';
+		fs.writeFileSync(envPath, envContent);
+		console.log('IS_HEADLESS=false added to .env');
+	} else {
+		console.log('.env file already contains IS_HEADLESS setting');
+	}
+}

package/backend/services/reportService.js

@@ -0,0 +1,50 @@
+/*
+ * 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 REPORTS_DIR = path.join(__dirname, '../reports');
+
+const getAllReports = () => {
+	const files = fs.readdirSync(REPORTS_DIR);
+
+	// Get all files ending with '.html'
+	const htmlFiles = files.filter((file) => file.endsWith('.html'));
+
+	// Sort files by modification time (latest first)
+	const sortedFiles = htmlFiles.sort((a, b) => {
+		const aStats = fs.statSync(path.join(REPORTS_DIR, a));
+		const bStats = fs.statSync(path.join(REPORTS_DIR, b));
+		return bStats.mtime - aStats.mtime; // Sort in descending order of modification time
+	});
+
+	return sortedFiles;
+};
+
+const getLatestReport = () => {
+	const reportFiles = getAllReports()
+		.map((file) => ({
+			file,
+			time: fs.statSync(path.join(REPORTS_DIR, file)).mtime.getTime()
+		}))
+		.sort((a, b) => b.time - a.time);
+
+	return reportFiles.length ? reportFiles[0].file : null;
+};
+
+module.exports = { getAllReports, getLatestReport };

package/backend/services/scheduleService.js

@@ -0,0 +1,34 @@
+/*
+ * 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 SETTINGS_PATH = path.join(__dirname, '../config/settings.json');
+
+const getAllSchedules = () => {
+	try {
+		const fileContent = fs.readFileSync(SETTINGS_PATH, 'utf8');
+		const settings = JSON.parse(fileContent);
+		return settings.cronJobSchedules || [];
+	} catch (error) {
+		console.error('Error reading or parsing the settings file:', error);
+		return [];
+	}
+};
+
+module.exports = { getAllSchedules };