Makefile

PYTHON_VERSION=3.11

REQUIREMENTS_PATH=lambdas/requirements
LAMBDA_LAYER_REQUIREMENTS_PATH=$(REQUIREMENTS_PATH)/layers

GITHUB_REQUIREMENTS=$(REQUIREMENTS_PATH)/requirements_github_runner.txt
TEST_REQUIREMENTS=$(REQUIREMENTS_PATH)/requirements_test.txt
CORE_REQUIREMENTS=$(LAMBDA_LAYER_REQUIREMENTS_PATH)/requirements_core_lambda_layer.txt
DATA_REQUIREMENTS=$(LAMBDA_LAYER_REQUIREMENTS_PATH)/requirements_data_lambda_layer.txt
FILES_REQUIREMENTS=$(LAMBDA_LAYER_REQUIREMENTS_PATH)/requirements_files_lambda_layer.txt
REPORTS_REQUIREMENTS=$(LAMBDA_LAYER_REQUIREMENTS_PATH)/requirements_reports_lambda_layer.txt
ALERTING_REQUIREMENTS=$(LAMBDA_LAYER_REQUIREMENTS_PATH)/requirements_alerting_lambda_layer.txt
EDGE_REQUIREMENTS=$(REQUIREMENTS_PATH)/requirements_edge_lambda.txt
LAMBDAS_BUILD_PATH=build/lambdas
LAMBDA_LAYERS_BUILD_PATH=build/lambda_layers
LAMBDA_LAYER_PYTHON_PATH=python/lib/python$(PYTHON_VERSION)/site-packages

ZIP_BASE_PATH = ./$(LAMBDAS_BUILD_PATH)/$(lambda_name)/tmp
ZIP_COMMON_FILES = lambdas/utils lambdas/models lambdas/services lambdas/repositories lambdas/enums lambdas/scripts
CONTAINER ?= false
VENV_PATH_PREFIX := $(if $(filter true,$(CONTAINER)),./.venv,./lambdas/venv)
FORMAT_ALL ?= false
CHECK ?= false

.PHONY: \
	install clean help format list requirements ruff build-and-deploy-sandbox \
	aws-login download-api-certs \
	test-lg-fhir-api-e2e test-core-fhir-api-e2e test-apim-e2e test-lg-fhir-api-e2e-snapshots \
	initiate-bulk-upload test-bulk-upload-e2e test-bulk-upload-e2e-snapshots \
	test-unit test-unit-coverage test-unit-coverage-html test-unit-collect \
	env github_env edge_env \
	package edge_zip lambda_layer_zip zip \
	install-asdf install-poetry install-dev \
	start test-ui test-ui-coverage build build-env-check \
	docker-up docker-up-rebuild docker-down \
	cypress-open cypress-run cypress-report install-cypress

default: help

help: ## Show available targets and usage.
	@echo ""
	@echo "Available commands (documented):"
	@echo "--------------------------------"
	@grep -E --no-filename '^[a-zA-Z0-9_.-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
		sort | \
		awk 'BEGIN {FS = ":.*?## "}; { \
			desc = $$2; \
			if (index(desc, "Usage:") > 0) { \
				split(desc, parts, "Usage:"); \
				printf "\033[36m%-30s\033[0m\n    %s\n    \033[1mUsage:\033[0m%s\n\n", $$1, parts[1], parts[2]; \
			} else { \
				printf "\033[36m%-30s\033[0m\n    %s\n\n", $$1, desc; \
			} \
		}'
	@echo "Tip: Add  \033[33m## description ... Usage: ...\033[0m  to a target line to include it in the documented list."
	@echo ""

guard-%:
	@ if [ "${${*}}" = "" ]; then \
		echo "❌ $* is a required parameter. See make help for usage."; \
		exit 1; \
	fi

aws-login: ## Login to AWS. Usage: make aws-login AWS_PROFILE=<AWS_PROFILE>
	aws sso login --profile $(PROFILE) && export AWS_PROFILE=$(PROFILE)

clean: clean-build clean-py clean-test

clean-build:
	rm -fr build/
	rm -fr dist/
	rm -fr .eggs/
	find . -name '*.egg-info' -exec rm -fr {} +
	find . -name '*.egg' -exec rm -f {} +

clean-py:
	find . -name '*.pyc' -exec rm -f {} +
	find . -name '*.pyo' -exec rm -f {} +
	find . -name '__pycache__' -exec rm -fr {} +

