Merge pull request #1303 from dof-dss/development

Dev to main for release

Author: neilblair

.ddev/.homeadditions/.bashrc.d/platformsh-environment.sh

@@ -0,0 +1,9 @@
+#ddev-generated
+
+export PATH=$PATH:$PLATFORM_APP_DIR/.global/bin
+
+for item in .global/environment .environment; do
+  if [ -f "${item}" ]; then
+    . "${item}"
+  fi
+done

.ddev/.homeadditions/appserver_build.sh

@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+
+# Variables to indicate key settings files or directories for Drupal.
+DRUPAL_ROOT=/var/www/html/web
+
+# If we don't have a Drupal install, download it.
+if [ ! -d "/var/www/html/core" ]; then
+  echo "Installing Drupal"
+  export COMPOSER_PROCESS_TIMEOUT=600
+  composer install
+fi
+
+# Create Drupal public files directory and set IO permissions.
+if [ ! -d "/var/www/html/files" ]; then
+  echo "Creating public Drupal files directory"
+  mkdir -p /var/www/html/files
+  chmod -R 0775 /var/www/html/files
+fi
+
+# Create Drupal private file directory above web root.
+if [ ! -d "/var/www/html/private" ]; then
+  echo "Creating private Drupal files directory"
+  mkdir -p /var/www/html/private
+fi
+
+if [ ! -d $DRUPAL_ROOT/sites/default/settings.local.php ]; then
+  echo "Creating local Drupal settings and developent services files"
+  cp -v /var/www/html/.ddev/homeadditions/config/drupal.settings.php $DRUPAL_ROOT/sites/default/settings.local.php
+  cp -v /var/www/html/.ddev/homeadditions/config/drupal.services.yml $DRUPAL_ROOT/sites/local.development.services.yml
+fi
+
+# Set Simple test variables and put PHPUnit config in place.
+if [ ! -f "${DRUPAL_ROOT}/core/phpunit.xml" ]; then
+  echo "Adding localised PHPUnit config to Drupal webroot"
+  cp $DRUPAL_ROOT/core/phpunit.xml.dist $DRUPAL_ROOT/core/phpunit.xml
+  # Fix bootstrap path
+  sed -i -e "s|bootstrap=\"tests/bootstrap.php\"|bootstrap=\"${DRUPAL_ROOT}/core/tests/bootstrap.php\"|g" $DRUPAL_ROOT/core/phpunit.xml
+  # Inject database params for kernel tests.
+  sed -i -e "s|name=\"SIMPLETEST_DB\" value=\"\"|name=\"SIMPLETEST_DB\" value=\"${DB_DRIVER}://${DB_USER}:${DB_PASS}@${DB_HOST}/${DB_NAME}\"|g" $DRUPAL_ROOT/core/phpunit.xml
+  # Uncomment option to switch off Symfony deprecatons helper (we use drupal-check for this).
+  sed -i -e "s|<!-- <env name=\"SYMFONY_DEPRECATIONS_HELPER\" value=\"disabled\"/> -->|<env name=\"SYMFONY_DEPRECATIONS_HELPER\" value=\"disabled\"/>|g" $DRUPAL_ROOT/core/phpunit.xml
+  # Set the base URL for kernel tests.
+  sed -i -e "s|name=\"SIMPLETEST_BASE_URL\" value=\"\"|name=\"SIMPLETEST_BASE_URL\" value=\"${DDEV_PRIMARY_URL}\"|g" $DRUPAL_ROOT/core/phpunit.xml
+fi

.lando/config/local.development.services.yml .ddev/.homeadditions/config/drupal.services.yml

