​

End-to-end testing with Cypress

Chatwoot uses Cypress for end-to-end testing. Use the following steps to run the tests on your local machine.

​

Prepare the Test Server

Choose any of the given methods to run your Chatwoot test server.

RAILS_ENV=test bin/rake db:drop
RAILS_ENV=test bin/rake db:create
RAILS_ENV=test bin/rake db:schema:load

RAILS_ENV=test foreman start -f Procfile.test

http://localhost:5050/app/login

RAILS_ENV=test bin/rake db:drop
RAILS_ENV=test bin/rake db:create
RAILS_ENV=test bin/rake db:schema:load

RAILS_ENV=test foreman start -f Procfile.test

http://localhost:5050/app/login

# In docker-compose.yaml
environment:
  - RAILS_ENV=test  # Change from development to test

# In docker-compose.yaml
ports:
  - 5050:3000  # Change from 3000:3000 to 5050:3000

docker-compose run --rm rails bundle exec rails db:reset

docker-compose up

http://localhost:5050/app/login

​

Run Cypress

Load localhost:5050 on your browser and ensure that the Chatwoot server is running.

Navigate to your Chatwoot local directory and execute the following command to run the Cypress tests:

pnpm cypress open --project ./spec

This will open the Cypress Test Runner where you can:

1. Choose a browser for running tests
2. Select test files to run individual or all tests
3. Watch tests run in real-time with step-by-step execution
4. Debug failed tests with detailed error information

​

Getting Help

If you encounter issues with Cypress testing:

• Cypress Documentation: Official Cypress Docs
• Cypress Best Practices: Testing Guide
• Common Errors: See Common Errors
• Community Support: Discord

​

Useful Resources

• Cypress API Reference: https://docs.cypress.io/api/table-of-contents
• Testing Library: Testing utilities for better element selection
• Cypress Examples: Real-world examples

Your Cypress testing environment is now ready for comprehensive end-to-end testing! 🧪