Makefile

# This file is for you! Edit it to implement your own hooks (make targets) into
# the project as automated steps to be executed on locally and in the CD pipeline.
# ==============================================================================
include scripts/init.mk

MAKE_DIR := $(abspath $(shell pwd))

#Installs dependencies using poetry.
install-python:
	poetry install --no-root

#Installs dependencies using npm.
install-node:
	npm install --legacy-peer-deps

#Condensed Target to run all targets above.
install: install-node install-python

make-hooks: .git/hooks/pre-commit

#Run the npm linting script (specified in package.json). Used to check the syntax and formatting of files.
lint:
	# npm run lint
	poetry run ruff format . --check
	poetry run ruff check .
	poetry run pyright


format: ## Format and fix code
	poetry run ruff format .
	poetry run ruff check . --fix-only

#Creates the fully expanded OAS spec in json
generate-sandbox-spec: clean
	mkdir -p build
	mkdir -p sandbox/specification
	npm run publish 2> /dev/null
	cp build/specification/sandbox/eligibility-signposting-api.json sandbox/specification/eligibility-signposting-api.json

#Files to loop over in release
_dist_include="pytest.ini poetry.lock poetry.toml pyproject.toml Makefile build/. tests"

# Example CI/CD targets are: dependencies, build, publish, deploy, clean, etc.

dependencies: # Install dependencies needed to build and test the project @Pipeline
	scripts/dependencies.sh

config:: # Configure development environment (main) @Configuration
	# TODO: Use only 'make' targets that are specific to this project, e.g. you may not need to install Node.js
	make _install-dependencies

##################
#### Proxygen ####
##################

# Verify current AWS account login and retrieve the proxygen key
# from AWS SSM Parameter Store
retrieve-proxygen-key:
	@ ./scripts/check-aws-account.sh
	mkdir -p ~/.proxygen
	aws ssm get-parameter --name /prod/proxygen/private_key --with-decryption \
	| jq -r ".Parameter.Value" \
	> ~/.proxygen/eligibility-signposting-api.pem && \
	echo "Retrieved proxygen key for APIM 'Prod' environment"

# Copy proxygen credentials for the specified environment to `~/.proxygen/`
# This location required location for local proxygen usage
setup-proxygen-credentials:
	@ cd specification && cp -r .proxygen ~

get-spec: # Get the most recent specification live in proxygen
	$(MAKE) setup-proxygen-credentials
	proxygen spec get

get-spec-uat: # Get the most recent specification live in proxygen
	$(MAKE) setup-proxygen-credentials
	proxygen spec get --uat

publish-spec: # Publish the specification to proxygen
	$(MAKE) setup-proxygen-credentials
	proxygen spec publish build/specification/prod/eligibility-signposting-api.yaml

publish-spec-uat: # Publish the specification to proxygen
	$(MAKE) setup-proxygen-credentials
	proxygen spec publish build/specification/preprod/eligibility-signposting-api.yaml --uat

delete-spec: # Delete the specification from proxygen
	$(MAKE) setup-proxygen-credentials
	proxygen spec delete

delete-spec-uat: # Delete the specification from proxygen
	$(MAKE) setup-proxygen-credentials
	proxygen spec delete --uat

#####################
### Specification ###
#####################

guard-%:
	@ if [ "${${*}}" = "" ]; then \
		echo "Variable $* not set"; \
		exit 1; \
	fi

set-target: guard-APIM_ENV
	@ TARGET=target-$$APIM_ENV.yaml \
	envsubst '$${TARGET}' \
	< specification/x-nhsd-apim/target-template.yaml > specification/x-nhsd-apim/target.yaml

set-access: guard-APIM_ENV
	@ ACCESS=access-$$APIM_ENV.yaml \
	envsubst '$${ACCESS}' \
	< specification/x-nhsd-apim/access-template.yaml > specification/x-nhsd-apim/access.yaml

set-security: guard-APIM_ENV
	@ SECURITY=security-$$APIM_ENV.yaml \
	envsubst '$${SECURITY}' \
	< specification/components/security/security-template.yaml > specification/components/security/security.yaml

