Skip to content

Latest commit

 

History

History
94 lines (72 loc) · 17.1 KB

README.md

File metadata and controls

94 lines (72 loc) · 17.1 KB
Raw

C++ TestMate

A Catch2, GoogleTest, doctest and GoogleBenchmark Explorer for VSCode

Visual Studio Marketplace GitHub issues Visual Studio Marketplace

This extension allows you to run your Catch2, Google Test and DOCtest tests using the native testing vscode-api. It also have basic support for 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

Screenshot1

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. (More)
  • Automatically runs executables if it is modified ("..." -> "Enable autorun") or if a dependency is modified (dependsOn)
  • Grouping can be fully customized. (Details)
  • and many more.. Ask on gitter.

Configuration

The extension is pre-configured and it should find executables inside the working directory which match the following glob pattern:

{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 to find test executables. (Relative to the workspace folder or absolute path.) Empty string means disabled. For more option set testMate.cpp.test.advancedExecutables 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).
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)
test.randomGeneratorSeed Shuffles the tests with the given random. Catch2: --rng-seed ( or 'time'); Google Test: --gtest_random_seed=;
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.
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; Google Test: --gtest_break_on_failure; Doctest: --no-breaks
debug.noThrow Skips all assertions that test that an exception is thrown, e.g. REQUIRE_THROWS. This is a Catch2 parameter: --nothrow;
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)
gtest.gmockVerbose Sets --gmock_verbose=.... (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

Support

Contribution