Makefile

.PHONY: all env docker-env venv install install-dev nopyc clean build-dev build-migrations migrate-dev test run-devserver build-docker run-docker stop-docker restart-docker smoke-test-docker publish start-frontend stop-frontend test-with-frontend

SHELL := /usr/bin/env bash
PYTHON_BIN := python
PLATFORM_VENV ?= venv
TAG_VERSION ?= latest
PLATFORM ?= arm64
ENVIRONMENT ?= prod

FRONTEND_IMAGE ?= public.ecr.aws/heliumedu/helium/frontend-web:$(PLATFORM)-latest

all: build-docker run-docker

env:
	cp -n .env.example .env | true

docker-env:
	@if [ ! -f ".env" ]; then \
		cp -n .env.docker.example .env | true; \
		echo "--> Adding local S3 'storage' hostname to /etc/hosts"; \
		sudo sh -c "grep -qxF '127.0.0.1 storage' /etc/hosts || echo '127.0.0.1 storage' >> /etc/hosts"; \
	fi

venv:
	$(PYTHON_BIN) -m pip install virtualenv
	$(PYTHON_BIN) -m virtualenv $(PLATFORM_VENV)

install: venv
	@( \
		source $(PLATFORM_VENV)/bin/activate; \
		python -m pip install -r requirements.txt -r requirements-deploy.txt; \
	)

install-dev: env venv
	@( \
		source $(PLATFORM_VENV)/bin/activate; \
		python -m pip install -r requirements.txt -r requirements-dev.txt; \
	)

nopyc:
	find . -name '*.pyc' | xargs rm -f || true
	find . -name __pycache__ | xargs rm -rf || true

clean: nopyc
	rm -rf build $(PLATFORM_VENV)

build-dev: install-dev
	@( \
		source $(PLATFORM_VENV)/bin/activate; \
		ENVIRONMENT=local python manage.py collectstatic --noinput; \
	)

build-migrations: install-dev
	@( \
		source $(PLATFORM_VENV)/bin/activate; \
		ENVIRONMENT=local python manage.py makemigrations; \
	)

migrate-dev: install-dev
	@( \
		source $(PLATFORM_VENV)/bin/activate; \
		ENVIRONMENT=local python manage.py migrate; \
	)

test: install-dev
	@( \
		source $(PLATFORM_VENV)/bin/activate; \
		coverage run -m pytest && coverage report && coverage html && coverage xml; \
	)

create-superuser: migrate-dev
	@( \
		source $(PLATFORM_VENV)/bin/activate; \
		ENVIRONMENT=local python manage.py createsuperuser; \
	)

run-devserver: build-dev migrate-dev
	# This will start a local dev server, outside of Docker. This can be useful during active development, so images
	# don't need to be rebuilt to validate each change.
	@( \
		source $(PLATFORM_VENV)/bin/activate; \
		ENVIRONMENT=local python manage.py runserver; \
	)

start-frontend:
	@if curl -s http://localhost:8080 > /dev/null 2>&1; then \
		echo "Frontend already running"; \
	else \
		curl -fsSL "https://raw.githubusercontent.com/HeliumEdu/frontend/main/bin/start-frontend.sh?$$(date +%s)" | \
			FRONTEND_IMAGE=$(FRONTEND_IMAGE) PLATFORM=$(PLATFORM) bash; \
	fi

stop-frontend:
	@curl -fsSL "https://raw.githubusercontent.com/HeliumEdu/frontend/main/bin/stop-frontend.sh?$$(date +%s)" | bash

test-with-frontend: run-docker start-frontend
	@echo "Platform and frontend are running"
	@echo "  Platform API: http://localhost:8000"
	@echo "  Frontend:     http://localhost:8080"
	@echo ""
	@echo "Run your tests, then use 'make stop-docker stop-frontend' to clean up"

build-docker:
	docker buildx build --build-arg ENVIRONMENT=$(ENVIRONMENT) --target platform_resource -t helium/platform-resource:$(PLATFORM)-latest -t helium/platform-resource:$(PLATFORM)-$(TAG_VERSION) --platform=linux/$(PLATFORM) --load .

	docker buildx build --build-arg ENVIRONMENT=$(ENVIRONMENT) --target platform_api -t helium/platform-api:$(PLATFORM)-latest -t helium/platform-api:$(PLATFORM)-$(TAG_VERSION) --platform=linux/$(PLATFORM) --load .

	docker buildx build --build-arg ENVIRONMENT=$(ENVIRONMENT) --target platform_worker -t helium/platform-worker:$(PLATFORM)-latest -t helium/platform-worker:$(PLATFORM)-$(TAG_VERSION) --platform=linux/$(PLATFORM) --load .

run-docker: docker-env
	@if curl -s http://localhost:8000/status/ > /dev/null 2>&1; then \
		echo "Platform already running"; \
	else \
		if [[ -n "$$PLATFORM_RESOURCE_IMAGE" || -n "$$PLATFORM_API_IMAGE" || -n "$$PLATFORM_WORKER_IMAGE" ]]; then \
			aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws/heliumedu; \
		fi; \
		if [ -n "$$PLATFORM_RESOURCE_IMAGE" ]; then \
			docker pull $$PLATFORM_RESOURCE_IMAGE; \
		fi; \
		if [ -n "$$PLATFORM_API_IMAGE" ]; then \
			docker pull $$PLATFORM_API_IMAGE; \
		fi; \
		if [ -n "$$PLATFORM_WORKER_IMAGE" ]; then \
			docker pull $$PLATFORM_WORKER_IMAGE; \
		fi; \
		if [ -n "$$DOCKERHUB_TOKEN" ]; then \
			echo "$$DOCKERHUB_TOKEN" | docker login --username "$$DOCKER_USERNAME" --password-stdin; \
		fi; \
		docker compose up -d; \
	fi

stop-docker: docker-env
	docker compose stop

restart-docker: stop-docker run-docker

smoke-test-docker:
	@echo "Starting platform for smoke test ..."
	@docker compose up -d
	@echo "Waiting for platform API to be ready ..."
	@for i in $$(seq 1 60); do \
		if curl -sf http://localhost:8000/status/ > /dev/null 2>&1; then \
			echo "Smoke test passed: /status/ returned 200"; \
			docker compose stop; \
			exit 0; \
		fi; \
		sleep 2; \
	done; \
	echo "Smoke test failed: /status/ did not return 200 within 120s"; \
	docker compose logs api; \
	docker compose stop; \
	exit 1

publish: build-docker
	aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws/heliumedu

	docker tag helium/platform-resource:$(PLATFORM)-$(TAG_VERSION) public.ecr.aws/heliumedu/helium/platform-resource:$(PLATFORM)-$(TAG_VERSION)
	docker push public.ecr.aws/heliumedu/helium/platform-resource:$(PLATFORM)-$(TAG_VERSION)

	docker tag helium/platform-api:$(PLATFORM)-$(TAG_VERSION) public.ecr.aws/heliumedu/helium/platform-api:$(PLATFORM)-$(TAG_VERSION)
	docker push public.ecr.aws/heliumedu/helium/platform-api:$(PLATFORM)-$(TAG_VERSION)

	docker tag helium/platform-worker:$(PLATFORM)-$(TAG_VERSION) public.ecr.aws/heliumedu/helium/platform-worker:$(PLATFORM)-$(TAG_VERSION)
	docker push public.ecr.aws/heliumedu/helium/platform-worker:$(PLATFORM)-$(TAG_VERSION)