Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/recca0120/vscode-phpunit

The VS Code Test Explorer extension for PHPUnit
https://github.com/recca0120/vscode-phpunit

php phpunit test test-explorer testing vscode vscode-extension

Last synced: 1 day ago
JSON representation

The VS Code Test Explorer extension for PHPUnit

Host: GitHub
URL: https://github.com/recca0120/vscode-phpunit
Owner: recca0120
License: mit
Created: 2017-08-15T19:47:39.000Z (over 7 years ago)
Default Branch: main
Last Pushed: 2023-11-20T23:48:47.000Z (about 1 year ago)
Last Synced: 2024-04-25T18:01:57.697Z (8 months ago)
Topics: php, phpunit, test, test-explorer, testing, vscode, vscode-extension
Language: TypeScript
Homepage:
Size: 9.24 MB
Stars: 121
Watchers: 9
Forks: 42
Open Issues: 24
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

README

# PHPUnit & Pest Test Explorer

[![version](https://img.shields.io/vscode-marketplace/v/recca0120.vscode-phpunit.svg?style=flat-square&label=vscode%20marketplace)](https://marketplace.visualstudio.com/items?itemName=recca0120.vscode-phpunit)
[![downloads](https://img.shields.io/vscode-marketplace/d/recca0120.vscode-phpunit.svg?style=flat-square)](https://marketplace.visualstudio.com/items?itemName=recca0120.vscode-phpunit)

Run your PHPUnit OR Pest tests in Node using the Test Explorer UI.

![PHPUnit](img/phpunit.gif)

![PEST](img/pest.png)

## Features

- Shows a Test Explorer in the Test view in VS Code's sidebar with all detected tests and suites and their state
- 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

## Extension Settings

Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.

This extension contributes the following settings:

- `phpunit.php`: Absolute path to php. Fallback to global php if it exists on the command line.
- `phpunit.phpunit`: Path to phpunit. Can be the phpunit file or phpunit.phar.\n\nAutomatically finds it in common
places:\n - Composer vendor directory\n - phpunit.phar in your project\n - phpunit (or phpunit.bat for windows)
globally on the command line
- `phpunit.command`: Custom command to run. Ex: `docker exec -t container_name`.
- `phpunit.args`: Any phpunit args (phpunit --help) E.g. --configuration ./phpunit.xml.dist
- `phpunit.environment`: Set environment variables before running the phpunit command, Ex: { "XDEBUG_MODE": "coverage" }
or "XDEBUG_MODE=coverage"
- `phpunit.clearOutputOnRun`: True will clear the output when we run a new test. False will leave the output after every
test.
- `phpunit.showAfterExecution` Specify if the test report will automatically be shown after execution

## Commands

The following commands are available in VS Code's command palette, use the ID to add them to your keyboard shortcuts:

- `phpunit.reload`: PHPUnit: Reload tests
- `phpunit.run-all`: PHPUnit: Run all tests
- `phpunit.run-file`: PHPUnit: Run tests in current file
- `phpunit.run-test-at-cursor`: PHPUnit: Run the test at the current cursor position
- `phpunit.rerun`: PHPUnit: Repeat the last test run

## Configuration

### [Pest](https://pestphp.com/)

```jsonc
{
"phpunit.phpunit": "vendor/bin/pest"
}
```

### [ParaTest](https://github.com/paratestphp/paratest)

```jsonc
{
"phpunit.phpunit": "vendor/bin/paratest"
}
```

### Docker

```jsonc
{
"phpunit.command": "docker exec -t [container_id] /bin/sh -c",
"phpunit.php": "php",
"phpunit.phpunit": "vendor/bin/phpunit",
"phpunit.args": [
"-c",
"phpunit.xml"
],
"phpunit.paths": {
"${workspaceFolder}": "/app",
},
}
```

```jsonc
{
"phpunit.command": "docker run --rm -t -v ${PWD}:/app -w /app php:latest",
"phpunit.php": "php",
"phpunit.phpunit": "vendor/bin/phpunit",
"phpunit.args": [
"-c",
"phpunit.xml"
],
"phpunit.paths": {
"${workspaceFolder}": "/app",
},
}
```

### Docker & Pest

```jsonc
{
"phpunit.command": "docker exec -t [container_id] /bin/sh -c",
"phpunit.php": "php",
"phpunit.phpunit": "vendor/bin/pest",
"phpunit.args": [
"-c",
"phpunit.xml"
],
"phpunit.paths": {
"${workspaceFolder}": "/app",
},
}
```

```jsonc
{
"phpunit.command": "docker run --rm -t -v ${PWD}:/app -w /app php:latest",
"phpunit.php": "php",
"phpunit.phpunit": "vendor/bin/pest",
"phpunit.args": [
"-c",
"phpunit.xml"
],
"phpunit.paths": {
"${workspaceFolder}": "/app",
},
}
```

### SSH

```jsonc
{
"phpunit.command": "ssh -i dockerfiles/pest/id_rsa -p 2222 root@localhost -o StrictHostKeyChecking=no cd /app;",
"phpunit.php": "php",
"phpunit.phpunit": "vendor/bin/phpunit",
"phpunit.args": [
"-c",
"phpunit.xml"
],
"phpunit.paths": {
"${workspaceFolder}": "/app",
}
}
```

### SSH & Pest

```jsonc
{
"phpunit.command": "ssh -i dockerfiles/pest/id_rsa -p 2222 root@localhost -o StrictHostKeyChecking=no cd /app;",
"phpunit.php": "php",
"phpunit.phpunit": "vendor/bin/pest",
"phpunit.args": [
"-c",
"phpunit.xml"
],
"phpunit.paths": {
"${workspaceFolder}": "/app",
}
}
```

## Troubleshooting