Makefile

CONCORD_BFT_DOCKER_REPO:=concordbft/
CONCORD_BFT_DOCKER_IMAGE:=concord-bft
CONCORD_BFT_DOCKER_IMAGE_VERSION:=0.7
CONCORD_BFT_DOCKER_CONTAINER:=concord-bft

CONCORD_BFT_DOCKERFILE:=Dockerfile
CONCORD_BFT_BUILD_DIR:=build
CONCORD_BFT_TARGET_SOURCE_PATH:=/concord-bft
CONCORD_BFT_CONTAINER_SHELL:=/bin/bash
CONCORD_BFT_CONTAINER_CC:=clang
CONCORD_BFT_CONTAINER_CXX:=clang++
CONCORD_BFT_CMAKE_FLAGS:= \
			-DCMAKE_BUILD_TYPE=Debug \
			-DBUILD_TESTING=ON \
			-DBUILD_COMM_TCP_PLAIN=FALSE \
			-DBUILD_COMM_TCP_TLS=FALSE \
			-DCMAKE_CXX_FLAGS_RELEASE=-O3 -g \
			-DUSE_LOG4CPP=TRUE \
			-DBUILD_ROCKSDB_STORAGE=TRUE \
			-DUSE_S3_OBJECT_STORE=TRUE \
			-DUSE_OPENTRACING=ON \
			-DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
			-DOMIT_TEST_OUTPUT=OFF \
			-DKEEP_APOLLO_LOGS=TRUE

# The consistency parameter makes sense only at MacOS.
# It is ignored at all other platforms.
CONCORD_BFT_CONTAINER_MOUNT_CONSISTENCY=,consistency=cached
CONCORD_BFT_CTEST_TIMEOUT:=3000 # Default value is 1500 sec. It takes 2500 to run all the tests at my dev station
CONCORD_BFT_USER_GROUP:=--user `id -u`:`id -g`

CONCORD_BFT_ADDITIONAL_RUN_PARAMS:=
CONCORD_BFT_ADDITIONAL_RUN_COMMANDS:=

.DEFAULT_GOAL:=build

# MakefileCustom may be useful for overriding the default variables
# or adding custom targets. The include directive is ignored if MakefileCustom file does not exist.
-include MakefileCustom

IF_CONTAINER_RUNS=$(shell docker container inspect -f '{{.State.Running}}' ${CONCORD_BFT_DOCKER_CONTAINER})

.PHONY: help
help: ## The Makefile helps to build Concord-BFT in a docker container
	@cat $(MAKEFILE_LIST) | grep -E '^[a-zA-Z_-]+:.*?## .*$$' | \
		awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

	# Basic HOW-TO:
	# make                    # Build Concord-BFT sources
	# make test               # Run tests
	# make remove-c           # Remove existing container
	# make build-docker-image # Build docker image locally

.PHONY: pull
pull: ## Pull image from remote
	docker pull ${CONCORD_BFT_DOCKER_REPO}${CONCORD_BFT_DOCKER_IMAGE}:${CONCORD_BFT_DOCKER_IMAGE_VERSION}

.PHONY: run-c
run-c: ## Run container in background
	docker run -d --rm --privileged=true \
			  --cap-add NET_ADMIN --cap-add=SYS_PTRACE --ulimit core=-1 \
			  --name="${CONCORD_BFT_DOCKER_CONTAINER}" \
			  --workdir=${CONCORD_BFT_TARGET_SOURCE_PATH} \
			  --mount type=bind,source=${CURDIR},target=/cores \
			  --mount type=bind,source=${CURDIR},target=${CONCORD_BFT_TARGET_SOURCE_PATH}${CONCORD_BFT_CONTAINER_MOUNT_CONSISTENCY} \
			  ${CONCORD_BFT_ADDITIONAL_RUN_PARAMS} \
			  ${CONCORD_BFT_DOCKER_REPO}${CONCORD_BFT_DOCKER_IMAGE}:${CONCORD_BFT_DOCKER_IMAGE_VERSION} \
			  ${CONCORD_BFT_CONTAINER_SHELL} -c \
			  "${CONCORD_BFT_ADDITIONAL_RUN_COMMANDS} \
			  /usr/bin/tail -f /dev/null"
	@echo
	@echo "The container \"${CONCORD_BFT_DOCKER_CONTAINER}\" with the build environment is started as daemon."
	@echo "Run \"make stop-c\" to stop or \"make remove-c\" to delete."

.PHONY: login
login: ## Login to the container
	@if [ "${IF_CONTAINER_RUNS}" != "true" ]; then \
		make run-c; \
	fi
	docker exec -it ${CONCORD_BFT_DOCKER_CONTAINER} \
		${CONCORD_BFT_CONTAINER_SHELL};exit 0

.PHONY: stop-c
stop-c: ## Stop the container
	docker container stop ${CONCORD_BFT_DOCKER_CONTAINER}
	@echo
	@echo "The container \"${CONCORD_BFT_DOCKER_CONTAINER}\" is successfully stopped."

.PHONY: remove-c
remove-c: ## Remove the container
	docker container rm -f ${CONCORD_BFT_DOCKER_CONTAINER}
	@echo
	@echo "The container \"${CONCORD_BFT_DOCKER_CONTAINER}\" is successfully removed."