@@ -0,0 +1,27 @@
+<?php
+
+// @codingStandardsIgnoreFile
+$local_services_config = $app_root . '/sites/local.development.services.yml';
+if (file_exists($local_services_config)) {
+  $settings['container_yamls'][] = $local_services_config;
+}
+
+// Add migration source database details, if needed.
+// NB: uses the same db container to store the source db.
+// This can be useful for cross-db queries.
+$databases['default']['drupal7db'] = [
+  'database' => getenv('MIGRATE_SOURCE_DB_NAME'),
+  'username' => getenv('MIGRATE_SOURCE_DB_USER'),
+  'password' => getenv('MIGRATE_SOURCE_DB_PASS'),
+  'host' => getenv('MIGRATE_SOURCE_DB_HOST'),
+  'port' => getenv('MIGRATE_SOURCE_DB_PORT'),
+  'driver' => getenv('MIGRATE_SOURCE_DB_DRIVER'),
+];
+
+// Prevent SqlBase from moaning.
+$databases['migrate']['default'] = $databases['default']['drupal7db'];
+
+// Set config split environment.
+$config['config_split.config_split.local']['status'] = TRUE;
+$config['config_split.config_split.development']['status'] = FALSE;
+$config['config_split.config_split.production']['status'] = FALSE;

.ddev/.homeadditions/config/drupal.settings.php

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+## Description: Run drupal-check locally to detect deprecated code and ensure future compliance.
+## Usage: drupal-check
+## Aliases: drck
+## Example: "ddev <drupal-check|drck> web/modules/custom"
+
+/var/www/html/vendor/bin/drupal-check --memory-limit=256M $1

.ddev/commands/web/drupal-check

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+## Description: Execute local PHPCS static analysis checks.
+## Usage: phpcs
+## Example: "ddev phpcs"
+
+/var/www/html/phpcs.sh "/var/www/html" "/var/www/html/web/modules/origins /var/www/html/web/modules/custom /var/www/html/web/themes/custom"

.ddev/commands/web/phpcs

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+## Description: Run phpunit to execute local tests.
+## Usage: phpunit
+## Example: "ddev phpunit"
+
+php /app/vendor/bin/phpunit -c /app/phpunit.xml

.ddev/commands/web/phpunit

@@ -0,0 +1,28 @@
+# DDEV project level config. See https://ddev.readthedocs.io/en/stable/users/configuration/config/
+# for full set of options that can be used.
+composer_version: "2"
+database:
+    type: mariadb
+    version: "10.11"
+docroot: web
+fail_on_hook_fail: true
+hooks:
+  pre-start:
+    # Ensure env var file is deployed; needs to be filled in manually for sensitive values.
+    - exec-host: "if [ ! -f .ddev/.env ]; then cp -v .env.sample .ddev/.env && echo PLEASE FILL IN SENSITIVE ENV VAR VALUES IN .ddev/.env THEN RUN ddev restart && exit 1; fi"
+  post-start:
+    - composer: install
+    - exec: ".ddev/homeadditions/appserver_build.sh"
+  post-import-db:
+    # Use --skip-hooks flag to skip these commands, eg: when importing the migration db for the first time.
+    # Ensure the local config split profile is detected and active.
+    - exec: "drush cr"
+    # Import any local config split profile overrides.
+    - exec: "drush cim -y"
+name: nidirect
+nodejs_version: 20
+php_version: "8.2"
+timezone: Europe/London
+type: drupal
+webimage_extra_packages: ["libjpeg-dev", "make", "python3", "g++", "dh-autoreconf"]
+xdebug_enabled: false

.ddev/config.yaml

@@ -0,0 +1,18 @@
+#ddev-generated
+services:
+  redis:
+    container_name: ddev-${DDEV_SITENAME}-redis
+    image: redis:6-bullseye
+    # These labels ensure this service is discoverable by ddev.
+    labels:
+      com.ddev.site-name: ${DDEV_SITENAME}
+      com.ddev.approot: $DDEV_APPROOT
+    volumes:
+    - ".:/mnt/ddev_config"
+    - "ddev-global-cache:/mnt/ddev-global-cache"
+    - "./redis:/usr/local/etc/redis"
+    - "redis:/data"
+    command: ["redis-server", "/usr/local/etc/redis/redis.conf"]
+
+volumes:
+  redis:

