Makefile

# Modifications Copyright (c) 2023 Ctrl IQ, Inc.

PYTHON := $(notdir $(shell for i in python3.14 python3; do command -v $$i; done|sed 1q))
SHELL := bash
DOCKER_COMPOSE ?= docker compose
OFFICIAL ?= no
NODE ?= node
NPM_BIN ?= npm
KIND_BIN ?= $(shell which kind)
CHROMIUM_BIN=/tmp/chrome-linux/chrome
GIT_BRANCH ?= $(shell git rev-parse --abbrev-ref HEAD)
MANAGEMENT_COMMAND ?= ascender-manage
VERSION ?= $(shell $(PYTHON) tools/scripts/scm_version.py 2> /dev/null)

# NOTE: This defaults the container image version to the branch that's active
COMPOSE_TAG ?= $(GIT_BRANCH)
MAIN_NODE_TYPE ?= hybrid
# If set to true docker-compose will also start a pgbouncer instance and use it
PGBOUNCER ?= false
# If set to true docker-compose will also start a keycloak instance
KEYCLOAK ?= false
# If set to true docker-compose will also start an ldap instance
LDAP ?= false
# If set to true docker-compose will also start a hashicorp vault instance
VAULT ?= false
# If set to true docker-compose will also start a hashicorp vault instance with TLS enabled
VAULT_TLS ?= false
# If set to true docker-compose will also start a tacacs+ instance
TACACS ?= false

EDITABLE_DEPENDENCIES ?= false

VENV_BASE ?= /var/lib/ascender/venv

DEV_DOCKER_OWNER ?= ctrliq
# Docker will only accept lowercase, so github names like Paul need to be paul
DEV_DOCKER_OWNER_LOWER = $(shell echo $(DEV_DOCKER_OWNER) | tr A-Z a-z)
DEV_DOCKER_TAG_BASE ?= ghcr.io/$(DEV_DOCKER_OWNER_LOWER)
DEVEL_IMAGE_NAME ?= $(DEV_DOCKER_TAG_BASE)/ascender_devel:$(COMPOSE_TAG)

#RECEPTOR_IMAGE ?= quay.io/ansible/receptor:v1.5.7
RECEPTOR_IMAGE ?= quay.io/ansible/receptor:devel

# Python packages to install only from source (not from binary wheels)
# Comma separated list
SRC_ONLY_PKGS ?= cffi,pycparser,psycopg,twilio
# These should be upgraded in the Ascender and Ansible venv before attempting
# to install the actual requirements
VENV_BOOTSTRAP ?= pip==26.2.1 setuptools==84.0.0 setuptools_scm[toml]==10.2.3 wheel==0.48.0

NAME ?= ascender

# TAR build parameters
SDIST_TAR_NAME=$(NAME)-$(VERSION)

SDIST_COMMAND ?= sdist
SDIST_TAR_FILE ?= $(SDIST_TAR_NAME).tar.gz

I18N_FLAG_FILE = .i18n_built

## PLATFORMS defines the target platforms for  the manager image be build to provide support to multiple
PLATFORMS ?= linux/amd64,linux/arm64  # linux/ppc64le,linux/s390x

.PHONY: ascender-link clean clean-tmp clean-venv requirements requirements_dev \
	develop refresh adduser migrate dbchange \
	receiver test test_unit test_coverage coverage_html \
	sdist \
	ui-release ui-devel \
	VERSION PYTHON_VERSION docker-compose-sources \
	.git/hooks/pre-commit

clean-tmp:
	rm -rf tmp/

clean-venv:
	rm -rf venv/

clean-dist:
	rm -rf dist

clean-schema:
	rm -rf swagger.json
	rm -rf schema.json
	rm -rf reference-schema.json

clean-languages:
	rm -f $(I18N_FLAG_FILE)
	find ./ascender/locale/ -type f -regex '.*\.mo$$' -delete

## Remove temporary build files, compiled Python files.
clean: clean-ui clean-api clean-dist
	rm -rf ascender/public
	rm -rf ascender/lib/site-packages
	rm -rf ascender/job_status
	rm -rf ascender/job_output
	rm -rf reports
	rm -rf tmp
	rm -rf $(I18N_FLAG_FILE)
	mkdir tmp

