plum-e2e 1.0.0

package/backend/Dockerfile

@@ -0,0 +1,30 @@
+#
+# 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 mcr.microsoft.com/playwright:v1.41.1
+WORKDIR /app
+
+COPY package.json package-lock.json ./
+RUN npm install
+RUN npx playwright install --with-deps
+
+COPY . .
+
+RUN npm run create-env && sed -i 's/^IS_HEADLESS=false/IS_HEADLESS=true/' .env
+
+EXPOSE 3001
+CMD ["node", "server.js"]

package/backend/_scaffold/features/LoginPage.feature

@@ -0,0 +1,6 @@
+@suite-1
+Feature: Demo Sauce Login
+
+  @test-1
+  Scenario: Verify User Can Login Using Correct Details
+    Given I am in Demo Sauce Login page

package/backend/_scaffold/pages/LoginPage.js

@@ -0,0 +1,22 @@
+const { SAMPLE_CONSTANT } = require('../utils/constants');
+const Utils = require('../utils/utils');
+
+class LoginPage {
+	constructor(page) {
+		this.page = page;
+		this.utils = new Utils(this.page);
+	}
+
+	async goToLoginPage() {
+		console.log(SAMPLE_CONSTANT);
+		await this.utils.goToPage(process.env.BASE_URL);
+		await this.page.waitForTimeout(3000);
+		throw Error();
+	}
+
+	async skipTest() {
+		test.skip();
+	}
+}
+
+module.exports = LoginPage;

package/backend/_scaffold/step_definitions/LoginSteps.js

@@ -0,0 +1,9 @@
+const { Given, When, Then } = require('@cucumber/cucumber');
+
+Given('I am in Demo Sauce Login page', async function () {
+	await this.loginPage.goToLoginPage();
+});
+
+Given('I fail this test', async function () {
+	throw new Error('err');
+});

package/backend/_scaffold/utils/constants.js

@@ -0,0 +1,3 @@
+module.exports = {
+	SAMPLE_CONSTANT: 'this is a constant'
+};

package/backend/_scaffold/utils/hooks.js

@@ -0,0 +1,65 @@
+/*
+ * 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/.
+ */
+
+require('dotenv').config();
+
+const { Before, After, setWorldConstructor } = require('@cucumber/cucumber');
+const { chromium } = require('playwright');
+const fs = require('fs');
+const path = require('path');
+const Utils = require('../utils/utils');
+const LoginPage = require('../pages/LoginPage');
+
+class CustomWorld {
+	constructor({ attach }) {
+		// Enable attaching files to reports
+		this.attach = attach;
+
+		// Instance
+		this.browser = null;
+		this.context = null;
+		this.page = null;
+
+		// Pages
+		this.loginPage = null;
+		this.utils = null;
+	}
+}
+
+setWorldConstructor(CustomWorld);
+
+Before(async function () {
+	this.browser = await chromium.launch({ headless: process.env.IS_HEADLESS === 'true' });
+	this.context = await this.browser.newContext();
+	this.page = await this.context.newPage();
+	this.loginPage = new LoginPage(this.page);
+	this.utils = new Utils(this.page);
+});
+
+After(async function (scenario) {
+	if (scenario.result.status === 'FAILED') {
+		const screenshotPath = path.join('reports/screenshots', `screenshot_${Date.now()}.png`);
+		await this.page.screenshot({ path: screenshotPath });
+
+		// Attach screenshot to the Cucumber report
+		const screenshotData = fs.readFileSync(screenshotPath);
+		this.attach(screenshotData, 'image/png');
+	}
+
+	// Close the browser after each test
+	await this.browser.close();
+});

package/backend/_scaffold/utils/utils.js

@@ -0,0 +1,10 @@
+class Utils {
+	constructor(page) {
+		this.page = page;
+	}
+	async goToPage(url) {
+		await this.page.goto(url);
+	}
+}
+
+module.exports = Utils;

package/backend/app.js

