Merge pull request #44 from thecodingmachine/upgrade-php8.0

Upgrade to php8.0

Author: mistraloz

.env.dist

@@ -10,7 +10,7 @@ VAGRANT_DOCKER_COMPOSE_VERSION=1.28.2
 # Consider putting here your secrets with dummy values and variables you want to
 # reuse in two or more services.
 
-APP_NAME=Symfony Boilerplate
+APP_NAME="Symfony Boilerplate"
 
 # Domain
 DOMAIN=symfony-boilerplate.localhost
@@ -36,4 +36,7 @@ STORAGE_ACCESS_KEY=accesskey
 STORAGE_SECRET_KEY=secretkey
 
 # i18n
-DEFAULT_LOCALE=en
+DEFAULT_LOCALE=en
+
+# XDebug
+XDEBUG_MODE=debug,coverage

.gitignore

@@ -1,2 +1,2 @@
-Vagrantfile
-.env
+/Vagrantfile
+/.env

.gitlab-ci.yml

@@ -1,7 +1,7 @@
 # Environment Definitions
 
 .api: &api
-  image: thecodingmachine/php:7.4-v4-cli
+  image: thecodingmachine/php:8.0-v4-cli
   variables:
     PHP_EXTENSIONS: gd pdo_mysql xdebug imap intl
     PHP_INI_MEMORY_LIMIT: 1G

Makefile

@@ -2,31 +2,65 @@ include .env
 
 .PHONY: up down webapp api consume vagrant
 
-# Start the Docker Compose stack.
-up:
+.env: ## Setup .env from dist
+	cp .env.dist .env
+
+up: .env ## Start the Docker Compose stack.
 	docker-compose up -d
 
-# Stop the Docker Compose stack.
-down:
+
+down: ## Stop the Docker Compose stack.
 	docker-compose down
 
-# Run bash in the webapp service.
-webapp:
+webapp: ## Run bash in the webapp service.
 	docker-compose exec webapp bash
 
-# Run bash in the api service.
-api:
+api: ## Run bash in the api service.
 	docker-compose exec api bash
 
-# Consume messages from the queue.
-consume:
+consume: ## Consume messages from the queue.
 	docker-compose exec api php bin/console messenger:consume async -vv
 
-# Create the Vagrantfile from the template Vagrantfile.template.
-vagrant:
+vagrant: ## Create the Vagrantfile from the template Vagrantfile.template.
 	./scripts/create-vagrantfile-from-template.sh \
 	$(VAGRANT_BOX) \
 	$(VAGRANT_PROJECT_NAME) \
 	$(VAGRANT_MEMORY) \
 	$(VAGRANT_CPUS) \
 	$(VAGRANT_DOCKER_COMPOSE_VERSION)
+
+.PHONY: create-migrate
+create-migrate: ## Create a new migration file
+	docker-compose exec api bin/console doctrine:database:drop --force
+	docker-compose exec api bin/console doctrine:database:create -n
+	docker-compose exec api bin/console doctrine:migrations:migrate -n
+	docker-compose exec api bin/console make:migration
+	docker-compose exec api bin/console doctrine:migrations:migrate -n
+
+.PHONY: graphql-print-schema
+graphql-print-schema: ## Display current GraphQL Schema
+	docker-compose exec api ./bin/console graphqlite:dump-schema
+
+.PHONY: test-% lint-%
+test-api: ## Launch test in api
+	docker-compose exec api composer yaml-lint
+	docker-compose exec api composer cscheck
+	docker-compose exec api composer phpstan
+	docker-compose exec api composer pest
+	docker-compose exec api composer deptrac
+
+test-webapp: ## Launch test in webapp
+	docker-compose exec webapp yarn lint
+
+lint-api: ## Launch linter in api
+	docker-compose exec api composer yaml-lint
+	docker-compose exec api composer csfix
+	docker-compose exec api composer cscheck
+
+lint-webapp: ## Launch linter in webapp
+	docker-compose exec webapp yarn lint:fix
+	docker-compose exec webapp yarn lint
+
+.PHONY: help
+help: ## This help.
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)

README.md

@@ -14,7 +14,7 @@ This is a template of a *README*. Adapt it according to the comments and your ne
 
 > Replace this title and the following description with your project name and description.
 
-A web application built with Nuxt.js, Symfony 5, and GraphQL.
+A web application built with Nuxt.js 2, Symfony 5.4 (LTS), and GraphQL 5.
 
 ## Setup
 

docker-compose.yml

