ElasticPress e2e tests use Cypress, wp-env, and an Elasticsearch Docker container.

• docker
• docker-compose
• npm (>= 10)

• Start the local environment (WP env and Elasticsearch containers): npm run env:start
• Install all node packages: npm i
• Build assets: npm run build
• Initial database setup: npm run cypress:setup
• Open Cypress: npm run cypress:open

• Destroy the WP env: npm run env destroy
• Restart WP env and redo initial setup: npm run env:start && npm run cypress:setup
• Open Cypress: npm run cypress:open

Run ./bin/wp-env-cli tests-wordpress "wp --allow-root config set EP_HOST http://host.docker.internal:8890/"

Run sudo apt update && sudo apt install libatk1.0-0 libatk-bridge2.0-0 libcups2 libgtk-3-0 libgbm-dev libasound2 xvfb

Make sure you have xvfb installed

export LIBGL_ALWAYS_INDIRECT=1
export DISPLAY=:0

This error may appear when running tests on an Apple Silicon device that was restored from a backup of an Intel machine. Run the following in ./bin/es-docker to ensure the Docker image is for the right platform:

docker-compose down
docker-compose up -d --build --force-recreate

To run tests locally using an ElasticPress.io endpoint, in place of running npm run cypress:setup during setup, run: ./bin/setup-cypress-env.sh --ep-host="https://" --es-shield="username:password" --ep-index-prefix="username", with the arguments populated with the details for your ElasticPress.io endpoint.