@@ -0,0 +1,37 @@
+/*
+ * 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 cors = require('cors');
+const app = express();
+
+app.use(cors({ origin: '*' }));
+app.use(express.json());
+
+// Routes
+const testRoutes = require('./routes/tests.routes');
+const reportRoutes = require('./routes/reports.routes');
+const cronRoutes = require('./routes/cron.routes');
+const scheduleRoutes = require('./routes/schedules.routes');
+
+app.use('/tests', testRoutes);
+app.use('/reports', reportRoutes);
+app.use('/cron-jobs', cronRoutes);
+app.use('/reports', express.static('reports'));
+app.use('/schedules', scheduleRoutes);
+
+module.exports = app;

package/backend/config/scripts/create-settings.js

@@ -0,0 +1,60 @@
+/*
+ * 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 fse = require('fs-extra'); // fs-extra for directory copying
+
+// Path to the settings.json file inside the backend/config directory
+const settingsFilePath = path.join(process.cwd(), 'config', 'settings.json');
+const scaffoldFolderPath = path.join(process.cwd(), '_scaffold');
+const userTestsFolderPath = path.join(process.cwd(), 'tests');
+
+// Check if the settings.json file exists
+if (!fs.existsSync(settingsFilePath)) {
+	console.log('⚠️ settings.json not found. Creating it with default values...');
+
+	// Default content for settings.json
+	const settingsContent = JSON.stringify(
+		{
+			reportsHistory: 20,
+			cronJobSchedules: [
+				{ label: 'Every minute', value: '* * * * *' },
+				{ label: 'Every hour', value: '0 * * * *' },
+				{ label: 'Every midnight', value: '0 0 * * *' },
+				{ label: 'Every Sunday', value: '0 0 * * 0' }
+			]
+		},
+		null,
+		2
+	);
+
+	// Write the settings to the settings.json file
+	fs.writeFileSync(settingsFilePath, settingsContent, 'utf8');
+	console.log('✅ settings.json created with default values.');
+} else {
+	console.log('⚠️ settings.json already exists. Skipping creation.');
+}
+
+// Check if the tests folder exists, if not, copy the scaffold folder as tests
+if (!fs.existsSync(userTestsFolderPath)) {
+	console.log('🧪 `tests/` folder not found. Creating `tests/` from the scaffold folder...');
+	fse.copySync(scaffoldFolderPath, userTestsFolderPath);
+	console.log('✅ `tests/` folder created from scaffold.');
+} else {
+	console.log('⚠️ `tests/` folder already exists. Skipping creation.');
+}

package/backend/config/scripts/generate-report.js

@@ -0,0 +1,135 @@
+/*
+ * 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 reporter = require('cucumber-html-reporter');
+const fs = require('fs');
+const path = require('path');
+const { reportsHistory } = require('../settings.json');
+
+/* -----------------------------------------------------
+ *            Screenshot and Report Management
+ *
+ *  Description:
+ * 		To avoid reports and screenshots extract
+ *  	status, tags, run name, and date.
+ * ------------------------------------------------------ */
+
+const reportsDir = 'reports';
+const screenshotsDir = path.join(reportsDir, 'screenshots');
+const maxReports = reportsHistory;
+
+// Ensure the reports and screenshots directories exist
+if (!fs.existsSync(reportsDir)) {
+	fs.mkdirSync(reportsDir, { recursive: true });
+}
+
+if (!fs.existsSync(screenshotsDir)) {
+	fs.mkdirSync(screenshotsDir, { recursive: true });
+}
+
+// Remove the oldest report depending on maxReport
+const existingReports = fs
+	.readdirSync(reportsDir)
+	.filter((file) => file.startsWith('PASS_') || file.startsWith('FAIL_'))
+	.sort(
+		(a, b) =>
+			fs.statSync(path.join(reportsDir, b)).mtime - fs.statSync(path.join(reportsDir, a)).mtime
+	);
+
+while (existingReports.length >= maxReports) {
+	const oldestReport = existingReports.pop();
+	fs.unlinkSync(path.join(reportsDir, oldestReport));
+}
+
+// Remove the oldest screenshot depending on maxReport
+const existingScreenshots = fs
+	.readdirSync(screenshotsDir)
+	.filter((file) => file.endsWith('.png') || file.endsWith('.jpg'))
+	.sort(
+		(a, b) =>
+			fs.statSync(path.join(screenshotsDir, b)).mtime -
+			fs.statSync(path.join(screenshotsDir, a)).mtime
+	);
+
+while (existingScreenshots.length >= maxReports) {
+	const oldestScreenshot = existingScreenshots.pop();
+	fs.unlinkSync(path.join(screenshotsDir, oldestScreenshot));
+}
+
+/* -----------------------------------------------------
+ *               Generate the report name
+ *
+ *  Description:
+ * 		This is where the reports page will
+ *  	extract status, tags, run name, and date.
+ * ------------------------------------------------------ */
+
+const jsonReportFile = path.join(reportsDir, 'cucumber_report.json');
+let status = 'PASS';
+
+if (fs.existsSync(jsonReportFile)) {
+	const reportData = fs.readFileSync(jsonReportFile, 'utf8');
+
+	// Ensure the JSON is not empty
+	if (reportData) {
+		const parsedData = JSON.parse(reportData);
+
+		const hasFailures = parsedData.some((feature) =>
+			feature.elements.some((scenario) =>
+				scenario.steps.some((step) => step.result.status === 'failed')
+			)
+		);
+
+		if (hasFailures) {
+			status = 'FAIL';
+		}
+	} else {
+		console.log('Report file is empty or malformed');
+	}
+}
+
+let tag = process.env.TAG;
+
+if (!tag) {
+	tag = '(@all-tests)';
+}
+
+if (tag && !tag.startsWith('(') && !tag.endsWith(')')) {
+	tag = `(${tag})`;
+}
+
+const timestamp = new Date().toISOString().replace(/[-:.]/g, '_');
+const reportFileName = `${status}_cucumber_report_${process.env.TRIGGER}_${tag}_${timestamp}.html`;
+
+const options = {
+	theme: 'bootstrap',
+	jsonFile: jsonReportFile,
+	output: path.join(reportsDir, reportFileName),
+	reportSuiteAsScenarios: true,
+	launchReport: true, // Automatically opens the report in a browser
+	metadata: {
+		'App Name': 'Plum',
+		'Test Environment': 'Local',
+		Browser: 'Chromium',
+		Platform: 'Ubuntu',
+		Parallel: 'Scenarios',
+		Executed: 'Local'
+	}
+};
+
+reporter.generate(options);
+console.log(`Generated report: ${reportFileName}`);

package/backend/config/scripts/run-tests.js

@@ -0,0 +1,37 @@
+/*
+ * 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 { execSync } = require('child_process');
+const tag = process.env.TAG; // Read the TAG environment variable
+
+try {
+	// Run the tests with the tag filter, only if a tag is provided
+	const cucumberCommand = tag
+		? `cucumber-js tests/features/**/*.feature --format json:reports/cucumber_report.json --tags "${tag}"`
+		: `cucumber-js tests/features/**/*.feature --format json:reports/cucumber_report.json`;
+
+	execSync(cucumberCommand, { stdio: 'inherit' });
+} catch (error) {
+	console.error('Tests failed:', error.message);
+} finally {
+	// Always run the report generation after tests (even if they fail)
+	try {
+		execSync('node config/scripts/generate-report.js', { stdio: 'inherit' });
+	} catch (error) {
+		console.error('Error running report generation:', error.message);
+	}
+}

package/backend/cucumber.json

@@ -0,0 +1,6 @@
+{
+	"default": {
+		"require": ["tests/step_definitions/*.js", "tests/utils/hooks.js"],
+		"featurePaths": ["tests/features/**/*.feature"]
+	}
+}