Merge pull request #277 from wp-media/develop

Merge dev to trunk and release 1.2.0

Author: wordpressfan

.gitignore

@@ -1,9 +1,7 @@
 /config/wp.config.ts
 /node_modules
 /artifacts
-/plugin/new_release.zip
-/plugin/previous_stable.zip
-/plugin/wp-rocket_3.10.9.zip
+/plugin/*.zip
 /plugin/exported_settings/wp-rocket-settings-test-2023-00-01-64e7ada0d3b70.json
 /plugin/exported_settings/wp-rocket-settings-test-2023-00-02-64e7ada0d3b70.json
 /plugin/exported_settings/wp-rocket-settings-test-2023-00-03-64e7ada0d3b70.json
@@ -14,4 +12,5 @@
 /backstop_data/html_report
 .DS_Store
 .idea
-backstop.json
+backstop.json
+/temp

README.md

@@ -27,20 +27,24 @@ E2E tests here are written with Playwright. Without further ado, let's meet belo
  You can find this [here](https://github.com/wp-media/wp-rocket-e2e/blob/trunk/config/wp.config.sample.ts)
 
  ## Running Tests
- - Please delete the debug.log from your test site before running tests, We will automate this step in the future.
  - Don't forget to install the [helper plugin](https://github.com/wp-media/wp-rocket-e2e-test-helper)
  - To run tests on playwright, simply run `npx playwright test` or `npm run test:e2e` which ever you prefer.
- 
- **NB:** By default, test will run in headless mode.
+- To run Visual regression with certain feature run 
+`npm run test:vr --wproption=lazyloadCssBgImg` This means to run visual regression for the pages defined for this feature LLCSSBG after enabling it
 
  ## Debugging Tests
  Use `npx playwright test --debug` to control and get a view of each test step.
 
  You can also run `npx playwright test --headed` to view the tests being executed on the browser.
 
  ## Reporting
- At the end of a failed test cycle, playwright will launch a temporary server and open reports with videos and screenshot of failed tests.
+ - In order to have report at the shared folder /var/shared/rocket-e2e-reports on remote e2e server, we can run this "WPRversion_e2e_testType_branch"
+ `npm run test:e2e --tag=wpr3.19.4_e2e_all_dev` This means the test ran using WPR version 3.19.4 and e2e develop branch to run all tests
+
+ - At the end of a failed test cycle, playwright will launch a temporary server and open reports with videos and screenshot of failed tests.
 
 If you ever get failed tests like the one below, it indicates that WP Rocket has some related errors in debug.log
 ![Screenshot 2023-04-27 at 09 55 37](https://user-images.githubusercontent.com/38788055/234812244-c1cd0c87-702a-49a9-baf6-0fab7afd2cd0.png)
 
+### BackWpUp Doc
+- [BackWpUp Documentation](src/backwpup/README.md)

backstop.json

@@ -20,11 +20,12 @@
   ],
   "engine": "puppeteer",
   "engineOptions": {
+    "readyTimeout": 30000,
+    "gotoTimeout": 30000,
     "args": [
       "--no-sandbox"
     ],
-    "headless": false,
-    "timeout": 0
+    "headless": false
   },
   "asyncCaptureLimit": 5,
   "asyncCompareLimit": 50,

config/wp.config.sample.ts

@@ -1,4 +1,3 @@
-import ScenarioUrls from "./scenarioUrls.json";
 /**
  * The default WordPress admin user configuration for both local and live environments.
  * @constant
@@ -26,6 +25,29 @@ const IMAGIFY_INFOS = {
 	apiKey: ''
 } as const;
 
+/**
+ * Backwpup settings information
+ */
+const BACKWPUP_INFOS = {
+    msazure: {
+        accountName: '',
+        accessKey: '',
+        container: ''
+    },
+    sugarsync: {
+        email: '',
+        password: ''
+	},
+    ftp: {
+        host: '',
+        username: '',
+        password: '',
+        port: '21',
+        ssl: false,
+        passiveMode: true
+    }
+} as const;
+
 /**
  * Extracted environment variables related to WordPress configuration.
  * Uses default values if environment variables are not set.
@@ -62,21 +84,6 @@ const {
 	WP_SSH_ROOT_DIR = ''
 } = process.env;
 
-/**
- * Exported Scenario urls to be used for visual regression testing with backstopjs
- * @exports
- * @type {{
- * [key: string]: {
- *	 path?: string,
- *	 disableJs?: boolean,
- *	 theme?: string,
- *	 mobile?: boolean
- *	}
- * }}
- */
-const scriptName = process.env.npm_lifecycle_event;
-const SCENARIO_URLS = ScenarioUrls[scriptName];
-
 /**
  * Exported WordPress environment configuration.
  * @exports
@@ -94,12 +101,6 @@ const SCENARIO_URLS = ScenarioUrls[scriptName];
  *   WP_SSH_ADDRESS: string;
  *   WP_SSH_KEY: string;
  *   WP_SSH_ROOT_DIR: string;
- * 	 SCENARIO_URLS: {
- * 		home: string;
- * 		llcss: string;	
- * 		noJsLlcss: string;
- * 		elementorLlcss: string;
- * 	 },
  * }}
  */
 export { 
@@ -116,6 +117,6 @@ export {
 	WP_SSH_ADDRESS,
 	WP_SSH_KEY,
 	WP_SSH_ROOT_DIR,
-	SCENARIO_URLS,
-	IMAGIFY_INFOS
+	IMAGIFY_INFOS,
+	BACKWPUP_INFOS
 };

cucumber.json

@@ -4,13 +4,16 @@
       "snippetInterface": "async-await"
     },
     "paths": [
-      "src/features/"
+      "src/features/",
+      "src/backwpup/"
     ],
     "publishQuiet": true,
     "dryRun": false,
     "require": [
       "src/support/steps/**/*.ts",
-      "src/support/hooks.ts"
+      "src/support/hooks.ts",
+      "src/backwpup/support/hooks.ts",
+      "src/backwpup/steps/**/*.ts"
     ],
     "requireModule": [
       "ts-node/register"
@@ -21,7 +24,8 @@
       "json:test-results/cucumber-report.json",
       "rerun:@rerun.txt"
     ],
