diff options
| author | Aram Drevekenin <aram@poor.dev> | 2021-06-21 10:45:18 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-06-21 10:45:18 +0200 |
| commit | 3313634fe969a69925a5d32445ba14a5f79e5d87 (patch) | |
| tree | 778f1badfeed4a26d58e3413180f41629134d35a /CONTRIBUTING.md | |
| parent | docs(changelog): Autodetach #581 (diff) | |
| download | sl0ppij-3313634fe969a69925a5d32445ba14a5f79e5d87.tar.gz sl0ppij-3313634fe969a69925a5d32445ba14a5f79e5d87.tar.xz sl0ppij-3313634fe969a69925a5d32445ba14a5f79e5d87.zip | |
Add e2e tests (#582)
* feature(tests): e2e tests
* chore(build): github action
* chore(build): fix workflow
* chore(build): fix workflow
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* work
* working
* working
* working
* bring back the proper errors
* make e2e flow run properly
* style(fmt): make rustfmt happy
* style(fmt): make rustfmt happy
* run on everything just to test the workflow
* bring back running behaviour on workflow
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 95ac05ec..d34367f3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,6 +44,18 @@ cargo make manpage To run `install` or `publish`, you'll need the package `binaryen` in the version `wasm-opt --version` > 97, for it's command `wasm-opt`. +## Running the end-to-end tests +Zellij includes some end to end tests which test the whole application as a black-box from the outside. +These tests work by running a docker container which contains the Zellij binary, connecting to it via ssh, sending some commands and comparing the output received against predefined snapshots. + +To run these tests locally, you'll need to have both `docker` and `docker-compose` installed. +Once you do, in the repository root: +1. `docker-compose up -d` will start up the docker container +2. `cargo make build-e2e` will build the generic linux executable of Zellij in the target folder, which is shared with the container +3. `cargo make e2e-test` will run the tests + +To re-run the tests after you've changed something in the code base, be sure to repeat steps 2 and 3. + ## Looking for something to work on? If you are new contributor to `Zellij` going through |