Makefile

#!make

# ------------------------------------------------------------------------------
# Makefile -- SIMS
# ------------------------------------------------------------------------------

-include .env

# Apply the contents of the .env to the terminal, so that the compose file can use them in its builds
export $(shell sed 's/=.*//' .env)

## ------------------------------------------------------------------------------
## Alias Commands
## - Performs logical groups of commands for your convenience
## ------------------------------------------------------------------------------

# Running the docker build
# 1. Run `make env`
# 2. Edit the `.env` file as needed to update variables and secrets
# 3. Run `make web`

setup: | setup-env check-env ## Copies the default ./env_config/env.docker to ./.env
env: | setup-env check-env ## Copies the default ./env_config/env.docker to ./.env

postgres: | close check-env build-postgres run-postgres ## Performs all commands necessary to run the postgres project (db) in docker
backend: | close check-env build-backend run-backend ## Performs all commands necessary to run all backend projects (db, api) in docker
web: | close check-env build-web run-web ## Performs all commands necessary to run all backend+web projects (db, api, app) in docker

db-setup: | check-env build-db-setup run-db-setup ## Performs all commands necessary to run the database migrations and seeding

clamav: | check-env build-clamav run-clamav ## Performs all commands necessary to run clamav

fix: | lint-fix format-fix ## Performs both lint-fix and format-fix commands

## ------------------------------------------------------------------------------
## Setup Commands
## ------------------------------------------------------------------------------

setup-env: ## Prepares the environment variables used by all project docker containers, by copying the sample 'env.docker' to '.env'. Note: Some variables may need to be updated, like secrets
	@echo "==============================================="
	@echo "Make: setup-env - copying env.docker to .env"
	@echo "==============================================="
	@cp -i env_config/env.docker .env

check-env: ## Logs any env vars that are missing or have no value, in the '.env' file
	@echo "==============================================="
	@echo "Make: check-env - checking for missing env vars"
	@echo "==============================================="
	@awk -F '=' 'NR==FNR && !/^#/ && NF {a[$$1]; next} !/^#/ && NF && !($$1 in a)' .env env_config/env.docker | while read -r line; do echo "Warning: Missing value for $$line in .env"; done

## ------------------------------------------------------------------------------
## Cleanup Commands
## ------------------------------------------------------------------------------

close: ## Closes all project containers
	@echo "==============================================="
	@echo "Make: close - closing Docker containers"
	@echo "==============================================="
	@docker compose down

clean: ## Closes and cleans (removes) all project containers
	@echo "==============================================="
	@echo "Make: clean - closing and cleaning Docker containers"
	@echo "==============================================="
	@docker compose down -v --rmi all --remove-orphans

prune: ## Deletes ALL docker artifacts (even those not associated to this project)
	@echo -n "Delete ALL docker artifacts? [y/n] " && read ans && [ $${ans:-n} = y ]
	@echo "==============================================="
	@echo "Make: prune - deleting all docker artifacts"
	@echo "==============================================="
	@docker system prune --all --volumes -f
	@docker volume prune --all -f

## ------------------------------------------------------------------------------
## Build/Run Postgres DB Commands
## - Builds all of the SIMS postgres db projects (db, db_setup)
## ------------------------------------------------------------------------------

build-postgres: ## Builds the postgres db containers
	@echo "==============================================="
	@echo "Make: build-postgres - building postgres db  images"
	@echo "==============================================="
	@docker compose build db db_setup

run-postgres: ## Runs the postgres db containers
	@echo "==============================================="
	@echo "Make: run-postgres - running postgres db  images"
	@echo "==============================================="
	@docker compose up -d db db_setup

## ------------------------------------------------------------------------------
## Build/Run Backend Commands
## - Builds all of the SIMS backend projects (db, db_setup, api)
## ------------------------------------------------------------------------------

build-backend: ## Builds all backend containers
	@echo "==============================================="
	@echo "Make: build-backend - building backend images"
	@echo "==============================================="
	@docker compose build db db_setup api

run-backend: ## Runs all backend containers
	@echo "==============================================="
	@echo "Make: run-backend - running backend images"
	@echo "==============================================="
	@docker compose up -d db db_setup api

## ------------------------------------------------------------------------------
## Build/Run Backend+Web Commands (backend + web frontend)
## - Builds all of the SIMS backend+web projects (db, db_setup, api, app)
## ------------------------------------------------------------------------------

build-web: ## Builds all backend+web containers
	@echo "==============================================="
	@echo "Make: build-web - building web images"
	@echo "==============================================="
	@docker compose build db db_setup api app

