Project

General

Profile

Debugging CiviCRM cheatsheet » History » Version 2

Jon Goldberg, 07/03/2020 09:03 PM

1 1 Jon Goldberg
# Debugging CiviCRM cheatsheet
2
3
### Command-line runs of PHPUnit:
4
5
From a buildkit civiroot, run a specific file's tests::
6
7 2 Jon Goldberg
```shell
8
CIVICRM_UF=UnitTests phpunit5 tests/phpunit/CRM/Core/BAO/AddressTest.php
9
```
10 1 Jon Goldberg
11
You can also limit to a single test by filtering on name:
12
13 2 Jon Goldberg
```shell
14
CIVICRM_UF=UnitTests phpunit5 tests/phpunit/CRM/Core/BAO/AddressTest.php --filter testShared
15
```
16
To run with XDebug:
17
* You need to define an additional php.ini setting at runtime (otherwise XDebug will always be on for CLI, leading to a big loss in performance);
18
* You need to specify a full path to phpunit5 (because running `php <script>` won't check your path for the script, just `php`).
19
* You need to have XDebug otherwise configured for CLI.  Here's the contents of my `/etc/php/7.3/cli/conf.d/xdebug.ini`:
20
```
21
xdebug.remote_enable=1
22
xdebug.remote_autostart=1
23
xdebug.remote_handler=dbgp
24
xdebug.remote_mode=req
25
xdebug.remote_host=127.0.0.1
26
xdebug.remote_port=9000
27
```
28
29
Once you've got all that:
30
```shell
31
env CIVICRM_UF=UnitTests idekey=VSCODE php -dzend_extension=/usr/lib/php/20180731/xdebug.so /home/jon/local/civicrm-buildkit/bin/phpunit5 /home/jon/local/civicrm-buildkit/build/dmaster/web/sites/all/modules/civicrm/tests/phpunit/CRM/Contact/Import/Parser/ContactTest.php --filter '^.*::testIgnoreLocationTypeId( .*)?$'
32
```