clean-test:
	find . -name '.pytest_cache' -exec rm -fr {} +
	find . -name '.coverage' -exec rm -fr {} +
	find . -name 'htmlcov' -exec rm -fr {} +
	find . -name '.cache' -exec rm -fr {} +

format: ## Format Python files. Usage: make format CONTAINER=<true|false> FORMAT_ALL=<true|false> CHECK=<true|false>
	@bash scripts/format.sh \
		$(if $(filter true,$(FORMAT_ALL)),--all) \
		$(if $(filter true,$(CONTAINER)),--container) \
		$(if $(filter true,$(CHECK)),--check)


sort-requirements:
	sort -o $(TEST_REQUIREMENTS) $(TEST_REQUIREMENTS)
	sort -o $(CORE_REQUIREMENTS) $(CORE_REQUIREMENTS)
	sort -o $(DATA_REQUIREMENTS) $(DATA_REQUIREMENTS)
	sort -o $(FILES_REQUIREMENTS) $(FILES_REQUIREMENTS)
	sort -o $(REPORTS_REQUIREMENTS) $(REPORTS_REQUIREMENTS)
	sort -o $(ALERTING_REQUIREMENTS) $(ALERTING_REQUIREMENTS)


check-packages:
	./lambdas/venv/bin/pip-audit -r $(TEST_REQUIREMENTS)
	./lambdas/venv/bin/pip-audit -r $(CORE_REQUIREMENTS)
	./lambdas/venv/bin/pip-audit -r $(DATA_REQUIREMENTS)
	./lambdas/venv/bin/pip-audit -r $(FILES_REQUIREMENTS)
	./lambdas/venv/bin/pip-audit -r $(REPORTS_REQUIREMENTS)
	./lambdas/venv/bin/pip-audit -r $(ALERTING_REQUIREMENTS)

build-and-deploy-sandbox: ## Build a sandbox and deploy code. If no SANDBOX_NAME is provided it will use your current branch as the name. It will default to building and deploying using 'main', You can skip building infrastructure by BUILD_INFRA=false. Usage: make build-and-deploy-sandbox SANDBOX_NAME=<sandbox_name> NDRI_WORKFLOW_BRANCH=<branch> NDRI_BRANCH=<branch> NDR_WORKFLOW_BRANCH=<branch> NDR_BRANCH=<branch> BUILD_INFRA=<true|false> NDRI_DIR_LOC_OVERRIDE=<dir_location>
	@./scripts/build_and_deploy_sandbox.sh \
		$(if $(NDRI_WORKFLOW_BRANCH),--ndri_workflow_branch=$(NDRI_WORKFLOW_BRANCH)) \
		$(if $(NDRI_BRANCH),--ndri_branch=$(NDRI_BRANCH)) \
		$(if $(NDR_WORKFLOW_BRANCH),--ndr_workflow_branch=$(NDR_WORKFLOW_BRANCH)) \
		$(if $(NDR_BRANCH),--ndr_branch=$(NDR_BRANCH)) \
		$(if $(SANDBOX_NAME),--sandbox_name=$(SANDBOX_NAME)) \
		$(if $(BUILD_INFRA),--build_infra=$(BUILD_INFRA)) \
		$(if $(FULL_DEPLOY),--full_deploy=$(FULL_DEPLOY)) \
		$(if $(SKIP_MAIN),--skip_main=$(SKIP_MAIN)) \
		$(if $(NDRI_DIR_LOC_OVERRIDE),--ndri_dir_loc_override=$(NDRI_DIR_LOC_OVERRIDE))

download-api-certs: ## Downloads mTLS certificates (use with dev envs only). Usage: make download-api-certs WORKSPACE=<workspace>
	rm -rf ./lambdas/mtls_env_certs/$(WORKSPACE)
	./scripts/aws/download-api-certs.sh $(WORKSPACE)

test-lg-fhir-api-e2e: ## Runs LG FHIR API E2E tests. See readme for required environment variables. Usage: make test-lg-fhir-api-e2e CONTAINER=<true|false>
ifeq ($(CONTAINER), true)
	cd ./lambdas && PYTHONPATH=. poetry run pytest tests/e2e/api --ignore=tests/e2e/api/fhir -vv
else
	cd ./lambdas && ./venv/bin/python3 -m pytest tests/e2e/api --ignore=tests/e2e/api/fhir -vv
endif

test-core-fhir-api-e2e: guard-WORKSPACE ## Runs Core FHIR API E2E tests. Usage: make test-core-fhir-api-e2e WORKSPACE=<workspace> CONTAINER=<true|false>
	./scripts/test/run-e2e-fhir-api-tests.sh --workspace $(WORKSPACE) --container $(CONTAINER)
	rm -rf ./lambdas/mtls_env_certs/$(WORKSPACE)