run-web: ## Runs all backend+web containers
	@echo "==============================================="
	@echo "Make: run-web - running web images"
	@echo "==============================================="
	@docker compose up -d db db_setup api app

## ------------------------------------------------------------------------------
## Commands to shell into the target container
## ------------------------------------------------------------------------------

db-container: ## Executes into database container.
	@echo "==============================================="
	@echo "Make: Shelling into database container"
	@echo "==============================================="
	@export PGPASSWORD=$(DB_ADMIN_PASS)
	@docker compose exec db psql -U $(DB_ADMIN) -d $(DB_DATABASE)

app-container: ## Executes into the app container.
	@echo "==============================================="
	@echo "Shelling into app container"
	@echo "==============================================="
	@docker compose exec app bash

api-container: ## Executes into the api container.
	@echo "==============================================="
	@echo "Shelling into api container"
	@echo "==============================================="
	@docker compose exec api bash

## ------------------------------------------------------------------------------
## Cronjob commands
## - You can include additional CLI arguments by appending the `args` param
## - Ex: `make telemetry-cronjob args="--concurrently 100 --batchSize 1000"`
## ------------------------------------------------------------------------------
telemetry-cronjob: ## Run the telemetry cronjob
	@echo "==============================================="
	@echo "Telemetry Cronjob"
	@echo "==============================================="
	@docker compose exec api npm run telemetry-cronjob -- $(args)
## ------------------------------------------------------------------------------
## Database migration commands
## ------------------------------------------------------------------------------

build-db-setup: ## Build the db knex setup (migrations + seeding) image
	@echo "==============================================="
	@echo "Make: build-db-setup - building db knex setup image"
	@echo "==============================================="
	@docker compose build db_setup

run-db-setup: ## Run the database migrations and seeding
	@echo "==============================================="
	@echo "Make: run-db-setup - running database migrations and seeding"
	@echo "==============================================="
	@docker compose up db_setup

## ------------------------------------------------------------------------------
## Clamav commands
## ------------------------------------------------------------------------------

build-clamav: ## Build the clamav image
	@echo "==============================================="
	@echo "Make: build-clamav - building clamav image"
	@echo "==============================================="
	@docker compose build clamav

run-clamav: ## Run clamav
	@echo "==============================================="
	@echo "Make: run-clamav - running clamav"
	@echo "==============================================="
	@docker compose up -d clamav

## ------------------------------------------------------------------------------
## Run `npm` commands for all projects
## ------------------------------------------------------------------------------

install: ## Runs `npm install` for all projects
	@echo "==============================================="
	@echo "Running /api install"
	@echo "==============================================="
	@cd api && npm install && cd ..
	@echo "==============================================="
	@echo "Running /app install"
	@echo "==============================================="
	@cd app && npm install && cd ..
	@echo "==============================================="
	@echo "Running /database install"
	@echo "==============================================="
	@cd database && npm install && cd ..

test: ## Runs `npm test` for api, and app projects
	@echo "==============================================="
	@echo "Running /api tests"
	@echo "==============================================="
	@cd api && npm test && cd ..
	@echo "==============================================="
	@echo "Running /app tests"
	@echo "==============================================="
	@cd app && npm test && cd ..

cypress: ## Runs `npm run test:e2e` for api, and app projects
	@echo "==============================================="
	@echo "Running cypress tests"
	@echo "==============================================="
	@cd testing/e2e && npm run test:e2e && cd ../..

lint: ## Runs `npm lint` for all projects
	@echo "==============================================="
	@echo "Running /api lint"
	@echo "==============================================="
	@cd api && npm run lint && cd ..
	@echo "==============================================="
	@echo "Running /app lint"
	@echo "==============================================="
	@cd app && npm run lint && cd ..
	@echo "==============================================="
	@echo "Running /database lint"
	@echo "==============================================="
	@cd database && npm run lint && cd ..

lint-fix: ## Runs `npm run lint-fix ` for all projects
	@echo "==============================================="
	@echo "Running /api lint-fix"
	@echo "==============================================="
	@cd api && npm run lint-fix && cd ..
	@echo "==============================================="
	@echo "Running /app lint-fix"
	@echo "==============================================="
	@cd app && npm run lint-fix && cd ..
	@echo "==============================================="
	@echo "Running /database lint-fix"
	@echo "==============================================="
	@cd database && npm run lint-fix && cd ..

