Makefile

# We need to use bash, not 'sh' (which is bash on osx and something else on linux)
SHELL := /bin/bash

help:  ## print this message
# borrowed from: https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
	@grep -E '^[a-zA-Z_\.-]+:' $(MAKEFILE_LIST) \
		| sort \
		| awk 'BEGIN {FS = ":[^#]*(## )?"}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2 }'

###########################
# local workflow commands #
###########################


_.setup: # build docker container, create dbs, run migrations
	./bin/dev/setup

_.update: # install node dependencies, run migrations
	./bin/dev/update

_.upgrade: # upgrade node packages
	./bin/dev/upgrade

_.unlock: ## unlock signalboost secrets
	./bin/blackbox/decrypt_all_files

###################
# ansible-related #
###################

ansible.install: ## removes boost cli files from your path
	./ansible/install-ansible

ansible.deploy: # deploy the app to prod
	./bin/deploy

ansible.deploy.crontab: # deploy changes to the crontab on prod
	cd ansible && ansible-playbook -i inventory playbooks/provision_backup_src.yml --tags crontab

ansible.deploy.friendo: # deploy the app to prod
	FRIENDO_DEPLOY=1 ./bin/deploy

ansible.deploy.metrics: # deploy grafana/prometheus to metrics server
	./bin/deploy-metrics

ansible.deploy.staging: # deploy staging
	./bin/blackbox/postdeploy && \
	cd ansible && ansible-playbook -i inventory -e "sb_host=sb_staging env_file=files/.env.staging" playbooks/deploy.yml

ansible.deploy.splash: ## deploy the splash app
	./splash/bin/deploy

ansible.harden.splash: ## harden the server hosting the splash page
	./splash/bin/harden

ansible.harden.staging: # provision staging
	cd ansible && ansible-playbook -i inventory -e "sb_host=sb_staging" playbooks/harden.yml

ansible.provision: # deploy the app to prod
	cd ansible && ansible-playbook -i inventory playbooks/provision.yml

ansible.provision.backup.src: # deploy the app to prod
	cd ansible && ansible-playbook -i inventory playbooks/provision_backup_src.yml

ansible.provision.backup.dst: # deploy the app to prod
	cd ansible && ansible-playbook -i inventory playbooks/provision_backup_dst.yml

ansible.provision.splash: ## provision the splash app
	./splash/bin/provision

ansible.provision.staging: # provision staging
	./bin/blackbox/postdeploy && \
    cd ansible && ansible-playbook -i inventory -e "sb_host=sb_staging" playbooks/provision.yml

ansible.harden: # deploy the app to prod
	cd ansible && ansible-playbook -i inventory playbooks/harden.yml

ansible.backup: # backup the app from prod to sb_backup host
	cd ansible && ansible-playbook -i inventory playbooks/backup.yml

ansible.repair.db: # repair corrupted postgres write-ahead-log
	cd ansible && ansible-playbook -i inventory playbooks/repair_db.yml

ansible.restore: # restore from backup on sb_backup host to prod
	cd ansible && ansible-playbook -i inventory playbooks/restore.yml

ansible.restart: # restart prod
	cd ansible && ansible-playbook -i inventory playbooks/restart.yml


########################
# cli-related commands #
########################

cli.install: ## install the boost cli (puts ./cli/boost-commands on your $PATH)
	sudo ./cli/install

cli.uninstall: ## removes boost cli files from your path
	sudo ./cli/uninstall

# TODO: add aliases to commands here that accept args...


#######################
# db-related commands #
#######################

db.drop: # drop db
	./bin/dev/drop

db.psql: # get a psql shell on dev db
	./bin/dev/psql

db.migrate.up: # run all migrations
	./bin/dev/migrate

db.migrate.down: # undo last migration
	./bin/dev/migrate-undo

db.migrate.status: # check migration statuses
	./bin/dev/migrate-status

dev.psql: # get a psql shell on dev db
	./bin/dev/psql

prod.psql: # get a psql shell on prod db
	./bin/prod/psql

##########################
# start and stop the app #
##########################

dev.db.up: ## run signalboost db in docker (for use in local unit tests or psql explorations)
	docker-compose -f docker-compose.yml -f docker-compose-dev.yml \
	up -d db

dev.db.down: ## spin down signalboost db
	docker-compose -f docker-compose.yml -f docker-compose-dev.yml \
	stop db

