mirror/cypress
1
0
Fork 0
mirror of https://github.com/cypress-io/cypress.git synced 2026-05-20 23:28:42 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: Added toc-top layout to Errors + made all errors linkable.

Browse Source
This commit is contained in:
Jennifer Shehane
2017-06-21 14:30:47 -04:00
parent 068d5a3f07
commit dcbdf701f9
1 changed files with 14 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/guides/references/error-messages.md
+14 -24
View File
@@ -1,19 +1,19 @@
---
layout: toc-top
title: Error Messages
comments: false
---
# Test File Errors
**{% fa fa-exclamation-triangle red %} No tests found in your file**
## {% fa fa-exclamation-triangle red %} No tests found in your file
This message means that Cypress was unable to find tests in the specified file. You'll likely get this message if you have an empty test file and have not yet written any tests.
{% img /img/guides/no-tests-found.png No tests found %}
***
**{% fa fa-exclamation-triangle red %} We found an error preparing your test file**
## {% fa fa-exclamation-triangle red %} We found an error preparing your test file
This message means that Cypress encountered an error when compiling and/or bundling your test file. Cypress automatically compiles and bundles your test code so you can use ES2015, CoffeeScript, modules, etc.
@@ -27,7 +27,7 @@ When the error is fixed in your test file, your tests will automatically re-run.
# Support File Errors
**{% fa fa-exclamation-triangle red %} Support file missing or invalid**
## {% fa fa-exclamation-triangle red %} Support file missing or invalid
The `supportFolder` option was removed from Cypress in version {% url `0.18.0` changelog#0-18-0 %} and was replaced by module support and the {% url `supportFile` configuration#Folders %} configuration option.
@@ -60,7 +60,7 @@ Just like with your test files, the {% url `supportFile` configuration#Folders %
# Command Errors
**{% fa fa-exclamation-triangle red %} Cypress cannot execute commands outside a running test**
## {% fa fa-exclamation-triangle red %} Cypress cannot execute commands outside a running test
{% img /img/guides/cypress-cannot-execute.png Cannot Execute Commands %}
@@ -93,9 +93,7 @@ Simply move those Cypress commands into an `it(...)` block and everything will w
If you are purposefully writing commands outside of a test, there is probably a better way to accomplish what you're trying to do. Read through the {% url "Examples" examples/recipes/unit-testing %}, {% url "chat with someone in our chat" https://gitter.im/cypress-io/cypress %}, or {% open_an_issue %}.
***
**{% fa fa-exclamation-triangle red %} `cy...()` failed because the element you are chaining off of has become detached or removed from the dom**
## {% fa fa-exclamation-triangle red %} `cy...()` failed because the element you are chaining off of has become detached or removed from the dom
Getting this errors means you've tried to interact with a "dead" DOM element - meaning it's been detached or completely removed from the DOM.
@@ -155,9 +153,7 @@ When we say *guard*, this usually means:
- Writing an assertion
- Waiting on an XHR
***
**{% fa fa-exclamation-triangle red %} `cy....()` failed because the element cannot be interacted with**
## {% fa fa-exclamation-triangle red %} `cy....()` failed because the element cannot be interacted with
You may see a variation of this message for 4 different reasons:
@@ -180,9 +176,7 @@ cy.get('[disabled]').click({force: true}).
*Be careful with this option. It's possible to force your tests to pass when the element is actually not interactable in your application.*
***
**{% fa fa-exclamation-triangle red %} `cy....()` failed because the element is currently animating**
## {% fa fa-exclamation-triangle red %} `cy....()` failed because the element is currently animating
{% img /img/guides/cy-method-failed-element-is-animating.png cy.method() failed because element is animating %}
@@ -209,9 +203,7 @@ You can globally disable animation error checking, or increase the threshold by
}
```
***
**{% fa fa-exclamation-triangle red %} The test has finished but Cypress still has commands in its queue**
## {% fa fa-exclamation-triangle red %} The test has finished but Cypress still has commands in its queue
Let's examine several different ways you may get this error message. In every situation, you'll need to change something in your test code to prevent the error.
@@ -312,13 +304,13 @@ it('does not forget to return a promise', function(){
})
```
**{% fa fa-exclamation-triangle red %} `cy.visit()` failed because you are attempting to visit a second unique domain**
## {% fa fa-exclamation-triangle red %} `cy.visit()` failed because you are attempting to visit a second unique domain
See {% url "`cy.visit()`" visit %} documentation.
# CI Errors
**{% fa fa-exclamation-triangle red %} You passed the `--record` flag but did not provide us your Record Key.**
## {% fa fa-exclamation-triangle red %} You passed the `--record` flag but did not provide us your Record Key.
You may receive this error when trying to run Cypress tests in {% url 'Continuous Integration' continuous-integration %}. This means that you did not pass a specific record key to: {% url '`cypress run --record`' command-line#cypress-run-record %}.
@@ -328,9 +320,7 @@ You can get your project's record key by locating it in your settings tab in the
You will want to then {% url 'add the key to your config file or as an environment variable' continuous-integration#Record-Key %}.
***
**{% fa fa-exclamation-triangle red %} The 'cypress ci' command has been deprecated**
## {% fa fa-exclamation-triangle red %} The 'cypress ci' command has been deprecated
As of version {% url `0.19.0` changelog#0-19-0 %} and CLI versions `0.13.0`, the `cypress ci` command has been deprecated. We did this to make it clearer what the difference was between a *regular test run* and a *recorded test run*.
@@ -358,7 +348,7 @@ We will automatically apply the record key environment variable.
# Page Load Errors
**{% fa fa-exclamation-triangle red %} Cypress detected a cross origin error happened on page load**
## {% fa fa-exclamation-triangle red %} Cypress detected a cross origin error happened on page load
{% note info %}
For a more thorough explanation of Cypress's Web Security model, {% url 'please read our dedicated guide to it' web-security %}.
@@ -386,7 +376,7 @@ If you find yourself stuck and can't work around these issues you can just set t
# Browser Errors
**{% fa fa-exclamation-triangle red %} The Chromium Renderer process just crashed**
## {% fa fa-exclamation-triangle red %} The Chromium Renderer process just crashed
Browsers are enormously complex pieces of software, and from time to time they will inconsistently crash *for no good reason*. Crashes are just a part of running automated tests.