clean-api:
	rm -rf build $(NAME)-$(VERSION) *.egg-info
	rm -rf .tox
	find . -type f -regex ".*\.py[co]$$" -delete
	find . -depth -type d -name "__pycache__" -delete
	rm -rf requirements/vendor
	rm -rf ascender/projects

## convenience target to assert environment variables are defined
guard-%:
	@if [ "$${$*}" = "" ]; then \
	    echo "The required environment variable '$*' is not set"; \
	    exit 1; \
	fi

virtualenv: virtualenv_ascender

# flit is needed for offline install of certain packages, specifically ptyprocess
# it is needed for setup, but not always recognized as a setup dependency
# similar to pip, setuptools, and wheel, these are all needed here as a bootstrapping issues
virtualenv_ascender:
	if [ "$(VENV_BASE)" ]; then \
		if [ ! -d "$(VENV_BASE)" ]; then \
			mkdir $(VENV_BASE); \
		fi; \
		if [ ! -e "$(VENV_BASE)/ascender" ] && [ -d "$(VENV_BASE)/awx" ] && [ ! -L "$(VENV_BASE)/awx" ]; then \
			echo "Moving $(VENV_BASE)/awx to $(VENV_BASE)/ascender, and linking the old name to it."; \
			mv $(VENV_BASE)/awx $(VENV_BASE)/ascender; \
		fi; \
		if [ ! -d "$(VENV_BASE)/ascender" ]; then \
			$(PYTHON) -m venv $(VENV_BASE)/ascender; \
			$(VENV_BASE)/ascender/bin/pip install $(PIP_OPTIONS) $(VENV_BOOTSTRAP); \
		fi; \
		if [ ! -e "$(VENV_BASE)/awx" ] || [ -L "$(VENV_BASE)/awx" ]; then \
			ln -sfn ascender $(VENV_BASE)/awx; \
		fi; \
	fi

## Install third-party requirements needed for Ascender's environment.
# this does not use system site packages intentionally
requirements_ascender: virtualenv_ascender
	if [[ "$(PIP_OPTIONS)" == *"--no-index"* ]]; then \
	    cat requirements/requirements.txt requirements/requirements_local.txt | UWSGI_PROFILE_OVERRIDE=xml=false $(VENV_BASE)/ascender/bin/pip install $(PIP_OPTIONS) -r /dev/stdin ; \
	else \
	    cat requirements/requirements.txt requirements/requirements_git.txt | UWSGI_PROFILE_OVERRIDE=xml=false $(VENV_BASE)/ascender/bin/pip install $(PIP_OPTIONS) --no-binary $(SRC_ONLY_PKGS) -r /dev/stdin ; \
	fi
	$(VENV_BASE)/ascender/bin/pip uninstall --yes -r requirements/requirements_tower_uninstall.txt

requirements_ascender_dev:
	UWSGI_PROFILE_OVERRIDE=xml=false $(VENV_BASE)/ascender/bin/pip install -r requirements/requirements_dev.txt

requirements: requirements_ascender

requirements_dev: requirements_ascender requirements_ascender_dev

requirements_test: requirements

## "Install" the ascender package in development mode.
develop:
	@if [ "$(VIRTUAL_ENV)" ]; then \
	    pip uninstall -y awx; \
	    $(PYTHON) setup.py develop; \
	else \
	    pip uninstall -y awx; \
	    $(PYTHON) setup.py develop; \
	fi

## Refresh development environment after pulling new code.
refresh: clean requirements_dev develop migrate

## Create Django superuser.
adduser:
	$(MANAGEMENT_COMMAND) createsuperuser

## Create database tables and apply any new migrations.
migrate:
	if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	$(MANAGEMENT_COMMAND) migrate --noinput

## Run after making changes to the models to create a new migration.
dbchange:
	$(MANAGEMENT_COMMAND) makemigrations

supervisor:
	@if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	supervisord --pidfile=/tmp/supervisor_pid -n -c /etc/supervisord.conf

collectstatic:
	@if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	$(PYTHON) manage.py collectstatic --clear --noinput > /dev/null 2>&1

