small improvements to the test env setup scripts

Author: gggeek

tests/ci/Dockerfile

@@ -10,7 +10,7 @@ COPY config/* /root/config/
 
 RUN if [ ! -f /.dockerenv ]; then touch /.dockerenv; fi && \
   cd /root/setup && \
-  ./install_packages.sh && \
+  ./install_packages.sh -u && \
   ./create_user.sh && \
   ./setup_perl.sh && \
   ./setup_apache.sh && \

tests/ci/setup/create_user.sh

@@ -7,6 +7,8 @@ set -e
 echo "Creating user account..."
 
 USERNAME="${1:-docker}"
+USER_ID=2000
+USER_GID=2000
 
 # adduser is not preinstalled on noble
 DEBIAN_FRONTEND=noninteractive apt-get install -y \
@@ -18,8 +20,8 @@ if [ -d /home/ubuntu ]; then
     rm -rf ubuntu
 fi
 
-addgroup --gid 2000 "${USERNAME}"
-adduser --system --uid=2000 --gid=2000 --home "/home/${USERNAME}" --shell /bin/bash "${USERNAME}"
+addgroup --gid "${USER_GID}" "${USERNAME}"
+adduser --system --uid="${USER_ID}" --gid="${USER_GID}" --home "/home/${USERNAME}" --shell /bin/bash "${USERNAME}"
 adduser "${USERNAME}" "${USERNAME}"
 
 mkdir -p "/home/${USERNAME}/.ssh"

tests/ci/setup/install_packages.sh

@@ -1,20 +1,35 @@
 #!/bin/sh
 
-# Has to be run as admin
+# Has to be run as root
 
 set -e
 
 echo "Installing base software packages..."
 
-# @todo make updating of preinstalled sw optional, so that f.e. we can have faster builds as part of CI
+UPDATE_INSTALLED=false
 
 export DEBIAN_FRONTEND=noninteractive
 
+while getopts ":u" opt
+do
+    case $opt in
+        u)
+          UPDATE_INSTALLED=true
+          ;;
+        \?)
+          echo "Invalid option: -$OPTARG" >&2
+          exit 1
+          ;;
+    esac
+done
+
 if [ ! -d /usr/share/man/man1 ]; then mkdir -p /usr/share/man/man1; fi
 
 apt-get update
 
-apt-get upgrade -y
+if [ "$UPDATE_INSTALLED" = true ]; then
+    apt-get upgrade -y
+fi
 
 apt-get install -y \
     git locales sudo unzip wget

tests/ci/setup/setup_apache.sh

@@ -1,8 +1,8 @@
 #!/bin/sh
 
 # Install and configure apache2
-# Has to be run as admin
-# @todo make this work across all ubuntu versions (precise to noble)
+# Has to be run as root
+# @todo make sure this works across all ubuntu versions (precise to noble)
 
 echo "Installing and configuring Apache2..."
 
@@ -35,11 +35,11 @@ if [ -f /etc/apache2/sites-available/default-ssl.conf ]; then
     rm /etc/apache2/sites-available/default-ssl.conf
 fi
 
-# NB: TESTS_ROOT_DIR in /etc/apache2/envvars is reset by entrypoint.sh when running in a local container
-# @todo avoid adding these lines if they already exist
+# @todo avoid adding these lines if they already exist - rewrite them instead
 if [ -n "${GITHUB_ACTIONS}" ]; then
     echo "export TESTS_ROOT_DIR=$(pwd)" >> /etc/apache2/envvars
 else
+    # NB: TESTS_ROOT_DIR in /etc/apache2/envvars is reset by entrypoint.sh when running in a local container
     echo "export TESTS_ROOT_DIR=/var/www/html" >> /etc/apache2/envvars
 fi
 echo "export HTTPSERVER=localhost" >> /etc/apache2/envvars

tests/ci/setup/setup_app.sh

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 # Install and configure the 'app'
-# Has to be run as admin
+# Has to be run as root
 
 set -e
 

tests/ci/setup/setup_composer.sh

@@ -29,7 +29,7 @@ rm composer-setup.php
 
 ###
 
-if [ -f /usr/local/bin/composer.phar -a "$RESULT" = 0 ]; then
+if [ -f /usr/local/bin/composer.phar ] && [ "$RESULT" = 0 ]; then
     mv /usr/local/bin/composer.phar /usr/local/bin/composer && chmod 755 /usr/local/bin/composer
 fi
 

tests/ci/setup/setup_perl.sh

@@ -2,7 +2,7 @@
 
 # Installs php modules necessary to test the Perl file in the extras dir
 
-# Has to be run as admin
+# Has to be run as root
 
 # @todo test in the VM env: do we need any ubuntu dev packages ?
 

tests/ci/setup/setup_php.sh

@@ -1,12 +1,12 @@
 #!/bin/sh
 
-# Has to be run as admin
+# Has to be run as root
 
 # @todo make it optional to install xdebug. It is fe. missing in sury's ppa for Xenial
 # @todo make it optional to install fpm. It is not needed for the cd workflow
 # @todo make it optional to disable xdebug ?
 # @todo set the list of required php extensions in a variable, allow it to be overridden
-# @todo allow to force usage of shivammatur/ondrej repos regardless of php version in use
+# @todo allow to force usage of shivammatur or ondrej repos regardless of php version in use
 
 set -e
 

tests/ci/setup/setup_privoxy.sh

@@ -1,15 +1,17 @@
 #!/bin/sh
 
 # Install and configure privoxy
-# Has to be run as admin
+# Has to be run as root
 
 set -e
 
 echo "Installing privoxy..."
 
 SCRIPT_DIR="$(dirname "$(readlink -f "$0")")"
 
-DEBIAN_FRONTEND=noninteractive apt-get install -y privoxy
+export DEBIAN_FRONTEND=noninteractive
+
+apt-get install -y privoxy
 
 cp -f "$SCRIPT_DIR/../config/privoxy" /etc/privoxy/config
 service privoxy restart

tests/ci/vm.sh

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 # @todo rename: this is not based on a vm. Also, the 'ci' folder should really be called 'env' or 'testenv'...
-# @todo support getting the various settings as cli options as well as via env vars?
+# @todo support getting the various settings as cli options as well as via env vars (use getopts)
 
 set -e
 
@@ -317,6 +317,11 @@ case "${ACTION}" in
         unlock
         ;;
 
+    -h)
+        help
+        exit 0
+        ;;
+
     *)
         printf "\n\e[31mERROR:\e[0m unknown action '%s'\n\n" "${ACTION}" >&2
         help