This module is for using Docker and TestContainer for end to end test.
You have to install Docker before you runn this module. See Docker Version Requirement.
IoTDB project will detect whether a Docker is installed (but do not check the docker's version).
The logic is, for Unix-like system, it checks whether /var/run/docker.sock exists. For Window system, it checks whether C:\Program Files\Docker\Docker\resources\bin\docker.exe exists.
If you are sure you have installed the Docker but testcontainer module is not loaed, use -P unixDockerCheck in your maven command, which also works on Windows OS.
Before running integration-test in this module, binaries must be generated in the distribution module, e.g, call mvn package -Dmaven.test.skip=true.
In this module, when running mvn pre-integration-test (or mvn integration-test, mvn post-integration-test), the module will build two docker images, apache/iotdb:maven-development, and apache/iotdb:cluster-maven-development.
In the post-integration-test phase, the above images will be removed.
In the integration-test phase, all src/test/java/**/*IT.java will be tested.
apache/iotdb:maven-development is generated following the Dockerfile ${basedir}/docker/src/main/Dockerfile-single, and apache/iotdb:cluster-maven-development is generated following the Dockerfile ${basedir}/docker/src/main/Dockerfile-cluster.
For testing a cluster, we use docker-compose and testcontainer.
The docker-compose file is located at src/test/resources/1nodes, src/test/resources/3nodes and src/test/resources/5nodes, in which one is for 1 node with replica number =1 , 3 nodes with replica number=3, and the last one is for 5 nodes with replica number =3.
TestContainer can start the docker (or docker compose) automatically.
But these docker compose files can also be used independently. e.g., docker-compose up.