.ddev/docker-compose.redis.yaml

@@ -0,0 +1,83 @@
+# DDEV Apache Solr recipe file.
+#ddev-generated
+#
+#
+# To use this in your own project:
+# 1. Copy this file to your project's ".ddev" directory.
+# 2. Create the folder path ".ddev/solr/conf".
+# 3. Copy the Solr configuration files for the appropriate plugin/module to
+#    ".ddev/solr/conf". For example, using Drupal 8's Search API Solr module,
+#    you'll get the config files as a file config.zip from
+#    /admin/config/search/search-api/server/solr and unzip it into .ddev/solr/conf
+#    so that a file exists with the path ".ddev/solr/conf/solrconfig.xml".
+#
+# To access Solr after it is installed:
+# - The Solr admin interface will be accessible at:
+#   http://<projectname>.ddev.site:8983/solr/
+#   For example, if the project is named "myproject" the hostname will be:
+#   http://myproject.ddev.site:8983/solr/
+# - To access the Solr container from the web container use:
+#   http://solr:8983/solr/
+# - A Solr core is automatically created with the name "dev" unless you
+#   change that usage throughout. It can be
+#   accessed at the URL: http://solr:8983/solr/dev (inside web container)
+#   or at http://myproject.ddev.site:8983/solr/dev (on the host)
+
+services:
+  solr:
+    # Name of container using standard ddev convention
+    container_name: ddev-${DDEV_SITENAME}-solr
+    # The solr docker image is at https://hub.docker.com/_/solr/
+    # and code at https://github.com/docker-solr/docker-solr
+    # README: https://github.com/docker-solr/docker-solr/blob/master/README.md
+    # It's almost impossible to work with it if you don't read the docs there
+    image: solr:8
+    restart: "no"
+    # Solr is served from this port inside the container.
+    expose:
+      - 8983
+    # These labels ensure this service is discoverable by ddev.
+    labels:
+      com.ddev.site-name: ${DDEV_SITENAME}
+      com.ddev.approot: $DDEV_APPROOT
+    environment:
+      # This defines the host name the service should be accessible from. This
+      # will be sitename.ddev.site.
+      - VIRTUAL_HOST=$DDEV_HOSTNAME
+      # HTTP_EXPOSE exposes http traffic from the container port 8983
+      # to the host port 8983 vid ddev-router reverse proxy.
+      - HTTP_EXPOSE=8983:8983
+    volumes:
+      # solr core *data* is stored on the 'solr' docker volume
+      # This mount is optional; without it your search index disappears
+      # each time the ddev project is stopped and started.
+      - solr:/var/solr
+
+      # This mounts the conf in .ddev/solr into the container where
+      # the solr-precreate command in the entrypoint uses it as a one-time
+      # configuration to copy config into the newly-created core. It is not
+      # used if the core has previously been created.
+      - ./solr:/solr-conf
+
+      - ".:/mnt/ddev_config"
+
+      # solr-configupdate.sh copies fresh configuration files into the
+      # solr container on each
+      # startup, so if you change the config in .ddev/solr/conf
+      # it will be refreshed on `ddev start`. It must be executable,
+      # `chmod +x solr
+      - "./solr/docker-entrypoint-initdb.d:/docker-entrypoint-initdb.d"
+
+    # The odd need to use $$SOLR_CORENAME here is explained in
+    # https://stackoverflow.com/a/48189916/215713
+    entrypoint:  'bash -c "VERBOSE=yes docker-entrypoint.sh solr-precreate $${SOLR_CORENAME:-dev} /solr-conf"'
+
+    external_links:
+      - "ddev-router:${DDEV_SITENAME}.${DDEV_TLD}"
+    healthcheck:
+      test: ["CMD-SHELL", "curl --fail -s localhost:8983/solr/"]
+
+volumes:
+  # solr is a persistent Docker volume for solr data
+  solr:
+    name: "ddev-${DDEV_SITENAME}_solr"

