End-to-end testing with Cypress

Onelink 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 test server for the fork.

Local Installation
Docker Setup

Using Local Onelink Installation

You have to install the necessary dependencies as described in setup guide for this method to work.

Navigate to the repository in your local machine and execute the following steps:

Create a fresh test database

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

Start Onelink in the test environment

RAILS_ENV=test foreman start -f Procfile.test

Load the URL in the browser and wait for it to start up:

http://localhost:5050/app/login

Using Docker

Follow the docker setup guide until you build the images.

Change the Rails Environment

Open docker-compose.yaml and update all the RAILS_ENV values from development to test:

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

Update the Port

Under rails section in your docker-compose.yaml update the port value as given below:

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

Reset the Database

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

Start Chatwoot Docker in the test environment

docker-compose up

Load the URL in the browser and wait for it to start 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:

Choose a browser for running tests
Select test files to run individual or all tests
Watch tests run in real-time with step-by-step execution
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! 🧪

Current State

Direction And Decisions

End-to-end testing with Cypress

End-to-end testing with Cypress

Prepare the Test Server

Using Local Onelink Installation

Create a fresh test database

Start Onelink in the test environment

Using Docker

Change the Rails Environment

Update the Port

Reset the Database

Start Chatwoot Docker in the test environment

Run Cypress

Getting Help

Useful Resources

Current State

Direction And Decisions

​End-to-end testing with Cypress

​Prepare the Test Server

​Using Local Onelink Installation

​Create a fresh test database

​Start Onelink in the test environment

​Using Docker

​Change the Rails Environment

​Update the Port

​Reset the Database

​Start Chatwoot Docker in the test environment

​Run Cypress

​Getting Help

​Useful Resources

End-to-end testing with Cypress

Prepare the Test Server

Using Local Onelink Installation

Create a fresh test database

Start Onelink in the test environment

Using Docker

Change the Rails Environment

Update the Port

Reset the Database

Start Chatwoot Docker in the test environment

Run Cypress

Getting Help

Useful Resources