LokiCheckout_FunctionalTests

Jump to User Docs

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

Installation

Install this package via composer (assuming you have setup the composer.yireo.com repository correctly already):

composer require loki-checkout/magento2-functional-tests

Next, enable this module:

bin/magento module:enable LokiCheckout_FunctionalTests

Setup

Setup Playwright:

cd vendor/loki-checkout/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=foobar

Next, copy the file modules.json.example to modules.json and include a list of modules you would like to include for testing. To generate a new listing for all existing modules, run the following:

bin/magento loki-checkout:modules:list --format=json > vendor/loki-checkout/magento2-functional-tests/Test/Playwright/modules.json

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/general/token foobar

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/general/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-checkout/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 modules.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_ basic-test
npx playwright test --ui --project=LokiCheckout_ 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 :(

Support

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

https://gitlab.yireo.com/loki-checkout/LokiCheckout_FunctionalTests