# uwsgi ran five worker processes, so the ASGI server starts with the same.
UVICORN_WORKERS ?= 5

## Run the ASGI server that answers both the API and the websockets.
# AWX_MOUNT_PATH is the ingress prefix the stack serves under, and --root-path is
# what uwsgi's mount did with it: tell the application which prefix nginx has
# already matched, so a reverse URL carries it and a request below it resolves.
#
# uvicorn builds the request path as root_path + path, so the prefix must not
# end in a slash: "/" or "/awx/" would turn /api/ into //api/ and 404 every
# request. The trailing slash is stripped, which also makes the compose
# default of "/" mean what uwsgi's mount made it mean: no prefix at all.
uvicorn: collectstatic
	@if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	root_path="$${AWX_MOUNT_PATH%/}"; \
	uvicorn --host 127.0.0.1 --port 8051 --workers $(UVICORN_WORKERS) --ws auto --no-server-header \
		$${root_path:+--root-path "$$root_path"} ascender.asgi:channel_layer

ascender-autoreload:
	@/ascender_devel/tools/docker-compose/ascender-autoreload /ascender_devel/ascender

## Run to start the background task dispatcher for development.
dispatcher:
	@if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	$(PYTHON) manage.py run_dispatcher

## Run to start the zeromq callback receiver
receiver:
	@if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	$(PYTHON) manage.py run_callback_receiver

nginx:
	nginx -g "daemon off;"

## Start a Jupyter notebook server in the dev environment (requires a manual
## `pip install notebook`; run `import django; django.setup()` in the first cell).
jupyter:
	@if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	DJANGO_SETTINGS_MODULE=ascender.settings.development $(PYTHON) -m notebook --IdentityProvider.token= --ip 0.0.0.0 --port 9888 --allow-root --no-browser

## Start the rsyslog configurer process in background in development environment.
run-rsyslog-configurer:
	@if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	$(PYTHON) manage.py run_rsyslog_configurer

## Start cache_clear process in background in development environment.
run-cache-clear:
	@if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	$(PYTHON) manage.py run_cache_clear

## Start the wsrelay process in background in development environment.
run-wsrelay:
	@if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	$(PYTHON) manage.py run_wsrelay

## Start the heartbeat process in background in development environment.
run-ws-heartbeat:
	@if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	$(PYTHON) manage.py run_ws_heartbeat

reports:
	mkdir -p $@

## Format the Python source in place. Set RUFF_FORMAT_ARGS=--check to report instead.
format: reports
	@command -v ruff >/dev/null 2>&1 || { echo "could not find ruff on your PATH, you may need to \`pip install ruff\`, or set AWX_IGNORE_RUFF=1" && exit 1; }
	@(set -o pipefail && ruff format $(RUFF_FORMAT_ARGS) ascender | tee reports/format.report)

## Legacy alias for format, so `make black` keeps working in existing habits and scripts.
black: format

## Lint the Python source against the rules selected in pyproject.toml.
lint:
	@command -v ruff >/dev/null 2>&1 || { echo "could not find ruff on your PATH, you may need to \`pip install ruff\`" && exit 1; }
	ruff check ascender

../../.git/hooks/pre-commit:
	@echo "if [ -x pre-commit.sh ]; then" > .git/hooks/pre-commit
	@echo "    ./pre-commit.sh;" >> .git/hooks/pre-commit
	@echo "fi" >> .git/hooks/pre-commit
	@chmod +x .git/hooks/pre-commit

genschema: ascender-link reports
	@if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	$(MANAGEMENT_COMMAND) spectacular --format openapi-json --file schema.json

genschema-yaml: ascender-link reports
	@if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	$(MANAGEMENT_COMMAND) spectacular --format openapi --file schema.yaml
check: format

api-lint:
	RUFF_FORMAT_ARGS="--check" $(MAKE) format
	$(MAKE) lint
	yamllint -s .

