Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/DavidSchuldenfrei/gtest-adapter


https://github.com/DavidSchuldenfrei/gtest-adapter

Last synced: 28 days ago
JSON representation

Awesome Lists containing this project

README 

        
# GoogleTest adapter README



Allows viewing all GoogleTests in a tree view, and running/debugging them.



## Features



This extension presents all GoogleTests in your application in a tree view. The developer can then run/debug any of these tests.



![Show GoogleTest Adapter](/images/Demo.gif)



## Usage



This extension is standalone, and doesn't depend on any other extensions. To use this extension, you must first define a "Debug" configuration in `launch.json` to debug your GoogleTests, and then set this for your tests `debugConfig`.  



## Extension Settings



This extension contributes the following settings:



* `gtest-adapter.debugConfig`: The name of the debug configuration(s) which defines the GTest test application, and how to debug it. This can be an array of configurations.



* `gtest-adapter.showCodeLens`: Determines whether to show the CodeLens test status or not. Default is true



* `gtest-adapter.refreshAfterBuild`: Determines whether to automatically refresh the test tree after each build. Default is true



* `gtest-adapter.runAfterBuild`: Determines whether to automatically run tests after each build. Only relevant if `gtest-adapter.refreshAfterBuild` is true. Default is false



* `gtest-adapter.gotoTestTitle`: Used for localization. Title for [Go To Test] in CodeLens. 



* `gtest-adapter.runTitle`: Used for localization. Title for [Run] in CodeLens. 



* `gtest-adapter.debugTitle`: Used for localization. Title for [Debug] in CodeLens. 



* `gtest-adapter.supportLocation`: Used internally by the extension to know if navigating  to the code is supported. The extension will manage the value of this setting automatically, and will decide whether to offer the "Go to Code" option in the popup menu.



* `gtest-adapter.showRunOutput`: Determines whether to show the output of the GoogleTest runs. Default is true



* `gtest-adapter.clearRunOutput`: Determines whether to clear the output of the GoogleTest runs whenever starting a new run. Default is true



* `gtest-adapter.mainConfig`: Determines which config setting is used for CodeLens, when multiple settings are configured for `gtest-adapter.debugConfig`



In addition to these specific extensions settings, this extension creates adds to the `editor.tokenColorCustomizations` setting to allow for coloring the GoogleTest output.



## Known Issues



* There is no way to navigate from a tree leaf to the corresponding test, if you are using versions of GoogleTest prior to version [1.8.1](https://github.com/google/googletest/tree/release-1.8.1). (more information about GoogleTest versions [here](/GoogleTestVersion.md))



* Codelens isn't available , if you are using versions of GoogleTest prior to version [1.8.1](https://github.com/google/googletest/tree/release-1.8.1). (more information about GoogleTest versions [here](/GoogleTestVersion.md))



* Codelens isn't updated when changes are made to the code. To refresh Codelens, you need to rebuild the googletest application , and refresh the tests tree. If the Codelens with this limitation is distracting, it can be disabled by setting `gtest-adapter.showCodeLens` to `false`.



* Links in GoogleTest output will not work if other extensions declare languages for output windows. This is a limitation of VsCode, which doesn't allow to declare a specific language per Output Channel.



* Links in GoogleTest output wich contain spaces are not recognized. VsCode doesn't support such links, either.



* When running with multiple configurations, Codelens only takes 1 configuration into account. This account can be specified with the setting `gtest-adapter.mainConfig`



* When running with multiple configurations, `Debug All` will only debug the current tree.



## Release Notes



### 1.8.4



* Fixed vulnerabilities



### 1.8.3



* Bug Fix: Handles spaces in path to executable containing tests



### 1.8.1



* Added Key bindings, which are valid when the Google Test tree has focus



### 1.8.0



* Feature: Better search in tree. Similar to VsCode file search



### 1.7.0



* Feature: When navigating from a tree leaf to the corresponding test is available, double clicking on a leaf, will go to the corresponding test.



* Bug Fix: Debug from the toolbar works



* Bug Fix: When debugging using the extension, Restart uses the previous selected test



### 1.6.2



* Feature: Allows using multiple debug configs. When multiple debug configs are used, each config will have its own subtree.



### 1.5.0



* Feature: Better Hierarchical display when having parametrized tests



* Feature: If `gtest-adapter.runAfterBuild` is set to true (`gtest-adapter.refreshAfterBuild` is set to true), the Google tests will run after every build



* Bug Fix: Uses the `cwd` value from the debug configuration when running Google tests



### 1.4.0



* Supports links to files from GoogleTest output.



### 1.3.1



* Minor release. If `gtest-adapter.refreshAfterBuild` is set to true, will reload the test tree after every build task. Fixes Ubuntu install issue.



### 1.3.0



* Enhancement: Better tree experience. Selecting a tree action by right click (Run/Debug/Go to code) will execute the action on the right clicked node, and not the selected one.



### 1.2.5



* Feature: Easier extension configuration



### 1.2.4



* Feature: Shows output of GoogleTest runs



### 1.2.3



* Bug: Go to Tests didn't work in some configurations 



### 1.2.1



* Feature: Added option to automatically refresh test tree after each build



### 1.2.0



* Feature: Added CodeLens for GoogleTests. Needs at least version [1.8.1](https://github.com/google/googletest/tree/release-1.8.1) of GoogleTest.



### 1.1.1



* Fixed Vulnerability. Upgraded used package



### 1.1.0 



* Feature: Allows navigating from the tree to the corresponding test in the code. Needs at least version [1.8.1](https://github.com/google/googletest/tree/release-1.8.1) of GoogleTest.



### 1.0.8



* Feature: Allows searching in the test tree



### 1.0.7



* Bug Fix: Takes configuration environment into account when running tests



### 1.0.6



* Bug Fix: Takes configuration environment into account when running tests

* Renamed tree view to Google Tests



### 1.0.5



* Uses the "Test" activity instead of the "Explorer" activity

* Switches to debug activity view when debugging tests

* Clears tree icons when rerunning tests



### 1.0.4



* Refactored.

* Better status bar.

* Allows to switch debug configurations

* Prettier README.md



### 1.0.3



* Warns the user if the project was never built.

* Supports workspaceRoot as well as workspaceFolder in launch.json (although obsolete, might be in legacy configurations).



### 1.0.2



* Allows the user to pick a debug config if no config found.

* Better error messages.



### 1.0.1



Minor tweaks.



### 1.0.0



Initial release of GoogleTest Adapter.