Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cypress-io/testing-workshop-cypress
End-to-end testing workshop with Cypress
https://github.com/cypress-io/testing-workshop-cypress
cypress cypress-io testing workshop
Last synced: 3 months ago
JSON representation
End-to-end testing workshop with Cypress
- Host: GitHub
- URL: https://github.com/cypress-io/testing-workshop-cypress
- Owner: cypress-io
- Archived: true
- Created: 2018-06-16T19:33:07.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-20T16:16:33.000Z (about 2 years ago)
- Last Synced: 2024-04-14T08:35:34.809Z (10 months ago)
- Topics: cypress, cypress-io, testing, workshop
- Language: JavaScript
- Homepage: https://testing-workshop-cypress.netlify.app/
- Size: 45.1 MB
- Stars: 474
- Watchers: 20
- Forks: 188
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# testing-workshop-cypress
 [![CircleCI][ci-badge]][ci-url] [](https://ci.appveyor.com/project/cypress-io/testing-workshop-cypress/branch/master) [![renovate-app badge][renovate-badge]][renovate-app]
> A full day testing workshop complete with application, exercise tests and speaker slides for [Cypress.io](https://www.cypress.io/)
## Requirements
- Any computer: Mac, Windows, Linux
- [Node 12.0.0+ (LTS)](https://nodejs.org/), check [GH workflow file](.github/workflows/min-node-version.yml)
- [git](https://git-scm.com)
In order to get the code and install dependencies
```bash
git clone [email protected]:cypress-io/testing-workshop-cypress.git
cd testing-workshop-cypress
npm install
```
If necessary, install dependencies inside TodoMVC folder
```bash
cd todomvc
npm install
```
### Quick check ✅
You can test the installation by starting TodoMVC in the first terminal window
```shell
cd todomvc
npm start
```
and you should see in the terminal
```text
> json-server --static . data.json --middlewares ./node_modules/json-server-reset
\{^_^}/ hi!
Loading data.json
Loading ./node_modules/json-server-reset
Done
Resources
http://localhost:3000/todos
Home
http://localhost:3000
```
Note for Windows users: if `npm start` throws an error, it is probably due to `cd todomvc; ...` first command in the `npm start `script. In this case change the working folder to "todomvc" and run `npm start` from there.
From the second terminal window you should be able to open Cypress in the root of the project with
```bash
$ npm run cy:open
> [email protected] cy:open /git/testing-workshop-cypress
> cypress open
```
### Tip
You can use the installed [start-server-and-test](https://github.com/bahmutov/start-server-and-test) utility to start the app, open Cypress and then shutdown the app when you exit Cypress.
```bash
$ npm run dev
```
## Application 💾
[Vue.js](https://vuejs.org/) + [Vuex](https://vuex.vuejs.org/) + REST server application that we are going to test is in the folder `todomvc`. This application and its full testing is described in [this blog post](https://www.cypress.io/blog/2017/11/28/testing-vue-web-application-with-vuex-data-store-and-rest-backend/). The application should run fine without network access.
## Slides 🖥
See the presentation at [https://testing-workshop-cypress.netlify.app/][presentation]. Every section of the presentation has a subfolder in the [slides](./slides) folder with a Markdown file. The Markdown is rendered into HTML using [Vite and Reveal.js combination](https://glebbahmutov.com/blog/reveal-vite/). You can open the presentation by clicking on "link" in the table below.
[presentation]: https://testing-workshop-cypress.netlify.app/
## Content 🗂
### Beginner
| | topic | folder | contents | slides |
| --- | -------------------------------------- | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------- | ------ |
| [🔗](#intro) | Introduction, TodoMVC application | [todomvc](todomvc) | [intro.md](slides/intro/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=intro)
| [🔗](#start) | Loading page | [00-start](00-start) | [00-start](slides/00-start/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=00-start)
| [🔗](#basic) | `cypress open` vs `cypress run` | [01-basic](cypress/integration/01-basic) | [01-basic](slides/01-basic/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=01-basic)
| [🔗](#adding-items) | Adding items test, `cypress.json` file | [02-adding-items](cypress/integration/02-adding-items) | [02-adding-items](slides/02-adding-items/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=02-adding-items)
| [🔗](#selector-playground) | Selector Playground | [03-selector-playground](cypress/integration/03-selector-playground) | [03-selector-playground](slides/03-selector-playground/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=03-selector-playground)
| [🔗](#reset-state) | Reset database using `cy.request` | [04-reset-state](cypress/integration/04-reset-state) | [04-reset-state](slides/04-reset-state/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=04-reset-state)
| [🔗](#xhr) | Spy and stub XHR requests, fixtures | [05-xhr](cypress/integration/05-xhr) | [05-xhr](slides/05-xhr/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=05-xhr)
| [🔗](#app-data-store) | Access application code and data | [06-app-data-store](cypress/integration/06-app-data-store) | [06-app-data-store](slides/06-app-data-store/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=06-app-data-store)
### Intermediate
| | topic | folder | contents | slides |
| --- | -------------------------------------- | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------- | ------ |
| [🔗](#ci) | Setting up E2E tests on CI | [07-ci](cypress/integration/07-ci) | [07-ci](slides/07-ci/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=07-ci)
| [🔗](#dashboard) | Setting up Cypress Dashboard | [07-ci](cypress/integration/07-ci) | [08-dashboard](slides/08-dashboard/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=08-dashboard)
| [🔗](#reporters) | Test reporters | - | [09-reporters](slides/09-reporters/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=09-reporters)
| [🔗](#configuration) | Configuration | - | [10-configuration](slides/10-configuration/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=10-configuration)
| [🔗](#retry-ability) | Retry-ability | [11-retry-ability](cypress/integration/11-retry-ability) | [11-retry-ability](slides/11-retry-ability/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=11-retry-ability)
| [🔗](#custom-commands) | Custom commands | [12-custom-commands](cypress/integration/12-custom-commands) | [12-custom-commands](slides/12-custom-commands/PITCHME.md)| [link](https://testing-workshop-cypress.netlify.app?p=12-custom-commands)
### Advanced
| | topic | folder | contents | slides |
| --- | -------------------------------------- | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------- | ------ |
| [🔗](#app-actions) | Page Objects vs App Actions | [13-app-actions](cypress/integration/13-app-actions) | [13-app-actions](slides/13-app-actions/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=13-app-actions)
| [🔗](#fixtures) | Fixtures | [14-fixtures](cypress/integration/14-fixtures) | [14-fixtures](slides/14-fixtures/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=14-fixtures)
| [🔗](#debugging) | Debugging | [02-adding-items/demo.js](cypress/integration/02-adding-items/demo.js) | [15-debugging](slides/15-debugging/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=15-debugging)
| [🔗](#preprocessors) | Preprocessors | [16-preprocessors](cypress/integration/16-preprocessors) | [16-preprocessors](slides/16-preprocessors/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=16-preprocessors)
| [🔗](#component-testing) | Component testing | [17-component-testing](cypress/integration/17-component-testing) | [17-component-testing](slides/17-component-testing/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=17-component-testing)
| [🔗](#backend) | Backend code | [18-backend](cypress/integration/18-backend) | [18-backend](slides/18-backend/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=18-backend)
| [🔗](#code-coverage) | Code coverage | [19-code-coverage](cypress/integration/19-code-coverage) | [19-code-coverage](slides/19-code-coverage/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=19-code-coverage)
| [🔗](#stubbing-methods) | Stubbing methods | [20-stubbing](./cypress/integration/20-stubbing) | [20-stubbing](./slides/20-stubbing/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=20-stubbing)
| | The end | - | [end](slides/end/PITCHME.md) | [link](https://testing-workshop-cypress.netlify.app?p=end)
## For speakers 🎙
[](https://app.netlify.com/sites/testing-workshop-cypress/deploys)
This workshop can take all day, but you can pick the sections you are interested in teaching at will and customize it into any time duration. Everyone is coding for the most part, except for CI and the Cypress Dashboard sections, where the usage was shown via slides and actual sites.
During the workshop, keep the `todomvc` app running in one shell, while each section `01-basic`, `02-...`, `03-...` etc. has its own Cypress and specs subfolders `cypress/integration/...`. Usually a spec has several tests with placeholder comments. The workshop attendees are expected to make the tests pass using the knowledge from the slides and hints (and [Cypress documentation](https://docs.cypress.io/)). Note that most folders have a prepared `spec.js` file and an `answer.js` file. The `answer.js` file is ignored by Cypress using a setting in `cypress.json`.
The only exception is the folder `00-start`. This is a folder for students to see how Cypress scaffolds example specs when you open Cypress for the very first time. In this folder students should execute...
```
cd 00-start
npm run cy:open
```
...and see the list of created example specs.
The slides are generated using Reveal.js from Markdown sources in the [slides](slides) folder. You can show the slides locally by running
```shell
npm run slides:dev
```
The slides are deployed to Netlify automatically, see [https://testing-workshop-cypress.netlify.app/](https://testing-workshop-cypress.netlify.app/)
## Additional information 🗃
- https://www.cypress.io/
- https://docs.cypress.io/
- https://docs.cypress.io/api/api/table-of-contents.html
[ci-badge]: https://circleci.com/gh/cypress-io/testing-workshop-cypress.svg?style=svg
[ci-url]: https://circleci.com/gh/cypress-io/testing-workshop-cypress
[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
[renovate-app]: https://renovateapp.com/