diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 619a33e24..58aa5df79 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -12,6 +12,12 @@ can do so by running the following command: ``` sbt integtest/test ``` +If you get integration test failures with error message "Previous attempts to find a Docker environment failed" in macOS, fix the issue by following the checklist: +1. Check you've installed Docker in your dev host. If not, install Docker first. +2. Check if the file /var/run/docker.sock exists. If not, go to `3`. +3. Run `sudo ln -s $HOME/.docker/desktop/docker.sock /var/run/docker.sock` or `sudo ln -s $HOME/.docker/run/docker.sock /var/run/docker.sock` +4. If you use Docker Desktop, as an alternative of `3`, check mark the "Allow the default Docker socket to be used (requires password)" in advanced settings of Docker Desktop. + ### AWS Integration Test The integration folder contains tests for cloud server providers. For instance, test against AWS OpenSearch domain, configure the following settings. The client will use the default credential provider to access the AWS OpenSearch domain. ```