test-apim-e2e: ## Runs APIM E2E tests for National Document Repository FHIR R4 API against ndr-dev.
	./scripts/test/run-apim-e2e-tests.sh --container $(CONTAINER)

test-lg-fhir-api-e2e-snapshots:
ifeq ($(CONTAINER), true)
	cd ./lambdas && PYTHONPATH=. poetry run pytest tests/e2e/api --ignore=tests/e2e/api/fhir --snapshot-update
else
	cd ./lambdas && ./venv/bin/python3 -m pytest tests/e2e/api --ignore=tests/e2e/api/fhir --snapshot-update
endif

initiate-bulk-upload:
ifeq ($(CONTAINER), true)
	cd ./lambdas && PYTHONPATH=. poetry run pytest tests/e2e/bulk_upload/upload -vv
else
	cd ./lambdas && ./venv/bin/python3 -m pytest tests/e2e/bulk_upload/upload -vv
endif

test-bulk-upload-e2e:
ifeq ($(CONTAINER), true)
	cd ./lambdas && PYTHONPATH=. poetry run pytest tests/e2e/bulk_upload/check -vv
else
	cd ./lambdas && ./venv/bin/python3 -m pytest tests/e2e/bulk_upload/check -vv
endif

test-bulk-upload-e2e-snapshots:
ifeq ($(CONTAINER), true)
	cd ./lambdas && PYTHONPATH=. poetry run pytest tests/e2e/bulk_upload/check --snapshot-update
else
	cd ./lambdas && ./venv/bin/python3 -m pytest tests/e2e/bulk_upload/check --snapshot-update
endif

test-unit:
ifeq ($(CONTAINER), true)
	cd ./lambdas && \
	PYTHONPATH=. poetry run pytest $(if $(ARGS),$(ARGS),tests/unit ../scripts/github/checklist_validator/tests)
else
	cd ./lambdas && \
	PYTHONPATH=.. ./venv/bin/python3 -m pytest $(if $(ARGS),$(ARGS),tests/unit ../scripts/github/checklist_validator/tests)
endif

test-unit-coverage:
ifeq ($(CONTAINER), true)
	cd ./lambdas && PYTHONPATH=. poetry run pytest tests/unit --cov=. --cov-report xml:coverage.xml
else
	cd ./lambdas && ./venv/bin/python3 -m pytest tests/unit --cov=. --cov-report xml:coverage.xml
endif

test-unit-coverage-html:
ifeq ($(CONTAINER), true)
	cd ./lambdas && poetry run coverage run --source=. --omit="tests/*" -m pytest -v tests/unit && coverage report && coverage html
else
	cd ./lambdas && coverage run --source=. --omit="tests/*" -m pytest -v tests/unit && coverage report && coverage html
endif

test-unit-collect:
ifeq ($(CONTAINER), true)
	cd ./lambdas && PYTHONPATH=. poetry run pytest tests/unit --collect-only
else
	cd ./lambdas && ./venv/bin/python3 -m pytest tests/unit --collect-only
endif

env:
	@echo "Removing old venv."
	@rm -rf lambdas/venv || true
	@echo "Building new venv and installing requirements."
	@python3 -m venv ./lambdas/venv
	@./lambdas/venv/bin/pip3 install --upgrade pip
	@./lambdas/venv/bin/pip3 install -r $(TEST_REQUIREMENTS) --no-cache-dir
	@./lambdas/venv/bin/pip3 install -r $(CORE_REQUIREMENTS) --no-cache-dir
	@./lambdas/venv/bin/pip3 install -r $(DATA_REQUIREMENTS) --no-cache-dir
	@./lambdas/venv/bin/pip3 install -r $(FILES_REQUIREMENTS) --no-cache-dir
	@./lambdas/venv/bin/pip3 install -r $(REPORTS_REQUIREMENTS) --no-cache-dir
	@./lambdas/venv/bin/pip3 install -r $(ALERTING_REQUIREMENTS) --no-cache-dir
	@echo " "
	@echo " "
	@echo "Now activate your venv."

github_env:
	rm -rf lambdas/venv || true
	python3 -m venv ./lambdas/venv
	./lambdas/venv/bin/pip3 install --upgrade pip
	./lambdas/venv/bin/pip3 install -r $(GITHUB_REQUIREMENTS) --no-cache-dir

