Testing

Code of the Loki Checkout is tested in various ways:

• Unit tests based on PHPUnit;
• Integration tests based on PHPUnit and the Magento Testing Framework;
• Functional tests based on PHPUnit;
• Functional tests based on Playwright;

Unit tests based on PHPUnit

Unit tests are focused on specific methods and classes with little dependencies. Unit tests are meant to be run within an instance of Magento, which for instance gives the benefit of autoloading classes in app/code, but without depending the dev/tests/unit/ folder (which also means that the testing framework its ObjectManager is not used). This works in 99% of all the cases, but because there are edge-cases where the ObjectManager (of the unit testing framework) is a better solution, we recommend to run unit tests via the unit testing framework.

Typically, unit tests can be run by using the following CLI:

cd dev/tests/unit
../../../vendor/bin/phpunit ../../../vendor/yireo/magento2-loki-checkout/Test/Unit/

As soon as the complexity of a unit goes up, an integration test is preferred instead.

Integration tests based on PHPUnit

We aim for a large coverage of methods and classes via integration tests. Furthermore, if there are bugs in the code, the aim is to either proof such a bug via an integration test or a functional tests based on Playwright. The integration tests of the LokiCheckout can be divided into 2 groups:

• Tests for specific classes and methods. This includes DI plugin tests, observer tests, utility tests. It also includes tests for LokiComponents repositories, contexts and ViewModels. These tests are first generated and then custom-tailored to test for the specific functionality. This is comparable to unit tests, except for that the entire Magento application is bootstrapped and taken into account.

• Tests that run across multiple classes and sometimes even multiple modules. This includes tests for entire Loki-components, often rendering the page to see if the component guerantees specific behaviour. Or for instance, the basic ModuleTest test that checks if a module is enabled while running integration tests, pretty vital.

Integration tests can be run by using the following CLI:

cd dev/tests/integration
../../../vendor/bin/phpunit ../../../vendor/yireo/magento2-loki-checkout/Test/Integration/

Note that this requires you to know how to setup the integration tests for your system as well.

Functional tests based on Playwright

In addition to PHPUnit-based tests (unit and integration), we also aim for coverage with Playwright. These tests are labeled as functional tests and not end-to-end tests, because the goal of these tests is the guarantee the functionality of the Loki Checkout, not the functionality of a real-life Magento project. The functional tests of Loki involve for instance using the official Magento sample data and toggling fields in the configuration to check the functionality with or without a specific setting or module.

To allow for modifying backend settings, we have created a specific HTTP API for various tasks (toggling modules, toggling settings, adding additional XML layout handles, flushing the cache) protected with an access token. Also, Loki offers logic in Playwright tests to quickly call upon these tasks as well.

Because of the complexity of the tests, these tests are included in a separate composer package yireo/magento2-loki-checkout-functional-tests which includes numerous Magento modules that are created for testing purpose only and Playwright tests.

Playwright tests are added to a Test/Playwright/ folder of each module, which is then included by the module Yireo_LokiCheckoutFunctionalTests.

Setting up functional tests

First, make sure you have a running instance of Magento 2 with the Loki Checkout installed. The composer package yireo/magento2-loki-checkout-functional-tests installs all required dependencies. To a minimum, the module Yireo_LokiCheckoutFunctionalTests should be installed and enabled.

Within the Store Configuration configure the following options:

• Test token (yireo_loki_checkout/test/token). In this example, we'll use a value foobar23423

Next, create an .env file with the following details:

TEST_URL=http://localhost
TEST_TOKEN=superdupersecrettoken

In the default setup, this is used in the configuration playwright.config.ts as follows:

import { defineConfig } from '@playwright/test';
export default defineConfig({
  use: {
    baseURL: `${process.env.TEST_URL}`,
    extraHTTPHeaders: {
      'Authorization': `token ${process.env.TEST_TOKEN}`,
    },
  }
});

End-to-end tests

Finally, we also have end-to-end tests for specific LokiCheckout sites based on Playwright. The Yireo_LokiCheckoutFunctionalTests module is not needed here. The tests are based on manual Playwright code that is customized for each specific testing site.

In the future, we hope to share some of this work with the world as well.