Skip to content

Issue 150 #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 2, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ alias:
guides/network-requests-xhr/: guides/guides/network-requests.html
guides/issuing-commands/: guides/core-concepts/introduction-to-cypress.html#Subject-Management
guides/installing-and-running/: guides/getting-started/installing-cypress.html
guides/core-concepts/overview-of-the-gui/: guides/core-concepts/overview-of-test-runner.html
guides/core-concepts/overview-of-the-gui.html: guides/core-concepts/overview-of-test-runner.html
why-cypress/: guides/overview/why-cypress.html

api/index.html: api/introduction/api.html
Expand Down
2 changes: 1 addition & 1 deletion lib/tags/usage.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ module.exports = function usageOptions (hexo, args) {

const log = () => {
/* eslint-disable quotes */
const url = `{% url 'Command Log' overview-of-the-gui#Command-Log %}`
const url = `{% url 'Command Log' overview-of-test-runner#Command-Log %}`

return render(`Displays the command in the ${url}`)
}
Expand Down
2 changes: 1 addition & 1 deletion source/_data/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ guides:
introduction-to-cypress: introduction-to-cypress.html
writing-and-organizing-tests: writing-and-organizing-tests.html
interacting-with-elements: interacting-with-elements.html
overview-of-the-gui: overview-of-the-gui.html
overview-of-test-runner: overview-of-test-runner.html
aliases-and-references: aliases-and-references.html
conditional-testing: conditional-testing.html
guides:
Expand Down
2 changes: 1 addition & 1 deletion source/api/commands/click.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ cy.get('button').click(5, 60, { force: true })

***Click all buttons found on the page***

By default, Cypress will error if you're trying to click multiple elements. By passing `{ multiple: true }` Cypress will iteratively apply the click to each element and will also log to the {% url 'Command Log' overview-of-the-gui#Command-Log %} multiple times.
By default, Cypress will error if you're trying to click multiple elements. By passing `{ multiple: true }` Cypress will iteratively apply the click to each element and will also log to the {% url 'Command Log' overview-of-test-runner#Command-Log %} multiple times.

```javascript
cy.get('button').click({ multiple: true })
Expand Down
2 changes: 1 addition & 1 deletion source/api/commands/pause.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ cy.get('#action-canvas')
.click(170, 165)
```

The commands above will display in the GUI as:
The commands above will display in the Command Log as:

![Pause command on intial pause](/img/api/pause/initial-pause-in-gui-highlights-the-pause-command.png)

Expand Down
2 changes: 1 addition & 1 deletion source/api/commands/request.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ cy

***Request is not displayed in the Network Tab of Developer Tools***

Cypress does not *actually* make an XHR request from the browser. We are actually making the HTTP request from the Cypress desktop application (in Node.js). So, you won't see the request inside of your Developer Tools.
Cypress does not *actually* make an XHR request from the browser. We are actually making the HTTP request from the Cypress Test Runner (in Node.js). So, you won't see the request inside of your Developer Tools.

## Cors

Expand Down
2 changes: 1 addition & 1 deletion source/api/commands/visit.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ cy.visit('http://localhost:3000/#/users', {
***Visit will automatically follow redirects***

```javascript
// we aren't logged in, so our webserver
// we aren't logged in, so our web server
// redirected us to /login
cy.visit('http://localhost3000/admin')
cy.url().should('match', /login/)
Expand Down
4 changes: 2 additions & 2 deletions source/dashboard/overview/features-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ The {% url 'Cypress Dashboard' https://on.cypress.io/dashboard %} is a service w
- Watch a video of your entire test run or a clip at the point of test failure.
- Manage who has access to your recorded test data.

***See Tests Runs in Desktop***
***See Tests Runs in the Test Runner***

Additionally we've integrated the test runs into the Cypress {% url 'Desktop Application' installing-cypress %}. This means you can see the test runs in the *Runs* tab from within every project.
Additionally we've integrated the test runs into the Cypress {% url 'Test Runner' installing-cypress %}. This means you can see the test runs in the *Runs* tab from within every project.

![Runs List](/img/dashboard/runs-list-in-desktop-gui.png)

Expand Down
2 changes: 1 addition & 1 deletion source/dashboard/overview/projects-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Once you're set up to record test runs, we automatically generate a *Record Key*
f4466038-70c2-4688-9ed9-106bf013cd73
```

You can create multiple Record Keys for a project, or delete existing ones from our {% url 'Dashboard' https://on.cypress.io/dashboard %}. You can also find your Record Key inside of the *Settings* tab on the Desktop App.
You can create multiple Record Keys for a project, or delete existing ones from our {% url 'Dashboard' https://on.cypress.io/dashboard %}. You can also find your Record Key inside of the *Settings* tab in the Test Runner.

![Record Key in Configuration Tab](/img/dashboard/record-key-shown-in-desktop-gui-configuration.png)

Expand Down
4 changes: 2 additions & 2 deletions source/faq/questions/dashboard-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You can read more {% url 'here' features-dashboard %}.
1. First {% url 'set up the project to record' projects-dashboard#Setup %}.
2. Then {% url 'record your runs' runs-dashboard %}.

After recording your tests, you will see them in the {% url 'Dashboard' https://on.cypress.io/dashboard %} and in the "Runs" tab of the Desktop Application.
After recording your tests, you will see them in the {% url 'Dashboard' https://on.cypress.io/dashboard %} and in the "Runs" tab of the Test Runner.

## {% fa fa-angle-right %} How much does it cost?

Expand Down Expand Up @@ -52,7 +52,7 @@ No, although we are looking to build an on-premise version of the Dashboard for

## {% fa fa-angle-right %} Can I choose not to use the Dashboard?

Of course. The dashboard is a separate service from the Desktop Application and will always remain optional. We hope you'll find a tremendous amount of value out of it, but it is not coupled to being able to run your tests.
Of course. The Dashboard Service is a separate service from the Test Runner and will always remain optional. We hope you'll find a tremendous amount of value out of it, but it is not coupled to being able to run your tests.

You can simply always run your tests in CI using {% url "`cypress run`" command-line#cypress-run %} without the `--record` flag which does not communicate with our external servers and will not record any test results.

Expand Down
2 changes: 1 addition & 1 deletion source/faq/questions/general-questions-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ No. In fact Cypress' architecture is very different from Selenium in a few criti

Yes, technically; it's sandboxed and has to follow the same rules as every other browser. That's actually a good thing because it doesn't require a browser extension, and it naturally will work across all browsers (which enables cross-browser testing).

But Cypress is actually way beyond just a basic JavaScript application running in the browser. It's also a Desktop Application and communicates with backend web services.
But Cypress is actually way beyond just a basic JavaScript application running in the browser. It is also a desktop application and communicates with backend web services.

All of these technologies together are coordinated and enable Cypress to work, which extends its capabilities far outside of the browser sandbox. Without these, Cypress would not work at all. For the vast majority of your web development, Cypress will work just fine, and already *does* work.

Expand Down
6 changes: 3 additions & 3 deletions source/faq/questions/using-cypress-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,12 +179,12 @@ f4466038-70c2-4688-9ed9-106bf013cd73
```

{% note info %}
You can create multiple Record Keys for a project, or delete existing ones from our {% url 'Dashboard' https://on.cypress.io/dashboard %}.
You can create multiple Record Keys for a project, or delete existing ones from our {% url 'Dashboard Service' https://on.cypress.io/dashboard %}.
{% endnote %}

You can also find your Record Key inside of the *Settings* tab in our Desktop Application.
You can also find your Record Key inside of the *Settings* tab in the Test Runner.

![Settings Tab of Desktop](/img/dashboard/record-key-shown-in-desktop-gui-configuration.png)
![Settings Tab of Test Runner](/img/dashboard/record-key-shown-in-desktop-gui-configuration.png)

## {% fa fa-angle-right %} How do I check that an email was sent out?

Expand Down
6 changes: 3 additions & 3 deletions source/guides/core-concepts/interacting-with-elements.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Imagine you have a button:
</button>
```

Oftentimes either the `<i>` or `<span>` element is covering the exact coordinate we're attempting to interact with. In those cases, the event fires on the child. We even note this for you in the {% url "Command Log" overview-of-the-gui#Command-Log %}.
Oftentimes either the `<i>` or `<span>` element is covering the exact coordinate we're attempting to interact with. In those cases, the event fires on the child. We even note this for you in the {% url "Command Log" overview-of-test-runner#Command-Log %}.

## Scrolling

Expand All @@ -132,7 +132,7 @@ After we verify the element is actionable, Cypress will then fire all of the app
cy.get('button').click({ position: 'topLeft' })
```

The coordinates we fired the event at will generally be available when clicking the command in the {% url 'Command Log' overview-of-the-gui %}.
The coordinates we fired the event at will generally be available when clicking the command in the {% url 'Command Log' overview-of-test-runner %}.

![event coordinates](/img/guides/coords.png)

Expand All @@ -146,7 +146,7 @@ It can be difficult to debug problems when elements are not considered actionabl

Although you *should* see a nice error message, nothing beats visually inspecting and poking at the DOM yourself to understand the reason why.

When you use the {% url "Command Log" overview-of-the-gui#Command-Log %} to hover over a command, you'll notice that we will always scroll the element the command was applied to into view. Please note that this is *NOT* using the same algorithms that we described above.
When you use the {% url "Command Log" overview-of-test-runner#Command-Log %} to hover over a command, you'll notice that we will always scroll the element the command was applied to into view. Please note that this is *NOT* using the same algorithms that we described above.

In fact we only ever scroll elements into view when actionable commands are running using the above algorithms. We *do not* scroll elements into view on regular DOM commands like {% url `cy.get()` get %} or {% url `.find()` find %}.

Expand Down
2 changes: 1 addition & 1 deletion source/guides/core-concepts/introduction-to-cypress.md
Original file line number Diff line number Diff line change
Expand Up @@ -760,7 +760,7 @@ Some assertions modify the current subject unexpectedly. For example,

This is because Cypress honors the return value of the assertion, and `have.attr` is a {% url "`Chai-jQuery`" assertions#Chai-jQuery %} assertion that returns the matched string instead of the original subject. This can be surprising!

Whenever you have failing assertions and don't understand why, click the command in the Cypress {% url "Command Log" overview-of-the-gui#Command-Log %}. Cypress will print details to the browser console to help you troubleshoot what is going on.
Whenever you have failing assertions and don't understand why, click the command in the Cypress {% url "Command Log" overview-of-test-runner#Command-Log %}. Cypress will print details to the browser console to help you troubleshoot what is going on.
{% endnote %}

If we wrote this assertion in the explicit form "the long way", it would look like this:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Overview of the GUI
title: Overview of Test Runner
comments: false
---

{% note info %}
# {% fa fa-graduation-cap %} What You'll Learn

- The names and purposes of the visual parts of the Cypress GUI tool
- The names and purposes of the visual parts of the Cypress Test Runner
- How the tool behaves under different situations and inputs
- How the tool integrates the browser console experience
{% endnote %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Check out our recipe using {% url 'ES2015 and CommonJS modules' extending-cypres

To see an example of every command used in Cypress, open the {% url "`example_spec.js`" https://github.com/cypress-io/cypress-example-kitchensink/blob/master/cypress/integration/example_spec.js %} within your `cypress/integration` folder.

To start writing tests for your app, simply create a new file like `app_spec.js` within your `cypress/integration` folder. Refresh your tests list in the Cypress GUI and your new file should have appeared in the list.
To start writing tests for your app, simply create a new file like `app_spec.js` within your `cypress/integration` folder. Refresh your tests list in the Cypress Test Runner and your new file should have appeared in the list.

## Support Files

Expand Down
6 changes: 3 additions & 3 deletions source/guides/getting-started/_readme_in_progress.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ We've done this by:
- Enabling Dev Tools access while tests run
- Adding support for `debugger` in either test code **and** app code
- Snapshotting and time-traveling through all commands
- Providing a GUI that indicates the state of commands, like the number of elements found for a selector
- Providing a Test Runner that indicates the state of commands, like the number of elements found for a selector
- Displaying additional command information on click
- Logging page events such as XHRs, form submissions, page loads, and URL changes

Expand Down Expand Up @@ -275,7 +275,7 @@ But a friendly error is not enough (it's still just a string of text trying to s

***

### GUI Indicators
### Test Runner Indicators

**Page Events:**

Expand Down Expand Up @@ -329,7 +329,7 @@ We automatically intelligently retry everything until it passes.

## Network Stubbing

Because Cypress is a proxy that sits between your application and your webserver - this gives us the ability to modify any of your traffic.
Because Cypress is a proxy that sits between your application and your web server - this gives us the ability to modify any of your traffic.

While we currently only allow you to to stub XHR requests, everything is architecturally built to be able to modify or change **any type of HTTP request** - even websocket frames.

Expand Down
2 changes: 1 addition & 1 deletion source/guides/getting-started/installing-cypress.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ $(npm bin)/cypress open
npx cypress open
```

After a moment, the Cypress Desktop application will launch.
After a moment, the Cypress Test Runner will launch.

## Adding npm scripts

Expand Down
2 changes: 1 addition & 1 deletion source/guides/getting-started/testing-your-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ We {% url "covered Cypress in a simple app" writing-your-first-test %}, now let'

# {% fa fa-terminal %} Step 1: Start Your Server

Assuming you've successfully {% url "installed the Desktop Application" installing-cypress#Installing %} and {% url "opened the Cypress app" installing-cypress#Opening-Cypress %} in your project, the first thing you'll want to do is start your local development server that hosts the application.
Assuming you've successfully {% url "installed the Test Runner" installing-cypress#Installing %} and {% url "opened the Test Runner" installing-cypress#Opening-Cypress %} in your project, the first thing you'll want to do is start your local development server that hosts the application.

It should look something like **http://localhost:8080**.

Expand Down
Loading