Skip to content

Commit

Permalink
Fix Cypress app branding
Browse files Browse the repository at this point in the history
  • Loading branch information
debrisapron committed Jun 8, 2022
1 parent a9e7b0c commit 27e0e50
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 27 deletions.
8 changes: 4 additions & 4 deletions content/_data/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,10 @@
"title": "Testing Types",
"slug": "testing-types"
},
{
"title": "Cypress App",
"slug": "cypress-app"
},
{
"title": "Writing and Organizing Tests",
"slug": "writing-and-organizing-tests"
Expand All @@ -192,10 +196,6 @@
{
"title": "Conditional Testing",
"slug": "conditional-testing"
},
{
"title": "Cypress App",
"slug": "cypress-app"
}
]
},
Expand Down
46 changes: 23 additions & 23 deletions content/guides/core-concepts/cypress-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,22 @@ title: Cypress App

## <Icon name="graduation-cap"></Icon> What you'll learn

- The names and purposes of the visual parts of the Cypress App
- The names and purposes of the visual parts of the Cypress app
- How to use the Selector Playground for targeting your page elements
- How to debug tests using the built-in features of the Cypress App
- How to debug tests using the built-in features of the Cypress app

</Alert>

## Overview

The Cypress App is a desktop application with powerful features for creating,
The Cypress app is a desktop application with powerful features for creating,
configuring, browsing and most importantly running your tests. We'll touch on a
few of the different functions before moving on to the Test Runner, the heart of
the Cypress testing experience.

<Alert type="warning">

<strong class="alert-header">Dashboard Syndication</strong>
<strong class="alert-header">Dashboard Integration</strong>

A number of the features described below will only be shown if you are logged
into the [Cypress Dashboard](/guides/dashboard/introduction). If you're not sure
Expand All @@ -42,7 +42,7 @@ The Launchpad is your portal to Cypress, helping with onboarding, choosing a
testing type and launching a browser.

