plum-e2e 1.0.2 → 1.0.4

package/.prettierrc

@@ -1,15 +1,15 @@
-{
-	"useTabs": true,
-	"singleQuote": true,
-	"trailingComma": "none",
-	"printWidth": 100,
-	"plugins": ["prettier-plugin-svelte"],
-	"overrides": [
-		{
-			"files": "*.svelte",
-			"options": {
-				"parser": "svelte"
-			}
-		}
-	]
-}
+{
+	"useTabs": true,
+	"singleQuote": true,
+	"trailingComma": "none",
+	"printWidth": 100,
+	"plugins": ["prettier-plugin-svelte"],
+	"overrides": [
+		{
+			"files": "*.svelte",
+			"options": {
+				"parser": "svelte"
+			}
+		}
+	]
+}

package/README.md

@@ -1,5 +1,66 @@
-![alt-text="social-preview"](https://repository-images.githubusercontent.com/936477779/e928fce3-6d4c-4609-92a0-0a1091c99752)
-
-**_Pre-requisite:_**
-
-**_I. How to Run:_**
+![alt-text="social-preview"](https://repository-images.githubusercontent.com/936477779/e928fce3-6d4c-4609-92a0-0a1091c99752)
+
+<p align="center">
+  📖 <a href="https://github.com/silverlunah/plum/wiki">Wiki</a> |
+  📦 <a href="https://www.npmjs.com/package/plum-e2e">npm</a>
+</p>
+
+## Welcome to Plum!
+
+Plum makes setting up your testing framework easy. In just a few seconds, you can run the scaffold tests and write your own tests!
+
+By combining [Playwright](https://playwright.dev) and [Cucumber](https://cucumber.io), tests are easy to write and read. The code follows a POM (Page Object Model) structure, making it scalable and easy for developers to understand, while Cucumber test cases are written in [Gherkin](https://cucumber.io/docs/gherkin/) format, making them accessible to non-developers as well.
+
+You can view, run, schedule tests in a simple UI and even view the history of your runs in the Report page!
+
+**_Pre-requisite:_**
+
+1. Install Docker and ensure the Docker daemon is running.
+
+## For Users
+
+For normal users. People that want to use Plum as a test environment for their website.
+
+**_I. How to Run:_**
+
+1. `npm install -g plum-e2e`
+2. Create your project directory. Example: `mkdir my-test-folder`
+3. Go inside the folder you created `cd my-test-folder`
+4. Run `plum init`
+   1. This will initialize Plum and will create your base files:
+      1. `\tests` folder: This include sample test cases for [SauceLabs](https://www.saucedemo.com/v1/)
+      2. `.env` file: Your starting .env file. You can set the BASE_URL to your own site after you're done with the scaffold tests.
+5. There are two ways to start testing:
+   1. By running the server. Run:<br/> `plum start to start the server`
+   2. Without running the server. Recommended while you're writing your tests. Run:<br/> `plum dev <@test-id>`. If no test ID is included, it will run all tests
+
+## Basic Structure
+
+After you run `plum init`, these files will be created inside your project directory.
+
+<pre>
+╠═ tests
+║  ╠═ features         : Cucumber feature files, contains your test cases
+║  ╠═ step_definitions : Reference to steps in the feature files
+║  ╠═ pages            : Contains functions used in step_definitions
+║  ╚═ utils            : Utility files (Constants, utility codes, etc.)
+╚═ env.                : Your .env file
+</pre>
+
+## Tutorial
+
+1. For a complete guide on how to write tests, visit our [Wiki](https://github.com/silverlunah/plum/wiki)
+2. An easy way to learn is to check the scaffold files starting from the Feature files -> Step Definitions -> Page files and utils/hooks.js for the CustomWorld and Before hook page class initialization. Those are the main files you need to write a test case.
+
+## For Developers/Contributors
+
+For people that want to contribute to the project
+
+1. Clone the project `git clone https://github.com/silverlunah/plum.git`
+2. `cd plum`
+3. Initialize the project by:<br/>`npm run init`
+4. Check if its running:<br/> `docker compose up --build -d`
+
+## Other
+
+Plum is completely free to use! But if you want to share some love, here's my [PayPal](https://www.paypal.me/silverlunah) or [Wise](<[https://www.paypal.me/silverlunah](https://wise.com/pay/me/janneserjosee)>)

package/backend/_scaffold/pages/LoginPage.js

@@ -1,22 +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;
+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

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

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

package/backend/_scaffold/utils/hooks.js

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

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

package/backend/app.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 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;
+/*
+ * 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

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