Switch adhoc backends to use same script

Author: wctaylor

README.md

@@ -55,14 +55,14 @@ To run the whole system via Terraform, juju and charms simulating production and
 
 A charmed Test Observer deployment can be integration tested using `charmcraft test` (which itself internally uses a classically confined copy of [spread](https://github.com/canonical/spread) bundled with `charmcraft`).
 
-The integration tests are runnable either locally (using [lxd](https://documentation.ubuntu.com/lxd/en/latest/installing/) at the time of writing) or using GitHub. Alternative test execution backends are configurable by adding new `adhoc` backends next to `lxd` and `github` in the [spread.yaml](./spread.yaml).
+The integration tests are runnable either locally or using GitHub. Alternative test execution backends are configurable by adding new `adhoc` backends next to `lxd-vm` and `localhost` in the [spread.yaml](./spread.yaml).
 
 ### Run integration tests locally
 
 Tests can be run locally with either `charmcraft test lxd` or `charmcraft.spread lxd` (the latter gives a bit more verbose log output).
 
 ```bash
-charmcraft.spread -v lxd
+charmcraft.spread -v lxd-vm
 ```
 
 ### Jump into a `spread` provided shell environment
@@ -71,11 +71,11 @@ To debug the charm integration tests, you can jump into a `spread` provided envi
 
 ```bash
 # open a shell to the execution environment _before_ executing each test task 
-charmcraft.spread -v -shell-before lxd 
+charmcraft.spread -v -shell-before lxd-vm
 
 # open a shell to the execution environment _instead of_ executing each test task 
-charmcraft.spread -v -shell lxd
+charmcraft.spread -v -shell lxd-vm
 
 # open a shell to the execution environment _after_ of executing each test task 
-charmcraft.spread -v -shell-after lxd
+charmcraft.spread -v -shell-after lxd-vm
 ```

spread.yaml

@@ -1,21 +1,5 @@
 project: test-observer-charm-tests
 
-# This is the path the project is copied to on the worker systems
-# and it is set to the SPREAD_PATH environment variable after allocation
-# It must be under /root because spread executes the test scripts
-# as root, which means that juju can only see files in root's
-# home directory due to snap confinement.
-path: /root/project
-
-exclude:
-  - .coverage
-  - .git
-  - .github
-  - .pytest_cache
-  - .ruff_cache
-  - .tox
-  - .venv
-
 backends:
   # The LXD backend can hit this error, so we define our own lxd backend
   # https://github.com/canonical/spread/issues/232
@@ -37,25 +21,20 @@ backends:
       # so we replace everything else with a hyphen
       NAME="$(echo "${NAME}" | sed 's/[^a-zA-Z0-9-]/-/g')"
 
+      RUN_UPDATE_SCRIPT="false"
       EXISTS="$(lxc list --format csv --columns n name="${NAME}")"
       if [[ -z "${EXISTS}" ]]; then
         # Get the image portion, e.g. 24.04 from ubuntu-24.04
         IMAGE="$(echo "${SPREAD_SYSTEM}" | cut -d '-' -f 2)"
 
-        CLOUD_INIT_USER_DATA="$(mktemp)"
-        cp spread/cloud-init-user-data.yaml "${CLOUD_INIT_USER_DATA}"
-        sed -i "s|SPREAD_REPLACE_USERNAME|${SPREAD_SYSTEM_USERNAME}|g" "${CLOUD_INIT_USER_DATA}"
-        sed -i "s|SPREAD_REPLACE_PASSWORD|${SPREAD_PASSWORD}|g" "${CLOUD_INIT_USER_DATA}"
-
         # We need to use the ubuntu: remote, because it provides Ubuntu Server images,
         # which work with cloud-init. Ubuntu Desktop images do not.
         lxc launch --vm "ubuntu:${IMAGE}" "${NAME}" \
-          --config cloud-init.user-data="$(cat "${CLOUD_INIT_USER_DATA}")" \
           --config limits.cpu="${LIMIT_CPU_CORES}" \
           --config limits.memory="${LIMIT_MEMORY_GIB}GiB" \
           --device root,size="${ROOT_DISK_GIB}GiB"
 
-        rm "${CLOUD_INIT_USER_DATA}"
+        RUN_UPDATE_SCRIPT="true"
       fi
 
       # Wait for the VM to come up and have an IP address
@@ -72,6 +51,17 @@ backends:
         sleep 5
       done
 
+      if [[ "${RUN_UPDATE_SCRIPT}" == "true" ]]; then
+        UPDATE_SCRIPT="spread/update-adhoc-system.sh"
+        cp spread/update-adhoc-system-template.sh "${UPDATE_SCRIPT}"
+        sed -i "s|SPREAD_REPLACE_USERNAME|${SPREAD_SYSTEM_USERNAME}|g" "${UPDATE_SCRIPT}"
+        sed -i "s|SPREAD_REPLACE_PASSWORD|${SPREAD_PASSWORD}|g" "${UPDATE_SCRIPT}"
+
+        lxc file push "${UPDATE_SCRIPT}" "${NAME}"/root/update-adhoc-system.sh
+        lxc exec "${NAME}" -- bash /root/update-adhoc-system.sh allocate
+        rm "${UPDATE_SCRIPT}"
+      fi
+
       # adhoc backends require the ADDRESS command provided by spread
       # to set the SSH address
       ADDRESS "${address}"
@@ -99,26 +89,34 @@ backends:
     # it should only run when explicitly requested
     manual: true
     allocate: |
-      sudo sed -i "s|#PasswordAuthentication yes|PasswordAuthentication yes|g" /etc/ssh/sshd_config
-      sudo sed -i "s|KbdInteractiveAuthentication no|KbdInteractiveAuthentication yes|g" /etc/ssh/sshd_config
-      sudo cp /etc/ssh/sshd_config.d/60-cloudimg-settings.conf /etc/ssh/sshd_config.d/60-cloudimg-settings.conf.bak || true
-      sudo rm -f /etc/ssh/sshd_config.d/60-cloudimg-settings.conf || true
-      sudo systemctl daemon-reload
-      sudo systemctl restart ssh
+      UPDATE_SCRIPT="spread/update-adhoc-system.sh"
+      cp spread/update-adhoc-system-template.sh "${UPDATE_SCRIPT}"
+      sed -i "s|SPREAD_REPLACE_USERNAME|${SPREAD_SYSTEM_USERNAME}|g" "${UPDATE_SCRIPT}"
+      sed -i "s|SPREAD_REPLACE_PASSWORD|${SPREAD_PASSWORD}|g" "${UPDATE_SCRIPT}"
 
-      sudo useradd ${SPREAD_SYSTEM_USERNAME} --shell /bin/bash --create-home || true
-      echo "${SPREAD_SYSTEM_USERNAME}:${SPREAD_PASSWORD}" | sudo chpasswd || true
-      echo "${SPREAD_SYSTEM_USERNAME} ALL=(ALL) NOPASSWD:ALL " | sudo tee /etc/sudoers.d/99-${SPREAD_SYSTEM_USERNAME}-user || true
+      bash "${UPDATE_SCRIPT}" allocate
 
       ADDRESS "127.0.0.1"
 
     discard: |
-      sudo userdel -f -r ${SPREAD_SYSTEM_USERNAME} || true
-      sudo rm -f /etc/sudoers.d/99-${SPREAD_SYSTEM_USERNAME}-user || true
-      sudo rm -f /etc/ssh/sshd_config.d/60-cloudimg-settings.conf || true
-      sudo mv /etc/ssh/sshd_config.d/60-cloudimg-settings.conf.bak /etc/ssh/sshd_config.d/60-cloudimg-settings.conf || true
-      sudo sed -i "s|KbdInteractiveAuthentication yes|KbdInteractiveAuthentication no|g" /etc/ssh/sshd_config
-      sudo sed -i "s|PasswordAuthentication yes|#PasswordAuthentication yes|g" /etc/ssh/sshd_config
+      bash spread/update-adhoc-system.sh discard
+      rm spread/update-adhoc-system.sh
+
+# This is the path the project is copied to on the backend systems
+# once they are allocated. It is set to the SPREAD_PATH environment variable.
+# It must be under /root because spread executes the test scripts
+# as root, which means that the juju snap can only see files in root's
+# home directory due to snap confinement.
+path: /root/project
+
+exclude:
+  - .coverage
+  - .git
+  - .github
+  - .pytest_cache
+  - .ruff_cache
+  - .tox
+  - .venv
 
 environment:
   CONCIERGE_JUJU_CHANNEL: 3.6/stable

spread/update-adhoc-system-template.sh

@@ -0,0 +1,42 @@
+#!/bin/bash
+
+# Check if exactly one argument was provided
+if [ "$#" -ne 1 ]; then
+    echo "Usage: $0 <allocate|discard>"
+    exit 1
+fi
+
+SPREAD_SYSTEM_USERNAME=SPREAD_REPLACE_USERNAME
+SPREAD_PASSWORD=SPREAD_REPLACE_PASSWORD
+
+MODE=$1
+case "${MODE}" in
+    "allocate")
+        sudo sed -i "s|#PasswordAuthentication yes|PasswordAuthentication yes|g" /etc/ssh/sshd_config
+        sudo sed -i "s|KbdInteractiveAuthentication no|KbdInteractiveAuthentication yes|g" /etc/ssh/sshd_config
+        sudo cp /etc/ssh/sshd_config.d/60-cloudimg-settings.conf /etc/ssh/sshd_config.d/60-cloudimg-settings.conf.bak || true
+        sudo rm -f /etc/ssh/sshd_config.d/60-cloudimg-settings.conf || true
+        sudo systemctl daemon-reload
+        sudo systemctl restart ssh
+
+        sudo useradd ${SPREAD_SYSTEM_USERNAME} --shell /bin/bash --create-home || true
+        echo "${SPREAD_SYSTEM_USERNAME}:${SPREAD_PASSWORD}" | sudo chpasswd || true
+        echo "${SPREAD_SYSTEM_USERNAME} ALL=(ALL) NOPASSWD:ALL " | sudo tee /etc/sudoers.d/99-${SPREAD_SYSTEM_USERNAME}-user || true
+        ;;
+    
+    "discard")
+        sudo userdel -f -r ${SPREAD_SYSTEM_USERNAME} || true
+        sudo rm -f /etc/sudoers.d/99-${SPREAD_SYSTEM_USERNAME}-user || true
+        sudo rm -f /etc/ssh/sshd_config.d/60-cloudimg-settings.conf || true
+        sudo mv /etc/ssh/sshd_config.d/60-cloudimg-settings.conf.bak /etc/ssh/sshd_config.d/60-cloudimg-settings.conf || true
+        sudo sed -i "s|KbdInteractiveAuthentication yes|KbdInteractiveAuthentication no|g" /etc/ssh/sshd_config
+        sudo sed -i "s|PasswordAuthentication yes|#PasswordAuthentication yes|g" /etc/ssh/sshd_config
+        ;;
+
+    *)
+        echo "Invalid mode: ${MODE}. Use 'allocate' or 'discard'."
+        exit 1
+        ;;
+esac
+
+exit 0