edge_env:
	rm -rf lambdas/venv || true
	python3 -m venv ./lambdas/venv
	./lambdas/venv/bin/pip3 install --upgrade pip
	./lambdas/venv/bin/pip3 install -r $(GITHUB_REQUIREMENTS) --no-cache-dir
	./lambdas/venv/bin/pip3 install -r $(EDGE_REQUIREMENTS) --no-cache-dir

zip:
	echo $(LAMBDAS_BUILD_PATH)/$(lambda_name)
	rm -rf ./$(LAMBDAS_BUILD_PATH)/$(lambda_name) || true
	mkdir -p $(ZIP_BASE_PATH)/handlers
	cp lambdas/handlers/${lambda_path}/$(lambda_name).py $(ZIP_BASE_PATH)/handlers
	cp -r $(ZIP_COMMON_FILES) $(ZIP_BASE_PATH)
	cd $(ZIP_BASE_PATH) ; zip -r ../$(lambda_name).zip .
	rm -rf $(ZIP_BASE_PATH)

edge_zip: zip
	mkdir -p $(ZIP_BASE_PATH)/python
	cp -r lambdas/venv/lib/python*/site-packages/* $(ZIP_BASE_PATH)
	cd $(ZIP_BASE_PATH) ; zip -r ../$(lambda_name).zip .
	rm -rf $(ZIP_BASE_PATH)

lambda_layer_zip:
	rm -rf ./$(LAMBDA_LAYERS_BUILD_PATH)/$(layer_name) || true
	mkdir -p ./$(LAMBDA_LAYERS_BUILD_PATH)/$(layer_name)
	./lambdas/venv/bin/pip3 install --platform manylinux2014_x86_64 --only-binary=:all: --implementation cp  -r $(LAMBDA_LAYER_REQUIREMENTS_PATH)/requirements_$(layer_name).txt -t ./$(LAMBDA_LAYERS_BUILD_PATH)/$(layer_name)/tmp/$(LAMBDA_LAYER_PYTHON_PATH)
	cd ./$(LAMBDA_LAYERS_BUILD_PATH)/$(layer_name)/tmp; zip -r ../$(layer_name).zip .
	rm -rf ./$(LAMBDA_LAYERS_BUILD_PATH)/$(layer_name)/tmp
	cd ../..

package: format zip

install:
	npm --prefix ./app install --legacy-peer-deps
	cp ./app/node_modules/pdfjs-dist/build/pdf.worker.min.mjs ./app/public/

clean-install:
	npm --prefix ./app ci --legacy-peer-deps

install-pdfjs:
	mkdir -p ./app/public/pdfjs
	wget https://github.com/mozilla/pdf.js/releases/download/v5.4.624/pdfjs-5.4.624-dist.zip -O ./app/public/pdfjs/pdfjs.zip
	unzip -o -d ./app/public/pdfjs ./app/public/pdfjs/pdfjs.zip
	rm ./app/public/pdfjs/pdfjs.zip

# Environment tooling targets:
install-asdf:
	echo "Setting up ASDF and related dependencies"
	cut -d ' ' -f1 .tool-versions | xargs -I {} asdf plugin add {} || true
	asdf install

install-poetry:
	echo "Installing all poetry dependencies to local environment"
	poetry install

	echo "Generating 'requirements.txt' files"
	$(MAKE) requirements

install-dev: install-asdf install-poetry install-cypress
	git config --unset-all core.hooksPath || true
	pre-commit install --config src/config/pre-commit.yml --install-hooks

start:
	npm --prefix ./app start

test-ui:
	npm --prefix ./app run test-all

test-ui-coverage:
	npm --prefix ./app run test-all:coverage

build:
	npm --prefix ./app run build

build-env-check:
	npm --prefix ./app run build-env-check

docker-up:
	docker-compose -f ./app/docker-compose.yml up -d

docker-up-rebuild:
	docker-compose -f ./app/docker-compose.yml up -d --build --force-recreate

docker-down:
	docker-compose -f ./app/docker-compose.yml down

cypress-open:
ifeq ($(CONTAINER), true)
	xvfb-run -- npm --prefix ./app run cypress
else
	npm --prefix ./app run cypress
endif

cypress-run:
ifeq ($(CONTAINER), true)
	xvfb-run -- npm --prefix ./app run cypress-run
else
	npm --prefix ./app run cypress-run
endif

cypress-report:
ifeq ($(CONTAINER), true)
	xvfb-run -- npm --prefix ./app run cypress-report
else
	npm --prefix ./app run cypress-report
endif

install-cypress:
	npm install --save-dev cypress