diff --git a/Docs/Build.md b/Docs/Build.md index 527aa3b..b056ba0 100644 --- a/Docs/Build.md +++ b/Docs/Build.md @@ -16,7 +16,7 @@ For those that want to add the test adapter to their own extension repository, b Test Adapter for Catch2. Visual Studio Test Adaptor for use with Catch2 test framework. 2018-06-24T12:17:00Z - 2018-07-29T13:32:00Z + 2018-08-18T08:17:00Z Johnny Hendriks @@ -25,7 +25,7 @@ For those that want to add the test adapter to their own extension repository, b xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/developer/vsx-syndication-schema/2010"> VSTestAdapterCatch2.73ba8471-3771-47bf-bd23-49a1ba09af89 - 1.2.0 + 1.3.0 diff --git a/Docs/CHANGELOG.md b/Docs/CHANGELOG.md index b192685..f32f201 100644 --- a/Docs/CHANGELOG.md +++ b/Docs/CHANGELOG.md @@ -2,7 +2,7 @@ Changes are relative to v1.0.0 -## Post v1.2.0 changes +## Changes for v1.3.0 ### Extended Features @@ -13,7 +13,7 @@ Changes are relative to v1.0.0 ### Bug fixes - Bug: StackTrace link does not display correctly when decimal points are part of the description (_e.g._, when displaying floating point numbers). Fixed. -- Bug: Test cases with names ending in '\' generate invalid output. Fixed. +- Bug: Test cases with names ending in '\\' generate invalid output. Fixed. ## Changes for v1.2.0 diff --git a/Docs/Capabilities.md b/Docs/Capabilities.md index 824c5dd..7014c09 100644 --- a/Docs/Capabilities.md +++ b/Docs/Capabilities.md @@ -21,13 +21,19 @@ The Visual Studio Test Explorer tries to extract extra information from a test c |---------|-----------|-------|-------------| | `std::vector. Test` | `std` | `vector` | `Test` | | `Root.Level0.Level1.Name. Test 01` | `Root.Level0.Level1` | `Name` | `Test 01` | -| `Root::Level0. Fraction=0.1` | `Root::Level0` | `Fraction=0` | `1` | +| `Root::Level0. Fraction=0.1` | `Root::Level0` | `Fraction=0` | `1` | -I suggest to experiment with this and (ab)use this functionality as appropriate for your case. +I suggest to experiment with this and (ab)use this functionality as appropriate for your case. Personally I prefer to use the "." as a delimiter using the following scheme: + +> `.. ` + +Here `` may have several "." delimiters. This scheme helps me to keep test case names unique, and it nicely organizes test cases in the Visual Studio Test Explorer hierarchical view. ### Special characters -Be aware that trailing spaces are automatically removed from a test case name, and that names ending in a backslash ("\\") cannot be called by the **Test Adapter for Catch2**. If you want to call a specific test case from the command line you need to escape any comma, double quote, open square bracket and backslash characters (_i.e._, use "\\,", "\\"", "\\[" and "\\\\"). This is basically what the **Test Adapter for Catch2** does internally when it calls a test. Otherwise any printable ASCII character can be safely used in a test name. No guarantees are given for the use of other characters (_e.g._, UTF-8). +Be aware that trailing spaces are automatically removed from a test case name. Also, names ending in a backslash ("\\") cannot be called specifically by the **Test Adapter for Catch2**. As of v1.3.0 a workaround is used where basically the backslashes are stripped from the end of the name. Subsequently all tests that start with the remaining test name are called. So there is a chance more than one test case will be called. This is handled in the same way as test case names that differ only in case (see [below](#catch2-specific)). + +If you want to call a specific test case from the command line you need to escape any comma, double quote, open square bracket and backslash characters (_i.e._, use "\\,", "\\"", "\\[" and "\\\\"). This is basically what the **Test Adapter for Catch2** does internally when it calls a test. Otherwise any printable ASCII character can be safely used in a test case name. No guarantees are given for the use of other characters (_e.g._, UTF-8). ### Catch2 specific diff --git a/Docs/Known-issues.md b/Docs/Known-issues.md index 968b81d..6f59122 100644 --- a/Docs/Known-issues.md +++ b/Docs/Known-issues.md @@ -2,4 +2,4 @@ All software has issues, the **Test Adapter for Catch2** is no exception. The following is a list of issues that are currently known (at least to me). -- Test case names that differ only in case (_e.g._, "NAME" and "name") and are part of the same Catch2 executable, are not handled well. See [Notes on test case names](Capabilities.md#notes-on-test-case-names) for details. The workaround for this issue is obvious, don't use test case names that differ only in case. \ No newline at end of file +- Currently there are no known major issues. \ No newline at end of file diff --git a/Docs/Settings.md b/Docs/Settings.md index acf0cd9..9980da9 100644 --- a/Docs/Settings.md +++ b/Docs/Settings.md @@ -1,6 +1,6 @@ # Settings for Test Adapter for Catch2 -**The information on this page is based on **Test Adapter for Catch2** v1.2.0.** +> The information on this page is based on **Test Adapter for Catch2** v1.2.0. In order for the **Test Adapter for Catch2** to do its job, it requires certain settings to be set explicitely by the user. This is done via a _.runsettings_ file. The settings for the **Test Adapter for Catch2** are collected inside the `` node that can be added to the `` node of the _.runsettings_ file. Below is the list of settings that are available for the **Test Adapter for Catch2**. The ones with an asterisk are required to be set by the user and have defaults that will cause the **Test Adapter for Catch2** to not discovery tests. @@ -13,7 +13,7 @@ In order for the **Test Adapter for Catch2** to do its job, it requires certain - [``](#logging) - [``](#messageformat) - [``](#stacktraceformat) -- [``](#stacktracepointreplacement) +- [``](#stacktracepointreplacement) (_v1.3.0_) - [``](#testcasetimeout) - [``](#workingdirectory) - [``](#workingdirectoryroot) @@ -262,6 +262,8 @@ Default: "," The `` option sets the string to use for the replacement of decimal points in StackTrace descriptions. The presence of decimal points in a StackTrace descriptions interferes with the displayed link. A common occurrence of this is when floating point numbers are part of the description. As such decimal points in the StackTrace description are replaced by an alternate string. As a typical occurrence of this problem is with floating point values, the default value for this setting is a comma. However, as this may not be a good option for everyone you can override the default with your personal preference (_e.g._, "`", "_", "ยท"). +> Introduced in v1.3.0 + ## TestCaseTimeout Default: -1 diff --git a/VSIX/VSTestAdapterCatch2/RELEASENOTES.txt b/VSIX/VSTestAdapterCatch2/RELEASENOTES.txt index fc818d4..b108772 100644 --- a/VSIX/VSTestAdapterCatch2/RELEASENOTES.txt +++ b/VSIX/VSTestAdapterCatch2/RELEASENOTES.txt @@ -1,3 +1,12 @@ +Release Notes for v1.3.0 of the Test Adapter for Catch2 +This version is mostly a bug fix release. +# Extended Features +- Add option to allow replacement of decimal points in StackTrace description with a custom string. This is related to a bug fix, where decimal points in the StackTrace description interferes with the displayed StackTrace link. +- Handle test cases with names differing only in case more gracefully (e.g., "TestName", "TESTNAME", and "testname"). Test cases with names that only differ by case are always run together. Now the correct test result and failures are shown for those tests. Shown assertion statistics are of all tests that were run, and a note is added to the test result message to indicate this. +# Bug fixes +- Bug: StackTrace link does not display correctly when decimal points are part of the description (e.g., when displaying floating point numbers). Fixed. +- Bug: Test cases with names ending in '\' generate invalid output. Fixed. + Release Notes for v1.2.0 of the Test Adapter for Catch2 This version contains an important fix that enables stack trace links to source code. This is a significant usabilty improvement. Please update to this version and stop using the older ones. Documentation has been adapted to asume you are using this version. # New Features diff --git a/VSIX/VSTestAdapterCatch2/source.extension.vsixmanifest b/VSIX/VSTestAdapterCatch2/source.extension.vsixmanifest index 901ce10..e531907 100644 --- a/VSIX/VSTestAdapterCatch2/source.extension.vsixmanifest +++ b/VSIX/VSTestAdapterCatch2/source.extension.vsixmanifest @@ -1,7 +1,7 @@ - + Test Adapter for Catch2 Test Adapter for use with the Catch2 C++ unit test framework. https://github.com/JohnnyHendriks/TestAdapter_Catch2