Makefile

SHELL = /bin/bash -o nounset -o pipefail -o errexit
MAKEFLAGS += --no-builtin-rules
.SUFFIXES:

## Argument Variables ##

CPUS = $(shell nproc)
MEMORY = 10000
DISK = 300000
DEVICE =
BACKEND = local
CHANNEL = beta
FLAVOR = aosp
IMAGE = hashbang/aosp-build:latest
IMAGE_OPTIONS =
RUN_OPTIONS =
NAME = aosp-build-$(FLAVOR)-$(BACKEND)
REQUIRED_FREE_SPACE_IN_GIB = 120

-include $(PWD)/config/env/$(BACKEND).env

## Default Target ##

.DEFAULT_GOAL := default
.PHONY: default
default: machine image fetch tools keys build release


## Primary Targets ##

.PHONY: fetch
fetch:
	$(contain) fetch

.PHONY: keys
keys:
	$(contain-keys) keys

.PHONY: review
review:
	$(contain) review

.PHONY: build
build: ensure-enough-free-disk-space
	$(contain) build

.PHONY: release
release:
	$(contain-keys) release

.PHONY: publish
publish:
	$(contain) publish

.PHONY: clean
clean:
	$(contain) clean

.PHONY: mrproper
mrproper: storage-delete machine-delete
	rm -rf build

## Secondary Targets ##

config/container/Dockerfile: config/container/Dockerfile.j2 config/container/render_template
	./config/container/render_template "$<" "{\"tags\":[]}" > "$@"

## Support for different Docker image variants.
config/container/Dockerfile-golang:
config/container/Dockerfile-latest:
config/container/Dockerfile-%: config/container/Dockerfile.j2 config/container/render_template
	./config/container/render_template "$<" "{\"tags\":[\"$*\"]}" > "$@"

.PHONY: image
image: config/container/Dockerfile
	$(docker) build \
		--tag $(IMAGE) \
		--file "$(PWD)/$<" \
		$(IMAGE_OPTIONS) \
		$(PWD)

.PHONY: image-%
image-golang:
image-latest:
image-%: config/container/Dockerfile-%
	$(docker) build \
		--tag $(IMAGE) \
		--file "$(PWD)/$<" \
		$(IMAGE_OPTIONS) \
		$(PWD)

## Note that the `image-latest` target should be used for pinning.
.PHONY: config/container/packages-pinned.list
config/container/packages-pinned.list:
	$(contain-no-tty) pin-packages > "$@"


.PHONY: tools
tools:
	mkdir -p config/keys build/base release build/external
	$(contain) tools

.PHONY: vendor
vendor:
	$(contain) build-vendor

.PHONY: chromium
chromium:
	$(contain) build-chromium

.PHONY: kernel
kernel:
	$(contain) build-kernel


## Development ##

.PHONY: latest
latest: config submodule-latest fetch

.PHONY: config
config:
	$(contain) bash -c "source <(environment) && config"

.PHONY: manifest
manifest:
	$(contain) bash -c "source <(environment) && manifest"

.PHONY: test-repro
test-repro:
	$(contain) test-repro

.PHONY: test
test: test-repro

.PHONY: patches
patches:
	@$(contain) bash -c "cd build/base && repo diff --absolute"

.PHONY: shell
shell:
	$(docker) exec --interactive --tty "$(NAME)" shell \
		|| $(contain) shell

.PHONY: monitor
monitor:
	$(docker) exec --interactive --tty "$(NAME)" htop

.PHONY: install
install: tools
	@scripts/flash


## Source Management ##

.PHONY: submodule-update
submodule-update:
	git submodule update --init --recursive

.PHONY: submodule-latest
submodule-latest:
	git submodule foreach 'git checkout master && git pull'

## Storage Bootstrapping ##

# TODO: detect if plugin is already installed or not
# TODO: Hash lock rexray with sha256 digest to prevent tag clobbering
.PHONY: storage-digitalocean
storage-digitalocean:
	$(docker) volume ls | grep $(NAME) \
	||( $(docker) plugin install \
			--grant-all-permissions \
			rexray/dobs:0.11.4 \
			DOBS_REGION=$(DIGITALOCEAN_REGION) \
			DOBS_TOKEN=$(DIGITALOCEAN_TOKEN) \
		; $(docker) volume create \
			--driver rexray/dobs:0.11.4 \
			--opt=size=$$(( $(DISK) / 1000 )) \
			--name=$(NAME) \
	)

.PHONY: storage-local
storage-local:
	$(docker) volume ls | grep $(NAME) \
	|| $(docker) volume create \
		--driver local \
		--opt type=none \
		--opt o=bind \
		--opt device=$(PWD)/build \
		$(NAME)