## Regenerate the UI's API types from the serializers themselves.
## Run this after any change to a serializer, and commit the result.
##
## openapi-typescript is deliberately not a devDependency: it is a generator
## rather than part of the build, its committed output is what everything else
## consumes, and its peer range wants TypeScript 5 where this project is on 6.
## npx fetches it for the length of this command and leaves nothing behind.
ui-api-types: ascender-link ascender/ui/node_modules
	@if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	$(MANAGEMENT_COMMAND) spectacular --format openapi-json --file ascender/ui/.schema.json
	$(NPM_BIN) --prefix ascender/ui run generate-api-types
	rm -f ascender/ui/.schema.json

## Run egg_info_dev to generate ascender.egg-info for development.
ascender-link:
	[ -d "/ascender_devel/ascender.egg-info" ] || $(PYTHON) /ascender_devel/tools/scripts/egg_info_dev

TEST_DIRS ?= ascender/main/tests/unit ascender/main/tests/functional ascender/conf/tests ascender/sso/tests
PYTEST_ARGS ?= -n auto --dist=loadfile
## Run all API unit tests.
test:
	if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	PYTHONDONTWRITEBYTECODE=1 py.test -p no:cacheprovider $(PYTEST_ARGS) $(TEST_DIRS)
	ascender-manage check_migrations --dry-run --check -n 'missing_migration_file'
	ascender-manage check_settings

## Run all API unit tests without parallel execution (safer but slower).
test-serial:
	if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	PYTHONDONTWRITEBYTECODE=1 py.test -p no:cacheprovider $(TEST_DIRS)
	ascender-manage check_migrations --dry-run --check -n 'missing_migration_file'
	ascender-manage check_settings

## Run tests with limited parallel workers (safer than auto).
test-safe:
	if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	PYTHONDONTWRITEBYTECODE=1 py.test -p no:cacheprovider -n 2 --dist=loadfile $(TEST_DIRS)
	ascender-manage check_migrations --dry-run --check -n 'missing_migration_file'
	ascender-manage check_settings

test_migrations:
	if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	PYTHONDONTWRITEBYTECODE=1 py.test -p no:cacheprovider --migrations -m migration_test $(PYTEST_ARGS) $(TEST_DIRS)

## Runs AWX_DOCKER_CMD inside a new docker container.
# Extra docker flags for the throwaway container. CI sets this to reach the
# PostgreSQL service the suite now needs, e.g.
#   DOCKER_RUNNER_OPTS='--network host -e AWX_TEST_DATABASE_HOST=127.0.0.1'
DOCKER_RUNNER_OPTS ?=

docker-runner:
	docker run -u $(shell id -u) --rm -v $(shell pwd):/ascender_devel/:Z --workdir=/ascender_devel $(DOCKER_RUNNER_OPTS) $(DEVEL_IMAGE_NAME) $(AWX_DOCKER_CMD)

test_unit:
	@if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	py.test ascender/main/tests/unit ascender/conf/tests/unit ascender/sso/tests/unit

## Run all API unit tests with coverage enabled.
test_coverage:
	@if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	py.test --create-db --cov=ascender --cov-report=xml --junitxml=./reports/junit.xml $(TEST_DIRS)

## Output test coverage as HTML (into htmlcov directory).
coverage_html:
	coverage html

## Run API unit tests across multiple Python/Django versions with Tox.
test_tox:
	tox -v


DATA_GEN_PRESET = ""
## Make fake data
bulk_data:
	@if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	$(PYTHON) tools/data_generators/rbac_dummy_data_generator.py --preset=$(DATA_GEN_PRESET)


# UI TASKS
# --------------------------------------

UI_BUILD_FLAG_FILE = ascender/ui/.ui-built

clean-ui:
	rm -rf node_modules
	rm -rf ascender/ui/node_modules
	rm -rf ascender/ui/build
	rm -rf ascender/ui/src/locales/_build
	rm -rf $(UI_BUILD_FLAG_FILE)
        # the collectstatic command doesn't like it if this dir doesn't exist.
	mkdir -p ascender/ui/build/static

ascender/ui/node_modules:
	NODE_OPTIONS=--max-old-space-size=6144 $(NPM_BIN) --prefix ascender/ui --loglevel warn --force ci --ignore-scripts

