plum-e2e 1.0.2 → 1.0.3

package/backend/services/cronService.js

@@ -1,127 +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 };
+/*
+ * 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

@@ -1,43 +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');
-	}
-}
+/*
+ * 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

@@ -1,50 +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 };
+/*
+ * 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

@@ -1,34 +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 };
+/*
+ * 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 };

package/backend/services/testService.js

@@ -1,70 +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 };
+/*
+ * 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 };