oppia / oppia/oppia-web-developer-docs

Debugging E2E test wiki contains stale information

Open
#317 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug Impact: Medium Work: Low
Dominant language
Python
Stars
18
Forks
133
PR merge metrics
No merged PRs in 30d

Description

The debugging e2e test wiki contains some stale or incorrect information.
For example, here the wiki page says to enable video recording for all the test cases of a test suite, we need to set saveAllVideos as true. But I did not find any variable with this name, although a variable with the name ALL_VIDEOS is present, which is actually used to enable videos for all the test cases.

Secondly, after following the steps mentioned in the wiki for enabling video recoding, I am still not able to get the recordings in the GitHub artifacts (in the summary of a CI run). This information in the wiki might also need an update.

Contributor guide

No contributing guide indexed for this repository

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

Start with the wiki's “Downloading screen recordings” section and compare its saveAllVideos instruction with the ALL_VIDEOS variable used by the end-to-end tests. Verify how recordings are surfaced in the GitHub artifacts for a CI run, then update the wiki so the variable name, enabling steps, and expected artifact location are accurate.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.