$(UI_BUILD_FLAG_FILE):
	$(MAKE) ascender/ui/node_modules
	$(PYTHON) tools/scripts/compilemessages.py
	$(NPM_BIN) --prefix ascender/ui --loglevel warn run compile-strings
	$(NPM_BIN) --prefix ascender/ui --loglevel warn run build
	touch $@

ui-release: $(UI_BUILD_FLAG_FILE)

ui-devel: ascender/ui/node_modules
	@$(MAKE) -B $(UI_BUILD_FLAG_FILE)
	@if [ -d "/var/lib/ascender" ] ; then \
		mkdir -p /var/lib/ascender/public/static/css; \
		mkdir -p /var/lib/ascender/public/static/js; \
		mkdir -p /var/lib/ascender/public/static/media; \
		cp -r ascender/ui/build/static/css/* /var/lib/ascender/public/static/css; \
		cp -r ascender/ui/build/static/js/* /var/lib/ascender/public/static/js; \
		cp -r ascender/ui/build/static/media/* /var/lib/ascender/public/static/media; \
	fi

## Start the Vite dev server on port 3001, proxying the API to TARGET.
ui-devel-test: ascender/ui/node_modules
	$(NPM_BIN) --prefix ascender/ui --loglevel warn run start

ui-lint: ascender/ui/node_modules
	$(NPM_BIN) run --prefix ascender/ui lint
	$(NPM_BIN) run --prefix ascender/ui prettier-check
	$(NPM_BIN) run --prefix ascender/ui check-strings

ui-type-check: ascender/ui/node_modules
	$(NPM_BIN) run --prefix ascender/ui type-check

ui-test: ascender/ui/node_modules
	$(NPM_BIN) run --prefix ascender/ui test

ui-test-screens: ascender/ui/node_modules
	$(NPM_BIN) run --prefix ascender/ui pretest
	$(NPM_BIN) run --prefix ascender/ui test-screens

ui-test-general: ascender/ui/node_modules
	$(NPM_BIN) run --prefix ascender/ui pretest
	$(NPM_BIN) run --prefix ascender/ui/ test-general

HEADLESS ?= no
ifeq ($(HEADLESS), yes)
dist/$(SDIST_TAR_FILE):
else
dist/$(SDIST_TAR_FILE): $(UI_BUILD_FLAG_FILE)
endif
	$(PYTHON) -m build -s
	ln -sf $(SDIST_TAR_FILE) dist/ascender.tar.gz
# ascender-install pip installs dist/awx.tar.gz by that path from its own
# repository, so the old name stays beside the new one until it moves.
	ln -sf $(SDIST_TAR_FILE) dist/awx.tar.gz

sdist: dist/$(SDIST_TAR_FILE)
	echo $(HEADLESS)
	@echo "#############################################"
	@echo "Artifacts:"
	@echo dist/$(SDIST_TAR_FILE)
	@echo "#############################################"

# This directory is bind-mounted inside of the development container and
# needs to be pre-created for permissions to be set correctly. Otherwise,
# Docker will create this directory as root.
ascender/projects:
	@mkdir -p $@

COMPOSE_UP_OPTS ?=
COMPOSE_OPTS ?=
CONTROL_PLANE_NODE_COUNT ?= 1
EXECUTION_NODE_COUNT ?= 0
MINIKUBE_CONTAINER_GROUP ?= false
MINIKUBE_SETUP ?= false # if false, run minikube separately
EXTRA_SOURCES_ANSIBLE_OPTS ?=

ifneq ($(ADMIN_PASSWORD),)
	EXTRA_SOURCES_ANSIBLE_OPTS := -e admin_password=$(ADMIN_PASSWORD) $(EXTRA_SOURCES_ANSIBLE_OPTS)
endif

docker-compose-sources: .git/hooks/pre-commit
	@if [ $(MINIKUBE_CONTAINER_GROUP) = true ]; then\
	    ansible-playbook -i tools/docker-compose/inventory -e minikube_setup=$(MINIKUBE_SETUP) tools/docker-compose-minikube/deploy.yml; \
	fi;

	ansible-playbook -i tools/docker-compose/inventory tools/docker-compose/ansible/sources.yml \
	    -e ascender_image=$(DEV_DOCKER_TAG_BASE)/ascender_devel \
	    -e ascender_image_tag=$(COMPOSE_TAG) \
	    -e receptor_image=$(RECEPTOR_IMAGE) \
	    -e control_plane_node_count=$(CONTROL_PLANE_NODE_COUNT) \
	    -e execution_node_count=$(EXECUTION_NODE_COUNT) \
	    -e minikube_container_group=$(MINIKUBE_CONTAINER_GROUP) \
	    -e enable_pgbouncer=$(PGBOUNCER) \
	    -e enable_keycloak=$(KEYCLOAK) \
	    -e enable_ldap=$(LDAP) \
	    -e enable_vault=$(VAULT) \
	    -e vault_tls=$(VAULT_TLS) \
	    -e enable_tacacs=$(TACACS) \
		-e install_editable_dependencies=$(EDITABLE_DEPENDENCIES) \
	    $(EXTRA_SOURCES_ANSIBLE_OPTS)

docker-compose: ascender/projects docker-compose-sources
	ansible-galaxy install --ignore-certs -r tools/docker-compose/ansible/requirements.yml;
	ansible-playbook -i tools/docker-compose/inventory tools/docker-compose/ansible/initialize_containers.yml \
	    -e enable_vault=$(VAULT) \
	    -e vault_tls=$(VAULT_TLS) \
	    -e enable_ldap=$(LDAP); \
	$(MAKE) docker-compose-up

docker-compose-up:
	$(DOCKER_COMPOSE) -f tools/docker-compose/_sources/docker-compose.yml $(COMPOSE_OPTS) up $(COMPOSE_UP_OPTS) --remove-orphans

docker-compose-down:
	$(DOCKER_COMPOSE) -f tools/docker-compose/_sources/docker-compose.yml $(COMPOSE_OPTS) down --remove-orphans

docker-compose-credential-plugins: ascender/projects docker-compose-sources
	echo -e "\033[0;31mTo generate a CyberArk Conjur API key: docker exec -it tools_conjur_1 conjurctl account create quick-start\033[0m"
	$(DOCKER_COMPOSE) -f tools/docker-compose/_sources/docker-compose.yml -f tools/docker-credential-plugins-override.yml up --no-recreate ascender_1 --remove-orphans

docker-compose-test: ascender/projects docker-compose-sources
	$(DOCKER_COMPOSE) -f tools/docker-compose/_sources/docker-compose.yml run --rm --service-ports ascender_1 /bin/bash

docker-compose-runtest: ascender/projects docker-compose-sources
	$(DOCKER_COMPOSE) -f tools/docker-compose/_sources/docker-compose.yml run --rm --service-ports ascender_1 /start_tests.sh

docker-compose-build-schema: ascender/projects docker-compose-sources
	$(DOCKER_COMPOSE) -f tools/docker-compose/_sources/docker-compose.yml run --rm --service-ports --no-deps ascender_1 make genschema

SCHEMA_DIFF_BASE_BRANCH ?= devel
detect-schema-change: genschema
	curl https://s3.amazonaws.com/awx-public-ci-files/$(SCHEMA_DIFF_BASE_BRANCH)/schema.json -o reference-schema.json
	# Ignore differences in whitespace with -b
	# diff exits with 1 when files differ - capture but don't fail
	-diff -u -b reference-schema.json schema.json

docker-compose-clean: ascender/projects
	$(DOCKER_COMPOSE) -f tools/docker-compose/_sources/docker-compose.yml rm -sf

docker-compose-container-group-clean:
	@if [ -f "tools/docker-compose-minikube/_sources/minikube" ]; then \
	    tools/docker-compose-minikube/_sources/minikube delete; \
	fi
	rm -rf tools/docker-compose-minikube/_sources/

.PHONY: Dockerfile.dev
## Generate Dockerfile.dev for ascender_devel image
Dockerfile.dev: tools/ansible/roles/dockerfile/templates/Dockerfile.j2
	ansible-playbook tools/ansible/dockerfile.yml \
		-e dockerfile_name=Dockerfile.dev \
		-e build_dev=True \
		-e receptor_image=$(RECEPTOR_IMAGE)

## Build ascender_devel image for docker compose development environment
docker-compose-build: Dockerfile.dev
	DOCKER_BUILDKIT=1 docker build \
		-f Dockerfile.dev \
		-t $(DEVEL_IMAGE_NAME) \
		--build-arg BUILDKIT_INLINE_CACHE=1 \
		--cache-from=$(DEV_DOCKER_TAG_BASE)/ascender_devel:$(COMPOSE_TAG) .


.PHONY: docker-compose-buildx
## Build awx_devel image for docker compose development environment for multiple architectures
docker-compose-buildx: Dockerfile.dev
	- docker buildx create --name docker-compose-buildx
	docker buildx use docker-compose-buildx
	- docker buildx build \
		--push \
		--build-arg BUILDKIT_INLINE_CACHE=1 \
		--cache-from=$(DEV_DOCKER_TAG_BASE)/ascender_devel:$(COMPOSE_TAG) \
		--platform=$(PLATFORMS) \
		--tag $(DEVEL_IMAGE_NAME) \
		-f Dockerfile.dev .
	- docker buildx rm docker-compose-buildx

docker-clean:
	-$(foreach container_id,$(shell docker ps -f name=tools_awx -aq && docker ps -f name=tools_receptor -aq),docker stop $(container_id); docker rm -f $(container_id);)
	-$(foreach image_id,$(shell docker images --filter=reference='*/*/*ascender_devel*' --filter=reference='*/*ascender_devel*' --filter=reference='*ascender_devel*' -aq),docker rmi --force $(image_id);)