.ddev/docker-compose.solr.yaml

@@ -0,0 +1,7 @@
+[PHP]
+
+; Globals
+error_reporting = E_ALL & ~E_DEPRECATED
+post_max_size = 200M
+memory_limit = 128M
+upload_max_filesize = 100M

.ddev/php/local-php.ini

@@ -0,0 +1,44 @@
+# NICS provider configuration.
+#
+# To use this provider you will need to add a personal Platform.sh token to your environment vars (.env)
+# The Key should be 'PLATFORMSH_CLI_TOKEN' and the token can be generated from 'My Profile' -> 'API Tokens'.
+#
+# Usage: ddev pull nidirect
+# This will take a snapshot of your current database and import both the Drupal and Migration databases.
+# Files will not be imported as the file system for Departmental is around 100GB.
+#
+
+auth_command:
+  command: |
+    set -eu -o pipefail
+    if [ -z "${PLATFORMSH_CLI_TOKEN:-}" ]; then echo "Please make sure you have set PLATFORMSH_CLI_TOKEN." && exit 1; fi
+    if [ -z "${PLATFORM_PROJECT:-}" ]; then echo "Please make sure you have set PLATFORM_PROJECT." && exit 1; fi
+    if [ -z "${PLATFORM_ENVIRONMENT:-}" ]; then echo "Please make sure you have set PLATFORM_ENVIRONMENT." && exit 1; fi
+
+db_pull_command:
+  command: |
+    # set -x                                      # You can enable bash debugging output by uncommenting.
+    set -eu -o pipefail
+    export PLATFORMSH_CLI_NO_INTERACTION=1
+    ls /var/www/html/.ddev >/dev/null             # This just refreshes stale NFS if possible.
+
+    platform db:dump --yes ${PLATFORM_APP:+"--app=${PLATFORM_APP}"} --relationship=database --gzip --file=/var/www/html/.ddev/.downloads/db.sql.gz --project="${PLATFORM_PROJECT:-setme}" --environment="${PLATFORM_ENVIRONMENT:-setme}"
+    echo "Downloaded db dump for database"
+
+db_import_command:
+  command: |
+    set -eu -o pipefail
+    # set -x                                      # You can enable bash debugging output by uncommenting.
+    ddev snapshot                                 # Comment out to disable snapshots on import.
+    gzip -dc .ddev/.downloads/db.sql.gz | ddev mysql db
+    ddev drush cim -y
+    ddev drush cr
+  service: host
+
+files_pull_command:
+  command: |
+    echo "Files will not be pulled due to filesize."
+
+files_import_command:
+  command: |
+    echo "Files will not be imported due to filesize."

.ddev/providers/nidirect.yaml

@@ -0,0 +1,14 @@
+# Redis configuration.
+# #ddev-generated
+# Example configuration files for reference:
+# http://download.redis.io/redis-stable/redis.conf
+# http://download.redis.io/redis-stable/sentinel.conf
+
+maxmemory 2048mb
+maxmemory-policy allkeys-lfu
+
+# If you want to enable Redis persistence,
+# remove ddev-generated from this file,
+# and comment the two lines below:
+appendonly no
+save ""

.ddev/redis/redis.conf

