From f6b54d52f2c27bed324cc0c4fe9d48753fda0f21 Mon Sep 17 00:00:00 2001 From: Stefan Forsberg Date: Sun, 11 Nov 2018 20:31:19 +0100 Subject: [PATCH] Create readme06.md --- readme06.md | 109 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 109 insertions(+) create mode 100644 readme06.md diff --git a/readme06.md b/readme06.md new file mode 100644 index 0000000..5d937b0 --- /dev/null +++ b/readme06.md @@ -0,0 +1,109 @@ +[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/vscode-dotnet-test-explorer/Lobby) + +# .NET Core Test Explorer + +## Features + +* Test Explorer for .NET Core + +## Prerequisites + +* [.NET Core](https://www.microsoft.com/net/core) is installed +* NUnit and MsTest requires a dotnet [sdk](https://www.microsoft.com/net/download) version of >= 2.1.2 and running dotnet tooling in english (see [#77](https://github.com/formulahendry/vscode-dotnet-test-explorer/issues/77) for details). + +## New in 0.6 + +* We now support multiple workspaces. We will try to find tests in all of the folders according to the testProjectPath setting. See the section regarding [configuring multiple test projects](#configuring-multiple-test-projects) +* Tests written in fsharp should be less unfoundable when trying to navigate to them +* Filter argument are now double-quoted (again, let's hope they stay that way from now on) + +## Usage + +Open a .NET Core test project, or set `dotnet-test-explorer.testProjectPath` to the folder path of .NET Core test project. Then, you will see all the tests in Test Explorer. + +![test-explorer](images/test-explorer.gif) + +#### Configuring multiple test projects + +Setting dotnet-test-explorer.testProjectPath accepts a glob pattern that should point to your test directories. You can also point to files and it will figure out the corresponding path. + +Given the folder structure +* root + * testProjectOne + * testproject1.Tests.csproj + * testProjectTwo + * testproject2.Tests.csproj + +the glob pattern "+(testProjectOne|testProjectTwo)" or "**/*Tests.csproj" should add both of the test projects. + +Due to some performance concerns discovery and test running over multiple directories are run one at a time in a synchronous fashion. When running specific tests (eg, not running all tests) the extension should be smart enought to figure out which test directory should be run and only run tests for that directory. + +#### Stopping the current test runner(s) + +Press the stop button in the top menu. After killing the processe(s) it will perform a new test discovery. + +![test-explorer](images/stop.PNG) + +#### Logging + +Text from the dotnet test output as well as debug info is written to the Output/Test explorer terminal window. To view the log you can access it simply by clicking the view log icon. + +![showlog](images/showlog.png) + + +## Keyboard shortcuts + +* Run all tests, default Alt+R Alt+A + +* Rerun last command, default Alt+R Alt+R + +* Run test(s) in context, default Alt+R Alt+C + +## Settings + +* `dotnet-test-explorer.testProjectPath`: Glob pattern that points to path of .NET Core test project(s). (Default is **""**) +* `dotnet-test-explorer.useTreeView`: If false, will list all tests as the full namespace. When set to true a tree will be created based on the namespaces of the tests. (Default is **true**) +* `dotnet-test-explorer.showCodeLens`: Determines whether to show the CodeLens test status or not. (Default is **true**) +* `dotnet-test-explorer.codeLensFailed`: The text to display in the code lens when a test has failed. (Default is **""**) +* `dotnet-test-explorer.codeLensPassed`: The text to display in the code lens when a test has passed. (Default is **""**) +* `dotnet-test-explorer.codeLensSkipped`: The text to display in the code lens when a test has been skipped. (Default is **""**) +* `dotnet-test-explorer.pathForResultFile`: The path to (temporarily) store test result files in. (Default is os temp dir) +* `dotnet-test-explorer.autoExpandTree`: If true, the tree will be in an expanded state by default. (Default is **false**) +* `dotnet-test-explorer.addProblems`: If true, failed tests will add to problems view. (Default is **true**) +* `dotnet-test-explorer.autoWatch`: If true, starts dotnet watch test after test discovery is completed. (Default is **false**) +* `dotnet-test-explorer.testArguments`: Additional arguments that are added to the dotnet test command +* `dotnet-test-explorer.leftClickAction`: What happens when a test in the list is left clicked. (Default is **gotoTest**) + +## Known issues + +##### Test result is not shown in codelens / tree +Try and change the setting dotnet-test-explorer.pathForResultFile to point to a folder you have access right too. Code lense functionality also requires the [C# extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.csharp)) + +##### No tree view or color coded explorer for nunit / mstest +This requieres you to run dotnet sdk version 2.1.2 or higher and running dotnet tooling in english (see [#77](https://github.com/formulahendry/vscode-dotnet-test-explorer/issues/77) for details). + +##### DisplayName attribute not working for xunit +See [#56](https://github.com/formulahendry/vscode-dotnet-test-explorer/issues/56) + +## Telemetry data + +By default, anonymous telemetry data collection is turned on to understand user behavior to improve this extension. To disable it, update the settings.json as below: +```json +{ + "dotnet-test-explorer.enableTelemetry": false +} +``` + +## Change Log + +See Change Log [here](CHANGELOG.md) + +## Issues + +If you find any bug or have any suggestion/feature request, please submit the [issues](https://github.com/formulahendry/vscode-dotnet-test-explorer/issues) to the GitHub Repo. + +## ❤️ Contributors + +Thanks to all the [contributors](https://github.com/formulahendry/vscode-dotnet-test-explorer/graphs/contributors)! + +Special thanks to Stefan Forsberg ([@stefanforsberg](https://github.com/stefanforsberg)) for maintaining the project and implementing so many cool features! Also thanks to Janaka Abeywardhana ([@janaka](https://github.com/janaka)) for maintaining the project!