feat: show better error message if testing type is not configured #22000
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for taking the time to open a PR!
|
|
Test summary
Run details
View run in Cypress Dashboard ➡️ Flakiness
This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
…if-testingType-is-not-configured
…if-testingType-is-not-configured
…if-testingType-is-not-configured
…if-testingType-is-not-configured
…if-testingType-is-not-configured
…if-testingType-is-not-configured
…if-testingType-is-not-configured
estrada9166
requested review from
jennifer-shehane,
a team,
tbiethman and
lmiller1990
and removed request for
a team,
tgriesser and
jennifer-shehane
tbiethman
reviewed
Jun 6, 2022
packages/errors/src/errors.ts
Outdated
| return errTemplate` | ||
| The testing type selected (${fmt.highlight(testingType)}) is not configured in your config file. | ||
|
|
||
| Please update it, and try running it again. |
There was a problem hiding this comment.
Do we also want to direct users to the configuration docs here? https://on.cypress.io/configuration
We do so for other errors, like INVALID_CONFIG_OPTION.
There was a problem hiding this comment.
Yes, this would be good to add also.
jennifer-shehane
previously requested changes
Jun 6, 2022
Co-authored-by: Jennifer Shehane <jennifer@cypress.io>
…if-testingType-is-not-configured
…-is-not-configured' of github.com:cypress-io/cypress into alejandro/feat/show-better-error-message-if-testingType-is-not-configured
lmiller1990
approved these changes
Jun 7, 2022
There was a problem hiding this comment.
I gave it a test and it's working as expected.
cd packges/driver
yarn cypress:run --component
yarn run v1.22.11
$ node ../../scripts/cypress run --spec "cypress/e2e/*/*","cypress/e2e/*/!(origin|sessions)/**/*" --component
The testing type selected (component) is not configured in your config file.
Please run ‘cypress open’ and choose your testing type to automatically update your configuration file.
https://on.cypress.io/configuration
error Command failed with exit code 1.
…if-testingType-is-not-configured
tbiethman
approved these changes
Jun 7, 2022
…if-testingType-is-not-configured
estrada9166
deleted the
alejandro/feat/show-better-error-message-if-testingType-is-not-configured
branch
BeijiYang
pushed a commit
to BeijiYang/cypress
that referenced
this pull request
Jun 23, 2022
…press-io#22000) * feat: show better error message if testing type is not configured * Add tests * Update tests * Fix some tests * Fix some tests * Fix test * Fix tests * Update packages/errors/src/errors.ts Co-authored-by: Jennifer Shehane <jennifer@cypress.io> * Update with code review * Fix test * Add on link Co-authored-by: Jennifer Shehane <jennifer@cypress.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
cypress runwhen CT/E2E has not been configured. #21909User facing changelog
Additional details
When a testing type is selected in run mode, and it has not been configured (
e2eorcomponentproperty) in the config file, we are showing a better error message, letting know the user that it needs to be configured before running itIf the selected testing type is
e2ethe config file needs to have at leaste2e: {}but if the selected testing type iscomponentit needs to have configured thedevServerIt is checked based on this logic
Steps to test
How has the user experience changed?
PR Tasks
cypress-documentation?type definitions?