Debugging CiviCRM cheatsheet » History » Revision 14
Revision 13 (Jon Goldberg, 10/11/2021 06:32 PM) → Revision 14/45 (Jon Goldberg, 10/11/2021 06:36 PM)
{{last_updated_at}} by {{last_updated_by}}
# Debugging CiviCRM cheatsheet
### Command-line runs of PHPUnit:
From a buildkit civiroot, run a specific file's tests::
```shell
CIVICRM_UF=UnitTests phpunit5 tests/phpunit/CRM/Core/BAO/AddressTest.php
```
You can also limit to a single test by filtering on name:
```shell
CIVICRM_UF=UnitTests phpunit5 tests/phpunit/CRM/Core/BAO/AddressTest.php --filter testShared
```
### With XDebug
#### Web Browser
* Install the xdebug extension (e.g. `sudo apt install php7.4-xdebug`).
* Configure xdebug by copying the values below to `/etc/php/7.4/fpm/conf.d/xdebug.ini`:
```
xdebug.mode=debug,develop
xdebug.start_with_request=trigger
xdebug.client_port=9000
xdebug.client_host = "127.0.0.1"
xdebug.log=/var/log/xdebug.log
#xdebug.mode=profile
#xdebug.output_dir = "/home/jon/temp/xdebug"
```
* Install a plugin for your browser, like "XDebug Helper for Firefox".
* In the plugin's configuration, set the IDE key to `VSCODE`.
To debug, you must turn on the debugger in VS Code, then enable debugging in the address bar for the requests in question.
#### Command Line (phpunit)
* You need to specify a full path to phpunit (because running `php <script>` won't check your path for the script, just `php`).
* You need to have XDebug otherwise configured for CLI. Use Here's the same configuration file as under "Web Browser", but at `/etc/php/7.4/cli/conf.d/xdebug.ini`. contents of my `/etc/php/7.4/cli/conf.d/xdebug.ini`:
```
xdebug.mode=debug,develop
xdebug.start_with_request=trigger
xdebug.client_port=9000
xdebug.client_host = "127.0.0.1"
xdebug.log=/var/log/xdebug.log
#xdebug.mode=profile
#xdebug.output_dir = "/home/jon/temp/xdebug"
```
* You need to start a debugging session in VS Code with "Listen for XDebug".
* Depending on your VS Code setup, you may need to listen on a different port (I can use the same port for FPM but not mod_php).
Once you've got all that:
```shell
env CIVICRM_UF=UnitTests idekey=VSCODE php /home/jon/local/civicrm-buildkit/bin/phpunit7 /home/jon/local/civicrm-buildkit/build/dmaster/web/sites/all/modules/civicrm/tests/phpunit/CRM/Event/Form/Registration/ConfirmTest.php --filter testSubmit
```
### Command-line runs of standalone scripts
```shell
env XDEBUG_SESSION=VSCODE php myscript.php
```