WebdriverIO testing library

[olivierwilkinson]

Describe the feature you'd like:

I absolutely love the API provided by DOM Testing Library, we use React Testing Library at work and it has improved our tests so much. For our E2E testing we use WebdriverIO. I was looking for ways to use the DOM Testing Library API in our E2E tests and found Nightwatch Testing Library, Puppeteer Testing Library and TestCafe Testing Library.

It would be great to see a version of DOM Testing Library that works with WebdriverIO.

Suggested implementation:

Because I was interested I decided to implement something myself 😄. I have an initial version based heavily off of Nightwatch Testing Library. I tried to keep the API and tests as similar as possible. Here is the repo, I've added some more information in the readme: https://github.com/olivierwilkinson/webdriverio-testing-library.

Describe alternatives you've considered:

My original thought was to use Puppeteer Testing Library with WebdriverIOs underlying puppeteer instance but there are some limitations:

• Puppeteer is not always available

Puppeteer is used when the tests are run locally and there is no browser driver detected at localhost:4444. This means the Puppeteer instance isn't available in some setups (including mine).

• Unable to use WebdriverIO specific APIs

APIs like Element.waitForDisplayed are no longer available since the queries return Puppeteer ElementHandles.

Teachability, Documentation, Adoption, Migration Strategy:

If this is something Testing Library would like to maintain I would happily transfer ownership of the repo. I made sure to keep the same packages, setup and workflows from Nightwatch Testing Library so hopefully that wouldn't be a hassle. I'm also very happy to maintain and publish the package if this isn't something Testing Library wants to pursue, in which case I would appreciate some direction in terms of attribution as I don't want to step on anybody's toes.

Thanks in advance for any help/feedback you can give me here!

[nickserv]

I'm not personally familiar with WebdriverIO, but this does sound like something that would be useful to have in the organization. Would you like to request a transfer to the organization? Then we can give you permissions for it. I'm not sure about how publishing would work though, as we have semantic release bots manage that.

[olivierwilkinson]

Sounds good to me!

I tried to transfer ownership to testing-library but it says I need to have permission to create public repos. Would you like me to transfer ownership to you so you can transfer it on to testing-library?

For the publishing I kept the same setup as Nightwatch Testing Library and have been using semantic-release to publish versions to my npm account. I'm hoping it will be as simple as adding a new npm token and updating the name in package.json 🤞.

[nickserv]

I tried to transfer ownership to testing-library but it says I need to have permission to create public repos.

Oops, I forgot about that restriction.

Would you like me to transfer ownership to you so you can transfer it on to testing-library?

Sure thanks, I'll see if I can take care of it.

[olivierwilkinson]

Ok great, I've requested to transfer ownership to you 👍

Thanks for taking care of this 😄

[nickserv]

Whoops sorry, I didn't respond to the invitation in time and it expired. Could you please try again?

[olivierwilkinson]

No worries haha, I'll request it again now.

[nickserv]

Thanks, I've completed the transfer into @testing-library and given you admin permissions. For next steps, I think it would be good to update the documentation and ask the other maintainers about how to handle releases on Discord (as I'm not sure how to set that up myself). Let me know if you need help with anything.

[olivierwilkinson]

Brilliant, Thanks so much for organising all of this!

I'll look into both of those tonight. I'll be sure to get in contact if I'm struggling, thank you for the offer 😄

[MatanBobi]

@nickmccurdy Do you think we should also open a new Discord channel for WebdriverIO?

[nickserv]

@nickmccurdy Do you think we should also open a new Discord channel for WebdriverIO?

@MatanBobi Good idea, I forgot about this. There's now a webdriverio channel. Here's the public invite link: https://discord.gg/AGyFvEKRqQ

@olivierwilkinson Most of our libraries have an emoji for branding purposes, do you want to pick one?

[olivierwilkinson]

@olivierwilkinson Most of our libraries have an emoji for branding purposes, do you want to pick one?

Oh definitely! How about a spider 🕷️? It works with the 🕸️ part of WebdriverIO.

[nickserv]

Good idea. I've added it to the Discord channel and git readme.

[MatanBobi]

Since WebdriverIO is now a part of the testing-library organisation, I'm closing this one :)
For future visitors, the repo is here.
Thanks!