Consensus node Dockerfile for test framework (BFT-398)

.dockerignore

@@ -0,0 +1 @@
+/node/target

Dockerfile

@@ -0,0 +1,21 @@
+# Build Stage
+FROM rust:1.72.1 as build
+COPY /node/ Makefile /node/
+WORKDIR /node
+RUN apt-get update && apt-get install -y libclang-dev
+RUN cargo build --release
+RUN make docker_node_configs
+
+# Runtime Stage
+FROM debian:stable-slim as runtime
+
+COPY --from=build /node/target/release/executor /node/
+COPY --from=build /node/tools/docker-config/node-configs /node/
+COPY entrypoint.sh /node/
+
+WORKDIR /node
+RUN chmod +x entrypoint.sh
+
+ENTRYPOINT ["./entrypoint.sh"]
+
+EXPOSE 3054

Makefile

@@ -0,0 +1,41 @@
+.PHONY: node node_configs docker_node_configs node_docker consenus_docker_example clean clean_docker  
+IP?=127.0.0.1:3054
+DOCKER_IP=172.12.0.10
+EXECUTABLE_NODE_DIR=node/tools
+
+# Locally run commands
+
+node:
+	export RUST_LOG=INFO && cd ${EXECUTABLE_NODE_DIR}/node-configs/${IP} && cargo run -- --database ../../database/${IP} 
+
+node_configs:
+	cd ${EXECUTABLE_NODE_DIR} && cargo run --bin localnet_config -- --input-addrs addresses.txt --output-dir node-configs
+
+# Docker commands
+
+docker_node_configs:
+	cd tools && cargo run --release --bin localnet_config -- --input-addrs docker-config/addresses.txt --output-dir docker-config/node-configs
+
+node_docker:
+	mkdir -p ${EXECUTABLE_NODE_DIR}/docker-config
+	cd ${EXECUTABLE_NODE_DIR}/docker-config && rm -rf addresses.txt && echo ${DOCKER_IP}:3054 >> addresses.txt
+	docker-compose up -d node-1
+
+consenus_docker_example:
+	mkdir -p ${EXECUTABLE_NODE_DIR}/docker-config
+	cd ${EXECUTABLE_NODE_DIR}/docker-config && rm -rf addresses.txt && touch addresses.txt && echo 172.12.0.10:3054 >> addresses.txt &&  echo 172.12.0.11:3054 >> addresses.txt
+	docker-compose up -d
+
+# Clean commands
+
+clean: clean_docker
+	rm -rf ${EXECUTABLE_NODE_DIR}/node-configs
+	rm -rf ${EXECUTABLE_NODE_DIR}/database
+
+clean_docker:
+	rm -rf ${EXECUTABLE_NODE_DIR}/docker-config
+	docker rm -f consensus-node
+	docker rm -f consensus-node-1
+	docker rm -f consensus-node-2
+	docker network rm -f node-net
+	docker image rm -f consensus-node

compose.yaml

@@ -0,0 +1,28 @@
+version: "3.9"
+
+services:
+  node-1:
+    build: .
+    image: consensus-node
+    container_name: consensus-node-1
+    networks:
+      node_net:
+        # This allow us to know the ip of the node-1 container to fill the address in the config file
+        # Only for test purposes, may be removed in the future
+        ipv4_address: 172.12.0.10
+  node-2:
+    image: consensus-node
+    container_name: consensus-node-2
+    networks:
+      node_net:
+        # This allow us to know the ip of the node-2 container to fill the address in the config file
+        # Only for test purposes, may be removed in the future
+        ipv4_address: 172.12.0.11
+
+networks:
+  node_net:
+    name: node-net
+    ipam:
+      config:
+        - subnet: "172.12.0.0/24"
+          gateway: "172.12.0.1"

entrypoint.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+cd $(hostname -i):3054
+export RUST_LOG=INFO
+../executor

node/tools/README.md

@@ -1,5 +1,27 @@
-# Running a test node
+# Running a test consensus node
+
+## Local
 
 1. Generate a file named `addresses.txt` in the root directory of the tools crate, containing node addresses in the format `IP:PORT`, with each address on a separate line.
-2. Run `make node-configs`. This command will establish a directory named `node-configs` and create a folder for each address listed in the `.txt` file, providing the necessary configuration files for the respective node.
-3. Execute `make run-node IP=<NODE_IP>`. The default value for this command would be `127.0.0.1:3054`. Note that running this command will take control of the terminal.
+2. Run `make node_configs`. This command will establish a directory named `node-configs` and create a folder for each address listed in the `.txt` file, providing the necessary configuration files for the respective node.
+3. Execute `make node IP=<NODE_IP>`. The default value for this command would be `127.0.0.1:3054`. Note that running this command will take control of the terminal.
+
+## Dockerized
+
+To get up a standalone consensus node running in a docker container just run the following command inside the tools crate:
+
+`make node_docker`
+
+This will create a container running a single node advancing views and finalizing blocks.
+
+To set up a simple example with two different nodes communicating with each other in running in different containers run the following command:
+
+`make consenus_docker_example`
+
+This will set up two distinct containers, each hosting a consensus node. These nodes will be interlinked, progressing through views and finalizing blocks achieving consensus between them.
+
+To clean all the state after running these commands use:
+
+`make clean_docker`
+
+> This will delete the generated images and containers, requiring them to be regenerated.