Makefile

# OpenShift settings
OC_VERSION	= v3.11
OC_DATA_DIR	= ${HOME}/.oc/openshift.local.data
OC_SOURCE	= registry.access.redhat.com/openshift3/ose

# PostgreSQL settings
PGSQL_VERSION   = 9.6

# Basic environment settings
PYTHON	= $(shell which python)
TOPDIR  = $(shell pwd)
PYDIR	= koku
APIDOC  = apidoc

# How to execute Django's manage.py
DJANGO_MANAGE = DJANGO_READ_DOT_ENV_FILE=True $(PYTHON) $(PYDIR)/manage.py

# required OpenShift template parameters
# if a value is defined in a parameter file, we try to use that.
# otherwise, we use a default value
NAME = $(or $(shell grep -h '^[^\#]*NAME=' openshift/parameters/* 2>/dev/null | uniq | awk -F= '{print $$2}'), koku)
NAMESPACE = $(or $(shell grep -h '^[^\#]*NAMESPACE=' openshift/parameters/* 2>/dev/null | uniq | awk -F= '{print $$2}'), koku)

OC_TEMPLATE_DIR = $(TOPDIR)/openshift
OC_PARAM_DIR = $(OC_TEMPLATE_DIR)/parameters
OC_TEMPLATES = $(wildcard $(OC_TEMPLATE_DIR))

# Platform differences
#
# - Use 'sudo' on Linux
# - Don't use 'sudo' on MacOS
#
OS := $(shell uname)
ifeq ($(OS),Darwin)
	PREFIX	=
else
	PREFIX	= sudo
endif

define HELP_TEXT =
Please use \`make <target>' where <target> is one of:

--- General Commands ---
  clean                    clean the project directory of any scratch files, bytecode, logs, etc.
  help                     show this message
  html                     create html documentation for the project
  lint                     run linting against the project

--- Commands using local services ---
  create-test-customer     create a test customer and tenant in the database
  collect-static           collect static files to host
  make-migrations          make migrations for the database
  requirements             generate Pipfile.lock and RTD requirements
  remove-db                remove local directory: $(TOPDIR)/pg_data
  run-migrations           run migrations against database
  serve                    run the Django app on localhost
  superuser                create a Django super user
  unittest                 run unittests

--- Commands using Docker Compose ---
  docker-up                 run django and database
  docker-up-db              run database only
  docker-down               shut down all containers
  docker-rabbit             run RabbitMQ container
  docker-reinitdb           drop and recreate the database
  docker-shell              run Django and database containers with shell access to server (for pdb)
  docker-logs               connect to console logs for all services
  docker-test-all           run unittests

--- Commands using an OpenShift Cluster ---
  oc-clean                     stop openshift cluster & remove local config data
  oc-create-all                create all application pods
  oc-create-celery-exporter    create the Celery Prometheus exporter pod
  oc-create-celery-scheduler   create the Celery scheduler pod
  oc-create-celery-worker      create the Celery worker pod
  oc-create-configmap          create the ConfigMaps
  oc-create-database           create the PostgreSQL DB pod
  oc-create-flower             create the Celery Flower pod
  oc-create-imagestream        create ImageStreams
  oc-create-koku-api           create the Koku API pod
  oc-create-koku-auth-cache    create the Redis pod for auth caching
  oc-create-listener           create Masu Listener pod (deprecated)
  oc-create-masu               create Masu pod (deprecated)
  oc-create-rabbitmq           create RabbitMQ pod
  oc-create-route              create routes for Koku APIs
  oc-create-secret             create Secrets
  oc-create-worker             create Celery worker pod
  oc-delete-all                delete most Openshift objects without a cluster restart
  oc-delete-celery-worker      delete the Celery worker pod
  oc-delete-configmap          delete the ConfigMaps
  oc-delete-database           delete the PostgreSQL DB pod
  oc-delete-flower             delete the Celery Flower pod
  oc-delete-imagestream        delete ImageStreams
  oc-delete-koku-api           delete the Koku API pod
  oc-delete-koku-auth-cache    delete the Redis pod for auth caching
  oc-delete-listener           delete Masu Listener pod (deprecated)
  oc-delete-masu               delete Masu pod (deprecated)
  oc-delete-rabbitmq           delete RabbitMQ pod
  oc-delete-secret             delete Secrets
  oc-delete-worker             delete Celery worker pod
  oc-down                      stop app & openshift cluster
  oc-forward-ports             port forward the DB to localhost
  oc-login-dev                 login to an openshift cluster as 'developer'
  oc-reinit                    remove existing app and restart app in initialized openshift cluster
  oc-run-migrations            run Django migrations in the Openshift DB
  oc-stop-forwarding-ports     stop port forwarding the DB to localhost
  oc-up                        initialize an openshift cluster
  oc-up-all                    run app in openshift cluster
  oc-up-db                     run Postgres in an openshift cluster
endef
export HELP_TEXT

# help always comes first.
help:
	@echo "$$HELP_TEXT"


### General Commands ###

clean:
	git clean -fdx -e .idea/ -e *env/

html:
	@cd docs; $(MAKE) html

lint:
	tox -e lint

create-test-customer: run-migrations
	sleep 1
	$(DJANGO_MANAGE) runserver > /dev/null 2>&1 &
	sleep 5
	$(PYTHON) $(TOPDIR)/scripts/create_test_customer.py --bypass-api || echo "WARNING: create_test_customer failed unexpectedly!"
	kill -HUP $$(ps -eo pid,command | grep "manage.py runserver" | grep -v grep | awk '{print $$1}')

collect-static:
	$(DJANGO_MANAGE) collectstatic --no-input

make-migrations:
	$(DJANGO_MANAGE) makemigrations api reporting reporting_common cost_models

remove-db:
	$(PREFIX) rm -rf $(TOPDIR)/pg_data

requirements:
	pipenv lock
	pipenv lock -r > docs/rtd_requirements.txt

run-migrations:
	$(DJANGO_MANAGE) migrate_schemas

serve:
	$(DJANGO_MANAGE) runserver

# FIXME: (deprecated) this will be removed after masu is fully merged.
serve-masu:
	FLASK_APP=masu \
	FLASK_ENV=development \
	MASU_SECRET_KEY='t@@ m4nY 53Cr3tZ' \
	flask run

unittest:
	$(DJANGO_MANAGE) test $(PYDIR) -v 2

superuser:
	$(DJANGO_MANAGE) createsuperuser

####################################
# Commands using OpenShift Cluster #
####################################

oc-clean: oc-down
	$(PREFIX) rm -rf $(OC_DATA_DIR)

oc-create-all: oc-create-database oc-create-rabbitmq oc-create-koku-auth-cache oc-create-koku-api oc-create-masu oc-create-celery-exporter oc-create-celery-scheduler oc-create-celery-worker oc-create-flower oc-create-listener

oc-create-celery-exporter: OC_OBJECT := dc/$(NAME)-celery-exporter
oc-create-celery-exporter: OC_PARAMETER_FILE := celery-exporter.env
oc-create-celery-exporter: OC_TEMPLATE_FILE := celery-exporter.yaml
oc-create-celery-exporter: OC_PARAMS := OC_OBJECT=$(OC_OBJECT) OC_PARAMETER_FILE=$(OC_PARAMETER_FILE) OC_TEMPLATE_FILE=$(OC_TEMPLATE_FILE)
oc-create-celery-exporter:
	$(OC_PARAMS) $(MAKE) oc-create-imagestream
	$(OC_PARAMS) $(MAKE) oc-create-configmap
	$(OC_PARAMS) $(MAKE) oc-create-secret
	$(OC_PARAMS) $(MAKE) __oc-apply-object
	$(OC_PARAMS) $(MAKE) __oc-create-object

oc-create-celery-scheduler: OC_OBJECT := 'bc/$(NAME)-scheduler dc/$(NAME)-scheduler'
oc-create-celery-scheduler: OC_PARAMETER_FILE := celery-scheduler.env
oc-create-celery-scheduler: OC_TEMPLATE_FILE := celery-scheduler.yaml
oc-create-celery-scheduler: OC_PARAMS := OC_OBJECT=$(OC_OBJECT) OC_PARAMETER_FILE=$(OC_PARAMETER_FILE) OC_TEMPLATE_FILE=$(OC_TEMPLATE_FILE)
oc-create-celery-scheduler:
	$(OC_PARAMS) $(MAKE) oc-create-imagestream
	$(OC_PARAMS) $(MAKE) oc-create-configmap
	$(OC_PARAMS) $(MAKE) oc-create-secret
	$(OC_PARAMS) $(MAKE) __oc-apply-object
	$(OC_PARAMS) $(MAKE) __oc-create-object

oc-create-celery-worker: OC_OBJECT := 'sts/$(NAME)-worker'
oc-create-celery-worker: OC_PARAMETER_FILE := celery-worker.env
oc-create-celery-worker: OC_TEMPLATE_FILE := celery-worker.yaml
oc-create-celery-worker: OC_PARAMS := OC_OBJECT=$(OC_OBJECT) OC_PARAMETER_FILE=$(OC_PARAMETER_FILE) OC_TEMPLATE_FILE=$(OC_TEMPLATE_FILE)
oc-create-celery-worker:
	$(OC_PARAMS) $(MAKE) oc-create-imagestream
	$(OC_PARAMS) $(MAKE) oc-create-configmap
	$(OC_PARAMS) $(MAKE) oc-create-secret
	$(OC_PARAMS) $(MAKE) __oc-apply-object
	$(OC_PARAMS) $(MAKE) __oc-create-object

oc-create-configmap: OC_OBJECT := 'configmap -l app=$(NAME)'
oc-create-configmap: OC_PARAMETER_FILE := configmap.env
oc-create-configmap: OC_TEMPLATE_FILE := configmap.yaml
oc-create-configmap: OC_PARAMS := OC_OBJECT=$(OC_OBJECT) OC_PARAMETER_FILE=$(OC_PARAMETER_FILE) OC_TEMPLATE_FILE=$(OC_TEMPLATE_FILE)
oc-create-configmap:
	$(OC_PARAMS) $(MAKE) __oc-create-object

oc-create-database: OC_OBJECT := 'bc/$(NAME)-db dc/$(NAME)-db'
oc-create-database: OC_PARAMETER_FILE := $(NAME)-database.env
oc-create-database: OC_TEMPLATE_FILE := $(NAME)-database.yaml
oc-create-database: OC_PARAMS := OC_OBJECT=$(OC_OBJECT) OC_PARAMETER_FILE=$(OC_PARAMETER_FILE) OC_TEMPLATE_FILE=$(OC_TEMPLATE_FILE)
oc-create-database:
	$(OC_PARAMS) $(MAKE) oc-create-imagestream
	$(OC_PARAMS) $(MAKE) oc-create-configmap
	$(OC_PARAMS) $(MAKE) oc-create-secret
	$(OC_PARAMS) $(MAKE) __oc-apply-object
	$(OC_PARAMS) $(MAKE) __oc-create-object

oc-create-flower: OC_OBJECT := 'bc/$(NAME)-flower dc/$(NAME)-flower'
oc-create-flower: OC_PARAMETER_FILE := celery-flower.env
oc-create-flower: OC_TEMPLATE_FILE := celery-flower.yaml
oc-create-flower: OC_PARAMS := OC_OBJECT=$(OC_OBJECT) OC_PARAMETER_FILE=$(OC_PARAMETER_FILE) OC_TEMPLATE_FILE=$(OC_TEMPLATE_FILE)
oc-create-flower:
	$(OC_PARAMS) $(MAKE) oc-create-imagestream
	$(OC_PARAMS) $(MAKE) oc-create-configmap
	$(OC_PARAMS) $(MAKE) oc-create-secret
	$(OC_PARAMS) $(MAKE) __oc-apply-object
	$(OC_PARAMS) $(MAKE) __oc-create-object

oc-create-imagestream: OC_OBJECT := 'is/centos is/python-36-centos7 is/postgresql'
oc-create-imagestream: OC_PARAMETER_FILE := imagestream.env
oc-create-imagestream: OC_TEMPLATE_FILE := imagestream.yaml
oc-create-imagestream: OC_PARAMS := OC_OBJECT=$(OC_OBJECT) OC_PARAMETER_FILE=$(OC_PARAMETER_FILE) OC_TEMPLATE_FILE=$(OC_TEMPLATE_FILE)
oc-create-imagestream:
	$(OC_PARAMS) $(MAKE) __oc-apply-object
	$(OC_PARAMS) $(MAKE) __oc-create-object

oc-create-koku-api: OC_OBJECT := 'bc/$(NAME) dc/$(NAME)'
oc-create-koku-api: OC_PARAMETER_FILE := $(NAME).env
oc-create-koku-api: OC_TEMPLATE_FILE := $(NAME).yaml
oc-create-koku-api: OC_PARAMS := OC_OBJECT=$(OC_OBJECT) OC_PARAMETER_FILE=$(OC_PARAMETER_FILE) OC_TEMPLATE_FILE=$(OC_TEMPLATE_FILE)
oc-create-koku-api:
	$(OC_PARAMS) $(MAKE) oc-create-imagestream
	$(OC_PARAMS) $(MAKE) oc-create-configmap
	$(OC_PARAMS) $(MAKE) oc-create-secret
	$(OC_PARAMS) $(MAKE) __oc-apply-object
	$(OC_PARAMS) $(MAKE) __oc-create-object

oc-create-koku-auth-cache: OC_OBJECT := 'dc/$(NAME)-redis'
oc-create-koku-auth-cache: OC_PARAMETER_FILE := $(NAME)-auth-cache.env
oc-create-koku-auth-cache: OC_TEMPLATE_FILE := $(NAME)-auth-cache.yaml
oc-create-koku-auth-cache: OC_PARAMS := OC_OBJECT=$(OC_OBJECT) OC_PARAMETER_FILE=$(OC_PARAMETER_FILE) OC_TEMPLATE_FILE=$(OC_TEMPLATE_FILE)
oc-create-koku-auth-cache:
	$(OC_PARAMS) $(MAKE) oc-create-imagestream
	$(OC_PARAMS) $(MAKE) oc-create-configmap
	$(OC_PARAMS) $(MAKE) oc-create-secret
	$(OC_PARAMS) $(MAKE) __oc-apply-object
	$(OC_PARAMS) $(MAKE) __oc-create-object

oc-create-listener: OC_OBJECT := 'sts/$(NAME)-listener'
oc-create-listener: OC_PARAMETER_FILE := masu-listener.env
oc-create-listener: OC_TEMPLATE_FILE := masu-listener.yaml
oc-create-listener: OC_PARAMS := OC_OBJECT=$(OC_OBJECT) OC_PARAMETER_FILE=$(OC_PARAMETER_FILE) OC_TEMPLATE_FILE=$(OC_TEMPLATE_FILE)
oc-create-listener:
	$(OC_PARAMS) $(MAKE) oc-create-imagestream
	$(OC_PARAMS) $(MAKE) oc-create-configmap
	$(OC_PARAMS) $(MAKE) oc-create-secret
	$(OC_PARAMS) $(MAKE) __oc-apply-object
	$(OC_PARAMS) $(MAKE) __oc-create-object

oc-create-masu: OC_OBJECT := 'bc/$(NAME)-masu dc/$(NAME)-masu'
oc-create-masu: OC_PARAMETER_FILE := masu.env
oc-create-masu: OC_TEMPLATE_FILE := masu.yaml
oc-create-masu: OC_PARAMS := OC_OBJECT=$(OC_OBJECT) OC_PARAMETER_FILE=$(OC_PARAMETER_FILE) OC_TEMPLATE_FILE=$(OC_TEMPLATE_FILE)
oc-create-masu:
	$(OC_PARAMS) $(MAKE) oc-create-imagestream
	$(OC_PARAMS) $(MAKE) oc-create-configmap
	$(OC_PARAMS) $(MAKE) oc-create-secret
	$(OC_PARAMS) $(MAKE) __oc-apply-object
	$(OC_PARAMS) $(MAKE) __oc-create-object

oc-create-rabbitmq: OC_OBJECT := statefulsets/rabbitmq
oc-create-rabbitmq: OC_PARAMETER_FILE := rabbitmq.env
oc-create-rabbitmq: OC_TEMPLATE_FILE := rabbitmq.yaml
oc-create-rabbitmq: OC_PARAMS := OC_OBJECT=$(OC_OBJECT) OC_PARAMETER_FILE=$(OC_PARAMETER_FILE) OC_TEMPLATE_FILE=$(OC_TEMPLATE_FILE)
oc-create-rabbitmq:
	$(OC_PARAMS) $(MAKE) __oc-apply-object
	$(OC_PARAMS) $(MAKE) __oc-create-object

oc-create-route: OC_OBJECT := 'route/koku route/koku-masu'
oc-create-route: OC_PARAMETER_FILE := route.env
oc-create-route: OC_TEMPLATE_FILE := route.yaml
oc-create-route: OC_PARAMS := OC_OBJECT=$(OC_OBJECT) OC_PARAMETER_FILE=$(OC_PARAMETER_FILE) OC_TEMPLATE_FILE=$(OC_TEMPLATE_FILE)
oc-create-route:
	$(OC_PARAMS) $(MAKE) __oc-apply-object
	$(OC_PARAMS) $(MAKE) __oc-create-object

oc-create-secret: OC_OBJECT := 'secret -l app=$(NAME)'
oc-create-secret: OC_PARAMETER_FILE := secret.env
oc-create-secret: OC_TEMPLATE_FILE := secret.yaml
oc-create-secret: OC_PARAMS := OC_OBJECT=$(OC_OBJECT) OC_PARAMETER_FILE=$(OC_PARAMETER_FILE) OC_TEMPLATE_FILE=$(OC_TEMPLATE_FILE)
oc-create-secret:
	$(OC_PARAMS) $(MAKE) __oc-create-object

oc-delete-all:
	oc delete all -l app=koku

# it's the only way to be sure...
oc-nuke-from-orbit:
	oc delete all,configmap,secret,pvc -l app=koku

oc-delete-celery-exporter:
	oc delete all -n $(NAMESPACE) -l template=koku-celery-exporter

oc-delete-celery-scheduler:
	oc delete all -n $(NAMESPACE) -l template=koku-celery-scheduler

oc-delete-celery-worker:
	oc delete all -n $(NAMESPACE) -l template=koku-celery-worker

oc-delete-configmap:
	oc delete configmap -n $(NAMESPACE) -l template=koku-configmap

oc-delete-database:
	oc delete all -n $(NAMESPACE) -l template=koku-database

oc-delete-flower:
	oc delete all -n $(NAMESPACE) -l template=koku-celery-flower

oc-delete-imagestream:
	oc delete all -n $(NAMESPACE) -l template=koku-imagestream

oc-delete-koku-api:
	oc delete all -n $(NAMESPACE) -l template=koku

oc-delete-koku-auth-cache:
	oc delete all -n $(NAMESPACE) -l template=koku-auth-cache

oc-delete-listener:
	oc delete all -n $(NAMESPACE) -l template=koku-masu-listener

oc-delete-masu:
	oc delete all -n $(NAMESPACE) -l template=koku-masu

oc-delete-rabbitmq:
	oc delete all -n $(NAMESPACE) -l template=rabbitmq

oc-delete-route:
	oc delete all -n $(NAMESPACE) -l template=koku-route

oc-delete-secret:
	oc delete secret -n $(NAMESPACE) -l template=koku-secret

oc-down:
	oc cluster down

oc-forward-ports: oc-stop-forwarding-ports
	@oc port-forward $$(oc get pods -o jsonpath='{.items[?(.status.phase=="Running")].metadata.name}' -l name=koku-db) 15432:5432 >/dev/null 2>&1 &

oc-login-dev:
	oc login -u developer --insecure-skip-tls-verify=true localhost:8443

oc-make-migrations: oc-forward-ports
	sleep 1
	$(DJANGO_MANAGE) makemigrations api reporting reporting_common cost_models
	$(MAKE) oc-stop-forwarding-ports

oc-reinit: oc-delete-all oc-create-koku

oc-run-migrations: oc-forward-ports
	sleep 1
	$(DJANGO_MANAGE) migrate_schemas
	$(MAKE) oc-stop-forwarding-ports

oc-stop-forwarding-ports:
	@kill -HUP $$(ps -eo pid,command | grep "oc port-forward" | grep -v grep | awk '{print $$1}') 2>/dev/null || true

oc-up:
	oc cluster up \
		--image=$(OC_SOURCE) \
		--version=$(OC_VERSION) \
		--host-data-dir=$(OC_DATA_DIR) \
		--use-existing-config=true
	sleep 60

oc-up-all: oc-up oc-create-koku

oc-up-db: oc-up oc-create-db


###############################
### Docker-compose Commands ###
###############################

docker-down:
	docker-compose down

docker-down-db:
	docker-compose stop db
	docker container rm $(shell docker ps -a -f name=koku_db -q)

docker-logs:
	docker-compose logs -f

docker-rabbit:
	docker-compose up -d rabbit

docker-reinitdb: docker-down-db remove-db docker-up-db
	sleep 5
	$(MAKE) create-test-customer

docker-shell:
	docker-compose run --service-ports koku-server

docker-test-all:
	docker-compose -f koku-test.yml up --build

docker-up:
	docker-compose up --build -d

docker-up-db:
	docker-compose up -d db

########################
### Internal targets ###
########################

__oc-create-project:
	@if [[ ! $$(oc get -o name project/$(NAMESPACE) 2>/dev/null) ]]; then \
		oc new-project $(NAMESPACE) ;\
	fi

# if object doesn't already exist,
# create it from the provided template and parameters
__oc-create-object: __oc-create-project
	@if [[ $$(oc get -o name $(OC_OBJECT) 2>&1) == '' ]] || \
	[[ $$(oc get -o name $(OC_OBJECT) 2>&1 | grep 'not found') ]]; then \
		if [ -f $(OC_PARAM_DIR)/$(OC_PARAMETER_FILE) ]; then \
			oc process -f $(OC_TEMPLATE_DIR)/$(OC_TEMPLATE_FILE) \
				--param-file=$(OC_PARAM_DIR)/$(OC_PARAMETER_FILE) \
			| oc create --save-config=True -n $(NAMESPACE) -f - 2>&1 || /usr/bin/true ;\
		else \
			oc process -f $(OC_TEMPLATE_DIR)/$(OC_TEMPLATE_FILE) \
				$(foreach PARAM, $(OC_PARAMETERS), -p $(PARAM)) \
			| oc create --save-config=True -n $(NAMESPACE) -f - 2>&1 || /usr/bin/true ;\
		fi ;\
	fi

__oc-apply-object: __oc-create-project
	@if [[ $$(oc get -o name $(OC_OBJECT)) != '' ]] || \
	[[ $$(oc get -o name $(OC_OBJECT) 2>&1 | grep -v 'not found') ]]; then \
		echo "WARNING: Resources matching 'oc get $(OC_OBJECT)' exists. Updating template. Skipping object creation." ;\
		if [ -f $(OC_PARAM_DIR)/$(OC_PARAMETER_FILE) ]; then \
			bash -c "oc process -f $(OC_TEMPLATE_DIR)/$(OC_TEMPLATE_FILE) \
				--param-file=$(OC_PARAM_DIR)/$(OC_PARAMETER_FILE) \
			| tee >(oc apply -n $(NAMESPACE) -f -) >(oc replace -f -) || /usr/bin/true" ;\
		else \
			bash -c "oc process -f $(OC_TEMPLATE_DIR)/$(OC_TEMPLATE_FILE) \
				$(foreach PARAM, $(OC_PARAMETERS), -p $(PARAM)) \
			| tee >(oc apply -n $(NAMESPACE) -f -) >(oc replace -f -) || /usr/bin/true" ;\
		fi ;\
	fi

#
# Phony targets
#
.PHONY: docs __oc-create-object __oc-create-project __oc-apply-object