https://github.com/shoorick/codeception-test-adapter
VSCode compatible test adapter for Codeception
https://github.com/shoorick/codeception-test-adapter
codeception testing vscode-extension
Last synced: 2 days ago
JSON representation
VSCode compatible test adapter for Codeception
- Host: GitHub
- URL: https://github.com/shoorick/codeception-test-adapter
- Owner: shoorick
- License: mit
- Created: 2025-12-14T12:21:23.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2025-12-22T22:13:25.000Z (24 days ago)
- Last Synced: 2025-12-24T11:18:43.453Z (22 days ago)
- Topics: codeception, testing, vscode-extension
- Language: TypeScript
- Homepage:
- Size: 318 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Codeception Test Adapter
VSCode compatible test adapter for [Codeception](https://codeception.com/)
(PHP testing framework).
The extension discovers Codeception tests in your workspace
and integrates them with the built‑in **Testing** view, so you can:
- run individual test methods, whole test files, or entire suites;
- see green/red status and failure messages directly in VS Code;
- re‑run tests from the Testing panel or from the editor gutter.
## Features
- **Automatic test discovery**
- Looks for Codeception suites in the `tests` directory.
- Detects test files:
- `*Test.php` (PHPUnit tests),
- `*Cest.php` (Codeception tests).
- For each file, parses PHP source and creates test items for:
- methods whose names start with `test` in `*Test.php` files;
- all public methods in `*Cest.php` files (excluding magic methods like `_before`).
- Watch for file changes and re-discover tests automatically.
- **Running tests**
- Run a **single method** from gutter icon or Testing view.
- Run all tests in a **file**.
- Run an entire **suite** (e.g. `unit`, `functional`, `acceptance`).
- Uses `vendor/bin/codecept` from the workspace if available,
otherwise falls back to `codecept` in `PATH`.
- **Result reporting**
- Executes Codeception with JUnit or PHPUnit XML or HTML report enabled
(`--xml`, `--phpunit-xml`, `--html`).
- Parses XML report and maps each `` back to the corresponding test item.
- Marks suites, files, methods and dataset entries
as **passed / failed / skipped** in the Testing view.
- Shows failure messages from Codeception directly in VS Code.
## Requirements
- **VSCode** or compatible IDE (Codium, Windsurf, etc.) with VSCode OSS version 1.105 or higher.
- **PHP** and **Composer** installed.
- **Codeception** installed in your project, typically via Composer:
```bash
composer require --dev codeception/codeception
```
- Your project should follow the standard Codeception layout, for example:
```
project/
codeception.yml
tests/
unit.suite.yml
functional.suite.yml
acceptance.suite.yml
unit/
SomeTest.php
functional/
SomeCest.php
```
- Codeception must be able to write reports to the output directory
(typically `tests/_output/`, use `codeception.yml` to configure the output path).
## Install
### From Extensions view
Open the Extensions view Ctrl+Shift+X,
search for "Codeception Test Adapter", and click Install.
### Using command line
```bash
code --install-extension codeception-test-adapter-VERSION.vsix
# or
codium --install-extension codeception-test-adapter-VERSION.vsix
# or
windsurf --install-extension codeception-test-adapter-VERSION.vsix
```
depending on your IDE.
Expected output:
```
Installing extensions...
Extension 'codeception-test-adapter-0.0.1.vsix' was successfully installed.
```
## Usage
1. Open a workspace with a Codeception project in VS Code.
2. Make sure `vendor/bin/codecept` (or `codecept` in `PATH`) works from the project root.
3. Open the **Testing** view.
4. The extension will discover suites and test files under the `tests` directory and create a tree:
- `workspace-directory`
- `unit`
- `SomeTest.php`
- `testSomething`
- `functional`
- `SomeCest.php`
- `testScenarioA`
- `[data-set-0]`
- `[data-set-1]`
5. Run tests:
- click the green triangle ▷ / green circled checkmark (✓) / red circled cross (×)
icon next to a method’s signature to run a **single test**;
right click for context menu with additional options;
- click the triangle ▷ icon next to search field or press
Ctrl+; L to **rerun last tests**
- move the mouse pointer over an element in Testing tree
and then click the appearing triangle ▷ icon to run:
- all tests in a **suite**
- all tests in a **file**
- a single **test method**
- a single **dataset entry** for parametrized tests
6. After the run finishes, check statuses and failure messages
in the **Testing** view and in the **Test Results** output.
## Configuration
The extension supports the following settings (workspace scope).
- `codeceptionTestAdapter.codeceptPath`
- Path to Codeception executable.
- Default: empty (auto-detect `vendor/bin/codecept`, then `codecept` from `PATH`).
- If relative, it is resolved from the workspace folder.
- Example: `./vendor/bin/codecept`
- `codeceptionTestAdapter.reportPath`
- Path to XML report produced by Codeception.
- Default: empty.
- If empty, the adapter uses Codeception defaults in `paths.output` from `codeception.yml`:
- JUnit XML: `report.xml`
- PHPUnit XML: `phpunit-report.xml`
- If relative, it is resolved from the workspace folder.
- Example: `tests/_output/junit.xml`
- `codeceptionTestAdapter.reportFormats`
- Which reports to generate.
- Values: `junit`, `phpunit`, `html`.
- Default: `["junit"]`.
- Note: HTML report can be generated, but the adapter parses test results only from XML.
## Development
This repository is a standard VS Code extension project.
- **Build / typecheck / lint**:
```bash
npm install
npm run compile
```
- **Launch the extension**:
- open this folder in VS Code;
- run the `Launch Extension` debug configuration;
- a new VS Code window will open with the extension loaded.
- **Run extension tests**:
```bash
npm test
```
When changing the adapter logic (test discovery, running, XML parsing), keep the Testing view open in the debug instance of VS Code and use it to verify that files, methods and suites appear and update as expected.
## See also
- [VS Code Extension API Documentation](https://code.visualstudio.com/api)
- [Codeception Documentation](https://codeception.com/docs)
- [Open-Meteo and Codeception example](https://github.com/shoorick/open-meteo-codeception), use it to check how it works