search

cypress-io / cypress-example-kitchensink

This is an example app used to showcase Cypress.io testing.
https://example.cypress.io/
MIT License
1.22k stars 2.2k forks source link

Missing API commands #796

Closed MikeMcC399 closed 8 months ago

MikeMcC399 commented 8 months ago

Issue

The README description of this repo says that "every API command in Cypress" is tested. This is not completely the case.

This is an example app used to showcase Cypress.io testing. The application uses every API command in Cypress for demonstration purposes. Additionally this example app is configured to run tests in various CI platforms. The tests are also heavily commented. For a full reference of our documentation, go to docs.cypress.io.

Missing API commands

The Cypress tests in cypress-io/cypress-example-kitchensink do not cover the following commands. They are also not described in the app on https://example.cypress.io/:

Suggestion

  1. Either add the missing commands (see above) to the Cypress tests in cypress-io/cypress-example-kitchensink and to the descriptions in the app on https://example.cypress.io/ OR
  2. Modify the text to avoid implying that every available Cypress API command is tested.
jennifer-shehane commented 8 months ago

Yah, we did take some preference towards putting some of these more complicated uses in the realworld app application (like session and origin). I wouldn't be opposed to adding more examples that cover these and reviewing the PRs, but this won't be a priority for us to add.

You could update the text to say there are expanded real case examples in the realworld-app for some of the other commands.

MikeMcC399 commented 8 months ago

@jennifer-shehane

Thanks for the background information! I'll pick up your suggestion to make a text proposal.

cypress-app-bot commented 8 months ago

:tada: This issue has been resolved in version 2.0.2 :tada:

The release is available on:

Your semantic-release bot :package::rocket: