Loki_FunctionalTests

This is an internal package containing Functional Tests based on Playwright. This is used specifically by the Loki core development team. Do not use this for your own shop. Also, do not enable the module Loki_FunctionalTests in production. When using this module anyway, do make sure to configured a proper token.

Installation

Install this package via composer:

composer require loki/magento2-functional-tests

Next, enable this module:

bin/magento module:enable Loki_FunctionalTests

Setup

Setup Playwright:

cd vendor/loki/magento2-functional-tests/Test/Playwright/
npm install
npx playwright install

Next, create a custom .env file within the same Test/Playwright/ folder:

TEST_URL=http://magento.local
TEST_TOKEN=loki

Next, make sure the listing of Loki modules in app/etc/loki.json is up to date:

bin/magento loki:modules:dump

Set the token from the CLI

Make sure a secure token is configured. The security token can also be reset from the CLI:

bin/magento config:set loki/functional_tests/token loki

For instance, you could generate a random token as follows

TOKEN=`tr -dc A-Za-z0-9 </dev/urandom | head -c 128; echo`
bin/magento config:set loki/functional_tests/token $TOKEN

Just make sure that the token matches the one in .env.

Running tests

All commands are run from the previous folder:

cd vendor/loki/magento2-functional-tests/Test/Playwright/

Run tests in headless mode:

npx playwright test
npx playwright show-report

Or run tests in the UI mode:

npx playwright test --ui

Or:

npx playwright test --headed

Because the app/etc/loki.json file contains entries that are being turned into Playwright projects, you can also run just a single project:

npx playwright test --ui --project=LokiCheckout_Mollie
npx playwright test --ui --project=LokiCheckout_Core basic-test
npx playwright test --ui --project=LokiCheckout_Core basic-test --debug

Note that parallelism doesn't work well. Each test could reconfigure the Magento instance with specific modules and configuration options. With that, the reconfiguration for one test might conflict with another test. Because of this, tests should not be run in parallel :(

If the Magento root could not be detected, for instance because your modules are symlinked into the Magento folder, define the Magento root via the environment variable MAGENTO_ROOT:

MAGENTO_ROOT=/var/www/html npx playwright test --ui

Switching the frontend theme

The configure endpoint (used by setupCheckout()) accepts a theme option with the code of a frontend theme:

await setupCheckout(page, context, {theme: 'Hyva/default-csp'});
await setupCheckout(page, context, {theme: 'Magento/luma'});

The theme is saved in the default scope. Any website-level or store-level theme overrides are removed, so that the given theme is always the active one.

Running the run-playwright-tests.sh script

This script is used mainly by the Loki core development team. To use it, navigate to your Magento root and symlink the script:

ln -s ./vendor/loki/magento2-functional-tests/run-playwright-tests.sh .

The script allows for the following parameters:

• A Playwright project aka Magento 2 module with a Test/Playwright/ folder. This can also be ui to start the UI instead;
• A specific test (or test pattern) within the Playwright project);
• Token type. Currently random is supported. Otherwise the token defaults to loki;

Run all LokiCheckout_Core tests:

./run-playwright-tests.sh LokiCheckout_Core

Starting the UI:

./run-playwright-tests.sh ui

Current status

Support

For getting support, create an Issue under the following project URL:

https://gitlab.yireo.com/loki-extensions/Loki_FunctionalTests.git