Makefile

# This is a Makefile that implements helpers for the docker stack
#

CONTAINER_NAME=api
TESTCASE=

UID := $(shell id -u)
#GID := $(shell id -g)

.PHONY: cli bash docker-up .start-containers docker-down lint test wait-for-mysql help
.DEFAULT_GOAL := help

help: # https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
	@echo "make implements common cli tasks"
	@echo ""
	@echo "Learn more about make at https://www.gnu.org/software/make/manual/make.html"
	@echo ""
	@echo "The following commands are available:"
	@echo ""
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "make \033[36m%-20s\033[0m %s\n", $$1, $$2}'

# Run a bash in a Docker container as your local user,
# so files are created owned by that user instead of root.
#
# For this to work, the user inside the container must have the same ID as the user outside.
# The name does not matter much but to avoid confusion it is helpful to make them have the same user name.
# You get a users ID by running the `id -u` command, and the users name is `whoami`.
cli: bash
bash: ## Run a bash in a Docker container as your local user,
	@echo "\nYou are now in the \033[1m$(CONTAINER_NAME)\033[0m container.\n"
	@docker-compose exec --user=$(UID) $(CONTAINER_NAME) php -v && echo ""
	@docker-compose exec --user=$(UID) $(CONTAINER_NAME) bash

# 1. Start Docker containers
# 2. Create a user with the same name and ID inside the docker conterainer if it does not exists.
#    The user is also added to the www-data group to work well with files created by the webserver.
#    The users home directory is /app/api/runtime/docker-home so bash history files are stored in the docker/home directory in this repo.
docker-up: .start-containers vendor/autoload.php api/web/index.php ## Start Docker containers and prepare Docker environment, auto-rebulids containers when Dockerfile changes
.start-containers: docker-compose.override.yml api/runtime/docker-build
	docker-compose up -d
	mkdir -p api/runtime/docker-home
	docker-compose exec -T $(CONTAINER_NAME) bash -c "grep '^$(shell whoami):' /etc/passwd || useradd '$(shell whoami)' --uid=$(UID) -G www-data -s /bin/bash -d /app/api/runtime/docker-home"
	docker-compose exec -T $(CONTAINER_NAME) bash -c "test -f /app/api/runtime/docker-home/.bashrc || (cp /etc/skel/.bashrc /app/api/runtime/docker-home/.bashrc && sed -i 's/#force_color_prompt=yes/force_color_prompt=yes/' /app/api/runtime/docker-home/.bashrc)"

# auto rebuild docker containers when Dockerfile changes
# will change timestamp of runtime/docker-build to only run this when docker files change
api/runtime/docker-build: $(shell find */Dockerfile)
	docker-compose build
	touch $@

# Stop Docker containers
docker-down: ## Stop Docker containers
	docker-compose down --remove-orphans

# Run composer install if vendor/autoload.php does not exist or is outdated (older than composer.json)
vendor/autoload.php: composer.json
	@docker-compose exec -T --user=$(UID) $(CONTAINER_NAME) composer install
	touch $@

# create docker-compose.override.yml if it does not exist
docker-compose.override.yml: docker-compose.override.dist.yml
	test -f $@ || cp $< $@

# run php init on first start
api/web/index.php: environments/dev/api/web/index.php
	test -f $@ || docker-compose exec -T --user=$(UID) $(CONTAINER_NAME) php init --env=Development --overwrite=n


test: tests/_data/dump.sql ## Run codeception tests, run a specific test by setting the TESTCASE variable: make test TESTCASE="acceptance tests/acceptance/NotSignedInCest.php"
	docker-compose exec -T --user=$(UID) $(CONTAINER_NAME) vendor/bin/codecept run $(TESTCASE)

# generate database dump for test env
TEST_DB := shipwise_test
tests/_data/dump.sql: tests/_data/shipwise_dump.sql $(shell find console/migrations -type f) wait-for-mysql
	docker-compose exec -T --user=$(UID) $(CONTAINER_NAME) sh -c 'echo "DROP DATABASE IF EXISTS \`$(TEST_DB)\`; CREATE DATABASE \`$(TEST_DB)\` CHARSET utf8mb4; GRANT ALL ON \`$(TEST_DB)\`.* TO \"app\"@\"%\"; " | mysql -h mysql -uroot -p123'
	docker-compose exec -T --user=$(UID) $(CONTAINER_NAME) sh -c 'cat $< | mysql -h mysql -uapp -p123 $(TEST_DB)'
	docker-compose exec -T --user=$(UID) $(CONTAINER_NAME) sh -c 'YII_ENV=test ./yii_test migrate/up --interactive=0'
	docker-compose exec -T --user=$(UID) $(CONTAINER_NAME) sh -c 'mysqldump -h mysql -uroot -p123 $(TEST_DB) > $@'

wait-for-mysql:
	@echo "Waiting for mysql to start up..."
	docker-compose exec -T --user=$(UID) $(CONTAINER_NAME) timeout 30s sh -c "while ! (mysql -h mysql -uapp -p123 --execute 'SELECT 1;' > /dev/null 2>&1); do echo -n '.'; sleep 0.1 ; done; echo 'ok'" || (docker-compose ps; docker-compose logs mysql; exit 1)

lint: ## Validate composer.{json|lock}
	docker-compose exec -T --user=$(UID) $(CONTAINER_NAME) composer validate --strict