bok-choy

UI-level acceptance test framework.

Warning

As of 2022-02-18, bok-choy is deprecated. All tests written using bok-choy have either been removed or are slated to be removed soon, and the code for the bok-choy framework itself will be archived in the near future.

If you are trying to write an acceptance or end-to-end test for Open edX code, please use a third-party tool like Cypress instead.

• Introduction
  • Installation
• Tutorial
  • Folder structure
  • Round 1 - The framework of a test
  • Round 2 - Interacting with a page
  • Round 3 - Search and verify results
  • Take it from here!
• Test-Design Guidelines
  • Put browser interactions in the page object, not the test
  • Put assertions in the test, not the page object
  • Never use time.sleep()
  • Always make pages wait for actions to complete
  • Wait for JavaScript to load
• Performing Accessibility Audits
  • Define the Accessibility Rules to Check for a Page
  • (Optional) Define the Scope of Accessibility Auditing for a Page
  • Trigger an Audit Actively and Assert on the Results Returned
  • Leverage Your Existing Tests and Fail on Accessibility Errors
• Visual Diff Testing
  • Write Your Page Object and Test Case Code to Navigate the System Under Test
  • Add the Call to assertScreenshot
  • Create the Initial Baseline Screenshot
  • Execute Your Test Cases After Changes to the System Under Test
  • Advanced Features
• Performing XSS Vulnerability Audits
  • Trigger XSS Vulnerability Audits in Existing Tests
• Browser Customization
  • Firefox Profile Preferences
  • Firefox Profile Directory
• Testing Environment Configuration
  • Testing via TravisCI
  • Testing via tox
• API Reference
  • browser
  • javascript
  • page_object
  • accessibility
  • promise
  • query
  • web_app_test

Indices and tables

• Index

• Module Index

• Search Page