Makefile

.PHONY: build pull pack-benchmark pack-package test-package

# ================================================================================================
# Settings
# ================================================================================================

ifeq (, $(shell which nvidia-smi))
CPU_OR_GPU ?= cpu
else
CPU_OR_GPU ?= gpu
endif

ifeq (${CPU_OR_GPU}, gpu)
GPU_ARGS = --gpus all
endif

SKIP_GPU ?= false
ifeq (${SKIP_GPU}, true)
GPU_ARGS =
endif

TAG = ${CPU_OR_GPU}-latest
LOCAL_TAG = ${CPU_OR_GPU}-local

REPO = petsprize-competition
REGISTRY_IMAGE = petsprize.azurecr.io/${REPO}:${TAG}
LOCAL_IMAGE = ${REPO}:${LOCAL_TAG}
CONTAINER_NAME = petsprize

# if not TTY (for example GithubActions CI) no interactive tty commands for docker
ifneq (true, ${GITHUB_ACTIONS_NO_TTY})
TTY_ARGS = -it
endif

# option to block or allow internet access from the package Docker container
ifeq (true, ${BLOCK_INTERNET})
NETWORK_ARGS = --network none
endif

# To run a package, use local version if that exists; otherwise, use official version
# setting PACKAGE_IMAGE as an environment variable will override the image
PACKAGE_IMAGE ?= $(shell docker images -q ${LOCAL_IMAGE})
ifeq (,${PACKAGE_IMAGE})
PACKAGE_IMAGE := $(shell docker images -q ${REGISTRY_IMAGE})
endif

# Give write access to the package folder to everyone so Docker user can write when mounted
_package_write_perms:
	mkdir -p package/
	chmod -R 0777 package/

# ================================================================================================
# Commands for building the container if you are changing the requirements
# ================================================================================================

## Builds the container locally
build:
	docker build --build-arg CPU_OR_GPU=${CPU_OR_GPU} -t ${LOCAL_IMAGE} runtime

## Ensures that your locally built container can import all the Python packages successfully when it runs
test-container: build _package_write_perms
	docker run \
		${TTY_ARGS} \
		--mount type=bind,source="$(shell pwd)"/runtime/tests,target=/tests,readonly \
		--entrypoint /bin/bash \
		${LOCAL_IMAGE} \
		-c "conda run --no-capture-output -n condaenv python -m pytest tests"

## Start your locally built container and open a bash shell within the running container; same as package setup except has network access
interact-container: build _package_write_perms
ifeq (${PACKAGE_TRACK},)
	$(error Specify the PACKAGE_TRACK=fincrime or pandemic)
endif
	docker run \
		${GPU_ARGS} \
		--mount type=bind,source="$(shell pwd)"/data/${PACKAGE_TRACK},target=/code_execution/data,readonly \
		--mount type=bind,source="$(shell pwd)"/package,target=/code_execution/package \
		--shm-size 8g \
		-it \
		--entrypoint /bin/bash \
		${LOCAL_IMAGE}

## Pulls the official container from Azure Container Registry
pull:
	docker pull ${REGISTRY_IMAGE}

## Creates a package/package.zip file from the source code in examples_src
pack-example:
# Don't overwrite so no work is lost accidentally
ifeq (${PACKAGE_TRACK},)
	$(error Specify the PACKAGE_TRACK=fincrime or pandemic)
endif
ifneq (,$(wildcard ./package/package.zip))
	$(error You already have a package/package.zip file. Rename or remove that file (e.g., rm package/package.zip).)