.PHONY: storage-delete
storage-delete:
	$(docker) volume rm -f $(NAME) || :


## VM Management ##

.PHONY: machine-start
machine-start: machine-create machine-date
	$(docker_machine) status $(NAME) \
	|| $(docker_machine) start $(NAME)

.PHONY: machine-sync
machine-sync:
	$(docker_machine) scp -r -d config/ $(NAME):$(PWD)/config/

.PHONY: machine-shell
machine-shell:
	$(docker_machine) ssh $(NAME)

.PHONY: machine-stop
machine-stop:
	$(docker_machine) stop $(NAME)

.PHONY: machine-delete
machine-delete:
	$(docker_machine) rm -f -y $(NAME)

.PHONY: machine-date
machine-date:
	$(docker_machine) ssh $(NAME) \
		"sudo date -s @$(shell date +%s)"

.PHONY: machine-create
machine-create:
	$(docker_machine) status $(NAME) \
	||( $(docker_machine) create \
			--driver $(BACKEND) \
			$(docker_machine_create_flags) \
			$(NAME) \
	)

## VM Bootstrapping ##

ifeq ($(BACKEND),local)

executables = docker
docker = docker
machine:
storage_flags = --volume $(PWD)/build/:/home/build/build/

else ifeq ($(BACKEND),virtualbox)

executables = docker-machine ssh virtualbox
docker = $(docker_machine) ssh $(NAME) -t docker
machine: machine-start storage-local
storage_flags = --volume $(NAME):/home/build/build/
docker_machine_create_flags = \
	--virtualbox-share-folder="$(PWD):$(PWD)" \
	--virtualbox-disk-size="$(DISK)" \
	--virtualbox-memory="$(MEMORY)" \
	--virtualbox-cpu-count="$(CPUS)"

else ifeq ($(BACKEND),digitalocean)

executables = docker-machine ssh
docker = $(docker_machine) ssh $(NAME) -t docker
machine: machine-start storage-digitalocean machine-sync
storage_flags = --volume $(NAME):/home/build/build/
docker_machine_create_flags = \
	--digitalocean-access-token=$(DIGITALOCEAN_TOKEN) \
	--digitalocean-region=$(DIGITALOCEAN_REGION) \
	--digitalocean-image=$(DIGITALOCEAN_IMAGE) \
	--digitalocean-size=$(DIGITALOCEAN_SIZE)

endif

userid = $(shell id -u)
groupid = $(shell id -g)
docker_machine = docker-machine --storage-path "${PWD}/build/machine"

# Can be used mount aosp-build directory to /opt/aosp-build to allow fast
# development without the need to rebuild the container image all the time.
# See HashbangMobile for example.
contain-base-extend =

contain-base = \
	$(docker) run \
		--rm \
		--interactive \
		--name "$(NAME)" \
		--hostname "$(NAME)" \
		--user $(userid):$(groupid) \
		--env DEVICE=$(DEVICE) \
		--privileged \
		--security-opt seccomp=unconfined \
		--volume $(PWD)/config:/home/build/config \
		--volume $(PWD)/release:/home/build/release \
		--volume $(PWD)/scripts:/home/build/scripts \
		$(contain-base-extend) \
		$(RUN_OPTIONS) \
		--shm-size="1g" \
		$(storage_flags)

contain-no-tty = \
	$(contain-base) \
		$(IMAGE)

contain-keys = \
	$(contain-base) \
		--tty \
		--volume $(PWD)/keys:/home/build/keys \
		$(IMAGE)

contain = \
	$(contain-base) \
		--tty \
		$(IMAGE)

## Helpers ##

ensure-git-status-clean:
	@if [ -z "$(shell git status --porcelain=v2)" ]; then \
		echo "git status has no output. Working tree is clean."; \
	else \
		git status; \
		echo "Working tree is not clean as required. Exiting."; \
		exit 1; \
	fi

ensure-enough-free-disk-space:
	@free_space=$(shell df -k --output=avail "$$PWD" | tail -n1); \
	needed_free_space=$$(( $(REQUIRED_FREE_SPACE_IN_GIB) * 1024 * 1024 )); \
	if [[ $$free_space -lt $$needed_free_space ]]; then \
		echo "Not enought free space. $(REQUIRED_FREE_SPACE_IN_GIB) GiB are required." 1>&2; \
		exit 1; \
	fi

## Required Binary Check ##

check_executables := $(foreach exec,$(executables),\$(if \
	$(shell which $(exec)),some string,$(error "No $(exec) in PATH")))