Merge pull request #1 from rishavjeet/learn/wp-e2e-utils

Add WooCommerce Test Automation

Author: rishavjeet

.github/workflows/playwright.yml

@@ -0,0 +1,27 @@
+name: Playwright Tests
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: lts/*
+    - name: Install dependencies
+      run: npm ci
+    - name: Install Playwright Browsers
+      run: npx playwright install --with-deps
+    - name: Run Playwright tests
+      run: npx playwright test
+    - uses: actions/upload-artifact@v4
+      if: ${{ !cancelled() }}
+      with:
+        name: playwright-report
+        path: playwright-report/
+        retention-days: 30

.gitignore

@@ -0,0 +1,8 @@
+node_modules/
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/
+.env
+.DS_Store
+artifacts/

README.md

@@ -1,2 +1,85 @@
-# TestAutomation-Hands-on
-This repository is for doing hands-on practice for the Playwright Framework
+# WordPress WooCommerce E2E Testing with Playwright
+
+This repository contains a set of end-to-end (E2E) test scripts designed to automate various processes in WordPress. The tests are written using the **wp-e2e-utils-playwright** framework functions, providing a powerful and flexible solution for testing WordPress websites.
+
+The test scripts in this repository cover the following areas:
+
+- **Product Management**
+  - Create a simple product.
+  - Add product categories and tags.
+  - Upload product images.
+  - Set pricing and inventory.
+  - Publish and verify product visibility.
+
+- **Coupon Management**
+  - Create different types of coupons (percentage, fixed amount).
+  - Apply coupons during checkout.
+  - Verify discount calculations.
+
+- **User Management**
+  - Create a customer user.
+  - Customer places an order.
+  - Admin/Store manager reviews the order.
+
+### Exclusive Features
+
+- **wp-e2e-utils-playwright Framework**: The tests are written using the **wp-e2e-utils-playwright** framework functions, which streamline the process of automating interactions with a WordPress site. This framework helps interact with the WordPress admin panel, as well as simulating user behavior on the frontend.
+
+- **Test Data Cleanup**: Each test script includes a **data cleanup** feature to ensure that the site storage is not overpopulated with test data. After each test execution, the relevant test data (e.g., products, users, coupons) is removed, maintaining a clean environment for subsequent tests.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Prerequisites](#prerequisites)
+- [Running the Tests](#running-the-tests)
+
+## Installation
+
+To get started, follow the steps below to set up the testing environment.
+
+1. **Clone the repository**:
+
+```bash
+git clone https://github.com/rishavjeet/test-automation-hands-on.git
+```
+2. **Install the dependencies**:
+
+This project uses npm to manage dependencies. Make sure you have Node.js and npm installed. Then, run the following command to install the required packages:
+
+```bash
+npm install
+```
+2. **Install the dependencies**:
+
+Create a .env file in the root directory of the project. You will need to add your WordPress admin credentials and other relevant environment configurations.
+
+```bash
+WP_USERNAME=
+WP_PASSWORD=
+WP_BASE_URL=
+```
+
+## Prerequisites
+
+Before running the test scripts, ensure that you have the following:
+
+- `Node.js` (version 14 or later)
+- `npm` (Node Package Manager)
+- Playwright (installed automatically through npm)
+- WordPress site setup for testing (local or staging environment)
+
+## Running the Tests
+
+Once the environment is set up, you can run the test scripts using Playwright’s test runner.
+
+1. Run all tests:
+
+```bash
+npx playwright test
+```
+2. Run a specific test script:
+
+```bash
+npx playwright test path/to/test-script.spec.js
+```
+*Replace `path/to/test-script.spec.js` with the path to the specific test script you want to run*

assets/product_test_image.png

@@ -0,0 +1,34 @@
+/**
+ * External dependencies
+ */
+import { request } from '@playwright/test';
+// import type { FullConfig } from '@playwright/test';
+
+/**
+ * WordPress dependencies
+ */
+import { RequestUtils } from '@wordpress/e2e-test-utils-playwright';
+
+async function globalSetup( config ) {
+    const { storageState, baseURL, userAgent } = config.projects[ 0 ].use;
+
+    console.log('config :'+ config.projects[0].use.userAgent);
+    const storageStatePath =
+        typeof storageState === 'string' ? storageState : undefined;
+
+    const requestContext = await request.newContext( {
+        baseURL,
+        userAgent,
+    } );
+
+    const requestUtils = new RequestUtils( requestContext, {
+        storageStatePath,
+    } );
+
+    // Authenticate and save the storageState to disk.
+    await requestUtils.setupRest();
+
+    await requestContext.dispose();
+}
+
+export default globalSetup;