Skip to content

Commit 82045f6

Browse files
committed
Update README
1 parent 07abe79 commit 82045f6

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

tests/README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
### Workaround for running the tests with Mac Apple Silicon
66

7-
The current version of the outdated maven plugin requires a workaround.
7+
The current version of the outdated Maven plugin requires a workaround. This is also necessary for running the tests
8+
with an outdated Arquillian Cube version.
89

910
Install socat
1011
```bash
@@ -39,20 +40,43 @@ You can add the function to your shell profile (`~/.bashrc`, `~/.zshrc`, etc.).
3940

4041
### Support for connecting to docker network from Mac host
4142

42-
You will also need to install [docker-mac-net-connect](https://github.com/chipmk/docker-mac-net-connect). It allows the tests to connect to the docker network from the Mac host.
43+
You will also need to install [docker-mac-net-connect](https://github.com/chipmk/docker-mac-net-connect). It allows the
44+
tests to connect to the Docker network from the Mac host.
45+
Disable host network mode in Docker Desktop settings before enabling `docker-mac-net-connect`, as they cannot be enabled
46+
simultaneously.
4347

4448
```bash
4549
brew install chipmk/tap/docker-mac-net-connect
4650
sudo brew services start chipmk/tap/docker-mac-net-connect
4751
```
4852

53+
You will also need to add the following to the Docker Desktop Docker Engine configuration on MacOS:
54+
```yaml
55+
{
56+
"default-network-opts": {
57+
"bridge": {
58+
"com.docker.network.bridge.gateway_mode_ipv4": "nat-unprotected"
59+
}
60+
}
61+
}
62+
```
63+
64+
Stop `docker-mac-net-connect` when you no longer need it:
65+
66+
```bash
67+
sudo brew services stop chipmk/tap/docker-mac-net-connect
68+
```
69+
4970
## Running the tests
5071

5172
Remember to start the unix socket proxy for docker as described in the previous section and set the `DOCKER_HOST` environment variable in the terminal where you run the tests.
5273

5374
### Building the docker images together with the project source code
5475

5576
```bash
77+
# remove possible remaining python client versions from previous builds
78+
git clean -fdx -- stream/clients/python
79+
# build the project and docker images
5680
mvn -B -nsu clean install -Pdocker -DskipTests
5781
docker images | grep apachebookkeeper
5882
```

0 commit comments

Comments
 (0)