docker-clean-volumes: docker-compose-clean docker-compose-container-group-clean
	docker volume rm -f tools_var_lib_awx tools_awx_db tools_vault_1 tools_ldap_1 $(docker volume ls --filter name=tools_valkey_socket_ -q)

docker-refresh: docker-clean docker-compose

docker-compose-container-group:
	MINIKUBE_CONTAINER_GROUP=true $(MAKE) docker-compose

VERSION:
	@echo "awx: $(VERSION)"

PYTHON_VERSION:
	@echo "$(subst python,,$(PYTHON))"

.PHONY: version-for-buildyml
version-for-buildyml:
	@echo $(firstword $(subst +, ,$(VERSION)))
# version-for-buildyml prints a special version string for build.yml,
# chopping off the sha after the '+' sign.
# tools/ansible/build.yml was doing this: make print-VERSION | cut -d + -f -1
# This does the same thing in native make without
# the pipe or the extra processes, and now the pb does `make version-for-buildyml`
# Example:
# 	22.1.1.dev38+g523c0d9781 becomes 22.1.1.dev38

.PHONY: Dockerfile
## Generate Dockerfile for awx image
Dockerfile: tools/ansible/roles/dockerfile/templates/Dockerfile.j2
	ansible-playbook tools/ansible/dockerfile.yml \
		-e receptor_image=$(RECEPTOR_IMAGE) \
		-e headless=$(HEADLESS)

