PHP: Unit Test Explorer UI for Visual Studio Code
Run your PHP tests using the
Test Explorer UI.
This project is a fork from recca0120/vscode-phpunit ❤️
Features
- Shows a Test Explorer in the Test view in VS Code's sidebar with all detected tests and suites and their state
- Adds CodeLenses to your test files for starting and debugging tests
- Adds Gutter decorations to your test files showing the tests' state
- Adds line decorations to the source line where a test failed
- Shows a failed test's log when the test is selected in the explorer
- Lets you choose test suites or individual tests in the explorer that should be run automatically after each file change
- Forwards the console output from PHPUnit to a VS Code output channel
- Run tests into the docker container
- (new) pathMapping when local folder and docker mount folder are different.
Getting started
- Install the extension
- Restart VS Code and open the Test view
- Run your tests using the
icons in the Test Explorer or the CodeLenses in your test file
- For running tests on a docker container see the configuration
- For running phpunit on a remote system or using vagrant see Troubleshooting
Configuration
Custom debugger configuration
Other options
| Property |
Description |
testExplorer.codeLens |
Show a CodeLens above each test or suite for running or debugging the tests |
testExplorer.gutterDecoration |
Show the state of each test in the editor using Gutter Decorations |
testExplorer.onStart |
Retire or reset all test states whenever a test run is started |
testExplorer.onReload |
Retire or reset all test states whenever the test tree is reloaded |
Commands
The following commands are available in VS Code's command palette, use the ID to add them to your keyboard shortcuts:
| ID |
Command |
test-explorer.reload |
Reload tests |
test-explorer.run-all |
Run all tests |
test-explorer.run-file |
Run tests in current file |
test-explorer.run-test-at-cursor |
Run the test at the current cursor position |
test-explorer.cancel |
Cancel running tests |
Troubleshooting
All tests are appearing twice with "*** duplicate ID ***" found.
You likely have a file sensitive file system. The default value of "phpunit.files": "{test,tests,Test,Tests}/**/*Test.php", should be changed to "phpunit.files": "{test,tests}/**/*Test.php",
I'm using Vagrant / Homestead for remote execution
Your tests will list in the explorer for reading locally, but you need to run your tests remotely using PHP on your vagrant machine.
To do this you need to configure the following settings:
"phpunit.relativeFilePath": true, - This will ensure your files are located correctly for local checks
"phpunit.phpunit": "/FULL_PATH_TO/vendor/bin/phpunit", - your remote path, likely in /var/www/html/
"phpunit.discoverConfigFile": false, if true the extension automatically try to find phpunit.xml or phpunit.xml.dist in you project.
"phpunit.configFile": "/FULL_PATH_TO/phpunit.xml", path to phpunit.xml or phpunit.xml.dist file. If this config is specified the "phpunit.discoverConfigFile" automatically turns to false
"phpunit.php": "/usr/local/bin/vagrant exec php", this is to execute PHP on the remote machine. You'll need to install and configure https://github.com/p0deje/vagrant-exec - this wraps the command like using ssh -C
You can also use the method above to execute on Docker remotely
"phpunit.docker": true, this is to enable run the tests into the docker container
"phpunit.dockerImage": "docker run --rm -v $(pwd):$(pwd) -w=$(pwd) dockername", this is to use the docker container to run the tests.
If you need configure this with docker-compose configure:
"phpunit.dockerImage": "docker-compose exec -T dockername"
"phpunit.pathMappings": "{"workspace/local/folder": "docker/folder"}", this is to use differents path between local folder and docker mount folder.
Example any project folder:
/src/
/data/
/mysql/
/dockerfiles/
/....
You need mount src/ into /var/www/html/, then configure pathMapping like this:
"phpunit.pathMappings": {
"${workspaceRoot}/src/": "/var/www/html/",
},
My /usr/local/bin/vagrant isn't found?
Spawn likely can't find vagrant locally. You need to switch to using your regular terminal using something like "phpunit.shell": "/bin/bash", or "phpunit.shell": "/bin/zsh",