dev.up: ## run signalboost in local dev mode
	docker-compose -f docker-compose.yml -f docker-compose-dev.yml \
	up -d ngrok app

dev.up.v: ## run signalboost in local dev mode with verbose logging
	SIGNALBOOST_VERBOSE_LOG=1 docker-compose -f docker-compose.yml -f docker-compose-dev.yml \
	up -d ngrok app

dev.up.metrics: ## run signalboost in local dev mode with prometheus/grafana
	docker-compose -f docker-compose.yml -f docker-compose-dev.yml \
	up -d

dev.down: ## gracefully stop all signalboost container
	docker-compose -f docker-compose.yml -f docker-compose-dev.yml \
	down

dev.abort: ## force stop all running signalboost containers
	docker ps --filter name=signalboost_* -aq | xargs -I container_id docker rm -f container_id

dev.logs: ## show logs for all docker containers
	docker-compose -f docker-compose.yml -f docker-compose-dev.yml \
	logs -f

dev.restart: ## force stop and start the app again
	docker ps --filter name=signalboost_* -aq | xargs -I container_id docker rm -f container_id && \
	docker-compose -f docker-compose.yml -f docker-compose-dev.yml \
	up -d ngrok app

dev.restart.v: ## force stop and start the app again with verbose loggins
	docker ps --filter name=signalboost_* -aq | xargs -I container_id docker rm -f container_id && \
	SIGNALBOOST_VERBOSE_LOG=1 docker-compose -f docker-compose.yml -f docker-compose-dev.yml \
	up -d ngrok app

dev.restart.metrics: ## force stop and start the app again (with prometheus/grafana)
	docker ps --filter name=signalboost_* -aq | xargs -I container_id docker rm -f container_id && \
	docker-compose -f docker-compose.yml -f docker-compose-dev.yml \
	up -d

dev.nc: ## get a netcat terminal on a running signald instance in dev stack
	docker-compose -f docker-compose.yml -f docker-compose-dev.yml \
	exec signald_0 nc -U /var/run/signald/signald.sock

##################
# docker-related #
##################
docker.pull: ## pull most recent versions of all the docker images in our dev env!
	docker-compose -f docker-compose.yml -f docker-compose-dev.yml pull

docker.pull.signalboost: ## pull the most recent version of our signalboost image
	docker-compose -f docker-compose.yml -f docker-compose-dev.yml pull app

docker.pull.signalc: ## pull the most recent version of our signalc image
	docker-compose -f docker-compoe.yml -f docker-compose-dev.yml pull signalc

docker.pull.signald: ## pull the most recent version of our signald image
	docker-compose -f docker-compose.yml -f docker-compose-dev.yml pull signald

docker.build.base: ## build the base docker image (accepts optional TAG=#.#.# argument)
	./bin/docker-build base $(TAG)

docker.build.signalboost: ## build the signalboost docker image (accepts optional TAG=#.#.# argument)
	./bin/docker-build signalboost $(TAG)

docker.build.signalc: ## build the signalc production image (accepts optional TAG=#.#.# argument)
	echo "use `make sc.build` instead!"

docker.build.signalc.dev: ## build the signalc dev image (accepts optional TAG=#.#.# argument)
	./bin/docker-build signalc-dev $(TAG)

docker.build.signald: ## build the signald docker image (accepts optional TAG=#.#.# argument)
	./bin/docker-build signald $(TAG)

docker.build.signald.staging: ## build the signald staging docker image (accepts optional TAG=#.#.# argument)
	./bin/docker-build signald-staging $(TAG)

docker.build.splash: ## build the splash site docker image (accepts optional TAG=#.#.# argument)
	./bin/docker-build splash $(TAG)

docker.push.base: ## push the base docker image (accepts optional TAG=#.#.# argument)
	./bin/docker-push base $(TAG)

docker.push.signalboost: ## push the signalboost docker image (accepts optional TAG=#.#.# argument)
	./bin/docker-push signalboost $(TAG)

docker.push.signalc: ## push the signalc production image (accepts optional TAG=#.#.# argument)
	./bin/docker-push signalc $(TAG)

docker.push.signalc.dev: ## push the signalc dev image (accepts optional TAG=#.#.# argument)
	./bin/docker-push signalc-dev $(TAG)

docker.push.signald: ## push the signald docker image (accepts optional TAG=#.#.# argument)
	./bin/docker-push signald $(TAG)

docker.push.signald.staging: ## push the signald staging docker image (accepts optional TAG=#.#.# argument)
	./bin/docker-push signald-staging $(TAG)

docker.push.splash: ## push the splash site docker image (accepts optional TAG=#.#.# argument)
	./bin/docker-push splash $(TAG)

##############
# load tests #
##############

load.logs: ## show logs from load env
	docker-compose -f docker-compose-loadtest.yml logs -f

load.logs.receiver: ## show logs from load env
	docker logs loadtest_receiver_signalc -f

load.logs.sender.signalc: ## show logs from load env
	docker logs loadtest_sender_signalc -f

load.logs.sender.signald: ## show logs from load env
	docker logs loadtest_sender_signald -f

load.nc.simulator: ## get a netcat shell inside the loadtest simulator
	docker-compose -f docker-compose-loadtest.yml exec receiver_signalc nc -U /signalc/sock/signald.sock

load.db.up: ## start load test db
	docker-compose -f docker-compose-loadtest.yml up -d db

load.db.psql: ## get a psql shell on loadtest db
	./bin/load/psql

load.up: ## start
	./bin/load/run

load.seed.signalc.app: ## seed the simulator environment backed by signalc
	SEED_TARGET=sender_signalc ./bin/load/seed

load.seed.signalc.simulator: ## seed the simulator environment backed by signalc
	SEED_TARGET=receiver_signalc ./bin/load/seed

load.seed.signald: ## seed the simulator environment backed by signald
	SEED_TARGET=sender_signald ./bin/load/seed

load.down: ## start
	docker-compose -f docker-compose-loadtest.yml down

load.setup: ## start
	./bin/load/setup

load.restart: ## restart loadtest stack
	docker-compose -f docker-compose-loadtest.yml down && ./bin/load/run

load.restart.sender_signalc:
	docker-compose -f docker-compose-loadtest.yml stop sender_signalc && docker-compose -f docker-compose-loadtest.yml up -d sender_signalc

load.reseed: ## clean signalc + signal-server databases
	./bin/load/reseed

load.test.lag.signald: ## run load tests to measure lag in a client
	TEST_SUBJECT=sender_signald ./bin/load/test-lag

load.test.lag.signalc:
	TEST_SUBJECT=sender_signalc ./bin/load/test-lag

load.test.concurrency.signald: ## run load tests to measure concurrency in a client
	TEST_SUBJECT=sender_signald ./bin/load/test-concurrency

load.test.concurrency.signalc:
	TEST_SUBJECT=sender_signalc ./bin/load/test-concurrency


###########
# signalc #
###########

sc.build: ## build jar and docker image for signalc
	./bin/sc/build

sc.jar: ## build
	docker-compose -f docker-compose-sc.yml \
	run --entrypoint 'gradle shadowJar' signalc && \
	echo "> jar available in signalc/build/libs"

sc.run: ## run signalc in isloation in dev mode
	docker-compose -f docker-compose-sc.yml \
	run -e SIGNALC_ENV=development --entrypoint 'rm /signalc/message.sock && gradle --console=plain run' \
	signalc_dev

sc.nc: ## open a netcat session on the signalc unix socket
	docker-compose -f docker-compose-sc.yml \
	exec signalc nc -U /signalc/sock/signald.sock

sc.up.debug: ## run signalboost against signalc in dev mode w/ debug flags on
	DEBUG_MODE=1 LOG_LEVEL=debug docker-compose -f docker-compose-sc.yml up -d signalc signalboost ngrok

sc.up: ## run signalboost against pinned signalc commit (for faster boot)
	docker-compose -f docker-compose-sc.yml up -d signalc signalboost ngrok

sc.down: # stop signalc stack
	docker-compose -f docker-compose-sc.yml down

sc.logs: ## view logs for signalc stack
	docker-compose -f docker-compose-sc.yml logs -f


sc.restart: ## restart signalc stack
	docker-compose -f docker-compose-sc.yml down && \
	docker-compose -f docker-compose-sc.yml up -d signalc signalboost ngrok

sc.restart.rebuild: ## restart signalc stack after rebuilding signalc
	docker-compose -f docker-compose-sc.yml down && \
	./bin/sc/build && \
	docker-compose -f docker-compose-sc.yml up -d signalc signalboost ngrok

