Adding multisite config split script

Author: David Ferlay

scripts/multisite/.gitlab-ci.mirroring_example.yml

@@ -0,0 +1,52 @@
+# Example of .gitlab-ci.yml jobs
+# Use with config_split.mk and config_split_disable_all.sh
+
+## Overhead config
+
+stages:
+  - deploy
+
+# Tags defines which runner to use (expected shell runner)
+.ra_tags: &ra_tags
+  tags:
+    - XXX # Mandatory, should equal to tag of available runner server with docker + docker-compose + traefik
+
+.ra_only: &ra_only
+  only:
+    - branches
+
+## Multisite config
+
+Enable split default:
+  stage: deploy
+  environment:
+    url: https://${CI_ENVIRONMENT_SLUG}-${CI_PROJECT_PATH_SLUG}.${REVIEW_DOMAIN}
+    name: review/$CI_COMMIT_REF_NAME
+    on_stop: stop_review
+  script:
+  - echo "Starting job script in ${BUILD_DIR}"
+  - cd ${BUILD_DIR}
+  - pwd
+  - make split default
+  when: manual
+  <<: *ra_tags
+  <<: *ra_only
+
+Enable split first:
+  stage: deploy
+  environment:
+    url: https://${CI_ENVIRONMENT_SLUG}-${CI_PROJECT_PATH_SLUG}.${REVIEW_DOMAIN}
+    name: review/$CI_COMMIT_REF_NAME
+    on_stop: stop_review
+  script:
+  - echo "Starting job script in ${BUILD_DIR}"
+  - cd ${BUILD_DIR}
+  - pwd
+  - make split first # Vary for each site
+  when: manual
+  <<: *ra_tags
+  <<: *ra_only
+
+Enable split second: # Job can then be duplicated to navigate between to multiple set of config (just use a different make split command for each)
+  ...
+

scripts/multisite/README.md

@@ -0,0 +1,40 @@
+# Multisite script
+
+## What
+
+- These are scripts and commands to facilitate the use of different set of config in a multisite setup
+- It can be used locally using make commands as well as in Gitalb CI/CD pipelines using manual jobs 
+
+## Why
+
+- Being able to quickly switch from one set of config to another is very much useful for testing on a multisite Drupal setup
+
+## Setup
+
+3 files are required : 
+- `.gitlab-ci.yml`
+- `config_split.mk`
+- `config_split_disable_all.sh`
+
+1. Install and enable config_split module :
+   - `composer require drupal/config_split`
+   - `drush en -y config_split`
+1. In Drupal UI, create split(s) for site where config vary
+   - Do not create a split for "default" case, in which all shared config should be stored
+1. Create the config directories required by created splits
+1. Define a CI job "Enable split default" in .gitlab-ci.yml, as shown in .gitlab-ci.mirroring_example.yml
+1. Define additional CI jobs like "Enable split first" in .gitlab-ci.yml for each split
+1. Move files to scripts/makefile/ directory :
+   - `mv scripts/multisite/config_split.mk scripts/makefile/`
+   - `mv scripts/multisite/config_split_disable_all.sh scripts/makefile/`
+
+## Usage
+
+Locally you can use commands like :
+- `make split first` to simulate site "first" of multisite
+- `make split default` to revert back to no split
+
+On Gitlab CI/CD, Review Apps will be builded using default split :
+- Manually click on manual jobs "Enable split first" to simulate site "first" of multisite
+- Manually click on manual job "Enable split default" to revert back to no split
+

scripts/multisite/config_split.mk

@@ -0,0 +1,46 @@
+
+.PHONY: split
+
+# If the first argument is "split"
+ifeq (split,$(firstword $(MAKECMDGOALS)))
+  # Then use next strings as arguments
+  ARGS := $(wordlist 2,$(words $(MAKECMDGOALS)),$(MAKECMDGOALS))
+endif
+
+## Enable a specific split of config (config_split)
+split:
+	$($@,$(MAKECMDGOALS))
+
+# Message if no argument passed
+ifeq ($(ARGS),)
+	@echo "\nMachine name of split to enable is expected as argument \nFor exemple : \n - make split first // To enable first split\nor\n - make split default // To enable default config with no split\n"
+	@exit 1
+else
+		@echo "YAY $(ARGS)"
+
+# Disabling all active splits
+	@echo "Disabling all active splits:"
+ifneq ("$(wildcard scripts/makefile/config_split_disable_all.sh)","")
+	@echo "- Script found : Executing..."
+	@$(call php, /bin/sh ./scripts/makefile/config_split_disable_all.sh)
+else
+	@echo "- scripts/makefile/config_split_disable_all.sh file does not exist"
+	@exit 1
+endif
+
+# Enabling selected split
+	@echo "Enabling selected split : $(ARGS) ..."
+ifeq ($(ARGS),default)
+	@echo "No specific split to enable for $(ARGS) config..."
+else
+	@$(call php, drush config-set config_split.config_split.$(ARGS) status 1 -y)
+endif
+
+# Executing the rest of deploy commands
+	@echo "Importing $(ARGS) config..."
+	@$(call php, drush cim -y)
+	@make localize
+	@echo "Clearing cache..."
+	@$(call php, drush cr)
+	@make info
+

scripts/multisite/config_split_disable_all.sh

@@ -0,0 +1,29 @@
+#!/usr/bin/env sh
+
+# Parsing command
+PARSING_CMD='echo drush config:status --state=Any --format=list'
+
+# Entity to parse (see PARSING_CMD for more)
+CONFIG_TO_PARSE=config_split.config_split
+
+# Count entities
+CONFIG_COUNT=$($($PARSING_CMD) | grep -c $CONFIG_TO_PARSE)
+
+# List entities
+CONFIG_LIST=$($($PARSING_CMD) | grep $CONFIG_TO_PARSE | awk -F "." '{print $3}')
+
+
+# Looking for splits
+echo -e "- Looking for splits of config..."
+
+if [ "$CONFIG_COUNT" -gt "0" ]; then
+
+	echo -e "- Some splits were found : Disabling all splits..."
+
+	for bundles in $CONFIG_LIST; do
+		drush config-set config_split.config_split.$bundles status 0 -y
+	done
+
+else
+	printf "- \033[1mNo split of config was\033[0m found\n"
+fi