Sync gitlab-main to main

.env.example

@@ -5,8 +5,8 @@ PLAYWRIGHT_REVIEW_URL=https://hyva-demo.elgentos.io/
 MAGENTO_ADMIN_SLUG=
 MAGENTO_ADMIN_USERNAME=
 MAGENTO_ADMIN_PASSWORD=
-MAGENTO_THEME_LOCALE=
 
+MAGENTO_THEME_LOCALE=
 MAGENTO_NEW_ACCOUNT_PASSWORD=
 MAGENTO_EXISTING_ACCOUNT_EMAIL_CHROMIUM=
 MAGENTO_EXISTING_ACCOUNT_EMAIL_FIREFOX=
@@ -16,6 +16,4 @@ MAGENTO_EXISTING_ACCOUNT_CHANGED_PASSWORD=
 
 MAGENTO_COUPON_CODE_CHROMIUM=
 MAGENTO_COUPON_CODE_FIREFOX=
-MAGENTO_COUPON_CODE_WEBKIT=
-
-CAPTCHA_BYPASS=
+MAGENTO_COUPON_CODE_WEBKIT=

.gitignore

@@ -5,6 +5,7 @@ node_modules/
 /test-results/
 /auth-storage/
 /playwright-report/
+/base-tests/
 
 #files
 /*.config.ts

.gitlab-ci.yml

@@ -3,6 +3,10 @@ image: node:18-bullseye
 stages:
   - mirror
 
+variables:
+  GIT_DEPTH: 0
+  GIT_TRACE: 1
+
 mirror_to_github:
   stage: mirror
   only:
@@ -15,10 +19,10 @@ mirror_to_github:
     - git config --global user.name "developer-elgentos"
     - git config --global user.email "[email protected]"
   script:
-    - git remote add github [email protected]:elgentos/magento2-playwright.git
-    - git fetch github main
     - git fetch origin main
     - git checkout -B main origin/main
+    - git remote add github [email protected]:elgentos/magento2-playwright.git
+    - git fetch github main
     - git push github main:gitlab-main
 
 test_mirror_pipeline:
@@ -33,4 +37,4 @@ test_mirror_pipeline:
     - git config --global user.name "developer-elgentos"
     - git config --global user.email "[email protected]"
   script:
-    - git ls-remote [email protected]:elgentos/magento2-playwright.git
+    - git ls-remote [email protected]:elgentos/magento2-playwright.git

install.js

@@ -44,8 +44,17 @@ async function install() {
   const envPath = path.join('.env');
   let envContent = '';
 
+  // for (const [key, value] of Object.entries(envVars)) {
+  //   const userInput = await question(`Enter ${ key } (default: ${ value.default }): `);
+  //   envContent += `${ key }=${ userInput || value.default }\n`;
+  // }
+
+  const isCI = process.env.CI === 'true';
   for (const [key, value] of Object.entries(envVars)) {
-    const userInput = await question(`Enter ${ key } (default: ${ value.default }): `);
+    let userInput = '';
+    if (!isCI) {
+      userInput = await question(`Enter ${ key } (default: ${ value.default }): `);
+    }
     envContent += `${ key }=${ userInput || value.default }\n`;
   }
 
@@ -58,4 +67,4 @@ async function install() {
   rl.close();
 }
 
-install();
+install();

playwright.config.example.ts

@@ -8,32 +8,38 @@ import fs from "node:fs";
 dotenv.config({ path: path.resolve(__dirname, '.env') });
 
 function getTestFiles(baseDir: string, customDir?: string): string[] {
-  const baseFiles = new Set(fs.readdirSync(baseDir).filter(file => file.endsWith('.spec.ts')));
+  const baseFiles = new Set(
+      fs.readdirSync(baseDir)
+          .filter(file => file.endsWith('.spec.ts'))
+          .map(file => path.join(baseDir, file))
+  );
 
   if (!customDir || !fs.existsSync(customDir)) {
     return Array.from(baseFiles);
   }
 
-  const customFiles = fs.readdirSync(customDir).filter(file => file.endsWith('.spec.ts'));
+  const customFiles = fs.readdirSync(customDir)
+      .filter(file => file.endsWith('.spec.ts'))
+      .map(file => path.join(customDir, file));
 
-  if(customFiles.length === 0) {
+  if (customFiles.length === 0) {
     return Array.from(baseFiles);
   }
 
   const testFiles = new Set<string>();
 
   // Get base files that have an override in custom
   for (const file of baseFiles) {
-    const baseFilePath = path.join(baseDir, file);
-    const customFilePath = path.join(customDir, file);
+    const baseFilePath = path.join(baseDir, path.basename(file));
+    const customFilePath = path.join(customDir, path.basename(file));
 
     testFiles.add(fs.existsSync(customFilePath) ? customFilePath : baseFilePath);
   }
 
   // Add custom tests that aren't in base
   for (const file of customFiles) {
-    if (!baseFiles.has(file)) {
-      testFiles.add(path.join(customDir, file));
+    if (!baseFiles.has(path.basename(file))) {
+      testFiles.add(file);
     }
   }
 
@@ -49,6 +55,7 @@ const testFiles = getTestFiles(
  * See https://playwright.dev/docs/test-configuration.
  */
 export default defineConfig({
+  testDir: '.',
   /* Run tests in files in parallel */
   fullyParallel: true,
   /* Fail the build on CI if you accidentally left test.only in the source code. */

tests/account.spec.ts

@@ -60,7 +60,6 @@ test.describe('Account information actions', {annotation: {type: 'Account Dashbo
     }
 
     // Create account
-
     await registerPage.createNewAccount(faker.person.firstName(), faker.person.lastName(), emailPasswordUpdatevalue, passwordInputValue);
 
     // Update password
@@ -128,74 +127,32 @@ test.describe('Account information actions', {annotation: {type: 'Account Dashbo
 
 test.describe.serial('Account address book actions', { annotation: {type: 'Account Dashboard', description: 'Tests for the Address Book'},}, () => {
 
-  /**
-   * @feature Magento 2 Add First Address to Account
-   * @scenario User adds a first address to their account
-   * @given I am logged in
-   *  @and I am on the account dashboard page
-   * @when I go to the page where I can add my address
-   *   @and I haven't added an address yet
-   * @when I fill in the required information
-   *   @and I click the save button
-   * @then I should see a notification my address has been updated.
-   *  @and The new address should be selected as default and shipping address
-   */
-
-  test('Add_first_address',{ tag: ['@account-credentials', '@hot'] }, async ({page}, testInfo) => {
-    const accountPage = new AccountPage(page);
-    let addNewAddressTitle = page.getByRole('heading', {level: 1, name: UIReference.newAddress.addNewAddressTitle});
-
-    if(await addNewAddressTitle.isHidden()) {
-      await accountPage.deleteAllAddresses();
-      testInfo.annotations.push({ type: 'Notification: deleted addresses', description: `All addresses are deleted to recreate the first address flow.` });
-      await page.goto(slugs.account.addressNewSlug);
-    }
-
-    const firstAddress = inputValues.firstAddress;
-    const streetValue = firstAddress.firstStreetAddressValue + ' ' + Math.floor(Math.random() * 100 + 1);
-    const companyName = faker.company.name();
-    await accountPage.addNewAddress({
-      company: companyName,
-      phone: firstAddress.firstPhoneNumberValue,
-      street: streetValue,
-      zip: firstAddress.firstZipCodeValue,
-      city: firstAddress.firstCityValue,
-      state: firstAddress.firstProvinceValue,
-      country: firstAddress.firstNonDefaultCountry,
-    });
-
-    await expect(page.getByText(companyName)).toBeVisible();
-    await expect(page.getByText(streetValue)).toBeVisible();
+  test.beforeEach(async ({page}) => {
+    await page.goto(slugs.account.addressIndexSlug);
+    await page.waitForLoadState();
   });
 
   /**
+   * @feature Add an address
    * @given I am logged in
-   *  @and I am on the account dashboard page
+   * @and I am on the account dashboard page
    * @when I go to the page where I can add another address
    * @when I fill in the required information
-   *   @and I click the save button
+   * @and I click the save button
    * @then I should see a notification my address has been updated.
-   *  @and The new address should be listed
+   * @and The new address should be listed
    */
-  test('Add_another_address',{ tag: ['@account-credentials', '@hot'] }, async ({page}) => {
+  test('Add_an_address',{ tag: ['@address-actions', '@hot'] }, async ({page}) => {
     await page.goto(slugs.account.addressNewSlug);
     const accountPage = new AccountPage(page);
 
-    const secondAddress = inputValues.secondAddress;
-    const companyName = faker.company.name();
-    const streetValue = secondAddress.secondStreetAddressValue + ' ' + Math.floor(Math.random() * 100 + 1);
-    await accountPage.addNewAddress({
-      company: companyName,
-      phone: secondAddress.secondPhoneNumberValue,
-      street: streetValue,
-      zip: secondAddress.secondZipCodeValue,
-      city: secondAddress.secondCityValue,
-      state: secondAddress.secondProvinceValue,
-      country: secondAddress.secondNonDefaultCountry,
-    });
-
-    await expect(page.getByText(companyName)).toBeVisible();
-    await expect(page.getByText(streetValue)).toBeVisible();
+    const address = `${faker.location.streetAddress()} ${Math.floor(Math.random() * 100 + 1)}`;
+    const company = faker.company.name();
+
+    await accountPage.addNewAddress({ company: company, street: address});
+
+    await expect(page.getByText(address).first(), `Expect new address to be listed`).toBeVisible();
+    await expect(page.getByText(company).first(), `Expect new company name to be listed`).toBeVisible();
   });
 
   /**
@@ -210,35 +167,31 @@ test.describe.serial('Account address book actions', { annotation: {type: 'Accou
    * @then I should see a notification my address has been updated.
    *  @and The updated address should be visible in the addres book page.
    */
-  test('Edit_existing_address',{ tag: ['@account-credentials', '@hot'] }, async ({page}) => {
+  test('Edit_existing_address',{ tag: ['@address-actions', '@hot'] }, async ({page}) => {
     const accountPage = new AccountPage(page);
-    await page.goto(slugs.account.addressNewSlug);
+    await page.goto(slugs.account.addressBookSlug);
     let editAddressButton = page.getByRole('link', {name: UIReference.accountDashboard.editAddressIconButton}).first();
+    let isDefaultAddress = false;
 
     if(await editAddressButton.isHidden()){
       // The edit address button was not found, add another address first.
-      await accountPage.addNewAddress();
+      if(await page.getByRole('link', { name: 'Change Shipping Address arrow' }).isVisible()) {
+        isDefaultAddress = true;
+      } else {
+        expect (page.url(), `Edit address button not found, check URL is to the new address page`).toBe(slugs.account.addressNewSlug);
+        await accountPage.addNewAddress();
+      }
     }
 
-    await page.goto(slugs.account.addressBookSlug);
-    const editAddress = inputValues.editedAddress;
-    const companyName = faker.company.name();
-    const streetValue = editAddress.editStreetAddressValue + ' ' + Math.floor(Math.random() * 100 + 1);
-    await accountPage.editExistingAddress({
-      firstName: editAddress.editfirstNameValue,
-      lastName: editAddress.editLastNameValue,
-      company: companyName,
-      street: streetValue,
-      zip: editAddress.editZipCodeValue,
-      city: editAddress.editCityValue,
-      state: editAddress.editStateValue,
-      });
-
-    await expect(page.getByText(companyName)).toBeVisible();
-    await expect(page.getByText(streetValue)).toBeVisible();
+    // const companyName = faker.company.name();
+    const address = `${faker.location.streetAddress()} ${Math.floor(Math.random() * 100 + 1)}`;
+    await accountPage.editExistingAddress({street:address}, isDefaultAddress);
+
+    // await expect(page.getByText(companyName)).toBeVisible();
+    await expect(page.getByText(address).first()).toBeVisible();
   });
 
-  test('Missing_required_field_prevents_creation',{ tag: ['@account-credentials'] }, async ({page}) => {
+  test('Missing_required_field_prevents_creation',{ tag: ['@address-actions'] }, async ({page}) => {
     await page.goto(slugs.account.addressNewSlug);
     const accountPage = new AccountPage(page);
 
@@ -261,13 +214,14 @@ test.describe.serial('Account address book actions', { annotation: {type: 'Accou
    * @then I should see a notification my address has been deleted.
    *  @and The address should be removed from the overview.
    */
-  test('Delete_an_address',{ tag: ['@account-credentials', '@hot'] }, async ({page}, testInfo) => {
+  test('Delete_an_address',{ tag: ['@address-actions', '@hot'] }, async ({page}, testInfo) => {
     const accountPage = new AccountPage(page);
+    await page.goto(slugs.account.addressBookSlug);
 
     let deleteAddressButton = page.getByRole('link', {name: UIReference.accountDashboard.addressDeleteIconButton}).first();
 
     if(await deleteAddressButton.isHidden()) {
-      await page.goto(slugs.account.addressNewSlug);
+      // The delete address button was not found, add another address first.
       await accountPage.addNewAddress();
     }
     await accountPage.deleteFirstAddressFromAddressBook();

tests/cart.spec.ts

@@ -161,11 +161,6 @@ test.describe('Cart functionalities (guest)', () => {
 
 test.describe('Price checking tests', () => {
 
-  // Test: Configurable Product Input check from PDP to checkout
-  // test.step: add configurable product to cart, return priceOnPDP and productAmount as variables
-  // test.step: call function retrieveCheckoutPrices() to go to checkout, retrieve values
-  // test.step: call function compareRetrievedPrices() to compare price on PDP to price in checkout
-
   /**
    * @feature Simple Product price/amount check from PDP to Checkout
    * @given none
@@ -176,9 +171,9 @@ test.describe('Price checking tests', () => {
    *  @and the price in the checkout should equal the price of the product * the amount of the product
    */
   test('Simple_product_cart_data_consistent_from_PDP_to_checkout',{ tag: ['@cart-price-check', '@cold']}, async ({page}) => {
-    var productPagePrice: string;
-    var productPageAmount: string;
-    var checkoutProductDetails: string[];
+    let productPagePrice: string;
+    let productPageAmount: string;
+    let checkoutProductDetails: string[];
 
     const cart = new CartPage(page);
 

tests/category.spec.ts

@@ -4,30 +4,63 @@ import { test } from '@playwright/test';
 
 import CategoryPage from '@poms/frontend/category.page';
 
-test('Filter_category_on_size',{ tag: ['@category', '@cold']}, async ({page, browserName}) => {
+/**
+ * @feature Filter category page
+ * @scenario User filters category page on size L
+ * @given I navigate to the category page
+ * @when I open the Size filter category
+ * @and I click the size L button
+ * @then the URL should reflect this filter
+ * @and I should see fewer products
+ */
+test('Filter_category_on_size',{ tag: ['@category', '@cold']}, async ({page}) => {
   const categoryPage = new CategoryPage(page);
   await categoryPage.goToCategoryPage();
 
-  await categoryPage.filterOnSize(browserName);
+  await categoryPage.filterOnSize();
 });
 
+/**
+ * @feature Sort category page by price
+ * @scenario User sorts category page by price
+ * @given I navigate to the category page
+ * @when I open the 'Sort' dropdown
+ * @and I click the price button
+ * @then the URL should reflect this filter
+ * @and I should see products sorted by price
+ */
 test('Sort_category_by_price',{ tag: ['@category', '@cold']}, async ({page}) => {
   const categoryPage = new CategoryPage(page);
   await categoryPage.goToCategoryPage();
 
   await categoryPage.sortProducts('price');
 });
 
+/**
+ * @feature products per page
+ * @scenario User updates the amount of products shown on the page
+ * @given I navigate to the category page
+ * @when I change the 'Show' dropdown
+ * @then the URl should reflect this filter
+ * @and the amount of items should be the new amount I've selected
+ */
 test('Change_amount_of_products_shown',{ tag: ['@category', '@cold'],}, async ({page}) => {
   const categoryPage = new CategoryPage(page);
   await categoryPage.goToCategoryPage();
 
   await categoryPage.showMoreProducts();
-  // insert your code here
 });
 
+/**
+ * @feature View switcher
+ * @scenario User switches from the grid to the list view
+ * @given I navigate to the category page
+ * @when I click the grid or list mode button
+ * @then the URl should reflect this updated view
+ * @and the reported selected view should not be the same as it was before I clicked the button
+ */
 test('Switch_from_grid_to_list_view',{ tag: ['@category', '@cold'],}, async ({page}) => {
   const categoryPage = new CategoryPage(page);
   await categoryPage.goToCategoryPage();
   await categoryPage.switchView();
-});
+});