rust-lang / rust-lang/mdBook

Testing generated html pages with webdriver.io?

Open
#2,575 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-enhancement
Dominant language
Rust
Stars
22.2k
Forks
1.9k
PR merge metrics
PR metrics pending

Description

Problem

The comprehensive-rust repository is using mdBook and to ensure that we can safely modify code and update dependencies and not break anything in the process we now use tests based on webdriver.io (wdio). This is a powerful test framework running in a browser (headless) with a lot of interesting features like mocking APIs (e.g. for playground interaction).

Some months ago I did not see any tests in this repo and originally I wanted to ask you and get your opinion if you would consider writing some tests with wdio but it seems that you committed to another framework already. While digging through this repository I noticed that you also started testing the GUI.

Is this a fixed choice or would you consider wdio? I could offer to support setting this up and support writing tests for the generated html. But I also understand if you want to stick with what you already have and this might suit you.

Overall I'm already happy to see that you are working on testing the GUI! :)

Proposed Solution

No response

Notes

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing tests and the mdBook tests/gui directory, then compare that approach with the linked webdriver.io framework. The next step is to determine whether maintainers want webdriver.io support for generated HTML pages; done would be an agreed testing direction and, if accepted, a defined setup and test scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, rust
Domain
testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.