Skip to content
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

chore: re-name dashboard references to Cypress Cloud #24699

Merged
merged 9 commits into from Nov 17, 2022
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/4-flaky-test.yml
Expand Up @@ -10,8 +10,8 @@ body:
- type: textarea
id: dashboard
attributes:
label: Link to dashboard or CircleCI failure
description: Please include a link to the failure in the Cypress Dashboard or in CircleCI.
label: Link to Cypress Cloud or CircleCI failure
description: Please include a link to the failure in Cypress Cloud or in CircleCI.
validations:
required: true
- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -238,7 +238,7 @@ If there are errors building the packages, prefix the commands with `DEBUG=cypre

When running `yarn start` this routes through the CLI and eventually calls `yarn dev` with the proper arguments. This enables Cypress day-to-day development to match the logic of the built binary + CLI integration.

If you want to bypass the CLI entirely, you can use the `yarn dev` task and pass arguments directly. For example, to headlessly run a project in a given folder, while trying to record to the Dashboard
If you want to bypass the CLI entirely, you can use the `yarn dev` task and pass arguments directly. For example, to headlessly run a project in a given folder, while trying to record to Cypress Cloud.

```text
yarn dev --run-project /project/folder --record --key <key>
Expand Down
6 changes: 3 additions & 3 deletions cli/__snapshots__/cli_spec.js
Expand Up @@ -74,7 +74,7 @@ exports['shows help for run --foo 1'] = `
-C, --config-file <config-file> path to script file where configuration values are set. defaults to "cypress.config.{js,ts,mjs,cjs}".
--e2e runs end to end tests
-e, --env <env> sets environment variables. separate multiple values with a comma. overrides any value in cypress.config.{js,ts,mjs,cjs} or cypress.env.json
--group <name> a named group for recorded runs in the Cypress Dashboard
--group <name> a named group for recorded runs in Cypress Cloud
-k, --key <record-key> your secret Record Key. you can omit this if you set a CYPRESS_RECORD_KEY environment variable.
--headed displays the browser instead of running headlessly
--headless hide the browser instead of running headed (default for cypress run)
Expand All @@ -83,11 +83,11 @@ exports['shows help for run --foo 1'] = `
-p, --port <port> runs Cypress on a specific port. overrides any value in cypress.config.{js,ts,mjs,cjs}.
-P, --project <project-path> path to the project
-q, --quiet run quietly, using only the configured reporter
--record [bool] records the run. sends test results, screenshots and videos to your Cypress Dashboard.
--record [bool] records the run. sends test results, screenshots and videos to Cypress Cloud.
-r, --reporter <reporter> runs a specific mocha reporter. pass a path to use a custom reporter. defaults to "spec"
-o, --reporter-options <reporter-options> options for the mocha reporter. defaults to "null"
-s, --spec <spec> runs specific spec file(s). defaults to "all"
-t, --tag <tag> named tag(s) for recorded runs in the Cypress Dashboard
-t, --tag <tag> named tag(s) for recorded runs in Cypress Cloud
--dev runs cypress in development and bypasses binary check
-h, --help display help for command
-------
Expand Down
6 changes: 3 additions & 3 deletions cli/lib/cli.js
Expand Up @@ -110,19 +110,19 @@ const descriptions = {
exit: 'keep the browser open after tests finish',
forceInstall: 'force install the Cypress binary',
global: 'force Cypress into global mode as if its globally installed',
group: 'a named group for recorded runs in the Cypress Dashboard',
group: 'a named group for recorded runs in Cypress Cloud',
headed: 'displays the browser instead of running headlessly',
headless: 'hide the browser instead of running headed (default for cypress run)',
key: 'your secret Record Key. you can omit this if you set a CYPRESS_RECORD_KEY environment variable.',
parallel: 'enables concurrent runs and automatic load balancing of specs across multiple machines or processes',
port: 'runs Cypress on a specific port. overrides any value in cypress.config.{js,ts,mjs,cjs}.',
project: 'path to the project',
quiet: 'run quietly, using only the configured reporter',
record: 'records the run. sends test results, screenshots and videos to your Cypress Dashboard.',
record: 'records the run. sends test results, screenshots and videos to Cypress Cloud.',
reporter: 'runs a specific mocha reporter. pass a path to use a custom reporter. defaults to "spec"',
reporterOptions: 'options for the mocha reporter. defaults to "null"',
spec: 'runs specific spec file(s). defaults to "all"',
tag: 'named tag(s) for recorded runs in the Cypress Dashboard',
tag: 'named tag(s) for recorded runs in Cypress Cloud',
version: 'prints Cypress version',
}