## Build awx image for deployment on Kubernetes environment.
ascender-kube-build: Dockerfile
	DOCKER_BUILDKIT=1 docker build -f Dockerfile \
		--build-arg VERSION=$(VERSION) \
		--build-arg SETUPTOOLS_SCM_PRETEND_VERSION=$(VERSION) \
		--build-arg HEADLESS=$(HEADLESS) \
		-t $(DEV_DOCKER_TAG_BASE)/ascender:$(COMPOSE_TAG) .

## Build multi-arch awx image for deployment on Kubernetes environment.
ascender-kube-buildx: Dockerfile
	- docker buildx create --name ascender-kube-buildx
	docker buildx use ascender-kube-buildx
	- docker buildx build \
		--push \
		--build-arg VERSION=$(VERSION) \
		--build-arg SETUPTOOLS_SCM_PRETEND_VERSION=$(VERSION) \
		--build-arg HEADLESS=$(HEADLESS) \
		--platform=$(PLATFORMS) \
		--tag $(DEV_DOCKER_TAG_BASE)/ascender:$(COMPOSE_TAG) \
		-f Dockerfile .
	- docker buildx rm ascender-kube-buildx


.PHONY: Dockerfile.kube-dev
## Generate Docker.kube-dev for ascender_kube_devel image
Dockerfile.kube-dev: tools/ansible/roles/dockerfile/templates/Dockerfile.j2
	ansible-playbook tools/ansible/dockerfile.yml \
	    -e dockerfile_name=Dockerfile.kube-dev \
	    -e kube_dev=True \
	    -e template_dest=_build_kube_dev \
	    -e receptor_image=$(RECEPTOR_IMAGE)

