note: this document is a WIP
End-to-end tests are a great mean of:
- quality assurance
- feature documentation
They play a crucial role in communicating the expected behavior and interaction between the components. E2E test suites are great for documenting the user journeys - a good start to developing a given feature.
Our E2E tests live in the e2e folder. They rely on so-called stories located in src/stories folder. E2E tests are run with the combination of ladle (utility used for documenting our components in form of stories) and playwright (E2E test runner).
To run the E2E tests you need to:
- Create your Stream chat application in the Stream Dashboard (we recommend you to use a dedicated app).
- Create a
.envfile in the repository's root directory with env variable names corresponding to those in.env.examplefile. - Populate channels with messages in your chat application running the fixtures script
yarn e2e-fixtures - Run E2E tests with
yarn e2escript