Skip to content

Update Running the Selenium tests documentation to link to django-docker-box #40

Open
@colleenDunlap

Description

@colleenDunlap

Code of Conduct

  • I agree to follow Django's Code of Conduct

Feature Description

As of now in the contribution documentation for running Unit Tests, Selenium Tests section does not mention using django-docker-box to alleviate machine-based-flakiness (e.g. tests failing because your chrome settings use dark mode) in front end tests. Would like to call out Django-Docker-Box as this was pointed out to me in the discord, and it helped make a lot more of my tests pass than when I was trying to just run ./runtests.py --selenium=firefox,chrome in my django venv.

Problem

A lot of the people who love django and want to contribute come from a predominantly backend background, and thus might not be as familiar with tools like Selenium, but may want to contribute to admin functionality. This can give people a better leg to stand on when it comes to getting started.

Request or proposal

proposal

Additional Details

No response

Implementation Suggestions

Potential Wording--"Front End Tests can be very specific to browser or machine settings, as different operating systems and machines render elements differently. When running on local, you might notice tests failing when you run on a clean, up to date main, just because your laptop is on dark mode, or you're using a mac and the test is looking for windows key strokes. It can be very frustrating trying to make Selenium tests work on your specific machine. To alleviate this frustration, we recommend using Django-Docker-Box to normalize your test environment."

Could be trimmed down for simplicity to--"Front End Test Performance can be very specific to browser or machine settings, as different operating systems and machines render elements differently. To alleviate this frustration, we recommend using Django-Docker-Box to normalize your test environment."

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Idea

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions