create.sh

#!/bin/bash -e
#
# create.sh - Create Docker containers based on Joomla Git branches.
#   create
#   create 51 pgsql socket no-cache
#   create 52 53 php8.1 recreate
#   create 52 https://github.com/Elfangor93/joomla-cms:mod_community_info
#
# Distributed under the GNU General Public License version 2 or later, Copyright (c) 2024 Heiko Lübbe
# https://github.com/muhme/joomla-branches-tester

if [[ $(dirname "$0") != "scripts" || ! -f "scripts/helper.sh" ]]; then
  echo "Please run me as 'scripts/create'. Thank you for your cooperation! :)"
  exit 1
fi

source scripts/helper.sh

function help {
  echo "
    create – Creates the base and Joomla web server Docker containers.
             One or more optional Joomla versions, see 'scripts/versions' (default is ${allUsedBranches[*]}).
             The optional database variant can be one of: ${JBT_DB_VARIANTS[*]} (default is mariadbi).
             The optional 'socket' argument configures database access via Unix socket (default is TCP host).
             The optional 'IPv6' argument enables support for IPv6 (default is IPv4).
             The optional 'no-cache' argument disables Docker build caching (default is enabled).
             The optional 'recreate' argument creates or recreates specified web server containers.
             The optional PHP version can be set to one of: ${JBT_VALID_PHP_VERSIONS[0]} ... ${JBT_VALID_PHP_VERSIONS[${#JBT_VALID_PHP_VERSIONS[@]}-2]} (default is highest).
             The optional 'repository:branch' argument (default repository is https://github.com/joomla/joomla-cms).
             Optionally specify one or more patches (e.g., 'joomla-cypress-36'; default is unpatched).
             The optional argument 'help' displays this page. For full details see https://bit.ly/JBT-README.
    $(random_quote)"
}

# Wait until MySQL database is up and running
#
function waitForMySQL {
  MAX_ATTEMPTS=60
  attempt=1
  until docker exec jbt-mysql mysqladmin ping -h"127.0.0.1" --silent || [ $attempt -eq $MAX_ATTEMPTS ]; do
    log "Waiting for MySQL to be ready, attempt $attempt of $MAX_ATTEMPTS"
    attempt=$((attempt + 1))
    sleep 1
  done
  # If the MAX_ATTEMPTS are exceeded, simply try to continue.
}

# shellcheck disable=SC2207 # There are no spaces in version numbers
allUsedBranches=($(getAllUsedBranches))

# Defaults to use MariaDB with MySQLi database driver, to use cache and PHP 8.1.
database_variant="mariadbi"
socket=""
network="IPv4"
no_cache=false
recreate=false
php_version="highest"
versionsToInstall=()
unpatched=false
patches=()
while [ $# -ge 1 ]; do
  if [[ "$1" =~ ^(help|-h|--h|-help|--help|-\?)$ ]]; then
    help
    exit 0
  elif isValidVersion "$1"; then
    versionsToInstall+=("$(fullName "$1" | awk '{print $1}')")
    shift # Argument is eaten as one version number.
  elif [ "$1" = "socket" ]; then
    socket="socket"
    shift # Argument is eaten as use database with socket.
  elif [ "$1" = "recreate" ]; then
    recreate=true
    shift # Argument is eaten as option recreate.
  elif isValidVariant "$1"; then
    database_variant="$1"
    shift # Argument is eaten as database variant.
  elif [ "$1" = "IPv6" ]; then
    network="IPv6"
    shift # Argument is eaten as IPv6 option.
  elif [ "$1" = "no-cache" ]; then
    no_cache=true
    shift # Argument is eaten as no cache option.
  elif isValidPHP "$1"; then
    php_version="$1"
    shift # Argument is eaten as PHP version.
  elif [[ "$1" == *:* ]]; then
    # Split into repository and branch.
    arg_repository="${1%:*}" # remove everything after the last ':'
    arg_branch="${1##*:}"    # everything after the last ':'
    shift                    # Argument is eaten as repository:branch.
  elif [ "$1" = "unpatched" ]; then
    unpatched=true
    shift # Argument is eaten as unpatched option.
  elif [[ "$1" =~ ^(joomla-cms|joomla-cypress|database)-[0-9]+$ ]]; then
    patches+=("$1")
    shift # Argument is eaten as a patch.
  else
    help
    error "Argument '$1' is not valid."
    exit 1
  fi
done

# Zeroth check host.docker.internal entry
HOSTS_FILE="/etc/hosts"
if grep -Eq "127.0.0.1[[:space:]]+host.docker.internal" "$HOSTS_FILE"; then
  log "Entry '127.0.0.1 host.docker.internal' already exists in the file '${HOSTS_FILE}'"
else
  log "Adding entry '127.0.0.1 host.docker.internal' to the file '${HOSTS_FILE}'"
  sudo sh -c "echo '127.0.0.1 host.docker.internal' >> $HOSTS_FILE"
  if ! grep -Eq "127.0.0.1[[:space:]]+host.docker.internal" "$HOSTS_FILE"; then
    error "Please add entry '127.0.0.1 host.docker.internal' to the file '${HOSTS_FILE}'."
    exit 1
  fi
fi

if [ -n "${git_repository}" ] && [ ${#versionsToInstall[@]} -ne 1 ]; then
  error "If you use repository:branch, please specify one Joomla version."
  exit 1
fi

if [ "$recreate" = true ] && [ ! -f docker-compose.yml ]; then
  error "The 'recreate' option was given, but no 'docker-compose.yml' file exists. Please run 'scripts/create' first."
  exit 1
fi

# If no version was given, use all.
if [ ${#versionsToInstall[@]} -eq 0 ]; then
  versionsToInstall=("${allUsedBranches[@]}")
fi

if [ "$unpatched" = true ]; then
  patches=("unpatched")
elif [ ${#patches[@]} -eq 0 ]; then
  patches=("${JBT_DEFAULT_PATCHES[@]}")
fi
# else: patches are already filled in the array

if [ "$recreate" = false ]; then

  # Delete all docker containers and branches_* directories.
  scripts/clean.sh

  # Create Docker Compose setup with Joomla web servers for all versions to be installed.
  log "Create 'docker-compose.yml' file for version(s) ${versionsToInstall[*]}, based on ${php_version} PHP version and ${network}"
  createDockerComposeFile "${versionsToInstall[*]}" "${php_version}" "${network}"

  if $no_cache; then
    log "Running 'docker compose build --no-cache'"
    docker compose build --no-cache
  fi

  log "Running 'docker compose up'"
  docker compose up -d
fi

# Wait until MySQL database is up and running
# (This isn't accurate when using MariaDB or PostgreSQL, but so far it's working with the delay from MySQL.)
waitForMySQL

if [ "$recreate" = false ]; then

  # Disable MySQL binary logging to prevent waste of space
  # see https://github.com/joomla-docker/docker-joomla/issues/197
  log "Disable MySQL binary logging"
  docker exec jbt-mysql bash -c "sed -i '/^\[mysqld\]/a skip-log-bin' '/etc/my.cnf'"
  docker restart jbt-mysql
  waitForMySQL

  # For the tests we need old-school user/password login, once over TCP and once for localhost with Unix sockets
  log "Enable MySQL user root login with password"
  docker exec jbt-mysql mysql -uroot -proot \
    -e "ALTER USER 'root'@'%' IDENTIFIED WITH mysql_native_password BY 'root';" \
    -e "ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'root';"
  # And for MariaDB too
  log "Enable MariaDB user root login with password"
  docker exec jbt-madb mysql -uroot -proot \
    -e "ALTER USER 'root'@'%' IDENTIFIED BY 'root';" \
    -e "ALTER USER 'root'@'localhost' IDENTIFIED BY 'root';"
  # And Postgres (which have already user postgres with SUPERUSER, but to simplify we will use same user root on postgres)
  log "Create PostgreSQL user root with password root and SUPERUSER role"
  docker exec jbt-pg sh -c "\
  psql -U postgres -c \"CREATE USER root WITH PASSWORD 'root';\" && \
  psql -U postgres -c \"ALTER USER root WITH SUPERUSER;\""
fi

# Performing additional version-independent configurations to complete the base installation.
if [ "$recreate" = false ]; then
  log "jbt-cypress – Installing git, vim, ping, ip, telnet and netstat"
  docker exec jbt-cypress sh -c "apt-get update && apt-get install -y git vim iputils-ping iproute2 telnet net-tools"

  log "jbt-cypress – JBT 'installation' environment – installing cypress@latest"
  # First free 652 MB for pre-installed Cypress 13.14.2
  docker exec "jbt-cypress" bash -c "rm -rf /root/.cache/Cypress && \
                                     cd /jbt/installation && \
                                     npm install cypress-file-upload cypress@latest && \
                                     CYPRESS_CACHE_FOLDER=/jbt/cypress-cache npx cypress@latest install"

  # JBT Cypress Installation Environment
  log "jbt-cypress – Adding 'installation/joomla-cypress' module as a Git shallow clone of the main branch"
  docker exec "jbt-cypress" bash -c "cd /jbt/installation && \
                                     git clone --depth 1 https://github.com/joomla-projects/joomla-cypress"

  # Browsers are not preinstalled for ARM images with cypress/included – install Firefox
  log "jbt-cypress – Installing Firefox (if needed)"
  docker exec "jbt-cypress" bash -c "apt-get update && \
                                     apt-get install -y --no-install-recommends firefox-esr && \
                                     apt-get clean && \
                                     rm -rf /var/lib/apt/lists/*"

  # With https://github.com/joomla/joomla-cms/pull/44253 Joomla command line client usage has been added
  # to the System Tests. Hopefully, this is only temporary and can be replaced to reduce complexity and dependency.
  log "jbt-cypress – Adding PHP for cli/joomla.php (hopefully only temporary)"
  docker exec "jbt-cypress" bash -c "apt-get update && \
                                     apt-get install -y php php-simplexml php-mysql php-pgsql php-mysqli"

  log "Add bash for Alpine containers"
  for container in "jbt-pga" "jbt-mail"; do
    docker exec -u root ${container} apk add bash || true # Who cares?
  done

  log "Set container prompts for base containers"
  for container in "${JBT_BASE_CONTAINERS[@]}"; do
    docker exec -u root "${container}" sh -c \
      "echo PS1=\'${container} \# \' >> ~/.bashrc" || true # Who cares?
  done

  # pgpass file must me only pgadmin user read & writable
  log "Create pgAdmin password file with owner pgadmin and file mask 600"
  docker cp configs/pgpass jbt-pga:/pgadmin4/pgpass
  docker exec -u 0 jbt-pga bash -c "chmod 600 /pgadmin4/pgpass && chown pgadmin /pgadmin4/pgpass"

  log "*********************************************************************************************************************"
  log "Base installation is completed. If there should be an issue with any of the upcoming version-dependent installations,"
  log "the failed version-dependent installation could be repeated using 'recreate'."
  log "*********************************************************************************************************************"
fi

for version in "${versionsToInstall[@]}"; do
  instance=$(getMajorMinor "${version}")

  if [ "$recreate" = true ]; then

    # Container exists?
    if docker ps -a --format '{{.Names}}' | grep -q "^jbt-${instance}$"; then
      # Running?
      if docker ps --format '{{.Names}}' | grep -q "^jbt-${instance}$"; then
        log "jbt-${instance} – Stopping Docker Container"
        docker compose stop "jbt-${instance}"
      fi
      log "jbt-${instance} – Removing Docker container"
      docker compose rm -f "jbt-${instance}" || log "jbt-${instance} – Ignoring failure to remove Docker container"
    fi

    createDockerComposeFile "${instance}" "${php_version}" "${network}" "append"

    log "jbt-${instance} – Building Docker container"
    docker compose build "jbt-${instance}"

    log "jbt-${instance} – Starting Docker container"
    docker compose up -d "jbt-${instance}"

  fi

  # If the copying has not yet been completed, then we have to wait, or we will get e.g.
  # rm: cannot remove '/var/www/html/libraries/vendor': Directory not empty.
  max_retries=120
  for ((i = 1; i < max_retries; i++)); do
    if docker logs "jbt-${instance}" 2>&1 | grep 'This server is now configured to run Joomla!'; then
      break
    else
      log "jbt-${instance} – Waiting for original Joomla installation, attempt ${i} of ${max_retries}"
      sleep 1
    fi
  done
  if (( i >= max_retries )); then
    error "jbt-${instance} – Failed after $max_retries attempts. Giving up."
    exit 1
  fi
  log "jbt-${instance} – Deleting original Joomla installation"
  docker exec "jbt-${instance}" bash -c 'rm -rf /var/www/html/* && rm -rf /var/www/html/.??*'

  JBT_INTERNAL=42 bash scripts/setup.sh "initial" "${version}" "${database_variant}" "${socket}" \
                                        "${arg_repository}:${arg_branch}" "${patches[@]}"

  log "jbt-${instance} – Installing Joomla required Cypress binary version (if needed)"
  docker exec "jbt-cypress" bash -c "cd '/jbt/joomla-${instance}' && \
                                     CYPRESS_CACHE_FOLDER=/jbt/cypress-cache npx cypress install"

done