https://github.com/matepek/vscode-catch2-test-adapter
Catch2, Google Test and doctest Adapter for the VSCode
https://github.com/matepek/vscode-catch2-test-adapter
catch2 cpp doctest googletest gtest testing testing-tools testmate typescript visual-studio-code-extension vscode vscode-extension
Last synced: 1 day ago
JSON representation
Catch2, Google Test and doctest Adapter for the VSCode
- Host: GitHub
- URL: https://github.com/matepek/vscode-catch2-test-adapter
- Owner: matepek
- License: mit
- Created: 2018-08-24T08:52:33.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2026-03-19T10:45:59.000Z (14 days ago)
- Last Synced: 2026-03-19T18:40:36.972Z (14 days ago)
- Topics: catch2, cpp, doctest, googletest, gtest, testing, testing-tools, testmate, typescript, visual-studio-code-extension, vscode, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=matepek.vscode-catch2-test-adapter
- Size: 8.57 MB
- Stars: 247
- Watchers: 4
- Forks: 61
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# C++ TestMate
## A **Catch2**, **GoogleTest**, **doctest** and **GoogleBenchmark** Explorer for VSCode
[](https://marketplace.visualstudio.com/items?itemName=matepek.vscode-catch2-test-adapter)
[](https://github.com/matepek/vscode-catch2-test-adapter/issues)
[](https://marketplace.visualstudio.com/items?itemName=matepek.vscode-catch2-test-adapter)
This extension allows you to run your
[Catch2](https://github.com/catchorg/Catch2),
[Google Test](https://github.com/google/googletest)
and [DOCtest](https://github.com/doctest/doctest)
tests using the native testing vscode-api.
It also have basic support for [Google Benchmark](https://github.com/google/benchmark).
## Features / Show-Off
- New testing API integration has just happened with a tons of improvements.
- Streaming the test run: Don't have to wait for the result to see the progress (in case you test uses `std::cout`)
- Catch Section and DOCTest SubCase support (limited but still sometings)
- Runs executables parallel (_testMate.cpp.test.parallelExecutionLimit_).
- Sorts tests and suites (_testExplorer.sort_).
- Supports popular **debuggers** such as `vadimcn.vscode-lldb`, `webfreak.debug` and `ms-vscode.cpptools` out of the box.
- Retire tests and "Autorun" them.
### Screenshots
### More features
- One executable can be run parallel with distinct set of subtests to boost runtime.
- Finds and recognises the executables by a given [glob pattern](https://code.visualstudio.com/docs/editor/codebasics#_advanced-search-options). ([More](#catch2TestExplorer_executables))
- Automatically runs executables if it is modified ("_..._" -> "_Enable autorun_") or if a dependency is modified (`dependsOn`)
- Grouping can be fully customized. ([Details](https://github.com/matepek/vscode-catch2-test-adapter/blob/master/documents/configuration/test.advancedExecutables.md#testgrouping))
- and many more.. Ask on [gitter](https://gitter.im/CppTestMate/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge).
## [Configuration](https://github.com/matepek/vscode-catch2-test-adapter/tree/master/documents/configuration)
[settings.json]: https://code.visualstudio.com/docs/getstarted/settings
[test.advancedexecutables]: https://github.com/matepek/vscode-catch2-test-adapter/blob/master/documents/configuration/test.advancedExecutables.md
[debug.configtemplate]: https://github.com/matepek/vscode-catch2-test-adapter/blob/master/documents/configuration/debug.configTemplate.md
The extension is **pre-configured** and it should find executables inside the working directory
which match the following [_glob pattern_](https://code.visualstudio.com/docs/editor/codebasics#_advanced-search-options):
```
{build,Build,BUILD,out,Out,OUT}/**/*{test,Test,TEST}*
```
Not good enough for you?!: Edit your `.vscode/`[settings.json] file according to the [test.advancedExecutables]!
| `testMate.cpp.___` | Description |
| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `test.executables` | A [glob pattern](https://code.visualstudio.com/docs/editor/codebasics#_advanced-search-options) to find test executables. (Relative to the workspace folder or absolute path.) Empty string means disabled. For more option set [testMate.cpp.test.advancedExecutables](https://github.com/matepek/vscode-catch2-test-adapter/blob/master/documents/configuration/test.advancedExecutables.md) instead of this. NOTE: if `testMate.cpp.test.advancedExecutables` is set then this is ignored. |
| [test.advancedExecutables] | Array of executables with a lot of options. (If this is set then `testMate.cpp.test.executables` is ignored.) ([Details](https://github.com/matepek/vscode-catch2-test-adapter/blob/master/documents/configuration/test.advancedExecutables.md)). |
| `test.workingDirectory` | Sets the working directory of the test executable (relative to the workspace folder or absolute path). Note: `testMate.cpp.advancedExecutables` overwrites it locally. ([Variables](https://github.com/matepek/vscode-catch2-test-adapter/blob/master/documents/configuration/test.advancedExecutables.md#variables)) |
| `test.randomGeneratorSeed` | Shuffles the tests with the given random. Catch2: [--rng-seed ( or 'time')](https://github.com/catchorg/Catch2/blob/master/docs/command-line.md#rng-seed); Google Test: [--gtest_random_seed=](https://github.com/google/googletest/blob/master/googletest/docs/advanced.md#shuffling-the-tests); |
| `test.runtimeLimit` | [seconds] Test executable is running in a process. In case of an infinite loop it will run forever unless this parameter is set. It applies instantly. (0 means infinite) |
| `test.parallelExecutionLimit` | Maximum parallel run of tasks. Tasks are _'running a set of tests'_, _'test executable discovery'_ and _'reload of the executable's test list'_. NOTE: If your executables depend on the **same resource** exclusively then this **could cause a problem**. |
| `test.parallelExecutionOfExecutableLimit` | Maximum number of execution of the same executable. With this config it can be allowed that one executable is running at the same time as multiple processes and those processes _'running a set of tests'_ parallel. Useful if one executable has a lot of tests which can be run parallel. It won't have effect unless the `test.parallelExecutionLimit` is adjusted too. To enable this just for specific executables use the `testMate.cpp.test.advancedExecutables` -> `parallelizationLimit`. NOTE: if your **test cases** depend on the **same resource** exclusively then this **could cause a problem**. |
| `test.testNameLengthLimit` | Maximum character count of combined test names for the extension to split the test run into multiple executions. Helps avoid issues coming from command line length limits imposed by the operating systems (`ENAMETOOLONG`) or development frameworks. Note: The actual executable arguments' lenght depends on the framework and other settings like `prependTestRunningArgs`. Recommended checking the logs to determine the actual lenght of the arguments. |
| `test.stderrDecorator` | Controls whether to show decorators around stderr output (`⬇ std::cerr:` and `⬆ std::cerr`). |
| `discovery.loadOnStartup` | If true, the extension will try to load all the tests after the startup. Otherwise the user has to click on the Test icon on the sidebar to trigger the process. |
| `discovery.gracePeriodForMissing` | [seconds] Test executables are being watched (only inside the workspace directory). In case of one recompiles it will try to preserve the test states. If compilation reaches timeout it will drop the suite. |
| `discovery.runtimeLimit` | [seconds] The timeout of the test-executable used to identify it (Calls the exec with `--help`). |
| `discovery.testListCaching` | In case your executable took too much time to list the tests, one can set this. It will preserve the output of `--gtest_list_tests --gtest_output=xml:...`. (Beware: Older Google Test doesn't support xml test list format.) |
| `discovery.strictPattern` | Test loading fails if one of the files matched by `test.executable` is not a test executable. (Helps noticing unexpected crashes/problems under test loading.) |
| [debug.configTemplate] | Sets the necessary debug configurations and the debug button will work. |
| `debug.breakOnFailure` | Debugger breaks on failure while debugging the test. Catch2: [--break](https://github.com/catchorg/Catch2/blob/master/docs/command-line.md#breaking-into-the-debugger); Google Test: [--gtest_break_on_failure](https://github.com/google/googletest/blob/master/googletest/docs/advanced.md#turning-assertion-failures-into-break-points); Doctest: [--no-breaks](https://github.com/doctest/doctest/blob/master/doc/markdown/commandline.md) |
| `debug.noThrow` | Skips all assertions that test that an exception is thrown, e.g. REQUIRE_THROWS. This is a Catch2 parameter: [--nothrow](https://github.com/catchorg/Catch2/blob/master/docs/command-line.md#eliding-assertions-expected-to-throw); |
| `log.logpanel` | Creates a new output channel and write the log messages there. For debugging. Enabling it could slow down your vscode. |
| `log.logfile` | Writes the log message into the given file. Empty means disabled. |
| `gtest.treatGmockWarningAs` | Forces the test to be failed even it is passed if it contains the string `GMOCK_WARNING:`. (You may should consider using [testing::StrictMock](https://github.com/google/googletest/blob/master/googlemock/docs/cook_book.md#the-nice-the-strict-and-the-naggy-nicestrictnaggy)) |
| `gtest.gmockVerbose` | Sets [--gmock_verbose=...](https://github.com/google/googletest/blob/master/googlemock/docs/cheat_sheet.md#flags). (Note: executable has to be linked to gmock `gmock_main` not `gtest_main`) |
Plenty of more **fine-tuning options** are available under [test.advancedExecutables] like:
- test grouping
- parallel running
- ingoring std error
- ...
## Commands
| ID | Command |
| -------------------------------- | ------------------------------------- |
| `testMate.cmd.reload-tests` | Reload tests |
| `testMate.cmd.reload-workspaces` | Force reload workspaces (clean slate) |
| `testing.refreshTests` | Force reload workspaces (clean slate) |
## [License](https://github.com/matepek/vscode-catch2-test-adapter/blob/master/LICENSE)
## [Support](https://github.com/matepek/vscode-catch2-test-adapter/blob/master/documents/support.md)
## [Contribution](CONTRIBUTING.md)