Project

General

Profile

Debugging CiviCRM cheatsheet » History » Version 10

Jon Goldberg, 10/05/2021 05:30 PM

1 7 Jon Goldberg
{{last_updated_at}} by {{last_updated_by}}
2
3 1 Jon Goldberg
# Debugging CiviCRM cheatsheet
4
5
### Command-line runs of PHPUnit:
6
7
From a buildkit civiroot, run a specific file's tests::
8
9 2 Jon Goldberg
```shell
10
CIVICRM_UF=UnitTests phpunit5 tests/phpunit/CRM/Core/BAO/AddressTest.php
11
```
12 1 Jon Goldberg
13
You can also limit to a single test by filtering on name:
14
15 2 Jon Goldberg
```shell
16
CIVICRM_UF=UnitTests phpunit5 tests/phpunit/CRM/Core/BAO/AddressTest.php --filter testShared
17
```
18 3 Jon Goldberg
19
### With XDebug
20 9 Jon Goldberg
21 1 Jon Goldberg
* 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);
22 10 Jon Goldberg
* You need to specify a full path to phpunit (because running `php <script>` won't check your path for the script, just `php`).
23
* You need to have XDebug otherwise configured for CLI.  Here's the contents of my `/etc/php/7.4/cli/conf.d/xdebug.ini`:
24 2 Jon Goldberg
25
```
26 10 Jon Goldberg
xdebug.mode=off
27
xdebug.start_with_request=yes
28
xdebug.client_port=9000
29
xdebug.client_host = "127.0.0.1"
30
xdebug.log=/var/log/xdebug.log
31 1 Jon Goldberg
```
32 5 Jon Goldberg
* You need to start a debugging session in VS Code with "Listen for XDebug".
33 2 Jon Goldberg
34
Once you've got all that:
35
```shell
36 10 Jon Goldberg
env CIVICRM_UF=UnitTests idekey=VSCODE php -dxdebug.mode=develop /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
37 2 Jon Goldberg
```
38 6 Jon Goldberg
39 8 Jon Goldberg
### Command-line runs of standalone scripts
40 6 Jon Goldberg
```shell
41 8 Jon Goldberg
env XDEBUG_SESSION=VSCODE php -dzend_extension=xdebug.so myscript.php
42 6 Jon Goldberg
```