plum-e2e 1.0.1 → 1.0.3

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

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

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

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

package/backend/package.json

@@ -1,29 +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"
-	}
-}
+{
+	"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

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