mirror of https://github.com/google/comprehensive-rust.git synced 2025-10-31 08:37:45 +02:00

Files

michael-kerscher d3fea80239 Start a small playbook on how to deal with failing webtests. (#2962 )

This is a starting point on how to deal with failures in the web-test
checks. They are supposed to warn for legitimate issues but if they
fail, they can be overridden.

The web-tests will be separated into its own job to better differentiate
if issues in building the English translation or web-testing the English
translation are happening

2025-10-30 09:14:21 +01:00

src

tests: Migrate create_slide.list.sh into cargo xtask function. (#2957 )

2025-10-29 18:15:21 +01:00

package-lock.json

build(deps-dev): bump tar-fs from 3.0.9 to 3.1.1 in /tests in the npm_and_yarn group across 1 directory (#2931 )

2025-09-27 10:57:27 +02:00

package.json

Bump the npm_and_yarn group across 1 directory with 2 updates (#2866 )

2025-09-04 21:51:43 +02:00

README.md

Start a small playbook on how to deal with failing webtests. (#2962 )

2025-10-30 09:14:21 +01:00

tsconfig.json

tests: fix the includes in test/tsconfig.json and switch to modern node18 module (#2740 )

2025-05-07 09:22:16 +02:00

wdio.conf-mdbook.ts

Bump dprint plugins to their latest versions (#2402 )

2025-02-28 14:27:17 +00:00

wdio.conf.ts

Re-enable the red box to show available space (#2932 )

2025-10-19 15:10:01 +00:00

README.md

Testing Comprehensive Rust

The course material contains JS code that can break and needs to be checked for functionality. Examples are theme/speaker-notes.js or theme/book.js.

Comprehensive Rust is using webdriverIO and the webdriverIO Expect API in combination with Mocha. WebdriverIO is taking care of accessing the webpage with a real browser and can access the state of the page so behavior can be asserted.

The Static Server Service is used mainly in the CI to serve the book on port localhost:8080 such that the test runner can access it. This mode is used when npm start or npm test is executed.

Tip: Use cargo xtask web-tests to run the tests in this directory from anywhere in the repository.

For local testing and quick iterations it is possible to use cargo xtask serve which creates a small HTTP server on port 3000 by default. There is a special config that is invoked with npm run test-mdbook that uses http://localhost:3000

Deal with failing tests

When you see tests failing they should already indicate what checks broke for specific pages.

Legitimate warnings

You might e.g. need to reduce the length of an overlong page (or get an exemption) or updating some mdbook infrastructure had a breaking change that breaks functionality. These issues need to be fixed before this change is merged.

Broken test environment

Sometimes tests can also fail in the CI environment with errors like this.

ERROR webdriver: WebDriverError: tab crashed

If you see messages like these, it may indicate an issue with the web-tests that is not caused by your changes. Please file a bug to report this. As a temporary workaround, if all other checks pass and you are confident your changes are correct, you may override the web-test requirement to merge your pull request.