@@ -0,0 +1,54 @@
+<?php
+// #ddev-generated
+use Drupal\Core\Installer\InstallerKernel;
+
+if (!InstallerKernel::installationAttempted() && extension_loaded('redis') && class_exists('Drupal\redis\ClientFactory')) {
+  // Set Redis as the default backend for any cache bin not otherwise specified.
+  $settings['cache']['default'] = 'cache.backend.redis';
+  $settings['redis.connection']['host'] = 'redis';
+  $settings['redis.connection']['port'] = 6379;
+
+  // Apply changes to the container configuration to better leverage Redis.
+  // This includes using Redis for the lock and flood control systems, as well
+  // as the cache tag checksum. Alternatively, copy the contents of that file
+  // to your project-specific services.yml file, modify as appropriate, and
+  // remove this line.
+  $settings['container_yamls'][] = 'modules/contrib/redis/example.services.yml';
+
+  // Allow the services to work before the Redis module itself is enabled.
+  $settings['container_yamls'][] = 'modules/contrib/redis/redis.services.yml';
+
+  // Manually add the classloader path, this is required for the container cache bin definition below
+  // and allows to use it without the redis module being enabled.
+  $class_loader->addPsr4('Drupal\\redis\\', 'modules/contrib/redis/src');
+
+  // Use redis for container cache.
+  // The container cache is used to load the container definition itself, and
+  // thus any configuration stored in the container itself is not available
+  // yet. These lines force the container cache to use Redis rather than the
+  // default SQL cache.
+  $settings['bootstrap_container_definition'] = [
+    'parameters' => [],
+    'services' => [
+      'redis.factory' => [
+        'class' => 'Drupal\redis\ClientFactory',
+      ],
+      'cache.backend.redis' => [
+        'class' => 'Drupal\redis\Cache\CacheBackendFactory',
+        'arguments' => ['@redis.factory', '@cache_tags_provider.container', '@serialization.phpserialize'],
+      ],
+      'cache.container' => [
+        'class' => '\Drupal\redis\Cache\PhpRedis',
+        'factory' => ['@cache.backend.redis', 'get'],
+        'arguments' => ['container'],
+      ],
+      'cache_tags_provider.container' => [
+        'class' => 'Drupal\redis\Cache\RedisCacheTagsChecksum',
+        'arguments' => ['@redis.factory'],
+      ],
+      'serialization.phpserialize' => [
+        'class' => 'Drupal\Component\Serialization\PhpSerialize',
+      ],
+    ],
+  ];
+}

.ddev/redis/scripts/settings.ddev.redis.php

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+#ddev-generated
+set -e
+
+if [[ $DDEV_PROJECT_TYPE != drupal* ]] || [[ $DDEV_PROJECT_TYPE =~ ^drupal(6|7)$ ]] ;
+then
+  exit 0
+fi
+
+if ( ddev debug configyaml 2>/dev/null | grep 'disable_settings_management:\s*true' >/dev/null 2>&1 ) ; then
+  exit 0
+fi
+
+cp redis/scripts/settings.ddev.redis.php $DDEV_APPROOT/$DDEV_DOCROOT/sites/default/
+
+SETTINGS_FILE_NAME="${DDEV_APPROOT}/${DDEV_DOCROOT}/sites/default/settings.php"
+echo "Settings file name: ${SETTINGS_FILE_NAME}"
+grep -qF 'settings.ddev.redis.php' $SETTINGS_FILE_NAME || echo "
+// Include settings required for Redis cache.
+if ((file_exists(__DIR__ . '/settings.ddev.redis.php') && getenv('IS_DDEV_PROJECT') == 'true')) {
+  include __DIR__ . '/settings.ddev.redis.php';
+}" >> $SETTINGS_FILE_NAME

.ddev/redis/scripts/setup-drupal-settings.sh

@@ -0,0 +1,9 @@
+#ddev-generated
+FROM solr:9.6
+
+# Fix HTTPS redirect to HTTP which breaks URL for Solr Admin UI.
+# The reason for this problem is that Solr uses Jetty as a webserver.
+# Jetty has X-Forwarded- headers disabled by default, enable them here:
+USER root
+RUN sed -i '/<!-- Uncomment to enable handling of X-Forwarded- style headers/,/-->/c\<Call name="addCustomizer"><Arg><New class="org.eclipse.jetty.server.ForwardedRequestCustomizer"/></Arg></Call>' /opt/solr/server/etc/jetty.xml
+USER solr