@@ -19,6 +19,12 @@ services:
       - "80:80"
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock
+    networks:
+      default:
+        aliases:
+          # Required so that the web application is able to call the same endpoint
+          # from both the browser and the server.
+          - "$API_SUBDOMAIN.$DOMAIN"
 
   webapp:
     image: thecodingmachine/nodejs:14
@@ -63,7 +69,7 @@ services:
       - ./src/webapp:/usr/src/app
 
   api:
-    image: thecodingmachine/php:7.4-v4-apache
+    image: thecodingmachine/php:8.0-v4-apache
     labels:
       - traefik.enable=true
       - traefik.http.routers.api_router.rule=Host(`${API_SUBDOMAIN}.${DOMAIN}`)
@@ -76,10 +82,9 @@ services:
       PHP_EXTENSION_INTL: "1"
       PHP_EXTENSION_GD: "1"
       PHP_INI_MEMORY_LIMIT: "1G"
-      STARTUP_COMMAND_1: "touch .env" # Create a fake .env file so that Symfony does not complain on startup.
-      STARTUP_COMMAND_2: "composer install"
-      STARTUP_COMMAND_3: "php bin/console doctrine:migrations:migrate -n --allow-no-migration" #FIXME: if no flag --allow-no-migration, the command fails. Why?
-      STARTUP_COMMAND_4: "php bin/console app:init-storage:s3"
+      STARTUP_COMMAND_1: "composer install"
+      STARTUP_COMMAND_2: "php bin/console doctrine:migrations:migrate -n --allow-no-migration" #FIXME: if no flag --allow-no-migration, the command fails. Why?
+      STARTUP_COMMAND_3: "php bin/console app:init-storage:s3"
       # Symfony.
       # ---------------------
       APP_NAME: "${APP_NAME}"
@@ -117,14 +122,12 @@ services:
       MAIL_FROM_NAME: "$APP_NAME"
       MAIL_WEBAPP_URL: "http://${DOMAIN}/"
       MAIL_WEBAPP_UPDATE_PASSWORD_ROUTE_FORMAT: "%s/update-password/%s/%s" # {locale}/update-password/{resetPasswordTokenId}/{plainToken}
+      # Debug
+      XDEBUG_MODE: ${XDEBUG_MODE:-debug}
     volumes:
       - ./src/api:/var/www/html
-    networks:
-      default:
-        aliases:
-          # Required so that the web application is able to call the same endpoint
-          # from both the browser and the server.
-          - "${API_SUBDOMAIN}.${DOMAIN}"
+    depends_on:
+      - mysql
 
   # For business data and user sessions.
   mysql:
@@ -151,7 +154,7 @@ services:
       - /var/lib/mysql
 
   phpmyadmin:
-    image: phpmyadmin/phpmyadmin:5.0
+    image: phpmyadmin/phpmyadmin:5
     labels:
       - traefik.enable=true
       - traefik.http.routers.phpmyadmin_router.rule=Host(`phpmyadmin.$DOMAIN`)

docs/docs/02_Development Environment/1_Docker Compose.md

@@ -122,7 +122,7 @@ You might need to extend a Docker image for installing one or more packages.
 For instance, let's say you want to install the `pdftk` package for the API:
 
 ```dockerfile title="src/api/Dockerfile"
-FROM thecodingmachine/php:7.4-v4-apache AS extended
+FROM thecodingmachine/php:8.0-v4-apache AS extended
 
 # Always use the root user for installing packages.
 USER root
@@ -141,7 +141,7 @@ FROM extended
 
 ```yaml title="docker-compose.yml"
 api:
-  #image: thecodingmachine/php:7.4-v4-apache
+  #image: thecodingmachine/php:8.0-v4-apache
   build:
     context: "./src/api"
     target: "extended"

docs/docs/17_CHANGELOG.md

@@ -3,6 +3,14 @@ title: CHANGELOG
 slug: /changelog
 ---
 
+## 0.3.0
+
+* Upgrade Symfony from `5.2` to `5.4` (LTS version)
+* Upgrade php from `7.4` to `8.0` 
+* Upgrade GraphQLite to `v5`
+* Add some useful command in `Makefile` (test and lint)
+* Add a test case to verify validity of the graphQL schema
+
 ## 0.2.0
 
 ### API

src/api/.env

@@ -0,0 +1 @@
+# Keep empty to load values from docker-compose environment

src/api/.env.test

@@ -0,0 +1,6 @@
+# define your env variables for the test env here
+KERNEL_CLASS='App\Kernel'
+APP_SECRET='$ecretf0rt3st'
+SYMFONY_DEPRECATIONS_HELPER=999999
+PANTHER_APP_ENV=panther
+PANTHER_ERROR_SCREENSHOT_DIR=./var/error-screenshots