Debugging

Debugging within the Functional Testing Framework is helpful in identifying test bugs by allowing you to pause execution so that you may:

• Examine the page.
• Check returned data and other variables being used during run-time.

This is straightforward to do once you create a basic Debug Configuration.

Prerequisites

• Xdebug
• PHPUnit configured for use in PHPStorm

Creating Debug Configuration with PHPStorm

1. If not already installed, download the Codeception Framework plugin for PHPStorm (PhpStorm->Preferences->Plugins).
2. Click Edit Configurations on the configuration dropdown.
3. Click + and select Codeception from the available types.
4. Change Test Scope to Type and select functional from the Type: dropdown.
5. Find the Custom Working Directory option and set the path to your dev/tests/acceptance/ directory.

If you get a warning Path to Codeception for local machine is not configured.:

1. Click Fix, then +, and select Codeception Local.
2. Click ... and locate /vendor/bin/codecept in your Adobe Commerce or Magento Open Source installation folder.

The easiest method of tagging a test for debugging is the following:

• In your Debug configuration, locate Test Runner options: and set --group testDebug.
• When you want to debug a test you are working on, simply add <group value="testDebug"/> to the annotations. Be sure to remove this after done debugging.

Your Debug Configuration should now be able to run your test and pause execution on any breakpoints you have set in the generated .php file under the _generated folder.

Last updated 9/11/2023

Was this helpful?

Yes

No