Addition of GetByTestId method to bUnit

[thatstatsguy]

Hi there

Just a shower thought - does anyone think there would be appetite for adding in a GetByTestId method?

Having worked in Playwright for some time I've found that it is quite a useful to be able to locate specific items by test id.

https://playwright.dev/dotnet/docs/locators#locate-by-test-id

Obviously, it's possible to do this in bUnit with

var cut = RenderComponent<ComponentName>()
var elements = cut.FindAll("[data-testid='SomeIdHere']")

but not having to type this all out would be quite nice.

[egil]

It sounds useful. That said, I've never needed them myself as component testing is usually only focused on one component at the time and there is less conflicts with other selectors.

We also generally don't add additional APIs to the project when the user is able to do so themselves with an extension method and get the same result. More stuff to maintain for us. It has to be pretty core functionality that many users can leverage to make sense.

[linkdotnet]

I do agree! The functionality is better placed in a user's library.
@thatstatsguy you might be better off as an extension method:

public static IElement FindByTestId(this IRenderedFragment fragment, string id) => cut.Find($"[data-testid={id}"]);

A FindAll wouldn't make much sense with an id, or?

But, there might be a place for such a function in the future. With #938 there would be a space to have such function, as the testing library itself provides your wished functionality.

[thatstatsguy]

Thanks both for the input!

Makes complete sense from a maintenance perspective.

Had no idea about the testing library, but do agree it would be amazing to have that kind of API available

Although you're not affiliated with Playwright, from a dev perspective I can see the appeal of having a cohesive experience across testing libraries

i.e. in both you could expect a healthy overlap of functionality with the same name and same behaviour which improves the overall workflow and cognitive overhead to remember what is available in each testing framework

[egil]

I do believe that the bunit.web.query package would have a variant of "get by test id", since that is also part of the testing library API stack. @scottsauber should be able to confirm this.