From 382acd9fc8aefd300c2814ebdaf894087134a12c Mon Sep 17 00:00:00 2001 From: Ken Matsui <26405363+ken-matsui@users.noreply.github.com> Date: Wed, 10 Nov 2021 01:37:54 +0900 Subject: fix(docs): Add additional e2e test instruction for macOS users (including m1) (#845) --- CONTRIBUTING.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 11c6d1f33..5dd0f8926 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,11 +46,22 @@ version `wasm-opt --version` > 97, for it's command `wasm-opt`. To run `test`, you will need the package `pkg-config` and a version of `openssl`. ## 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. +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. +
+Should you be a macOS (including m1) user, please follow these commands before. (expand here): + +1. `rustup target add x86_64-unknown-linux-musl` +2. `brew install messense/macos-cross-toolchains/x86_64-unknown-linux-musl` +3. `export CC_x86_64_unknown_linux_musl=$(brew --prefix)/bin/x86_64-unknown-linux-musl-gcc` +4. `export AR_x86_64_unknown_linux_musl=$(brew --prefix)/bin/x86_64-unknown-linux-musl-ar` +5. `export CARGO_TARGET_X86_64_UNKNOWN_LINUX_MUSL_LINKER=$CC_x86_64_unknown_linux_musl` +
+ 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 -- cgit v1.2.3