Makefile

.PHONY: all

# CONFIG ---------------------------------------------------------------------------------------------------------------
ifneq (,$(findstring xterm,${TERM}))
    BLACK   := $(shell tput -Txterm setaf 0)
    RED     := $(shell tput -Txterm setaf 1)
    GREEN   := $(shell tput -Txterm setaf 2)
    YELLOW  := $(shell tput -Txterm setaf 3)
    BLUE    := $(shell tput -Txterm setaf 4)
    MAGENTA := $(shell tput -Txterm setaf 5)
    CYAN    := $(shell tput -Txterm setaf 6)
    WHITE   := $(shell tput -Txterm setaf 7)
    RESET   := $(shell tput -Txterm sgr0)
else
    BLACK   := ""
    RED     := ""
    GREEN   := ""
    YELLOW  := ""
    BLUE    := ""
    MAGENTA := ""
    CYAN    := ""
    WHITE   := ""
    RESET   := ""
endif

COMMAND_COLOR := $(GREEN)
HELP_COLOR := $(BLUE)

IMAGE_NAME=graphicresources/itpg-api-coding-task
IMAGE_TAG_BASE=base
IMAGE_TAG_DEV=development
ASYNC_IMAGE_NAME := asyncapi/generator
ASYNC_OUTPUT_DIRECTORY := asyncapi-docs
PHPUNIT = ./vendor/bin/phpunit
BEHAT = ./vendor/bin/behat
COVERAGE_DIR = coverage/
EXEC_APP = docker exec -it api-coding-task-php
EXEC_APP_NO_IT = docker exec api-coding-task-php
OS_NAME := $(shell uname -s | tr A-Z a-z)
ifeq ($(OS_NAME),darwin)
	NUM_PROCESSORS := $(shell sysctl -n hw.ncpu)
else
	NUM_PROCESSORS := $(shell nproc)
endif


# DEFAULT COMMANDS -----------------------------------------------------------------------------------------------------
all: help

help: ## Listar comandos disponibles en este Makefile
	@echo "╔══════════════════════════════════════════════════════════════════════════════╗"
	@echo "║                           ${CYAN}.:${RESET} AVAILABLE COMMANDS ${CYAN}:.${RESET}                           ║"
	@echo "╚══════════════════════════════════════════════════════════════════════════════╝"
	@echo ""
	@grep -E '^[a-zA-Z_0-9%-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "${COMMAND_COLOR}%-40s${RESET} ${HELP_COLOR}%s${RESET}\n", $$1, $$2}'
	@echo ""


# BUILD COMMANDS -------------------------------------------------------------------------------------------------------
build: build-container composer-install setup-hooks ## Construye las dependencias del proyecto
	docker compose up -d
	$(EXEC_APP) /var/www/wait-for-db.sh
	docker exec -i api-coding-task-db mysql -uroot -proot lotr < ./opt/db/init.sql
	docker exec -i api-coding-task-db mysql -uroot -proot lotr < ./opt/db/init-test.sql
	$(EXEC_APP) /var/www/wait-for-rabbit.sh
	$(EXEC_APP) bin/console messenger:setup-transports

build-container: ## Construye el contenedor de la aplicación
	docker build --no-cache --target development -t $(IMAGE_NAME):$(IMAGE_TAG_DEV) .

composer-install: ## Instala las dependencias via composer
	docker run --rm -v ${PWD}:/var/www -w /var/www $(IMAGE_NAME):$(IMAGE_TAG_DEV) composer install --verbose

composer-update: ## Actualiza las dependencias via composer
	docker run --rm -v ${PWD}:/var/www -w /var/www $(IMAGE_NAME):$(IMAGE_TAG_DEV) composer update --verbose

composer-require: ## Añade nuevas dependencias de producción
	docker run --rm -ti -v ${PWD}:/var/www -w /var/www $(IMAGE_NAME):$(IMAGE_TAG_DEV) composer require --verbose

composer-require-dev: ## Añade nuevas dependencias de desarrollo
	docker run --rm -ti -v ${PWD}:/var/www -w /var/www $(IMAGE_NAME):$(IMAGE_TAG_DEV) composer require --dev --verbose

enter-container-php: ## Entra en el contenedor de PHP
	$(EXEC_APP) /bin/sh

up:
	docker compose up -d

stop:
	docker compose down


# DOC COMMANDS -------------------------------------------------------------------------------------------------------

