@webship.co/workspace 1.0.0-beta1 → 1.0.0-beta2

package/core/scripts/functions/fun-ddev-hostnames.sh

@@ -0,0 +1,213 @@
+#!/usr/bin/env bash
+
+################################################################################
+## Extra hostnames for a project — the same site at another address.
+################################################################################
+## A DDEV project answers at `<name>.<project_tld>` because the NAME decides the
+## address, and the workspace hands out a second, hierarchical one
+## (`<project>.<workspace>.workspace.ddev.site`) through its own nginx tier. What
+## neither gives you is a THIRD shape people keep asking for: the same project
+## name in two workspaces, told apart in one flat hostname —
+## `test3-dev.ddev.site` and `test3-test.ddev.site`.
+##
+## That is DDEV's `additional_hostnames`, and it is deliberately what this uses
+## rather than renaming the project:
+##
+##   * ADDING a hostname is reversible and costs nothing. RENAMING kills the old
+##     URL, recreates the containers and volumes under the new name, and leaves
+##     the DDEV project name no longer matching the folder — which is precisely
+##     what makes a git worktree collide with its source (fun-clone-project.sh).
+##   * Several addresses can coexist. A rename gives you exactly one, and takes
+##     one away.
+##   * Every link already printed, bookmarked or written in a doc keeps working.
+##
+## Written through `ddev config --additional-hostnames=`, never by editing the
+## YAML: DDEV owns that file, validates the names and rewrites the router
+## configuration. The list is REPLACED by that flag, so anything here that adds
+## one reads the current list first and writes it back whole — an add that
+## silently dropped the other hostnames would be worse than no add at all.
+##
+## A change only reaches the router on the next start, so these functions say so
+## and offer to do it rather than leaving a hostname that resolves to nothing.
+################################################################################
+
+# The additional_hostnames a project currently declares, one per line.
+# Read from the project's own config.yaml, which is the file the flag writes, so
+# what is read and what is written cannot disagree.
+function ddev_hostnames_list() {
+  local dir="${1:-}" cfg
+  cfg="${dir}/.ddev/config.yaml"
+  [ -f "${cfg}" ] || return 0
+  # The block is `additional_hostnames:` followed by `- name` lines, or an inline
+  # `[a, b]`. Both shapes are legal YAML and DDEV writes the first.
+  python3 - "${cfg}" <<'PY' 2>/dev/null
+import sys, re
+try:
+    lines = open(sys.argv[1], encoding='utf-8').read().split('\n')
+except Exception:
+    sys.exit(0)
+out, inblock = [], False
+for ln in lines:
+    if re.match(r'^additional_hostnames:', ln):
+        rest = ln.split(':', 1)[1].strip()
+        if rest.startswith('['):
+            out += [x.strip().strip('"\'') for x in rest.strip('[]').split(',') if x.strip()]
+        else:
+            inblock = True
+        continue
+    if inblock:
+        m = re.match(r'^\s+-\s*(.+?)\s*$', ln)
+        if m:
+            out.append(m.group(1).strip().strip('"\''))
+            continue
+        if ln.strip() == '' or ln.startswith(' '):
+            continue
+        inblock = False
+for h in out:
+    if h and h != '[]':
+        print(h)
+PY
+}
+
+# The hostname a project would get from its workspace: <project>-<workspace>.
+# One flat name that is unique across workspaces, which is the whole point —
+# `test3` in dev and `test3` in test cannot both be `test3.ddev.site`.
+function ddev_workspace_hostname() {
+  local project="${1:-}" workspace="${2:-}"
+  [ -n "${project}" ] && [ -n "${workspace}" ] || return 0
+  # DDEV allows letters, digits and hyphens in a hostname; a workspace key can
+  # carry a hyphen already (site-templates), which is fine, and nothing else.
+  echo "${project}-${workspace}" | tr -c 'a-zA-Z0-9-\n' '-'
+}
+
+# Is this a hostname DDEV will accept? Refused here rather than after a failed
+# `ddev config`, because the message DDEV gives is about its whole config file.
+function ddev_hostname_valid() {
+  local h="${1:-}"
+  [ -n "${h}" ] || return 1
+  # A label, not an FQDN: additional_hostnames gets project_tld appended. A dot
+  # here would silently produce name.example.com.ddev.site.
+  echo "${h}" | grep -qE '^[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$'
+}
+
+# Add one or more hostnames, keeping the ones already there.
+function ddev_hostnames_add() {
+  local dir="${1}" ; shift
+  local cfg="${dir}/.ddev/config.yaml" tld existing all h added=0
+  if [ ! -f "${cfg}" ] ; then
+    echo "Not a DDEV project: ${dir}" ; return 1 ;
+  fi
+  existing="$(ddev_hostnames_list "${dir}")"
+  all="${existing}"
+  for h in "$@" ; do
+    [ -n "${h}" ] || continue
+    if ! ddev_hostname_valid "${h}" ; then
+      echo "  '${h}' is not a hostname label — letters, digits and hyphens only, and no dots" ;
+      echo "  (the project's TLD is appended, so a dot here would give name.example.com.<tld>)." ;
+      return 1 ;
+    fi
+    if echo "${existing}" | grep -qx "${h}" ; then
+      echo "  ${h} is already there." ; continue ;
+    fi
+    # Two projects claiming one hostname is a router conflict, and it is invisible
+    # one project at a time: whichever started last wins, and the other simply
+    # stops answering at an address that used to work. Checked across the whole
+    # tree, not just this workspace, because the router is one thing for all of
+    # them — and against DDEV's project NAMES too, since the canonical hostname
+    # comes from the name and would be shadowed just the same.
+    local owner
+    owner="$(ddev_hostname_owner "${h}" "${dir}")"
+    if [ -n "${owner}" ] ; then
+      echo "  '${h}' is already taken by ${owner}." ;
+      echo "  Two projects on one hostname is a router conflict: the last one to" ;
+      echo "  start wins and the other quietly stops answering. Pick another." ;
+      return 1 ;
+    fi
+    all="$(printf '%s\n%s' "${all}" "${h}")"
+    added=$((added+1)) ;
+  done
+  [ "${added}" -eq 0 ] && return 0 ;
+
+  # Written whole, because the flag replaces the list.
+  local joined
+  joined="$(echo "${all}" | grep -v '^$' | paste -sd, -)"
+  ( cd "${dir}" && ddev config --additional-hostnames="${joined}" > /dev/null ) || {
+    echo "  ddev refused the hostname list: ${joined}" ; return 1 ;
+  }
+  tld="$(ddev_project_tld)"
+  echo "  Hostnames for this project are now:" ;
+  ddev_hostnames_list "${dir}" | sed "s|^|    https://|; s|\$|.${tld}|" ;
+  echo "" ;
+  echo "  A hostname reaches the router only on the next start:" ;
+  echo "    cd ${dir} && ddev start" ;
+}
+
+# Remove one hostname, leaving the rest.
+function ddev_hostnames_remove() {
+  local dir="${1}" h="${2}" cfg="${dir}/.ddev/config.yaml" kept
+  [ -f "${cfg}" ] || { echo "Not a DDEV project: ${dir}" ; return 1 ; }
+  if ! ddev_hostnames_list "${dir}" | grep -qx "${h}" ; then
+    echo "  ${h} is not one of this project's additional hostnames." ; return 1 ;
+  fi
+  kept="$(ddev_hostnames_list "${dir}" | grep -vx "${h}" | paste -sd, -)"
+  ( cd "${dir}" && ddev config --additional-hostnames="${kept}" > /dev/null ) || return 1 ;
+  echo "  Removed ${h}. Remaining: ${kept:-none}" ;
+  echo "  The router still holds the old route until the next start." ;
+}
+
+# Which project, anywhere in the tree, already answers at this hostname label —
+# whether as its DDEV name or as one of its additional hostnames. Empty when the
+# label is free. `skip_dir` is the project asking, so it does not find itself.
+function ddev_hostname_owner() {
+  local h="${1}" skip_dir="${2:-}" d p n
+  local skip_real
+  skip_real="$( (cd "${skip_dir}" 2>/dev/null && pwd -P) || echo "${skip_dir}")"
+  for d in "${WORKSPACE_ROOT}"/*/*/ ; do
+    [ -f "${d}/.ddev/config.yaml" ] || continue
+    [ "$( (cd "${d}" && pwd -P) )" == "${skip_real}" ] && continue
+    n="$(ddev_project_name "${d}" 2>/dev/null)"
+    p="$(basename "$(dirname "${d}")")/$(basename "${d}")"
+    if [ "${n}" == "${h}" ] ; then
+      echo "${p} (it is that project's own name)" ; return 0 ;
+    fi
+    if ddev_hostnames_list "${d}" | grep -qx "${h}" ; then
+      echo "${p} (an additional hostname there)" ; return 0 ;
+    fi
+  done
+  return 0
+}
+
+# The TLD every project hostname is under. Global unless the project overrides it.
+function ddev_project_tld() {
+  local dir="${1:-}" tld=''
+  if [ -n "${dir}" ] && [ -f "${dir}/.ddev/config.yaml" ] ; then
+    tld="$(sed -n 's/^project_tld:[[:space:]]*"\{0,1\}\([^"#]*\)"\{0,1\}[[:space:]]*$/\1/p' "${dir}/.ddev/config.yaml" | head -1 | tr -d '[:space:]')"
+  fi
+  if [ -z "${tld}" ] ; then
+    tld="$(ddev config global 2>/dev/null | sed -n 's/^project-tld=//p' | head -1 | tr -d '[:space:]')"
+  fi
+  echo "${tld:-ddev.site}"
+}
+
+# Everything one project answers at, for a report or a confirmation.
+function ddev_hostnames_report() {
+  local dir="${1}" project="${2:-}" workspace="${3:-}" tld name
+  tld="$(ddev_project_tld "${dir}")"
+  name="$(ddev_project_name "${dir}" 2>/dev/null)"
+  echo "  canonical    https://${name:-${project}}.${tld}" ;
+  [ -n "${workspace}" ] && echo "  hierarchical https://${project}.${workspace}.$(workspace_hub_domain)" ;
+  local extra
+  extra="$(ddev_hostnames_list "${dir}")"
+  if [ -n "${extra}" ] ; then
+    echo "  additional:" ;
+    echo "${extra}" | sed "s|^|    https://|; s|\$|.${tld}|" ;
+  else
+    echo "  additional   none" ;
+  fi
+}
+
+# The hub domain the dashboard hands out, from settings.yml — one field, and the
+# only place the hierarchical URLs come from.
+function workspace_hub_domain() {
+  echo "${hub_domain:-workspace.ddev.site}"
+}

package/core/scripts/functions/fun-ddev-nodejs.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+## The Node.js every project this workspace builds runs on.
+##
+## 24, in line with Drupal core, whose package.json asks for "node": ">= 24.0".
+## The major only: DDEV installs the latest 24.x when the container is built, so a
+## security release arrives with the next build and nothing here changes.
+##
+## A builder that needs another declares site_nodejs_version, the way it declares
+## site_php_version. Passed as --nodejs-version on EVERY `ddev config` that creates a
+## project and on the one that follows a create-project: a project template ships its
+## own .ddev/config.yaml, and an older release of one pins an older Node.
+
+function ddev_nodejs_version() {
+  echo "${site_nodejs_version:-24}" ;
+}

package/core/scripts/functions/fun-ddev-telemetry.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+## Keep Drupal CMS install telemetry off in every project this workspace builds.
+##
+## Drupal CMS reports anonymous install analytics. It skips GitLab CI, GitHub
+## Actions and Tugboat by environment, but not a local DDEV site, so test builds
+## here were counted as real installs. DRUPAL_CMS_TELEMETRY=0 in the web container
+## turns it off before the installer runs.
+##
+## Written through `ddev config --web-environment-add`, never by editing the YAML,
+## and called after EVERY `ddev config` that follows a create-project: a project
+## template ships its own .ddev/config.yaml and can replace the list.
+
+function ddev_telemetry_off() {
+  ddev config --web-environment-add=DRUPAL_CMS_TELEMETRY=0 > /dev/null ;
+}

package/core/scripts/functions/fun-default-settings.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+# DDEV owns the database connection: it generates settings.php and
+# settings.ddev.php (db host "db") for drupal-type projects itself. This
+# function no longer writes any $databases block — it only makes sure the
+# config sync directory is configured and stamps the build time.
+function set_default_settings() {
+  echo "Ensure DDEV-managed settings plus the config sync directory.";
+
+  local settings_file="${WORKSPACE_ROOT}/${doc_name}/${PROJECT_NAME}/${distribution_webroot}/sites/default/settings.php" ;
+
+  # Create the config/sync folder.
+  mkdir -p ${WORKSPACE_ROOT}/${doc_name}/${PROJECT_NAME}/config/sync ;
+
+  if [ -f "${settings_file}" ]; then
+    # Fixed, not a setting: it has to match the config/sync created above.
+    if ! grep -q "config_sync_directory" "${settings_file}" ; then
+      # Defaulted here rather than asked for in the settings: ../config/sync is the Drupal
+      # convention and the folder created just above. Setting config_sync_directory in
+      # settings.yml still overrides it.
+      echo "\$settings['config_sync_directory'] = '${config_sync_directory:-../config/sync}';" >> "${settings_file}" ;
+    fi
+    build_time=$( date '+%Y-%m-%d %H-%M-%S' );
+    echo "// Built time: ${build_time}" >> "${settings_file}" ;
+  else
+    echo "settings.php not found yet — DDEV will generate it on start/install." ;
+  fi
+}

package/core/scripts/functions/fun-distribution-cucumber.sh

@@ -0,0 +1,45 @@
+#!/usr/bin/env bash
+
+# Install Cucumber with Drush.
+function install_cucumber_with_drush() {
+  echo "Install Cucumber with Drush.";
+  ddev drush site:install cucumber --yes --site-name="${doc_name} ${PROJECT_NAME}" --account-name="${account_name}" --account-pass="${account_pass}" --account-mail="${account_mail}" --db-url="mysql://db:db@db/db" ;
+}
+
+# Enable Cucumber extra components.
+function enable_cucumber_extra_components() {
+  echo "Enable Cucumber extra components.";
+}
+
+# The default set of users `add_users` creates for Cucumber (--add-users).
+function set_cucumber_users() {
+  users=(authenticated developer tester analyst coordinator product_owner administrator);
+  user_authenticated_name="Authenticated user";
+  user_authenticated_mail="test.authenticated@webship.org";
+  user_authenticated_password="dD.123123ddd";
+  user_authenticated_role="_none_";
+  user_developer_name="Developer";
+  user_developer_mail="test.developer@webship.org";
+  user_developer_password="dD.123123ddd";
+  user_developer_role="developer";
+  user_tester_name="Tester";
+  user_tester_mail="test.tester@webship.org";
+  user_tester_password="dD.123123ddd";
+  user_tester_role="tester";
+  user_analyst_name="Analyst";
+  user_analyst_mail="test.analyst@webship.org";
+  user_analyst_password="dD.123123ddd";
+  user_analyst_role="analyst";
+  user_coordinator_name="Coordinator";
+  user_coordinator_mail="test.coordinator@webship.org";
+  user_coordinator_password="dD.123123ddd";
+  user_coordinator_role="coordinator";
+  user_product_owner_name="Product Owner";
+  user_product_owner_mail="test.product_owner@webship.org";
+  user_product_owner_password="dD.123123ddd";
+  user_product_owner_role="product_owner";
+  user_administrator_name="Administrator";
+  user_administrator_mail="test.administrator@webship.org";
+  user_administrator_password="dD.123123ddd";
+  user_administrator_role="administrator";
+}

package/core/scripts/functions/fun-distribution-drupal.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+# Install Drupal with Drush.
+function install_drupal_with_drush() {
+    echo "Install Drupal with Drush.";
+  ddev drush site:install ${PROFILE[*]} --yes --site-name="${doc_name} ${PROJECT_NAME}" --account-name="${account_name}" --account-pass="${account_pass}" --account-mail="${account_mail}" --db-url="mysql://db:db@db/db" --locale="en" install_configure_form.enable_update_status_emails=NULL --debug -vvv ;
+}
+
+# Enable Drupal extra components.
+function enable_drupal_extra_components() {
+  echo "Enable Drupal extra components.";
+
+}
+# The default set of users `add_users` creates for Drupal (--add-users).
+function set_drupal_users() {
+  users=(authenticated administrator);
+  user_authenticated_name="Authenticated user";
+  user_authenticated_mail="test.authenticated@webship.org";
+  user_authenticated_password="dD.123123ddd";
+  user_authenticated_role="_none_";
+  user_administrator_name="Administrator";
+  user_administrator_mail="test.administrator@webship.org";
+  user_administrator_password="dD.123123ddd";
+  user_administrator_role="administrator";
+}

package/core/scripts/functions/fun-distribution-drupal_cms.sh

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+
+# Install Drupal CMS with Drush.
+#
+# Drupal CMS ships the `drupal_cms_installer` profile, whose install tasks are
+# ordinary forms, so they can be driven non-interactively. The site-template step
+# (`installer_site_template_form`) settles on `drupal_cms_starter` by itself on a
+# non-interactive install, which is what a plain Drupal CMS build wants.
+#
+# Choosing a different template is what the site-templates workspace is for: those
+# builders require the template package and name it to the same form.
+function install_drupal_cms_with_drush() {
+  echo "Install Drupal CMS with Drush.";
+
+  ddev drush site:install drupal_cms_installer --yes --site-name="${doc_name} ${PROJECT_NAME}" --account-name="${account_name}" --account-pass="${account_pass}" --account-mail="${account_mail}" --db-url="mysql://db:db@db/db" --locale="en" installer_site_name_form.site_name="${doc_name} ${PROJECT_NAME}" ;
+}
+
+# Enable Drupal CMS extra components.
+function enable_drupal_cms_extra_components() {
+  echo "Enable Drupal CMS extra components.";
+
+}
+
+# The default set of users `add_users` creates for Drupal CMS (--add-users).
+function set_drupal_cms_users() {
+  users=(authenticated administrator);
+  user_authenticated_name="Authenticated user";
+  user_authenticated_mail="test.authenticated@webship.org";
+  user_authenticated_password="dD.123123ddd";
+  user_authenticated_role="_none_";
+  user_administrator_name="Administrator";
+  user_administrator_mail="test.administrator@webship.org";
+  user_administrator_password="dD.123123ddd";
+  user_administrator_role="administrator";
+}

package/core/scripts/functions/fun-distribution-webship.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+# Install Webship with Drush.
+function install_webship_with_drush() {
+  echo "Install Webship with Drush.";
+  ddev drush site:install webship --yes --site-name="${doc_name} ${PROJECT_NAME}" --account-name="${account_name}" --account-pass="${account_pass}" --account-mail="${account_mail}" --db-url="mysql://db:db@db/db" ;
+}
+
+# Enable Webship extra components.
+function enable_webship_extra_components() {
+  echo "Enable Webship extra components.";
+}
+# The default set of users `add_users` creates for Webship (--add-users).
+function set_webship_users() {
+  users=(authenticated content_editor administrator);
+  user_authenticated_name="Authenticated user";
+  user_authenticated_mail="test.authenticated@webship.org";
+  user_authenticated_password="dD.123123ddd";
+  user_authenticated_role="_none_";
+  user_content_editor_name="Content editor";
+  user_content_editor_mail="test.content_editor@webship.org";
+  user_content_editor_password="dD.123123ddd";
+  user_content_editor_role="content_editor";
+  user_administrator_name="Webmaster";
+  user_administrator_mail="test.Webmaster@webship.org";
+  user_administrator_password="dD.123123ddd";
+  user_administrator_role="administrator";
+}

package/core/scripts/functions/fun-distribution-webships.sh

@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+
+# Install Webships with Drush.
+function install_webships_with_drush() {
+  echo "Install Webships with Drush.";
+  ddev drush site:install webships --yes --site-name="${doc_name} ${PROJECT_NAME}" --account-name="${account_name}" --account-pass="${account_pass}" --account-mail="${account_mail}" --db-url="mysql://db:db@db/db" ;
+}
+
+# Enable Webships extra components.
+function enable_webships_extra_components() {
+  echo "Enable Webships extra components.";
+}
+
+# The default set of users `add_users` creates for Webships (--add-users).
+function set_webships_users() {
+  users=(authenticated app_admin api_admin administrator);
+  user_authenticated_name="Authenticated user";
+  user_authenticated_mail="test.authenticated@webship.org";
+  user_authenticated_password="dD.123123ddd";
+  user_authenticated_role="_none_";
+  user_app_admin_name="App Admin";
+  user_app_admin_mail="test.app_admin@webship.org";
+  user_app_admin_password="dD.123123ddd";
+  user_app_admin_role="api_admin";
+  user_api_admin_name="API Admin";
+  user_api_admin_mail="test.api_admin@webship.org";
+  user_api_admin_password="dD.123123ddd";
+  user_api_admin_role="api_admin";
+  user_administrator_name="Super Admin";
+  user_administrator_mail="test.administrator@webship.org";
+  user_administrator_password="dD.123123ddd";
+  user_administrator_role="administrator";
+}

package/core/scripts/functions/fun-distribution-website.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+# The default set of users `add_users` creates for the Website stack (--add-users).
+# The site templates build on the Standard recipe roles.
+function set_website_users() {
+  users=(authenticated content_editor administrator);
+  user_authenticated_name="Authenticated user";
+  user_authenticated_mail="test.authenticated@webship.org";
+  user_authenticated_password="dD.123123ddd";
+  user_authenticated_role="_none_";
+  user_content_editor_name="Content editor";
+  user_content_editor_mail="test.content_editor@webship.org";
+  user_content_editor_password="dD.123123ddd";
+  user_content_editor_role="content_editor";
+  user_administrator_name="Webmaster";
+  user_administrator_mail="test.webmaster@webship.org";
+  user_administrator_password="dD.123123ddd";
+  user_administrator_role="administrator";
+}

package/core/scripts/functions/fun-drush.sh

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# Add Drush if it was not in the system.
+function add_drush() {
+  echo "Add Drush if it was not in the system.";
+  if [ ! -d "${WORKSPACE_ROOT}/${doc_name}/${PROJECT_NAME}/vendor/drush/drush" ]; then
+    cd ${WORKSPACE_ROOT}/${doc_name}/${PROJECT_NAME};
+    # Which Drush a core can take is a fact about that core, so a builder may declare it
+    # and the rest keep what they have always had. Drupal 12 needs its own: core 12
+    # requires guzzle 8, every tagged Drush (through 13) requires guzzle ^7, and the
+    # resolver refuses the pair — which surfaces LATER as "drush is not available" at
+    # site:install, three steps from the line that caused it.
+    ddev composer require "drush/drush:${site_drush_version:-~11 || ~13}";
+  fi
+
+  # DDEV rewrites its shared command directory whenever ANY project on this machine starts, and `ddev drush`
+  # is missing from it for a moment. Wait for it, instead of failing the install on its very first line.
+  local attempt;
+  for attempt in 1 2 3 4 5 6 7 8 9 10 ; do
+    ddev drush --version > /dev/null 2>&1 && return 0 ;
+    echo "ddev drush is not available yet (attempt ${attempt} of 10), waiting." ;
+    sleep 6 ;
+  done
+  echo "ddev drush is still not available — the install cannot start." ;
+  return 1 ;
+}
+
+# Cache Rebuilding ...
+function drush_cr() {
+  echo "Cache Rebuilding ..."
+  ddev drush cache:rebuild ;
+}
+
+# Set Aggrigation off and error level all
+function drush_set_debug_on() {
+  echo "Set Aggrigation off and error_level on";
+  ddev drush config:set system.performance css.preprocess 0 --yes ;
+  ddev drush config:set system.performance js.preprocess 0 --yes ;
+  ddev drush config:set system.logging error_level all --yes ;
+}
+
+# Set Aggrigation ON and error level OFF
+function drush_set_debug_off() {
+  echo "Set Aggrigation ON and error_level OFF";
+  ddev drush config:set system.performance css.preprocess 1 --yes ;
+  ddev drush config:set system.performance js.preprocess 1 --yes ;
+  ddev drush config:set system.logging error_level 0 --yes ;
+}