## Build ascender_kube_devel image for development on local Kubernetes environment.
ascender-kube-dev-build: Dockerfile.kube-dev
	DOCKER_BUILDKIT=1 docker build -f Dockerfile.kube-dev \
	    --build-arg BUILDKIT_INLINE_CACHE=1 \
	    --cache-from=$(DEV_DOCKER_TAG_BASE)/ascender_kube_devel:$(COMPOSE_TAG) \
	    -t $(DEV_DOCKER_TAG_BASE)/ascender_kube_devel:$(COMPOSE_TAG) .

## Build and push multi-arch ascender_kube_devel image for development on local Kubernetes environment.
ascender-kube-dev-buildx: Dockerfile.kube-dev
	- docker buildx create --name ascender-kube-dev-buildx
	docker buildx use ascender-kube-dev-buildx
	- docker buildx build \
		--push \
		--build-arg BUILDKIT_INLINE_CACHE=1 \
		--cache-from=$(DEV_DOCKER_TAG_BASE)/ascender_kube_devel:$(COMPOSE_TAG) \
		--platform=$(PLATFORMS) \
		--tag $(DEV_DOCKER_TAG_BASE)/ascender_kube_devel:$(COMPOSE_TAG) \
		-f Dockerfile.kube-dev .
	- docker buildx rm ascender-kube-dev-buildx

kind-dev-load: ascender-kube-dev-build
	$(KIND_BIN) load docker-image $(DEV_DOCKER_TAG_BASE)/ascender_kube_devel:$(COMPOSE_TAG)

# Translation TASKS
# --------------------------------------

## generate UI .pot file, an empty template of strings yet to be translated
pot: $(UI_BUILD_FLAG_FILE)
	$(NPM_BIN) --prefix ascender/ui --loglevel warn run extract-template --clean

## generate UI .po files for each locale (will update translated strings for `en`)
po: $(UI_BUILD_FLAG_FILE)
	$(NPM_BIN) --prefix ascender/ui --loglevel warn run extract-strings -- --clean

## generate API django .pot .po
messages:
	@if [ "$(VENV_BASE)" ]; then \
		. $(VENV_BASE)/ascender/bin/activate; \
	fi; \
	$(PYTHON) manage.py makemessages -l en_us --keep-pot

.PHONY: print-%
print-%:
	@echo $($*)

# HELP related targets
# --------------------------------------

HELP_FILTER=.PHONY

## Display help targets
help:
	@printf "Available targets:\n"
	@$(MAKE) -s help/generate | grep -vE "\w($(HELP_FILTER))"

## Display help for all targets
help/all:
	@printf "Available targets:\n"
	@$(MAKE) -s help/generate

## Generate help output from MAKEFILE_LIST
help/generate:
	@awk '/^[-a-zA-Z_0-9%:\\\.\/]+:/ { \
		helpMessage = match(lastLine, /^## (.*)/); \
		if (helpMessage) { \
			helpCommand = $$1; \
			helpMessage = substr(lastLine, RSTART + 3, RLENGTH); \
			gsub("\\\\", "", helpCommand); \
			gsub(":+$$", "", helpCommand); \
			printf "  \x1b[32;01m%-35s\x1b[0m %s\n", helpCommand, helpMessage; \
		} else { \
			helpCommand = $$1; \
			gsub("\\\\", "", helpCommand); \
			gsub(":+$$", "", helpCommand); \
			printf "  \x1b[32;01m%-35s\x1b[0m %s\n", helpCommand, "No help available"; \
		} \
	} \
	{ lastLine = $$0 }' $(MAKEFILE_LIST) | sort -u
	@printf "\n"