format: ## Runs `npm run format` for all projects
	@echo "==============================================="
	@echo "Running /api format"
	@echo "==============================================="
	@cd api && npm run format && cd ..
	@echo "==============================================="
	@echo "Running /app format"
	@echo "==============================================="
	@cd app && npm run format && cd ..
	@echo "==============================================="
	@echo "Running /database format"
	@echo "==============================================="
	@cd database && npm run format && cd ..

format-fix: ## Runs `npm run format-fix` for all projects
	@echo "==============================================="
	@echo "Running /api format-fix"
	@echo "==============================================="
	@cd api && npm run format-fix && cd ..
	@echo "==============================================="
	@echo "Running /app format-fix"
	@echo "==============================================="
	@cd app && npm run format-fix && cd ..
	@echo "==============================================="
	@echo "Running /database format-fix"
	@echo "==============================================="
	@cd database && npm run format-fix && cd ..

## ------------------------------------------------------------------------------
## Run `npm` commands for all projects ./.pipeline
## ------------------------------------------------------------------------------
pipeline-install: ## Runs `npm install` for all projects
	@echo "==============================================="
	@echo "Running /api/.pipeline install"
	@echo "==============================================="
	@cd api/.pipeline && npm install && cd ../..
	@echo "==============================================="
	@echo "Running /app/.pipeline install"
	@echo "==============================================="
	@cd app/.pipeline && npm install && cd ../..
	@echo "==============================================="
	@echo "Running /database/.pipeline install"
	@echo "==============================================="
	@cd database/.pipeline && npm install && cd ../..

## ------------------------------------------------------------------------------
## Run `docker logs <container> -f` commands for all projects
## - You can include additional parameters by appaending an `args` param
## - Ex: `make log-app args="--tail 0"`
## Note: The default args, if not provided, are `--tail 2000`
## ------------------------------------------------------------------------------

args ?= --tail 2000 ## Default args if none are provided

log: ## Runs `docker compose logs -f` for all containers
	@echo "==============================================="
	@echo "Running docker logs for the app container"
	@echo "==============================================="
	@docker compose logs -f $(args)

log-app: ## Runs `docker logs <container> -f` for the app container
	@echo "==============================================="
	@echo "Running docker logs for the app container"
	@echo "==============================================="
	@docker logs $(DOCKER_PROJECT_NAME)-app-$(DOCKER_NAMESPACE)-container -f $(args)

log-api: ## Runs `docker logs <container> -f` for the api container
	@echo "==============================================="
	@echo "Running docker logs for the api container"
	@echo "==============================================="
	@docker logs $(DOCKER_PROJECT_NAME)-api-$(DOCKER_NAMESPACE)-container -f $(args)

log-db: ## Runs `docker logs <container> -f` for the database container
	@echo "==============================================="
	@echo "Running docker logs for the db container"
	@echo "==============================================="
	@docker logs $(DOCKER_PROJECT_NAME)-db-$(DOCKER_NAMESPACE)-container -f $(args)

log-db-setup: ## Runs `docker logs <container> -f` for the database setup container
	@echo "==============================================="
	@echo "Running docker logs for the db-setup container"
	@echo "==============================================="
	@docker logs $(DOCKER_PROJECT_NAME)-db-setup-$(DOCKER_NAMESPACE)-container -f $(args)

## ------------------------------------------------------------------------------
## Typescript Trace Commands
## Runs ts-trace to find typescript compilation issues and hotspots
## Docs: https://github.com/microsoft/typescript-analyze-trace
## ------------------------------------------------------------------------------
trace-app: ## Runs ts-trace to find typescript compilation issues and hotspots in the app
	@echo "==============================================="
	@echo "Typscript trace - searching App hotspots"
	@echo "==============================================="
	@cd app && npx tsc -p ./tsconfig.json --generateTrace ts-traces || npx @typescript/analyze-trace --skipMillis 100 --forceMillis 300 --expandTypes ts-traces

trace-api: ## Runs ts-trace to find typescript compilation issues and hotspots in the api
	@echo "==============================================="
	@echo "Typscript trace - searching for Api hotspots"
	@echo "==============================================="
	@cd api && npx tsc -p ./tsconfig.json --generateTrace ts-traces || npx @typescript/analyze-trace --skipMillis 100 --forceMillis 300 --expandTypes ts-traces

## ------------------------------------------------------------------------------
## Help
## ------------------------------------------------------------------------------
help: ## Display this help screen.
	@grep -h -E '^[0-9a-zA-Z_-]+:.*?##.*$$|^##.*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[33m%-20s\033[0m %s\n", $$1, $$2}' | awk 'BEGIN {FS = "## "}; {printf "\033[36m%-1s\033[0m %s\n", $$2, $$1}'