Expose & use TreeItem description and/or resourceUri through API for file differentiation

[yozlet]

I'm working on a project which has multiple folders below the project root, and each folder has its own tests.py. So my Test Explorer looks like this:

... which is not hugely helpful when trying to find the right one. (I'm using the Python Test Adapter, but this problem could apply to all of them.)

When dealing with multiple identically-named files, VSCode's practice is to differentiate on path by adding a smaller path description to tab headers:

Note that VSCode includes logic to work out the best text for these descriptions, based on where the paths differentiate.

These smaller, lighter/darker labels (a.k.a. Descriptions) are now available in extension tree views. You can provide the string for the description directly, or simply tell VSCode to work it out (using its path differentiation logic) from the TreeItem's resourceUri, which might be much easier.

[matepek]

I got a feature request: this
This is description related too.

I copy my proposal from a closed pull request:

Adding a description?: string to TestSuiteInfo, TestInfo, TestSuiteEvent and TestEvent.
Initially TreeItem#description is filled with TestSuiteInfo's and TestInfo's description if provided and could be overwritten by the event's description property if provided.

This case the adapter developer could choose how they wanna use the field.

(Maybe the tooltip property could be updated through events.)

Alternatively: having a description:string and durationInMiliSec:number field too and concatenating them on the test-explorer side.

[hbenl]

@matepek I just published a new version of Test Explorer and its API with the ability for adapters to set the description of tests and suites when loading and running. The tooltips can now also be changed when running.

@yozlet Since adapters can now set the descriptions, you should ask the developers of the Python adapter to add this feature. I also experimented with the possibility to let VS Code derive the descriptions from the resourceUri but I found the result not very convincing, that's why I decided it's probably not worth adding this special case to the Test Explorer.