Makefile

.PHONY: assets

# Allow non-Docker overrides for CI.
BIN_SHELL = docker compose exec php
_SYMFONY = ${BIN_SHELL} symfony
BIN_PHP = ${BIN_SHELL} php
BIN_CONSOLE = ${_SYMFONY} console
BIN_COMPOSER = ${_SYMFONY} composer
BIN_NPM = ${BIN_SHELL} npm
BIN_NPX = ${BIN_SHELL} npx

# No TTY commands.
_DOCKER_EXEC_PHP_NO_TTY = docker compose exec -T php
_SYMFONY_NO_TTY = ${_DOCKER_EXEC_PHP_NO_TTY} symfony
BIN_PHP_NO_TTY = ${_DOCKER_EXEC_PHP_NO_TTY} php
BIN_CONSOLE_NO_TTY = ${_SYMFONY_NO_TTY} console

##
## ----------------
## General
## ----------------
##

all: help

help: ## Display this message
	@grep -E '(^[a-zA-Z0-9_\-\.]+:.*?##.*$$)|(^##)' Makefile | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}' | sed -e 's/\[32m## /[33m/'

install: build start install_deps dbinstall assets blog_install ## Bootstrap project

install_deps: ## Install dependencies
	make composer CMD="install -n --prefer-dist"
	$(BIN_NPM) ci
	$(BIN_SHELL) chmod -R 777 public/storage

update_deps:
	make composer CMD="update"
	$(BIN_NPM) update

start: ## Start container
	docker compose up -d
	docker compose start

stop: ## Stop containers
	docker compose stop

ps: ## Display containers
	docker compose ps

restart: stop start ## Restart containers

build: ## Build containers
	docker compose build

rm: ## Remove containers
	make stop
	docker compose rm

##
## ----------------
## Database
## ----------------
##

dbinstall: ## Setup databases
	make dbmigrate
	make data_install
	make console CMD="doctrine:database:create --env=test --if-not-exists"
	make dbmigrate ARGS="--env=test"
	make data_install ARGS="--env=test"
	make dbfixtures

dbmigration: ## Generate new db migration
	${BIN_CONSOLE} doctrine:migrations:diff

dbmigrate: ## Run db migration
	${BIN_CONSOLE} doctrine:migrations:migrate -n --all-or-nothing ${ARGS}

bdtopo_migration: ## Generate new db migration for bdtopo
	${BIN_CONSOLE} doctrine:migrations:generate --configuration ./config/packages/bdtopo/doctrine_migrations.yaml

bdtopo_migrate: ## Run db migrations for bdtopo
	${BIN_CONSOLE} doctrine:migrations:migrate -n --all-or-nothing --configuration ./config/packages/bdtopo/doctrine_migrations.yaml ${ARGS}

bdtopo_migrate_redo: ## Revert db migrations for bdtopo and run them again
	# Revert to first migration which creates the postgis extension
	make bdtopo_migrate ARGS="App\\\Infrastructure\\\Persistence\\\Doctrine\\\BdTopoMigrations\\\Version20240320122522"
	# Re-run migrations from there
	make bdtopo_migrate

dbshell: ## Connect to the database
	docker compose exec database psql postgresql://dialog:dialog@database:5432/dialog

dbfixtures: ## Load tests fixtures
	make console CMD="doctrine:fixtures:load --env=test -n --purge-with-truncate"

redisshell: ## Connect to the Redis container
	docker compose exec redis redis-cli

data_install: data_init ## Load data into database
	make console CMD="app:data:fr_city ${ARGS}"

data_init: data/fr_city.sql ## Initialize data sources

data_update: ## Update data sources
	rm -f data/fr_city.sql data/communes.json
	make data_init

data/fr_city.sql: data/communes.json
	${BIN_PHP} tools/mkfrcitysql.php ./data/communes.json ./data/fr_city.sql

data/communes.json:
	curl -L https://unpkg.com/@etalab/decoupage-administratif/data/communes.json > data/communes.json

data_bac_idf_import: # Import BAC-IDF decrees as regulation orders
	make console CMD="app:bac_idf:import ${ARGS}"

data/bac_idf/decrees.json: ## Create BAC-IDF decrees file
	./tools/bacidfinstall

##
## ----------------
## Executable
## ----------------
##

composer: ## Run composer commands
	${BIN_COMPOSER} ${CMD}

console: ## Run console command
	${BIN_CONSOLE} ${CMD}

cc: ## Run clear cache command
	${BIN_CONSOLE} cache:clear

watch: ## Watch assets
	$(BIN_NPM) run watch

assets: ## Build assets
	$(BIN_NPM) run build

shell: ## Connect to the container
	docker compose exec php bash

##
## ----------------
## Quality
## ----------------
##

# Individual tools

phpstan: ## PHP Stan
	${BIN_PHP} ./vendor/bin/phpstan analyse -l 5 src

phpstan_no_tty: ## PHP Stan without TTY
	${BIN_PHP_NO_TTY} ./vendor/bin/phpstan analyse -l 5 src

php_lint: ## PHP linter
	${BIN_PHP} ./vendor/bin/php-cs-fixer fix -n ${ARGS}

php_lint_no_tty: ## PHP linter without TTY
	${BIN_PHP_NO_TTY} ./vendor/bin/php-cs-fixer fix -n ${ARGS}

twig_lint: ## Twig linter
	${BIN_CONSOLE} lint:twig -n templates/

twig_lint_no_tty: ## Twig linter without TTY
	${BIN_CONSOLE_NO_TTY} lint:twig -n templates/

security_check: ## Security checks
	${_SYMFONY} security:check

psr_lint: ## Check PSR autoloading
	${BIN_COMPOSER} dump-autoload --strict-psr

# All-in-one commands

check: ## Run checks
	make php_lint ARGS="--dry-run"
	make psr_lint
	make twig_lint
	make phpstan
	${BIN_CONSOLE} doctrine:schema:validate

husky: ## Husky pre-commit hook
	make php_lint_no_tty ARGS="--dry-run"
	make phpstan_no_tty
	make twig_lint_no_tty

format: php_lint ## Format code

##
## ----------------
## Tests
## ----------------
##

test: ## Run the test suite
	${BIN_PHP} ${OPTIONS} ./bin/phpunit ${ARGS}

test_cov: ## Run the test suite (with code coverage)
	make test OPTIONS="-d xdebug.mode=coverage" ARGS="${ARGS} --coverage-html coverage --coverage-clover coverage.xml"

test_unit: ## Run unit tests only
	${BIN_PHP} ./bin/phpunit --testsuite=Unit ${ARGS}

test_integration: ## Run integration tests only
	${BIN_PHP} ./bin/phpunit --testsuite=Integration ${ARGS}

test_all: ## Run the test suite (with coverage)
	make test_cov

##
## ----------------
## Blog
## ----------------
##

blog_install: blog_install_deps blog_build ## Bootstrap blog

blog_install_deps: ## Install blog dependencies
	${BIN_NPM} run blog_install

blog_build: ## Build blog
	${BIN_NPM} run blog_build

##
## ----------------
## CI
## ----------------
##

ci: ## Run CI steps
	make install_deps
	make assets
	make dbinstall
	make dbfixtures
	make blog_install
	make check
	make test_all

ci_eudonet_paris_import: ## Run CI steps for Eudonet Paris Import workflow
	make composer CMD="install -n --prefer-dist"
	scalingo login --ssh --ssh-identity ~/.ssh/id_rsa
	./tools/scalingodbtunnel ${EUDONET_PARIS_IMPORT_APP} --host-url --port 10000 & ./tools/wait-for-it.sh 127.0.0.1:10000
	make console CMD="app:eudonet_paris:import"

ci_litteralis_mel_import: ## Run CI steps for Litteralis MEL Import workflow
	make composer CMD="install -n --prefer-dist"
	scalingo login --ssh --ssh-identity ~/.ssh/id_rsa
	./tools/scalingodbtunnel ${APP_MEL_IMPORT_APP} --host-url --port 10000 & ./tools/wait-for-it.sh 127.0.0.1:10000
	make console CMD="app:mel:import"

ci_litteralis_fougeres_import: ## Run CI steps for Litteralis Fougeres Import workflow
	make composer CMD="install -n --prefer-dist"
	scalingo login --ssh --ssh-identity ~/.ssh/id_rsa
	./tools/scalingodbtunnel ${APP_FOUGERES_IMPORT_APP} --host-url --port 10000 & ./tools/wait-for-it.sh 127.0.0.1:10000
	make console CMD="app:fougeres:import"

ci_bdtopo_migrate: ## Run CI steps for BD TOPO Migrate workflow
	make composer CMD="install -n --prefer-dist"
	make bdtopo_migrate

ci_metabase_export: ## Export data to Metabase
	scalingo login --ssh --ssh-identity ~/.ssh/id_rsa
	./tools/scalingodbtunnel ${METABASE_DEST_APP} --host-url --port 10001 & ./tools/wait-for-it.sh 127.0.0.1:10001
	./tools/metabase-export.sh ${METABASE_SRC_DATABASE_URL} ${METABASE_DEST_DATABASE_URL}

##
## ----------------
## Prod
## ----------------
##

scalingo-node-postbuild: ## Scalingo postbuild hook for the Node buildpack
	make assets
	make blog_install

scalingo-postdeploy: ## Scalingo postdeploy hook
	@echo 'Executing migrations...'
	php bin/console doctrine:migrations:migrate --no-interaction