set-ratelimit: guard-APIM_ENV
	@ RATELIMIT=ratelimit-$$APIM_ENV.yaml \
	envsubst '$${RATELIMIT}' \
	< specification/x-nhsd-apim/ratelimit-template.yaml > specification/x-nhsd-apim/ratelimit.yaml

update-spec-template: guard-APIM_ENV
ifeq ($(APIM_ENV), $(filter $(APIM_ENV), sandbox internal-dev test int ref preprod prod dev))
	@ $(MAKE) set-target APIM_ENV=$$APIM_ENV
	@ $(MAKE) set-access APIM_ENV=$$APIM_ENV
	@ $(MAKE) set-security APIM_ENV=$$APIM_ENV
	@ $(MAKE) set-ratelimit APIM_ENV=$$APIM_ENV
else
	@ echo ERROR: $$APIM_ENV is not a valid environment. Please use one of [sandbox, internal-dev, test, int, ref, preprod, prod, dev]
	@ exit 1;
endif

construct-spec: guard-APIM_ENV
		@ $(MAKE) update-spec-template APIM_ENV=$$APIM_ENV
		mkdir -p build/specification/$(APIM_ENV)
ifeq ($(APIM_ENV), sandbox)
		sed '/^[[:space:]]*security:/,/^[[:space:]]*-[[:space:]]/c\      security:\n        - app-level0: []' specification/eligibility-signposting-api.yaml > specification/eligibility-signposting-api.generated.yaml && \
		npx redocly bundle specification/eligibility-signposting-api.generated.yaml --remove-unused-components --keep-url-references --ext yaml > build/specification/$(APIM_ENV)/eligibility-signposting-api.yaml
		rm specification/eligibility-signposting-api.generated.yaml
else
		npx redocly bundle specification/eligibility-signposting-api.yaml --remove-unused-components --keep-url-references --ext yaml > build/specification/$(APIM_ENV)/eligibility-signposting-api.yaml
endif

construct-spec-mac: guard-APIM_ENV
		@ $(MAKE) update-spec-template APIM_ENV=$$APIM_ENV
		mkdir -p build/specification/$(APIM_ENV)
ifeq ($(APIM_ENV), sandbox)
		gsed '/^[[:space:]]*security:/,/^[[:space:]]*-[[:space:]]/c\      security:\n        - app-level0: []' specification/eligibility-signposting-api.yaml > specification/eligibility-signposting-api.generated.yaml && \
		npx redocly bundle specification/eligibility-signposting-api.generated.yaml --remove-unused-components --keep-url-references --ext yaml > build/specification/$(APIM_ENV)/eligibility-signposting-api.yaml
		rm specification/eligibility-signposting-api.generated.yaml
else
		npx redocly bundle specification/eligibility-signposting-api.yaml --remove-unused-components --keep-url-references --ext yaml > build/specification/$(APIM_ENV)/eligibility-signposting-api.yaml
endif


SPEC_DIR := $(CURDIR)/specification
POSTMAN_DIR := $(SPEC_DIR)/postman

convert-postman: # Create Postman collection from OAS spec
	mkdir -p $(POSTMAN_DIR)
	cp $(SPEC_DIR)/eligibility-signposting-api.yaml $(POSTMAN_DIR)/
	docker build -t portman-converter -f $(POSTMAN_DIR)/Dockerfile $(SPEC_DIR)
	docker run --rm -u $(shell id -u):$(shell id -g) -v $(SPEC_DIR):/app portman-converter \
		portman -l /app/eligibility-signposting-api.yaml -o /app/postman/collection.json
	echo >> $(POSTMAN_DIR)/collection.json
	rm $(POSTMAN_DIR)/eligibility-signposting-api.yaml

build-and-publish-sandbox-image: # Build and publish the sandbox Docker image
	$(MAKE) -C sandbox build-and-publish-sandbox-image


# ==============================================================================

${VERBOSE}.SILENT: \
	build \
	clean \
	config \
	dependencies \
	deploy \