-    "parallel": 1
+    "parallel": 1,
+    "retry": 3
   },
   "rerun": {
     "formatOptions": {
@@ -31,7 +35,9 @@
     "dryRun": false,
     "require": [
       "src/support/steps/**/*.ts",
-      "src/support/hooks.ts"
+      "src/support/hooks.ts",
+      "src/backwpup/support/hooks.ts",
+      "src/backwpup/steps/**/*.ts"
     ],
     "requireModule": [
       "ts-node/register"

open-report.ts

@@ -0,0 +1,34 @@
+import { exec } from 'child_process';
+import * as path from 'path';
+import { promisify } from 'util';
+
+const execAsync = promisify(exec);
+
+interface PlatformCommands {
+    [key: string]: string;
+}
+
+async function openCucumberReport(): Promise<void> {
+    const reportPath: string = path.join(process.cwd(), 'test-results', 'cucumber-report.html');
+
+    const platformCommands: PlatformCommands = {
+        'win32': `start "" "${reportPath}"`,
+        'darwin': `open "${reportPath}"`,
+        'linux': `xdg-open "${reportPath}"`
+    };
+
+    const command: string = platformCommands[process.platform] || `xdg-open "${reportPath}"`;
+
+    try {
+        await execAsync(command);
+        console.log('✅ Cucumber report opened in browser');
+    } catch (error) {
+        console.error('❌ Error opening report:', error);
+    }
+}
+
+if (require.main === module) {
+    openCucumberReport();
+}
+
+export { openCucumberReport };

package.json

@@ -10,21 +10,30 @@
   "scripts": {
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint  . --ext .ts --fix",
-    "test:e2e": "$npm_package_config_testCommand  --tags \"not @vr\" ; npm run push-report --tag=$npm_config_tag",
+    "test:e2e": "$npm_package_config_testCommand  --tags \"not @vr and not @delayjs and not @bwpupsmoke\" ; npm run push-report --tag=$npm_config_tag",
     "test:smoke": "$npm_package_config_testCommand --tags @smoke ; npm run push-report --tag=$npm_config_tag",
     "test:local": "$npm_package_config_testCommand --tags @local",
+    "test:export": "$npm_package_config_testCommand --tags @export",
     "test:online": "$npm_package_config_testCommand --tags @online",
     "test:vr": "$npm_package_config_testCommand --tags @vr $npm_config_wproption",
     "test:llcssbg": "$npm_package_config_testCommand --tags @llcssbg",
     "test:delayjs": "$npm_package_config_testCommand --tags @delayjs",
     "test:lcp": "$npm_package_config_testCommand --tags @lcp",
+    "test:long-test": "$npm_package_config_testCommand --tags @long-test",
+    "test:priorityelements": "$npm_package_config_testCommand --tags @priorityelements",
+    "test:preloadfonts": "$npm_package_config_testCommand --tags @preloadfonts",
+    "test:selfhostgooglefonts": "$npm_package_config_testCommand --tags @selfhostgooglefonts",
     "test:test": "$npm_package_config_testCommand --tags @test",
     "test:lrc": "$npm_package_config_testCommand --tags @lrc",
     "test:cpcss": "$npm_package_config_testCommand --tags @cpcss",
     "test:performancehints": "$npm_package_config_testCommand --tags @performancehints",
     "healthcheck": "ts-node healthcheck.ts",
     "push-report": "ts-node report.ts",
-    "wp-env": "wp-env"
+    "wp-env": "wp-env",
+    "test:bwpupstorage": "$npm_package_config_testCommand --tags @bwpupstorage",
+    "test:bwpuponboarding": "$npm_package_config_testCommand --tags @bwpuponboarding",
+    "test:bwpupsmoke": "$npm_package_config_testCommand --tags @bwpupsmoke",
+    "test:bwpup": "$npm_package_config_testCommand --tags @bwpup"
   },
   "repository": {
     "type": "git",

src/backwpup/README.md

@@ -0,0 +1,42 @@
+# Welcome to BackWpUp E2E Tests Repo
+E2E tests here are written with Playwright. Without further ado, let's meet below below ⤵️
+
+
+## Requirements
+- Do you still not have node installed? You'll be needing it.
+- You also need zip files of Backwpup pro, I'll explain:
+    - zip the latest release - **rename the zip file name to `backwpup-pro.zip`. e.g `backwpup-5.3.1.zip` becomes `backwpup-pro.zip`**
+    - Make sure to put the file in the `./plugin` folder in the root - Playwright will pick these files when needed and use them during tests.
+    - To generate the zip, you can follow the steps [here](https://www.notion.so/wpmedia/Generate-a-Branch-Zip-File-29d931ad50e945dab8df5a4302ea948a#1c3ed22a22f0801f9d84f22b0bd1bd93)
+
+
+## Installation
+- Clone this repo
+- run a `npm install` to install dependencies, well for this case it's just playwright.
+- Additionally, in some cases on a fresh install you might also need to run `npx playwright install` to download the various browser engines as well.
+
+
+## Configuration
+You'll need to update the site you want to run tests on as well as the credentials.
+
+Update the `wp.config.sample.ts` to `wp.config.ts` in https://github.com/wp-media/wp-rocket-e2e/blob/trunk/config/
+
+Change the `live_username` & `live_password` & `WP_BASE_URL` to that of your test site.
+
+You can find this [here](https://github.com/wp-media/wp-rocket-e2e/blob/trunk/config/wp.config.sample.ts)
+
+## Running Tests
+- Please delete forget to delete the backup after running your tests, We will automate this step in the future.
+- To run tests on playwright, simply run `npm run test:bwpupsmoke` which ever you prefer.
+
+**NB:** By default, test will run in headless mode.
+
+## Debugging Tests
+Use `npx playwright test --debug` to control and get a view of each test step.
+
+You can also run `npx playwright test --headed` to view the tests being executed on the browser.
+
+
+## TODO
+- Add option for backwpup free plugin
+- Create helper function to read debug.log content

src/backwpup/common/custom-world.ts

@@ -0,0 +1,28 @@
+import {IWorldOptions, setWorldConstructor, World} from "@cucumber/cucumber";
+import {BrowserContext, Page} from "@playwright/test";
+import {Sections} from "../../common/sections";
+import {PageUtils} from "../../../utils/page-utils";
+import {Pickle} from "@cucumber/messages/dist/esm/src";
+import {Section} from "../../../utils/types";
+import {BackupRowData} from "../utils/types";
+import {StorageUtils} from "../utils/storage";
+
+export interface ICustomWorld extends World {
+    context?: BrowserContext;
+    page?: Page;
+    sections?: Sections;
+    utils?: PageUtils;
+    pickle?: Pickle;
+    wprSection?: Section;
+    wprOption?: string;
+    initialBackups?: BackupRowData[];
+    storage?: StorageUtils;
+}
+
+export class CustomWorld extends World implements ICustomWorld {
+    constructor(options: IWorldOptions) {
+        super(options)
+    }
+}
+
+setWorldConstructor(CustomWorld)

src/backwpup/features/backup.feature

@@ -0,0 +1,19 @@
+@bwpup @bwpupsetup @bwpupsmoke
+Feature: Should be able to backup
+
+  Background:
+    Given I am logged in
+    And I delete backwpup plugin
+    And plugin is installed 'backwpup-pro'
+    And plugin is activated
+
+  Scenario: Should common backup now generate files&DB locally
+    And I go '/wp-admin/admin.php?page=backwpup'
+    When I click '.js-backwpup-onboarding-step-2' button to continue
+    And I click '.js-backwpup-onboarding-step-3' button to continue
+    When I Configure web server storage
+    And I go '/wp-admin/admin.php?page=backwpup'
+    And I should see 'mixed' job cards
+    Then the backup should be added to the table
+    When I click on common backup now button
+    Then '1' backup is generated and added to history