fleet/cypress/README.md
eashaw 0af5e161d0
Remove numbers from documentation filenames in Fleet repo (#4313)
* Renaming files and a lot of find and replace

* pageRank meta tags, sorting by page rank

* reranking

* removing numbers

* revert changing links that are locked to a commit

* update metatag name, uncomment github contributers

* Update basic-documentation.page.js

* revert link change

* more explicit errors, change pageOrderInSection numbers, updated sort

* Update build-static-content.js

* update comment

* update handbook link

* handbook entry

* update sort

* update changelog doc links to use fleetdm.com

* move standard query library back to old location, update links/references to location

* revert unintentional link changes

* Update handbook/community.md

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2022-02-23 12:17:55 -06:00

2.0 KiB

Cypress Testing

Cypress tests are designed solely for end-to-end testing. If this is your first time developing or running end-to-end tests, Fleet testing documentation includes git instructions for test preparation and running tests.

Fleet Cypress directories

Integration directory

Cypress tests the integration of entire features of the app.

With the roll out of teams, Cypress tests the user interface of each role of a user on the Premium Tier (Fleet Premium Documentation) and Free Tier (Fleet Free Documentation).

Support directory

Commands that are shared across tests are located in the support directory.

Opening Cypress locally

To open simply run:

yarn cypress:open

This will open up cypress locally and allow you to view the current test suite, as well as start writing new tests.

Building best practices

As much as possible, build from a user's perspective. Use .within cypress command as needed to scope a command within a specific element (e.g. table, nav).

As much as possible, assert that the code is only selecting 1 item or that the final assertion is the appropriate count.

Prioritization of selecting elements

  1. By element tag using elements (e.g. buttons), we can target text within. Confirm what the user is seeing with target text. If this is not specific enough, add on Role.
  2. By role using default or explicitly assigned roles of elements. If this is not specific enough, add on element class.
  3. By element class is least preferred as it does not follow a user's perspective. Occasionally this may be the only option. If that is the case, prioritize using the class name that specifies what the element is doing.

Resources