endif
	mkdir -p package/
	cd examples_src/${PACKAGE_TRACK}; zip -r ../../package/package.zip ./*

## Creates a package/package.zip file from the source code in package_src
pack-package:
ifeq (${PACKAGE_TRACK},)
	$(error Specify the PACKAGE_TRACK=fincrime or pandemic)
endif
# Don't overwrite so no work is lost accidentally
ifneq (,$(wildcard ./package/package.zip))
	$(error You already have a package/package.zip file. Rename or remove that file (e.g., rm package/package.zip).)
endif
	mkdir -p package/
	cd package_src/${PACKAGE_TRACK}; zip -r ../../package/package.zip ./*


## Runs container using code from `package/package.zip` and data from `data/`
test-package: _package_write_perms
# if package file does not exist
ifeq (,$(wildcard ./package/package.zip))
	$(error To test your package, you must first put a "package.zip" file in the "package" folder. \
	  If you want to use the benchmark, you can run `make pack-benchmark` first)
endif
# if container does not exist, error and tell user to pull or build
ifeq (${PACKAGE_IMAGE},)
	$(error To test your package, you must first run `make pull` (to get official container) or `make build` \
		(to build a local version if you have changes).)
endif
ifeq (${PACKAGE_TYPE},)
	$(error Specify the PACKAGE_TYPE=centralized or federated)
endif
ifeq (${PACKAGE_TRACK},)
	$(error Specify the PACKAGE_TRACK=fincrime or pandemic)
endif
	docker run \
		${TTY_ARGS} \
		${GPU_ARGS} \
		${NETWORK_ARGS} \
		--env PACKAGE_TRACK=${PACKAGE_TRACK} \
		--network none \
		--mount type=bind,source="$(shell pwd)"/data/${PACKAGE_TRACK},target=/code_execution/data,readonly \
		--mount type=bind,source="$(shell pwd)"/package,target=/code_execution/package \
		--shm-size 8g \
		--name ${CONTAINER_NAME} \
		--rm \
		${PACKAGE_IMAGE} \
		${PACKAGE_TYPE}

## Delete temporary Python cache and bytecode files
clean:
	find . -type f -name "*.py[co]" -delete
	find . -type d -name "__pycache__" -delete
	rm -rf package

#################################################################################
# Self Documenting Commands                                                     #
#################################################################################

.DEFAULT_GOAL := help

# Inspired by <http://marmelab.com/blog/2016/02/29/auto-documented-makefile.html>
# sed script explained:
# /^##/:
# 	* save line in hold space
# 	* purge line
# 	* Loop:
# 		* append newline + line to hold space
# 		* go to next line
# 		* if line starts with doc comment, strip comment character off and loop
# 	* remove target prerequisites
# 	* append hold space (+ newline) to line
# 	* replace newline plus comments by `---`
# 	* print line
# Separate expressions are necessary because labels cannot be delimited by
# semicolon; see <http://stackoverflow.com/a/11799865/1968>
.PHONY: help
help:
	@echo
	@echo "$$(tput bold)Settings based on your machine:$$(tput sgr0)"
	@echo PACKAGE_IMAGE=${PACKAGE_IMAGE}  "\t# ID of the image that will be used when running test-package"
	@echo
	@echo "$$(tput bold)Available competition images:$$(tput sgr0)"
	@echo "$(shell docker images --format '{{.Repository}}:{{.Tag}} ({{.ID}}); ' ${REPO})"
	@echo
	@echo "$$(tput bold)Available commands:$$(tput sgr0)"
	@echo
	@sed -n -e "/^## / { \
		h; \
		s/.*//; \
		:doc" \
		-e "H; \
		n; \
		s/^## //; \
		t doc" \
		-e "s/:.*//; \
		G; \
		s/\\n## /---/; \
		s/\\n/ /g; \
		p; \
	}" ${MAKEFILE_LIST} \
	| LC_ALL='C' sort --ignore-case \
	| awk -F '---' \
		-v ncol=$$(tput cols) \
		-v indent=19 \
		-v col_on="$$(tput setaf 6)" \
		-v col_off="$$(tput sgr0)" \
	'{ \
		printf "%s%*s%s ", col_on, -indent, $$1, col_off; \
		n = split($$2, words, " "); \
		line_length = ncol - indent; \
		for (i = 1; i <= n; i++) { \
			line_length -= length(words[i]) + 1; \
			if (line_length <= 0) { \
				line_length = ncol - indent - length(words[i]) - 1; \
				printf "\n%*s ", -indent, " "; \
			} \
			printf "%s ", words[i]; \
		} \
		printf "\n"; \
	}' \
	| more $(shell test $(shell uname) = Darwin && echo '--no-init --raw-control-chars')