sc.restart.debug: ## restart signalc stack in dev mode w/ debug flags on
	docker-compose -f docker-compose-sc.yml down && \
	DEBUG_MODE=1 LOG_LEVEL=debug \
	docker-compose -f docker-compose-sc.yml up -d signalc_dev signalboost ngrok

sc.db.up: ## run the signalc db in isolation (useful for tests)
	docker-compose -f docker-compose-sc.yml up -d db

sc.db.down: ## stop the signalc db in isolation (useful for tests)
	docker-compose -f docker-compose-sc.yml stop db

sc.db.migrate: ## run migrations
	echo "----- running development migrations" && \
	docker-compose -f docker-compose-sc.yml \
	run -e SIGNALC_ENV=development --entrypoint 'gradle --console=plain update' signalc && \
	echo "----- running test migrations" && \
	docker-compose -f docker-compose-sc.yml \
	run -e SIGNALC_ENV=test --entrypoint 'gradle --console=plain update' signalc && \
	echo "----- run migrations for loadtests w/ 'make load.reseed'"

# TODO: inject the DB_NAME here!!!!
sc.db.rollback: ## run migrations
	echo "----- rolling back 1 development migration" && \
	docker-compose -f docker-compose-sc.yml \
	run -e SIGNALC_ENV=development --entrypoint 'gradle --console=plain rollbackCount -PliquibaseCommandValue=1' signalc && \
	echo "----- rolling back 1 test migration" && \
	docker-compose -f docker-compose-sc.yml \
	run -e SIGNALC_ENV=test --entrypoint 'gradle --console=plain rollbackCount -PliquibaseCommandValue=1' signalc

sc.db.rollback_n: ## run migrations
	echo "----- rolling back $(N) development migrations" && \
	docker-compose -f docker-compose-sc.yml \
	run -e SIGNALC_ENV=development --entrypoint 'gradle --console=plain rollbackCount -PliquibaseCommandValue=$(N)' signalc && \
	echo "----- rolling back $(N) test migrations" && \
	docker-compose -f docker-compose-sc.yml \
	run -e SIGNALC_ENV=test --entrypoint 'gradle --console=plain rollbackCount -PliquibaseCommandValue=$(N)' signalc

sc.db.clear_checksums: ## run migrations
	echo "----- rolling back 1 development migration" && \
	docker-compose -f docker-compose-sc.yml \
	run -e SIGNALC_ENV=development --entrypoint 'gradle --console=plain clearCheckSums' signalc && \
	echo "----- rolling back 1 test migration" && \
	docker-compose -f docker-compose-sc.yml \
	run -e SIGNALC_ENV=test --entrypoint 'gradle --console=plain clearCheckSums' signalc

sc.db.psql: # get a psql shell on signalc db
	./bin/sc/psql

sc.sockclient: # get a socket client to signalc
	nc -U /signalc/message.sock

sc.test: # run signalc tests
	./bin/test/sc


##################################
# run and deploy the splash page #
##################################


splash.setup: ## build dev env for docker site (build docker container, install  npm deps)
	./splash/bin/setup

splash.dev.up: ## run splash site in dev mode
	cd splash && docker-compose -f docker-compose-dev.yml up

splash.dev.down: ## shut down splash dev containers
	cd splash && docker-compose -f docker-compose-dev.yml down

splash.build: ## build production version of splash site
	cd splash && docker-compose run --entrypoint 'gatsby build' splash

splash.prod.up: ## run (already-built) version of splash site
	cd splash && docker-compose up

splash.prod.down: ## shut down splash prod containers
	cd splash && docker-compose down

splash.provision: ## deploy the splash app
	./splash/bin/provision

splash.harden: ## harden the server hosting the splash page
	./splash/bin/harden

splash.deploy: ## deploy the splash app
	./splash/bin/deploy

splash.update: ## install new node dependencies and rebuild docker container if needed
	./splash/bin/update

#############
# run tests #
#############

test.all: ## run all unit and e2e tests
	npx eslint app && ./bin/test/sb-unit && ./bin/test/sb-integration && ./bin/test/sc

test.sb.unit: ## run unit tests
	./bin/test/sb-unit

test.sb.integration: ## run integration tests
	./bin/test/sb-integration

test.sb.lint: ## run linter
	npx eslint app && npx eslint test

test.sb.lint.fix: ## run linter with --fix option to automatically fix what can be
	npx eslint --fix app && npx eslint --fix test

test.sc:
	./bin/test/sc