Skip to content

Tips & tricks

Tips & tricks

⛑ Problems

  • Since version 17, node prefers IP v6 over IP v4. This may prevent the process to properly connect to localhost. Either prefer url with http://127.0.0.1 or use the environment variable NODE_OPTIONS=--dns-result-order=ipv4first.

  • ui5-test-runner is regularly tested with the latest versions of puppeteer, selenium-webdriver and other packages. If you face troubles with one of these and you are not using the latest version (the runner will generate the PKGVRS warning), try upgrading.

  • Because of the asynchronous nature of sap.ui.define and sap.ui.require, tests are usually loaded after the QUnit framework. It is recommended to execute QUnit.config.autostart = false; as soon as possible to ensure the test framework waits for the tests to be loaded and then call QUnit.start();. If not done properly, the ui5-test-runner is capable of running the tests and updates itself while the tests are being loaded. However, it might happen that the QUnit framework fails to handle the tests, which may also fail the runner.

  • By default QUnit randomizes the unit tests order (not within OPA): use QUnit.config.reorder = false; to prevent this behavior. NOTE: this does not work if the autostart configuration is not done properly.

  • For language testing, it is recommended to use --page-params with sap-ui-language=DE (for instance).

👟 Performances

  • The runner takes a screenshot for every OPA assertion (Opa5.assert.ok) : disabling screenshots will speed up the tests. Yet, if a test fails, a screenshot is captured after the error (unless using --screenshot-on-failure false).

  • To benefit from parallelization, use the option --split-opa (available from version 4.5.0) : it automatically splits the OPA journeys into different test pages.

✍ IDEs

  • ui5-test-runner runs in Business Application Studio provided the instance is created with the Headless Testing Framework extension. Then configure the runner to use the webdriverio browser combined with the firefox setting. For instance : ui5-test-runner --browser $/webdriverio.js -- --browser firefox.

⚠️ As of March 2025, it is recommended to install webdriverio@8 first as it works better than the latest one.