Skip to content

test: leverage play functions

Paul Gascou-Vaillancourt requested to merge migrate-to-play-functions into main

What does this MR do?

test: leverage play functions

Some stories simulate user interactions programmatically on mount. This is done to demonstrate more of the components' behaviors, as well as ensure visual tests cover as much ground as possible.

Historically, we have done so by adding mounted lifecycle hooks to the stories, but this can be done via Storybook's API which now supports play functions for this purpose.

play functions have the benefit of behaving like integration of sorts, where we can assert that expected elements are actually visible when interactions have run.

This also helps in keeping our visual regression tests more reliable. Storybook Test Runner waits until play functions have executed before running its assertions (capturing screenshots for example). So, consistently using play functions prevent timing issues in visual regression tests that would otherwise require arbitrary timeouts to be added to the test suite.

Screenshots or screen recordings

Integration merge requests

Does this MR meet the acceptance criteria?

This checklist encourages the authors, reviewers, and maintainers of merge requests (MRs) to confirm changes were analyzed for conformity with the project's guidelines, security and accessibility.

Toggle the acceptance checklist

Conformity

  • Code review guidelines.
  • GitLab UI's contributing guidelines.
  • If it changes a Pajamas-compliant component's look & feel, the MR has been reviewed by a UX designer.
  • If it changes GitLab UI's documentation guidelines, the MR has been reviewed by a Technical Writer.
  • If the MR changes a component's API, integration MR(s) have been opened (see integration merge requests above).
  • Added the ~"component:*" label(s) if applicable.

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • Security reports checked/validated by a reviewer from the AppSec team

Accessibility

If this MR adds or modifies a component, take a few moments to review the following:

  • All actions and functionality can be done with a keyboard.
  • Links, buttons, and controls have a visible focus state.
  • All content is presented in text or with a text equivalent. For example, alt text for SVG, or aria-label for icons that have meaning or perform actions.
  • Changes in a component’s state are announced by a screen reader. For example, changing aria-expanded="false" to aria-expanded="true" when an accordion is expanded.
  • Color combinations have sufficient contrast.
Edited by Paul Gascou-Vaillancourt

Merge request reports