Once you get comfortable with Cypress you might find you don't need the
Launchpad any more. In this case you can launch the App with
Launchpad any more. In this case you can launch the app with
[`cypress open --e2e` or ` --component`](/guides/guides/command-line#cypress-open)
to go straight to the Spec Explorer.

Expand Down Expand Up @@ -75,40 +75,40 @@ should be the same everywhere.
This column shows the average time taken to run the entire spec file. Again,
this metadata is syndicated from the Dashboard.

### Recorded Runs (Recent Runs? Latest Runs?)
### Project Runs

TODO Ideally runs would show different commits
<DocsImage src="/img/guides/core-concepts/cypress-app/recorded-runs.png" alt="Recorded Runs"></DocsImage>

This screen shows detailed information about the most recently recorded test
runs, latest first. This metadata is syndicated from the Dashboard (see
[note above](#Overview)) so should be the same everywhere.
[note above](#Overview)) so should be the same everywhere. -- across branches --

The title of each run is taken from the
[git commit message](https://www.educative.io/edpresso/git-commit-message-simply-explained)
for that change, and clicking on it will take you to the corresponding run page
in the Dashboard.

TODO More detail needed?
TODO More detail needed? TODO link to dash runs

## The Test Runner

At the core of the app is the Test Runner itself. Cypress runs tests
interactively, allowing you to see commands as they execute while also viewing
the Application or Component Under Test, and exploring its DOM.

TODO Update this image
<DocsImage src="/img/guides/cypress-app/gui-diagram.png" alt="Cypress App"></DocsImage>
TODO Update this image (contact Ryan for help)
<DocsImage src="/img/guides/cypress-app/gui-diagram.png" alt="Cypress app"></DocsImage>

## Command Log

The lefthand side of the Cypress App is a visual representation of your test
The lefthand side of the Cypress app is a visual representation of your test
suite. Each test block is properly nested and each test, when clicked, displays
every Cypress command and assertion executed within the test's block as well as
any command or assertion executed in relevant `before`, `beforeEach`,
`afterEach`, and `after` hooks.

<DocsImage src="/img/guides/cypress-app/v10/command-log.png" alt="Cypress App" width-600></DocsImage>
<DocsImage src="/img/guides/cypress-app/v10/command-log.png" alt="Cypress app" width-600></DocsImage>

### Open files in your IDE

Expand All @@ -135,9 +135,9 @@ you may want to lower the `numTestsKeptInMemory` in your
</Alert>

In the following example, hovering over the `CONTAINS` command in the Command
Log changes the state of the Cypress App:
Log changes the state of the Cypress app:

<DocsImage src="/img/guides/cypress-app/v10/first-test-hover-contains.png" alt="Hovering over the contains tab highlights the dom element in the App in the Cypress App"></DocsImage>
<DocsImage src="/img/guides/cypress-app/v10/first-test-hover-contains.png" alt="Hovering over the contains tab highlights the dom element in the App in the Cypress app"></DocsImage>

Cypress automatically travels back in time to a snapshot of when a hovered-over
command resolved. Additionally, since [`cy.contains()`](/api/commands/contains)
Expand All @@ -159,7 +159,7 @@ command executed.
In the following example, clicking on the `CLICK` command highlights it in
purple, and does three other things worth noting:

<DocsImage src="/img/guides/cypress-app/v10/first-test-click-revert.png" alt="A click on the click command in the Command Log with Cypress App labeled as 1, 2, 3"></DocsImage>
<DocsImage src="/img/guides/cypress-app/v10/first-test-click-revert.png" alt="A click on the click command in the Command Log with Cypress app labeled as 1, 2, 3"></DocsImage>

#### 1. Pinned snapshots

Expand Down Expand Up @@ -238,14 +238,14 @@ it('intercept command log', () => {

## Preview Pane

The righthand side of the Cypress App is where the Application or Component
The righthand side of the Cypress app is where the Application or Component
Under Test is rendered.

### Application Under Test <E2EOnlyBadge />

In
[E2E Testing](/guides/core-concepts/testing-types#What-is-End-to-end-Testing),
the righthand side of the Cypress App is used to display the Application Under
the righthand side of the Cypress app is used to display the Application Under
Test (AUT): the application that was navigated to using a
[`cy.visit()`](/api/commands/visit) or any subsequent routing calls made from
the visited application.
Expand Down Expand Up @@ -294,7 +294,7 @@ unexpected behaviors

In
[Component testing](/guides/core-concepts/testing-types#What-is-Component-Testing),
the righthand side of the Cypress App is used to display the Component Under
the righthand side of the Cypress app is used to display the Component Under
Test (CUT): the component that was mounted using the
[`cy.mount()`](/api/commands/mount) command.

Expand Down Expand Up @@ -401,7 +401,7 @@ changes.
### Finding Selectors

To open the Selector Playground, click the <Icon name="crosshairs"></Icon>
button next to the URL at the top of the Cypress App. Hover over elements in
button next to the URL at the top of the Cypress app. Hover over elements in
your app to preview a unique selector for that element in the tooltip.

<DocsImage src="/img/guides/cypress-app/open-selector-playground.gif" alt="Opening selector playground and hovering over elements"></DocsImage>
Expand Down Expand Up @@ -446,7 +446,7 @@ off will allow you to interact with your app more easily.
## Keyboard Shortcuts

There are keyboard shortcuts to quickly perform common actions from within the
Cypress App.
Cypress app.

| Key | Action |
| --- | ----------------------------- |
Expand Down Expand Up @@ -478,7 +478,7 @@ information to your console.
Open up your Dev Tools and click on the `GET` for the `.action-email` class
selector.

<DocsImage src="/img/guides/cypress-app/v10/first-test-console-output.png" alt="Cypress App with get command pinned and console log open showing the yielded element"></DocsImage>
<DocsImage src="/img/guides/cypress-app/v10/first-test-console-output.png" alt="Cypress app with get command pinned and console log open showing the yielded element"></DocsImage>

**We can see Cypress output additional information in the console:**

Expand Down Expand Up @@ -524,7 +524,7 @@ describe('My First Test', () => {
Now, when the test runs, Cypress provides us a UI (similar to debugger) to step
forward through each command in the test.

<DocsImage src="/img/guides/cypress-app/v10/first-test-paused.png" alt="Cypress App shows label saying 'Paused' with Command Log showing 'Pause'"></DocsImage>
<DocsImage src="/img/guides/cypress-app/v10/first-test-paused.png" alt="Cypress app shows label saying 'Paused' with Command Log showing 'Pause'"></DocsImage>

In action:

Expand All @@ -534,5 +534,5 @@ In action:

| Version | Changes |
| ------------------------------------------- | --------------------------------------- |
| [3.5.0](/guides/references/changelog#3-5-0) | Added keyboard shortcuts to Cypress App |
| [3.5.0](/guides/references/changelog#3-5-0) | Added keyboard shortcuts to Cypress app |
| [1.3.0](/guides/references/changelog#1-3-0) | Added Selector Playground |

0 comments on commit 27e0e50

Please sign in to comment.