Debugging PHPUnit tests in VS Code?

Question

I have recently configured VS code to debug PHP with xdebug. It works reliably with my application code but when I am running unit tests with PHPunit, my breakpoints are ignored.

My server is run inside a vagrant box.

My php.ini file contains the following lines:

[xdebug]
zend_extension="/usr/lib/xdebug/xdebug-2.2.7/modules/xdebug.so" 
xdebug.remote_enable=1
xdebug.remote_port=9000
xdebug.remote_connect_back=1
xdebug.remote_autostart=1

I use the PHP Debug VS Code extension.

This is my launch.json config:

{
    "name": "Listen for XDebug",
    "type": "php",
    "request": "launch",
    "pathMappings": {
        "/var/www/mysite.local/": "${workspaceFolder}"
    },
    "port": 9000,
    "log": true
}

My unit tests run fine, for example, from within /var/www/mysite.local, I can run:

phpunit --filter myTestMethod path/to/my/test/file/myTest.php

but while the test will run, a breakpoint I have within the test itself is consistently ignored and I cannot figure out why.

Has anybody had a similar issue? Is there a difference between how debugging works in the context of a normal application request and a unit test?

I think an xdebug.log may be more explanatory. Add xdebug.remote_log=xdebug.log into your xdebug config and try to debug again a phpunit test. Then edid your question and place the xdebug.log into your answer. The xdebug.log will be in your project's root. — Dimitrios Desyllas
– Dimitrios Desyllas, Commented Oct 18, 2019 at 7:36

Moshe Fortgang · Accepted Answer · 2019-08-25 15:04:44Z

4

Your problem is happening because of pathMappings settings when you run a unit test with an absolute path, my suggestion is to replace the

   "pathMappings": {
        "/var/www/mysite.local/": "${workspaceFolder}"
    },

with

   "pathMappings": {
        "/var/www/mysite.local/": "${workspaceFolder}",
        "${workspaceFolder}": "${workspaceFolder}"
    },

or disabled it when you run unit test

edited Aug 25, 2019 at 15:04

answered Aug 25, 2019 at 14:48

Moshe Fortgang

1,2109 silver badges23 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

jagershark Over a year ago

Thanks for the answer @mfort. I tried adding "${workspaceFolder}": "${workspaceFolder}" to my pathMappings, to no such luck. What exactly should I disable when I run a unit test?

Moshe Fortgang Over a year ago

@loxyboi Refer to this line "/var/www/mysite.local/": "${workspaceFolder}", replace with // "/var/www/mysite.local/": "${workspaceFolder}",

jagershark Over a year ago

Thanks @mfort but that doesn't seem to have solved my problem.

dkg · Accepted Answer · 2019-12-31 14:05:44Z

0

In my case, phpunit was calling the php cli and this latter was not using the php.ini conf file used by my test server which had xdebug activated.

Be sure the right php.ini file is used. You can specify it when calling php with the -c argument.

You can pass this argument to php by editing the launch script of phpunit that can be found in vendor/bin/phpunit.bat (for windows).

The file looks like this:

@ECHO OFF
setlocal DISABLEDELAYEDEXPANSION
SET BIN_TARGET=%~dp0/../phpunit/phpunit/phpunit
php "%BIN_TARGET%" %*

Just add the -c behind php with the path to php.ini directory:

php -c PATH_TO_PHP.INI_DIRECTORY "%BIN_TARGET%" %*

edited Dec 31, 2019 at 14:05

answered Dec 29, 2019 at 17:40

dkg

1,78515 silver badges34 bronze badges

2 Comments

Tony Over a year ago

The -c flag of phpunit is to load an XML file (from the help: -c|--configuration <file> Read configuration from XML file) but the php.ini file is not an XML document, so how did you get it to load?

dkg Over a year ago

That's the -c flag of php, not phpunit. I may have not been very clear, let me updated the answer.

cjsimon · Accepted Answer · 2023-04-05 23:22:47Z

0

Do you happen to have your Xdebug 2 set to start on trigger?

xdebug.trace_enable_trigger=1
xdebug.trace_enable=0

xdebug.profile_enable_trigger=1
xdebug.profile_enable=0

On Xdebug 3 with start on trigger (xdebug.start_with_request=trigger), I had to set the xdebug.idekey for vscode. It can also be set using the XDEBUG_CONFIG envvar:

XDEBUG_CONFIG="idekey=VSCODE" phpunit --filter myTestMethod path/to/my/test/file/myTest.php

It seems like vscode checks for any set idekey value; In my browser my Xdebug helper extension has had the idekey set to PHPSTORM, and debugging from there has been working just fine

edited Apr 5, 2023 at 23:22

answered Mar 31, 2023 at 22:34

cjsimon

1,2211 gold badge13 silver badges23 bronze badges

1 Comment

cjsimon Over a year ago

You may need to append to the envvar instead if it isn't empty like mine was: XDEBUG_CONFIG="$XDEBUG_CONFIG \"idekey=VSCODE\""

Yan Zhao · Accepted Answer · 2024-06-09 20:26:35Z

0

I had the same issue and later found out somehow my Xdebug model is broken:

php -m

Didn't find the Xdebug model:

Warning: Failed to load D:\xampp\php\ext\php_xdebug-3.1.3-7.4-vc15-x86_64.dll, The system cannot find the file specified.

Reinstalled the XDebug fixed my problem.

Also need to restart Apache.

answered Jun 9, 2024 at 20:26

Yan Zhao

4695 silver badges15 bronze badges

Comments

phispi · Accepted Answer · 2024-11-30 11:42:33Z

0

I had the same effect (breakpoints were ignored in Visual Studio Code).

Ensure installation and loading the module worked by calling on a command line prompt
```
php -m  
```
This shows all loaded PHP extensions (Xdebug should be listed in the Zend Modules section)
Ensure your configuration was applied by checking that the .ini files you were modifying are loaded
```
php --ini
```
(in my case, the ini file /etc/php/8.2/cli/conf.d/my_xdebug.ini was only readable by root and therefore ignored, making it user readable solved my problem)
Show effective configuration options of xdebug
```
php --re xdebug
```

The options I finally used for phpunit in the ini file were

xdebug.mode=debug
xdebug.idekey=VSCODE

answered Nov 30, 2024 at 11:42

phispi

8898 silver badges21 bronze badges

Comments

Leutecia · Accepted Answer · 2025-01-08 21:34:27Z

0

For me, adding this in php.ini worked like a charm.

xdebug.start_with_request=yes

answered Jan 8 at 21:34

Leutecia

1451 gold badge4 silver badges10 bronze badges

Collectives™ on Stack Overflow

Debugging PHPUnit tests in VS Code?

6 Answers 6

3 Comments

2 Comments

1 Comment

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

3 Comments

2 Comments

1 Comment

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related