.PHONY: build
build: ## Build Concord-BFT source. Note: this command is mostly for developers
	@if [ "${IF_CONTAINER_RUNS}" != "true" ]; then \
		make run-c; \
	fi
	docker exec -it ${CONCORD_BFT_USER_GROUP} ${CONCORD_BFT_DOCKER_CONTAINER} \
		${CONCORD_BFT_CONTAINER_SHELL} -c \
		"mkdir -p ${CONCORD_BFT_TARGET_SOURCE_PATH}/${CONCORD_BFT_BUILD_DIR} && \
		cd ${CONCORD_BFT_BUILD_DIR} && \
		CC=${CONCORD_BFT_CONTAINER_CC} CXX=${CONCORD_BFT_CONTAINER_CXX} \
		cmake ${CONCORD_BFT_CMAKE_FLAGS} .. && \
		make format-check && \
		make -j $$(nproc)"
	@echo
	@echo "Build finished. The binaries are in ${CURDIR}/${CONCORD_BFT_BUILD_DIR}"

.PHONY: format
format: ## Format Concord-BFT source
	@if [ "${IF_CONTAINER_RUNS}" != "true" ]; then \
		make run-c; \
	fi
	docker exec -it ${CONCORD_BFT_USER_GROUP} ${CONCORD_BFT_DOCKER_CONTAINER} \
		${CONCORD_BFT_CONTAINER_SHELL} -c \
		"mkdir -p ${CONCORD_BFT_TARGET_SOURCE_PATH}/${CONCORD_BFT_BUILD_DIR} && \
		cd ${CONCORD_BFT_BUILD_DIR} && \
		CC=${CONCORD_BFT_CONTAINER_CC} CXX=${CONCORD_BFT_CONTAINER_CXX} \
		cmake ${CONCORD_BFT_CMAKE_FLAGS} .. && \
		make format"
	@echo
	@echo "Format finished."

.PHONY: tidy-check
tidy-check: ## Runs clang-tidy
	@if [ "${IF_CONTAINER_RUNS}" != "true" ]; then \
		make run-c; \
	fi
	docker exec -it ${CONCORD_BFT_USER_GROUP} ${CONCORD_BFT_DOCKER_CONTAINER} \
		${CONCORD_BFT_CONTAINER_SHELL} -c \
		"mkdir -p ${CONCORD_BFT_TARGET_SOURCE_PATH}/${CONCORD_BFT_BUILD_DIR} && \
		cd ${CONCORD_BFT_BUILD_DIR} && \
		CC=${CONCORD_BFT_CONTAINER_CC} CXX=${CONCORD_BFT_CONTAINER_CXX} \
		cmake ${CONCORD_BFT_CMAKE_FLAGS} .. && \
		run-clang-tidy-10 &> clang-tidy-report.txt && \
		../scripts/check-forbidden-usage.sh .." \
		&& (echo "\nClang-tidy finished successfully.") \
		|| ( echo "\nClang-tidy failed. The report is in ${CURDIR}/${CONCORD_BFT_BUILD_DIR}/clang-tidy-report.txt. \
			 \nFor detail information about the checks, please refer to https://clang.llvm.org/extra/clang-tidy/checks/list.html" \
			 ; exit 1)

.PHONY: test
test: ## Run all tests
	@if [ "${IF_CONTAINER_RUNS}" != "true" ]; then \
		make run-c; \
	fi
	docker exec -it ${CONCORD_BFT_DOCKER_CONTAINER} \
		${CONCORD_BFT_CONTAINER_SHELL} -c \
		"cd ${CONCORD_BFT_BUILD_DIR} && \
		ctest --timeout ${CONCORD_BFT_CTEST_TIMEOUT} --output-on-failure"

.PHONY: single-test
single-test: ## Run single test `make single-test TEST_NAME=<test name>`
	@if [ "${IF_CONTAINER_RUNS}" != "true" ]; then \
		make run-c; \
	fi
	docker exec -it ${CONCORD_BFT_DOCKER_CONTAINER} \
		${CONCORD_BFT_CONTAINER_SHELL} -c \
		"cd ${CONCORD_BFT_BUILD_DIR} && \
		ctest -R ${TEST_NAME} --timeout ${CONCORD_BFT_CTEST_TIMEOUT} --output-on-failure"

.PHONY: clean
clean: ## Clean Concord-BFT build directory
	@if [ "${IF_CONTAINER_RUNS}" != "true" ]; then \
		make run-c; \
	fi
	docker exec -it ${CONCORD_BFT_DOCKER_CONTAINER} \
		${CONCORD_BFT_CONTAINER_SHELL} -c \
		"rm -rf ${CONCORD_BFT_BUILD_DIR}"

.PHONY: build-docker-image
build-docker-image: ## Re-build the container without caching
	docker build --rm --no-cache=true -t ${CONCORD_BFT_DOCKER_IMAGE}:latest \
		-f ./${CONCORD_BFT_DOCKERFILE} .
	@echo
	@echo "Build finished. Docker image name: \"${CONCORD_BFT_DOCKER_IMAGE}:latest\"."
	@echo "Before you push it to Docker Hub, please tag it(CONCORD_BFT_DOCKER_IMAGE_VERSION + 1)."
	@echo "If you want the image to be the default, please update the following variables:"
	@echo "${CURDIR}/Makefile: CONCORD_BFT_DOCKER_IMAGE_VERSION"