Skip to content

Commit

Permalink
docs(e2e): add troubleshoot section (#2070)
Browse files Browse the repository at this point in the history
Add a workaround for the issue when running e2e tests on MacBook fails.

issue: #2062
  • Loading branch information
sideninja authored Oct 4, 2024
1 parent 802955c commit 49e5d6b
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ To run the end-to-end tests, run:
```bash
MANIFEST=devnet1 make e2e-run
```
_If the above command fails, [see the troubleshooting section](./e2e/README.md#troubleshooting)._

To start a devnet, run:

Expand Down
15 changes: 15 additions & 0 deletions e2e/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,18 @@ Auxiliary commands:
* `logs`: outputs all node logs.

* `tail`: tails (follows) node logs until canceled.


## Troubleshooting
**MacBook E2E test fails to start docker container**
If you are experiencing an issue running the e2e tests and the error output looks like this:
```
Error response from daemon: no match for platform in manifest
```
This error is known to happen on a freshly installed MacBook, we are investigating the underlying issue, but meanwhile, there is a workaround:
1. Clean all the build images `docker system prune -a -f --volumes`
2. Set the platform env: `export DOCKER_DEFAULT_PLATFORM=linux/amd64`
3. Rerun docker build: `make build-docker`
4. Run tests again: `make e2e-ci` or any other tests using the e2e command.

Please let the team know if you experienced the above issue.

0 comments on commit 49e5d6b

Please sign in to comment.