asyncapi-resolve: ## AsyncAPI generation
	docker run --rm -v $(PWD)/doc/asyncapi:/project wework/speccy resolve asyncapi.yaml > gen/asyncapi.yaml
	git add ./gen/asyncapi.yaml

asyncapi-lint: ## AsyncAPI validation
	docker run --rm -v $(PWD)/doc/asyncapi:/tmp -w /tmp stoplight/spectral lint asyncapi.yaml
	docker run --rm -v $(PWD)/gen:/tmp -v $(PWD)/doc/asyncapi/.spectral.yaml:/tmp/.spectral.yaml -w /tmp stoplight/spectral lint asyncapi.yaml

openapi-resolve: ## Genera la especificación OpenAPI
	docker run --rm -v $(PWD)/doc/openapi:/project wework/speccy resolve openapi.yaml > gen/openapi.yaml
	git add ./gen/openapi.yaml

openapi-lint: ## OpenAPI validation
	docker run --rm -v $(PWD)/doc/openapi:/tmp -w /tmp stoplight/spectral lint openapi.yaml
	docker run --rm -v $(PWD)/gen:/tmp -v $(PWD)/doc/openapi/.spectral.yaml:/tmp/.spectral.yaml -w /tmp stoplight/spectral lint openapi.yaml


# CODE QUALITY COMMANDS -----------------------------------------------------------------------------------------------
php-lint:
	$(EXEC_APP_NO_IT) ./vendor/bin/phpcbf --ignore=migrations/*

phpstan:
	$(EXEC_APP_NO_IT) ./vendor/bin/phpstan analyse -c phpstan.neon  --memory-limit=512M

php-cs-fixe:
	$(EXEC_APP_NO_IT) ./vendor/bin/php-cs-fixer fix --dry-run --diff

composer-validate:
	$(EXEC_APP_NO_IT) composer validate --no-check-lock

rector:
	$(EXEC_APP_NO_IT) ./vendor/bin/rector process

pre-commit: php-lint phpstan rector unit-test-coverage-checker  ## Execute precommit tasks

local-ci:
	make openapi-resolve
	make asyncapi-resolve
	make bdd-test-no-tty

# HELPER COMMANDS -------------------------------------------------------------------------------------------------------
setup-hooks: ## Configure git hooks
	@git config core.hooksPath ./hooks/

# RABBIT COMMANDS ------------------------------------------------------------------------------------------------------
consume-async-events: ## Run the rabbit consumer
	docker exec -i api-coding-task-php bin/console messenger:consume -q events_async

# TESTING COMMANDS ------------------------------------------------------------------------------------------------------
clean-reports:
	@rm -rf report/*

unit-test-coverage-checker:
	$(EXEC_APP_NO_IT) ./coverage-checker.sh

unit-test-no-tty: clean-reports ## Execute unit tests with no coverage
	$(EXEC_APP_NO_IT) php -d memory_limit=-1 ./vendor/bin/phpunit --testsuite Unit --no-coverage --stop-on-failure

unit-test: clean-reports ## Execute unit tests with no coverage
	$(EXEC_APP) php -d memory_limit=-1 ./vendor/bin/phpunit --testsuite Unit --no-coverage --stop-on-failure

unit-test-coverage: clean-reports ## Execute unit tests with coverage
	$(EXEC_APP) php -d memory_limit=-1 ./vendor/bin/phpunit --stop-on-failure

mutant-test: unit-test-coverage ## Execute mutant tests
	$(EXEC_APP) php -d memory_limit=-1 ./vendor/bin/infection --threads=${NUM_PROCESSORS} --coverage=report --skip-initial-tests --show-mutations

bdd-test: ## Execute behat tests
	rm -rf ./var/cache/*
	rm -rf /tmp/symfony-cache
	$(EXEC_APP) vendor/bin/behat --no-snippets --strict

bdd-test-no-tty: ## Execute behat tests
	rm -rf ./var/cache/*
	rm -rf /tmp/symfony-cache
	docker exec -i api-coding-task-db mysql -uroot -proot lotr < ./opt/db/init-test.sql
	${EXEC_APP_NO_IT} vendor/bin/behat --no-snippets --strict


functional-test:
	$(EXEC_APP) bin/console doctrine:fixtures:load --env=test --no-interaction
	$(EXEC_APP) php -d memory_limit=-1 ./vendor/bin/phpunit --testsuite Functional --no-coverage --stop-on-failure