Home

Awesome

cypress-book-todomvc

ci status

Initial screen

This application starts with an input field.

Initial screen

<details style="display:none"> <summary>Initial view</summary> <!-- fiddle Initial --> 
cy.visit('/')
cy.get('input').should('be.visible')
cy.screenshot('initial')
<!-- fiddle-end --> </details>

Main feature

User can enter several todos, and they are added to the list

Added three todos

<details style="display:none"> <!-- fiddle Adding todos --> 
cy.visit('/')
cy.get('.new-todo')
  .type('write in Markdown{enter}')
  .type('code in JavaScript{enter}')
  .type('test in Cypress{enter}')
cy.get('.todo-list li').should('have.length', 3)
cy.screenshot('todos')
<!-- fiddle-end --> </details>

Completing tasks

Once there are several todo items, the user can mark some items "done" and then clear them using a button.

Completed several items

You can see just the completed items using the filters below the list

Just completed items

The "Clear completed" button is at the bottom and becomes visible only if there are completed items.

Footer

Hover over the button and click on it

Clear completed button

Only a single active todo remains

Single remaining todo

<details style="display:none"> <!-- fiddle Completing tasks --> 
cy.visit('/')
cy.get('.new-todo')
  .type('write in Markdown{enter}')
  .type('code in JavaScript{enter}')
  .type('test in Cypress{enter}')
cy.get('.todo-list li').should('have.length', 3)

cy.contains('.view', 'code in JavaScript').find('.toggle').click()
cy.contains('.view', 'test in Cypress').find('.toggle').click()
cy.get('.todo-list li.completed').should('have.length', 2)
cy.screenshot('completed-todos')

cy.contains('.filters li', 'Completed').click()
cy.get('.todo-list li').should('have.length', 2)
cy.screenshot('just-completed-todos')

cy.contains('.filters li', 'All').click()
cy.get('footer.footer').screenshot('footer')
cy.contains('Clear completed')
  .should('be.visible')
  .then(($el) => {
    $el.css({
      textDecoration: 'underline',
      border: '1px solid pink',
      borderRadius: '2px',
    })
  })
cy.get('footer.footer').screenshot('clear-completed')

// clear completed items and take a screenshot
// of the single active todo
cy.contains('Clear completed').click()
cy.get('.todo-list li').should('have.length', 1)
cy.screenshot('remaining-todo')
<!-- fiddle-end --> </details>

Explanation

This README file contains tests Cypress understands and runs by using cypress-fiddle file preprocessor. Start the application and Cypress using

npm install
npm run dev

And click on the README.md file

README spec

The tests should run. These tests are above in this file, hiding inside an invisible HTML element and a comment:

<details style="display:none">
<!-- fiddle Initial -->
... Cypress test ...
<!-- fiddle-end -->
</details>

This is similar to what I have done in Self-testing JAM pages

The test usually includes several .screenshot commands, these images are moved into images folder using code in the cypress/plugins/index.js file.

You can also take a screenshot with the test runner to show how Cypress looks during the test.

TodoMVC test inside Cypress

<details style="display:none"> <summary>TodoMVC test</summary> <!-- fiddle TodoMVC test --> 
cy.visit('/')
cy.get('.new-todo').type('I ❤️ tests{enter}')
cy.get('.todo-list li').should('have.length', 1)
cy.screenshot('demo-test', { capture: 'runner', log: false })
<!-- fiddle-end --> </details>

For more advanced use case where you might want to generate video clips from tests, see cypress-movie

on CI

This project is built and tested using GitHub Actions. If there are any changed screenshots, they are automatically committed and pushed to GH, see .github/workflows/main.yml

Then this README is converted into a static site using VuePress and deployed to the GitHub Pages at https://glebbahmutov.com/cypress-book-todomvc/.