Expand Down
2 changes: 1 addition & 1 deletion cli/types/cypress.d.ts
Expand Up @@ -2863,7 +2863,7 @@ declare namespace Cypress {
*/
video: boolean
/**
* Whether Cypress will upload the video to the Dashboard even if all tests are passing. This applies only when recording your runs to the Dashboard. Turn this off if you'd like the video uploaded only when there are failing tests.
* Whether Cypress will upload the video to Cypress Cloud even if all tests are passing. This applies only when recording your runs to Cypress Cloud. Turn this off if you'd like the video uploaded only when there are failing tests.
* @default true
*/
videoUploadOnPasses: boolean
Expand Down
2 changes: 1 addition & 1 deletion cypress-prioritization-and-triage.md
Expand Up @@ -118,7 +118,7 @@ There are a number of reasons why a ticket may be closed without any change or P
The best place for asking questions is our [Discord server](https://discord.gg/cypress) which has a very active community of folks with a diverse set of knowledge. Other available channels to explore include [Cypress GitHub discussions](https://github.com/cypress-io/cypress/discussions), [community chat](https://on.cypress.io/chat), and [Stack Overflow](https://stackoverflow.com/questions/tagged/cypress).
We also offer support via email with our [paid plans](https://www.cypress.io/pricing/).

- **Feature request for Cypress Dashboard** - Thank you for your support as a Cypress Dashboard user! These issues are routed to our Cypress Dashboard team's ticketing system. Your customer success representative is available for follow-up and will reach out you directly via email if more information is needed.
- **Feature request for Cypress Cloud** - Thank you for your support as a Cypress Cloud user! These issues are routed to our Cypress Cloud team's ticketing system. Your customer success representative is available for follow-up and will reach out you directly via email if more information is needed.

- **The fix or feature is not within our vision for Cypress** - There will inevitably be suggestions that will not fit within the scope of Cypress' vision for our product. We will do our best to explain why we will not be addressing this issue.

Expand Down
4 changes: 2 additions & 2 deletions guides/release-process.md
Expand Up @@ -82,7 +82,7 @@ In the following instructions, "X.Y.Z" is used to denote the [next version of Cy
- Go into a project, run a quick test, make sure things look right
- Optionally, install the new version into an established project and run the tests there
- [cypress-realworld-app](https://github.com/cypress-io/cypress-realworld-app) uses yarn and represents a typical consumer implementation.
- Optionally, do more thorough tests, for example test the new version of Cypress against the Cypress Dashboard repo.
- Optionally, do more thorough tests, for example test the new version of Cypress against the Cypress Cloud repo.

5. Log into AWS SSO with `aws sso login --profile <name_of_profile>`. If you have setup your credentials under a different profile than `prod`, be sure to set the `AWS_PROFILE` environment variable to that profile name for the remaining steps. For example, if you are using `production` instead of `prod`, do `export AWS_PROFILE=production`.

Expand Down Expand Up @@ -119,7 +119,7 @@ In the following instructions, "X.Y.Z" is used to denote the [next version of Cy
- Go into a project, run a quick test, make sure things look right
- Install the new version into an established project and run the tests there
- [cypress-realworld-app](https://github.com/cypress-io/cypress-realworld-app) uses yarn and represents a typical consumer implementation.
- Optionally, do more thorough tests, for example test the new version of Cypress against the Cypress Dashboard repo.
- Optionally, do more thorough tests, for example test the new version of Cypress against the Cypress Cloud repo.

11. Create or review the release-specific documentation and changelog in [cypress-documentation](https://github.com/cypress-io/cypress-documentation). If there is not already a release-specific PR open, create one. This PR must be merged, built, and deployed before moving to the next step.
- Use [`release-automations`](https://github.com/cypress-io/release-automations)'s `issues-in-release` tool to generate a starting point for the changelog, based off of ZenHub:
Expand Down
10 changes: 5 additions & 5 deletions npm/cypress-schematic/README.md
Expand Up @@ -135,17 +135,17 @@ Before running Cypress in `open` mode, ensure that you have started your applica

Read our docs to learn more about [launching browsers](https://on.cypress.io/launching-browsers) with Cypress.

### Recording test results to the Cypress Dashboard
### Recording test results to Cypress Cloud

We recommend setting your [Cypress Dashboard](https://on.cypress.io/features-dashboard) recording key as an environment variable and NOT as a builder option when running it in CI.
We recommend setting your [Cypress Cloud](https://on.cypress.io/features-dashboard) recording key as an environment variable and NOT as a builder option when running it in CI.

```json
"cypress-run": {
"builder": "@cypress/schematic:cypress",
"options": {
"devServerTarget": "{project-name}:serve",
"record": true,
"key": "your-cypress-dashboard-recording-key"
"key": "your-cypress-cloud-recording-key"
},
"configurations": {
"production": {
Expand All @@ -155,7 +155,7 @@ We recommend setting your [Cypress Dashboard](https://on.cypress.io/features-das
}
```

Read our docs to learn more about [recording test results](https://on.cypress.io/recording-project-runs) to the [Cypress Dashboard](https://on.cypress.io/features-dashboard).
Read our docs to learn more about [recording test results](https://on.cypress.io/recording-project-runs) to [Cypress Cloud](https://on.cypress.io/features-dashboard).

### Specifying a custom config file

Expand Down Expand Up @@ -187,7 +187,7 @@ Read our docs to learn more about all the [configuration options](https://on.cyp
"devServerTarget": "{project-name}:serve",
"parallel": true,
"record": true,
"key": "your-cypress-dashboard-recording-key"
"key": "your-cypress-cloud-recording-key"
},
"configurations": {
"production": {
Expand Down
2 changes: 1 addition & 1 deletion packages/app/README.md
Expand Up @@ -16,7 +16,7 @@ This is the front-end for the Cypress App.

Cypress has two modes: `run` and `open`. We want run mode to be as light and fast as possible, since this is the mode used to run on CI machines, etc. Run mode has minimal UI showing only what is necessary. Open mode is the interactive experience.

- **`open`** mode is driven using GraphQL and urql. It shows the full Cypress app, include the top nav, side nav, spec list, etc. You can change between testing types, check your latest runs on the Cypress Dashboard, update settings, etc.
- **`open`** mode is driven using GraphQL and urql. It shows the full Cypress app, include the top nav, side nav, spec list, etc. You can change between testing types, check your latest runs on Cypress Cloud, update settings, etc.
- **`run`** mode is does not rely on GraphQL. This is so we can be as performant as possible. It only renders the "runner" part of the UI, which is comprised of the command log, Spec Runner header, and AUT iframe.

The two modes are composed using the same logic, but have slightly different components. You can see where the differences are in `Runner.vue`(src/pages/Specs/Runner.vue). Notice that `<SpecRunnerOpenMode>` receives a `gql` prop, since it uses GraphQL, and `<SpecRunnerRunMode>` does not.
Expand Down
14 changes: 7 additions & 7 deletions packages/app/cypress/e2e/runs.cy.ts
Expand Up @@ -279,7 +279,7 @@ describe('App: Runs', { viewportWidth: 1200 }, () => {
name: 'Test User A',
} })

cy.contains('button', 'Log in to the Cypress Dashboard').click()
cy.contains('button', 'Log in to Cypress Cloud').click()

cy.findByRole('dialog', { name: 'Log in to Cypress' }).as('logInModal').within(() => {
cy.findByRole('button', { name: 'Log in' }).click()
Expand Down Expand Up @@ -578,7 +578,7 @@ describe('App: Runs', { viewportWidth: 1200 }, () => {
})

context('Runs - No Runs', () => {
it('when no runs and not connected, shows connect to dashboard button', () => {
it('when no runs and not connected, shows connect to Cypress Cloud button', () => {
cy.scaffoldProject('component-tests')
cy.openProject('component-tests', ['--config-file', 'cypressWithoutProjectId.config.js'])
cy.startAppServer('component')
Expand Down Expand Up @@ -722,7 +722,7 @@ describe('App: Runs', { viewportWidth: 1200 }, () => {

moveToRunsPage()

cy.contains('h2', 'Cannot connect to the Cypress Dashboard')
cy.contains('h2', 'Cannot connect to Cypress Cloud')
// cy.percySnapshot() // TODO: restore when Percy CSS is fixed. See https://github.com/cypress-io/cypress/issues/23435

cy.remoteGraphQLIntercept((obj) => {
Expand Down Expand Up @@ -755,7 +755,7 @@ describe('App: Runs', { viewportWidth: 1200 }, () => {

cy.get('[data-cy=warning-alert]')
.should('contain.text', 'You have no internet connection')
.and('contain.text', 'Check your internet connection to pull the latest data from the dashboard')
.and('contain.text', 'Check your internet connection to pull the latest data from Cypress Cloud')
})

it('should remove the alert warning if the app reconnects to the internet', () => {
Expand All @@ -769,7 +769,7 @@ describe('App: Runs', { viewportWidth: 1200 }, () => {

cy.get('[data-cy=warning-alert]')
.should('contain.text', 'You have no internet connection')
.and('contain.text', 'Check your internet connection to pull the latest data from the dashboard')
.and('contain.text', 'Check your internet connection to pull the latest data from Cypress Cloud')

cy.goOnline()

Expand Down Expand Up @@ -810,7 +810,7 @@ describe('App: Runs', { viewportWidth: 1200 }, () => {

cy.get('[data-cy=standard-modal]')
.should('contain.text', 'You have no internet connection')
.and('contain.text', 'Check your internet connection to pull the latest data from the dashboard')
.and('contain.text', 'Check your internet connection to pull the latest data from Cypress Cloud')
})

it('shows correct message on connect project modal', () => {
Expand Down Expand Up @@ -844,7 +844,7 @@ describe('App: Runs', { viewportWidth: 1200 }, () => {

cy.get('[data-cy=standard-modal]')
.should('contain.text', 'You have no internet connection')
.and('contain.text', 'Check your internet connection to pull the latest data from the dashboard')
.and('contain.text', 'Check your internet connection to pull the latest data from Cypress Cloud')
})
})

Expand Down
20 changes: 10 additions & 10 deletions packages/app/cypress/e2e/settings.cy.ts
Expand Up @@ -21,7 +21,7 @@ describe('App: Settings', () => {

cy.findByText('Device settings').should('be.visible')
cy.findByText('Project settings').should('be.visible')
cy.findByText('Dashboard settings').should('be.visible')
cy.findByText('Cypress Cloud settings').should('be.visible')
})

describe('Cloud Settings', () => {
Expand All @@ -33,7 +33,7 @@ describe('App: Settings', () => {
cy.startAppServer('e2e')
cy.visitApp()
cy.get(SidebarSettingsLinkSelector).click()
cy.findByText('Dashboard settings').click()
cy.findByText('Cypress Cloud settings').click()
cy.findByText('Project ID').should('be.visible')
cy.get('[data-cy="code-box"]').should('contain', 'fromCli')
cy.findByText('Copy').click()
Expand All @@ -49,7 +49,7 @@ describe('App: Settings', () => {

cy.visitApp()
cy.get(SidebarSettingsLinkSelector).click()
cy.findByText('Dashboard settings').click()
cy.findByText('Cypress Cloud settings').click()
cy.findByText('Record key').should('be.visible')
})

Expand All @@ -59,7 +59,7 @@ describe('App: Settings', () => {

cy.visitApp()
cy.get(SidebarSettingsLinkSelector).click()
cy.findByText('Dashboard settings').click()
cy.findByText('Cypress Cloud settings').click()
cy.get('[data-cy="code-box"]').should('contain', '***')
cy.get('[aria-label="Record Key Visibility Toggle"]').click()
cy.get('[data-cy="code-box"]').should('contain', '2aaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa')
Expand All @@ -69,7 +69,7 @@ describe('App: Settings', () => {
cy.startAppServer('e2e')
cy.loginUser()
cy.visitApp('settings')
cy.findByText('Dashboard settings').click()
cy.findByText('Cypress Cloud settings').click()
cy.findByText('Manage keys').click()
cy.withRetryableCtx((ctx) => {
expect((ctx.actions.electron.openExternal as SinonStub).lastCall.lastArg).to.eq('http:/test.cloud/cloud-project/settings')
Expand Down Expand Up @@ -97,7 +97,7 @@ describe('App: Settings', () => {
// Wait for the test to pass, so the test is completed
cy.get('.passed > .num').should('contain', 1)
cy.get(SidebarSettingsLinkSelector).click()
cy.contains('Dashboard settings').click()
cy.contains('Cypress Cloud settings').click()
// Assert the data is not there before it arrives
cy.contains('Record key').should('not.exist')
cy.contains('Record key')
Expand All @@ -112,7 +112,7 @@ describe('App: Settings', () => {
})

cy.findByTestId('sidebar-link-settings-page').click()
cy.contains('Dashboard settings').click()
cy.contains('Cypress Cloud settings').click()
cy.contains('Record key').should('exist')
cy.findByTestId('sidebar-link-runs-page').click()
cy.findByTestId('user-avatar-title').click()
Expand All @@ -123,7 +123,7 @@ describe('App: Settings', () => {
})

cy.findByTestId('sidebar-link-settings-page').click()
cy.contains('Dashboard settings').click()
cy.contains('Cypress Cloud settings').click()
cy.contains('Record key').should('not.exist')
})
})
Expand Down Expand Up @@ -408,13 +408,13 @@ describe('App: Settings without cloud', () => {

cy.visitApp()
cy.get(SidebarSettingsLinkSelector).click()
cy.findByText('Dashboard settings').click()
cy.findByText('Cypress Cloud settings').click()
cy.findByText('Project ID').should('not.exist')
cy.withCtx((ctx, o) => {
o.sinon.spy(ctx._apis.authApi, 'logIn')
})

cy.contains('button', 'Log in to the Cypress Dashboard').click()
cy.contains('button', 'Log in to Cypress Cloud').click()
cy.findByRole('dialog', { name: 'Log in to Cypress' }).within(() => {
cy.contains('button', 'Log in').click()
})
Expand Down