Merge branch 'master' into composer_prestissimo

Author: David Ferlay

.env.default

@@ -17,12 +17,14 @@ IMAGE_SOLR=solr:8-slim
 IMAGE_REDIS=redis:5-alpine
 IMAGE_DRIVER=zenika/alpine-chrome
 CLEAR_FRONT_PACKAGES=no
-ADD_PHP_EXT=
+ADD_PHP_EXT=graphicsmagick
+#ADD_PHP_EXT=php7-pdo_pgsql postgresql-client postgresql-contrib  gnu-libiconv wkhtmltopdf
 MAIN_DOMAIN_NAME=docker.localhost
 DB_URL=sqlite:./../.cache/d8.sqlite
 # Faster but data will be lost on php container recreation
 #DB_URL=sqlite:///dev/shm/d8.sqlite
 #DB_URL=mysql://d8:d8@mysql/d8
+#DB_URL=pgsql://d9:d9root@postgresql/d9
 # Include path to this folder to your .gitignore if you override it
 DB_DATA_DIR=../.cache
 #DB_DATA_DIR=/dev/shm

.gitignore

@@ -17,6 +17,7 @@ docker/docker-compose.override.yml
 behat.yml
 features/*.html
 features/*.png
+features/junit/
 .cache/
 .editorconfig
 .gitattributes

.gitlab-ci.yml

@@ -1,12 +1,13 @@
 # Variables to add in Gitalb UI : Settings > CI/CD
 # - SONAR_HOST // Optional
 # - SONAR_TOKEN // Optional
+# - NEW_RELIC_LICENSE_KEY // Optional
 
 variables:
-  GIT_DEPTH: "3"
+  GIT_DEPTH: "10"
   THEME_PATH: "" # Update to enable front jobs (web/themes/custom/XXX)
   STORYBOOK_PATH: "" # Update to enable storybook job (themes/custom/XXX/dist/storybook/index.html)
-  GIT_STRATEGY: clone # Workaround until git is updated in runner, see https://gitlab.com/gitlab-org/gitlab-foss/issues/60466
+  GIT_STRATEGY: fetch
   REVIEW_DOMAIN: "XXX.XXX.com" # Mandatory, should equal to DNS of available runner server with docker + docker-compose + traefik
 
 image: skilldlabs/php:73
@@ -33,6 +34,7 @@ stages:
   - sniffers
   - prepare
   - deploy
+  - storybook
   - tests
   - reports
 
@@ -179,7 +181,7 @@ prepare:front:
     - echo "CI_PROJECT_NAME=${CI_PROJECT_NAME}"
     - echo "REVIEW_DOMAIN=${REVIEW_DOMAIN}"
     - mkdir -p ${BUILD_DIR}
-    - rsync -ah --exclude=.git --delete ./ ${BUILD_DIR}
+    - rsync -ah --exclude=.git --exclude=.cache --delete ./ ${BUILD_DIR}
     - cd ${BUILD_DIR}
     - echo "COMPOSE_PROJECT_NAME=${CI_PROJECT_NAME}-review-${CI_COMMIT_REF_SLUG}" >> .env.default
     - echo "MAIN_DOMAIN_NAME=${CI_ENVIRONMENT_SLUG}-${CI_PROJECT_PATH_SLUG}.${REVIEW_DOMAIN}" >> .env.default
@@ -196,7 +198,6 @@ prepare:front:
   dependencies:
     - prepare:back
     - prepare:front
-  allow_failure: false
   <<: *runner_tag_selection
   <<: *only_branches
 
@@ -230,7 +231,7 @@ stop_review:
   <<: *only_branches
 
 deploy:storybook:
-  stage: deploy
+  stage: storybook
   environment:
     url: https://${CI_ENVIRONMENT_SLUG}-${CI_PROJECT_PATH_SLUG}.${REVIEW_DOMAIN}
     name: review/$CI_COMMIT_REF_NAME
@@ -245,8 +246,6 @@ deploy:storybook:
   <<: *runner_tag_selection
   <<: *only_branches
   <<: *only_var_theme
-  when: always
-
 
 test:behat:
   stage: tests
@@ -257,22 +256,29 @@ test:behat:
   script:
   - echo "Starting job script in ${BUILD_DIR}"
   - cd ${BUILD_DIR}
-  - make behat
+  - BEHAT_ARGS='--colors -f pretty -o std -f junit -o features/junit' make behat
   after_script:
   - cd ${BUILD_DIR}
   - make browser_driver_stop
   - rm -rf web/screenshots
   - mkdir web/screenshots
   - mv features/*.png web/screenshots/
   - echo "- Screenshots are available here :" && cd web/screenshots && ls -h *.png | xargs -i echo "${CI_ENVIRONMENT_URL}/screenshots/{}"
+  - mv ${BUILD_DIR}/features/junit ${CI_PROJECT_DIR}
   retry:
     max: 2
     when: script_failure
   dependencies:
   - deploy:review
-  allow_failure: false
   <<: *runner_tag_selection
   <<: *only_branches
+  artifacts:
+    expire_in: 1 week
+    when: always
+    paths:
+      - junit/*.xml
+    reports:
+      junit: junit/*.xml
 
 test:cinsp:
   stage: tests

Makefile

@@ -24,9 +24,13 @@ CGID ?= $(LOCAL_GID)
 # Define network name.
 COMPOSE_NET_NAME := $(COMPOSE_PROJECT_NAME)_front
 
-# Determine mysql data directory if defined
-ifeq ($(shell docker-compose config --services | grep mysql),mysql)
-	MYSQL_DIR=$(shell cd docker && realpath $(DB_DATA_DIR))/$(COMPOSE_PROJECT_NAME)_mysql
+SDC_SERVICES=$(shell docker-compose config --services)
+# Determine database data directory if defined
+ifeq ($(findstring mysql,$(SDC_SERVICES)),mysql)
+	DB_MOUNT_DIR=$(shell cd docker && realpath $(DB_DATA_DIR))/$(COMPOSE_PROJECT_NAME)_mysql
+endif
+ifeq ($(findstring postgresql,$(SDC_SERVICES)),postgresql)
+	DB_MOUNT_DIR=$(shell cd docker && realpath $(DB_DATA_DIR))/$(COMPOSE_PROJECT_NAME)_pgsql
 endif
 
 # Define current directory only once
@@ -59,22 +63,30 @@ ifeq ($(strip $(COMPOSE_PROJECT_NAME)),projectname)
 	$(info Please review your project settings and run `make all` again.)
 	exit 1
 endif
-ifdef MYSQL_DIR
-	mkdir -p $(MYSQL_DIR) && chmod 777 $(MYSQL_DIR)
+ifdef DB_MOUNT_DIR
+	$(shell [ ! -d $(DB_MOUNT_DIR) ] && mkdir -p $(DB_MOUNT_DIR) && chmod 777 $(DB_MOUNT_DIR))
 endif
 	make -s down
 	@echo "Updating containers..."
 	docker-compose pull
 	@echo "Build and run containers..."
 	docker-compose up -d --remove-orphans
-	$(call php-0, apk add --no-cache graphicsmagick $(ADD_PHP_EXT))
+	$(call php-0, apk add --no-cache tzdata $(ADD_PHP_EXT))
+	# Set up timezone
+	$(call php-0, cp /usr/share/zoneinfo/Europe/Paris /etc/localtime)
+	# Install newrelic PHP extension if NEW_RELIC_LICENSE_KEY defined
+	make -s newrelic
 	$(call php-0, kill -USR2 1)
 	$(call php, composer global require -o --update-no-dev --no-suggest "hirak/prestissimo:^0.3")
 
 ## Install backend dependencies
 back:
-	docker-compose up -d --remove-orphans php # PHP container is required for composer
+	docker-compose up -d --remove-orphans --no-deps php # PHP container is required for composer
 	$(call php, composer global require -o --update-no-dev --no-suggest "hirak/prestissimo:^0.3")
+ifneq ($(strip $(ADD_PHP_EXT)),)
+# Install additional php extensions as this goal used in CI (todo stop doing it)
+	$(call php-0, apk add --no-cache $(ADD_PHP_EXT))
+endif
 ifeq ($(INSTALL_DEV_DEPENDENCIES), TRUE)
 	@echo "INSTALL_DEV_DEPENDENCIES=$(INSTALL_DEV_DEPENDENCIES)"
 	@echo "Installing composer dependencies, including dev ones"
@@ -143,9 +155,9 @@ clean: info
 	make -s down
 	$(eval SCAFFOLD = $(shell docker run --rm -v $(CURDIR):/mnt -w /mnt --user $(CUID):$(CGID) $(IMAGE_PHP) composer run-script list-scaffold-files | grep -P '^(?!>)'))
 	@docker run --rm --user 0:0 -v $(CURDIR):/mnt -w /mnt -e RMLIST="$(addprefix web/,$(SCAFFOLD)) $(DIRS)" $(IMAGE_PHP) sh -c 'for i in $$RMLIST; do rm -fr $$i && echo "Removed $$i"; done'
-ifdef MYSQL_DIR
-	@echo "Removing mysql data from $(MYSQL_DIR) ..."
-	docker run --rm --user 0:0 -v $(shell dirname $(MYSQL_DIR)):/mnt $(IMAGE_PHP) sh -c "rm -fr /mnt/`basename $(MYSQL_DIR)`"
+ifdef DB_MOUNT_DIR
+	@echo "Clean-up database data from $(DB_MOUNT_DIR) ..."
+	docker run --rm --user 0:0 -v $(shell dirname $(DB_MOUNT_DIR)):/mnt $(IMAGE_PHP) sh -c "rm -fr /mnt/`basename $(DB_MOUNT_DIR)`"
 endif
 ifeq ($(CLEAR_FRONT_PACKAGES), yes)
 	make clear-front

README.md

@@ -36,8 +36,8 @@
 ## Quickstart
 
 * Install docker for <a href="https://docs.docker.com/install/" target="_blank">Linux</a>, <a href="https://docs.docker.com/docker-for-mac/install/" target="_blank">Mac</a>, <a href="https://docs.docker.com/docker-for-windows/install/" target="_blank">Windows</a>
-  *  Check <a href="https://docs.docker.com/install/linux/linux-postinstall/" target="_blank">post-installation steps for Linux</a>
-* Install <a href="https://docs.docker.com/compose/install/" target="_blank">docker compose</a>
+  *  Check <a href="https://docs.docker.com/install/linux/linux-postinstall/" target="_blank">post-installation steps for Linux</a> version 17.12.0 or later
+* Install <a href="https://docs.docker.com/compose/install/" target="_blank">docker compose</a> version 1.21.0 or later
 
 * Copy **.env.default** to **.env**, more information about enviroment file can be found <a href="https://docs.docker.com/compose/env-file/" target="_blank">docs.docker.com</a>
 * Copy **docker-compose.override.yml.default** to **docker-compose.override.yml**, update parts you want to overwrite.
@@ -117,6 +117,8 @@ networks:
 * `make front` - Builds frontend tasks.
 * `make lint` - Runs frontend linters.
 * `make storybook` - Runs storybook in current theme.
+* `make blackfire` - Adds and enables blackfire.io php extension, needs [configuration](https://blackfire.io/docs/configuration/php) in docker-composer override.yml.
+* `make newrelic` - Adds and enables newrelic.com php extension, needs [configuration](https://docs.newrelic.com/docs/agents/php-agent/getting-started/introduction-new-relic-php#configuration) `NEW_RELIC_LICENSE_KEY` environment variable defined with valid license key.
 
 #### Additional goals
 

composer.json

@@ -13,39 +13,13 @@
     {
       "type": "composer",
       "url": "https://packages.drupal.org/8"
-    },
-    {
-      "type": "package",
-      "package": {
-        "name": "drupal/lb_ux",
-        "version": "dev-8.x-1.x",
-        "type": "drupal-module",
-        "source": {
-          "url": "https://git.drupalcode.org/project/lb_ux.git",
-          "type": "git",
-          "reference": "8.x-1.x"
-        }
-      }
-    },
-    {
-      "type": "package",
-      "package": {
-        "name": "drupal/panels_everywhere",
-        "version": "dev-8.x-4.x",
-        "type": "drupal-module",
-        "source": {
-          "url": "https://git.drupalcode.org/project/panels_everywhere.git",
-          "type": "git",
-          "reference": "8.x-4.x"
-        }
-      }
     }
   ],
   "require": {
     "composer/installers": "^1.9",
     "cweagans/composer-patches": "^1.6.5",
     "drupal/better_normalizers": "^1.0@beta",
-    "drupal/block_content_permissions": "1.x-dev",
+    "drupal/block_content_permissions": "^1",
     "drupal/core-composer-scaffold": "^9.0",
     "drupal/core-project-message": "^9.0",
     "drupal/core-recommended": "^9",
@@ -58,13 +32,13 @@
     "drupal/layout_builder_modal": "^1.1",
     "drupal/layout_builder_restrictions": "^2.7",
     "drupal/layout_library": "^1.0@beta",
-    "drupal/lb_ux": "dev-8.x-1.x",
+    "drupal/lb_ux": "1.x-dev",
     "drupal/manage_display": "^1.0@alpha",
     "drupal/menu_admin_per_menu": "^1.1",
-    "drupal/menu_link_attributes": "1.x-dev",
+    "drupal/menu_link_attributes": "^1.1",
     "drupal/page_manager": "^4.0.0-beta6",
     "drupal/panels": "^4.6",
-    "drupal/panels_everywhere": "dev-8.x-4.x",
+    "drupal/panels_everywhere": "^4.0@beta",
     "drupal/paragraphs": "^1.11",
     "drupal/pathauto": "^1.8",
     "drupal/rabbit_hole": "^1.0.0-beta7",
@@ -78,7 +52,7 @@
     "drupal/webform": "^6",
     "drush/drush": "^10.1.0",
     "skilldlabs/drupal-cleanup": "^1",
-    "zaporylie/composer-drupal-optimizations": "^1.0"
+    "zaporylie/composer-drupal-optimizations": "^1.2"
   },
   "require-dev": {
     "dmore/behat-chrome-extension": "^1.3",
@@ -98,8 +72,6 @@
   "config": {
     "sort-packages": true,
     "preferred-install": {
-      "drupal/lb_ux": "source",
-      "drupal/panels_everywhere": "source",
       "*": "dist"
     }
   },
@@ -152,7 +124,8 @@
       "drupal-module": [
         "tests",
         "src/Tests"
-      ]
+      ],
+      "exclude": []
     },
     "patches": {
       "drupal/core": {
@@ -182,15 +155,11 @@
       },
       "drupal/lb_ux": {
         "Cog icon not showing when Preview disabled": "https://www.drupal.org/files/issues/2020-05-22/3116402-8.patch",
-        "Errors when using with modules that alter a section's contextual menu": "https://www.drupal.org/files/issues/2020-05-22/3106939-4.patch",
-        "Indicate Drupal 8/9 compatibility via core_version_requirement": "https://www.drupal.org/files/issues/2020-05-22/d9_compatibility-3138698-4.patch"
+        "Errors when using with modules that alter a section's contextual menu": "https://www.drupal.org/files/issues/2020-05-22/3106939-4.patch"
       },
       "drupal/menu_link_attributes": {
         "Add missing schema for menu_link_attributes": "https://patch-diff.githubusercontent.com/raw/yannickoo/menu_link_attributes/pull/52.patch"
       },
-      "drupal/panels_everywhere": {
-        "Drupal 9 compatibility fixes for Panels Everywhere": "https://www.drupal.org/files/issues/2020-05-14/d9-compatibility-3111407-7.patch"
-      },
       "drupal/upgrade_status": {
         "Exclude node_modules from scan": "https://www.drupal.org/files/issues/2020-08-14/3162997-8.patch"
       }