patch: use a local version of ssh-uuid.sh

Update dependency balena-io/balena-cli to v22.1.1

.github/renovate.json

@@ -0,0 +1,27 @@
+{
+  "extends": ["github>balena-io/renovate-config"],
+  "ignorePaths": [
+    "**/node_modules/**",
+    "**/bower_components/**",
+    "**/vendor/**",
+    "**/examples/**",
+    "**/__tests__/**",
+    "**/test/**",
+    "**/tests/suites/**",
+    "**/__fixtures__/**",
+    "**/Dockerfile.template"
+  ],
+  "customManagers": [
+    {
+      "customType": "regex",
+      "fileMatch": [
+        ".*"
+      ],
+      "matchStrings": [
+        ".*amiFilter=(?<packageName>.*?)\n(.*currentImageName=(?<currentDigest>.*?)\n)?(.*\n)?.*?(?<depName>[a-zA-Z0-9-_:]*)[ ]*?[:|=][ ]*?[\"|']?(?<currentValue>ami-[a-z0-9]{17})[\"|']?.*"
+      ],
+      "datasourceTemplate": "aws-machine-image",
+      "versioningTemplate": "aws-machine-image"
+    }
+  ]
+}

.github/workflows/flowzone.yml

@@ -8,6 +8,11 @@ on:
     types: [opened, synchronize, closed]
     branches: [main, master]
 
+permissions:
+  contents: read
+  id-token: "write"  # AWS GitHub OIDC required: write
+  packages: read
+
 jobs:
   flowzone:
     name: Flowzone

.github/workflows/ssh-uuid.sh

@@ -0,0 +1,419 @@
+#!/usr/bin/env bash
+
+# Copyright 2022 Balena Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -e  # Exit immediately on unhandled errors
+
+BALENARC_DATA_DIRECTORY="${BALENARC_DATA_DIRECTORY:-"${HOME}/.balena"}"
+
+function quit {
+	echo "ERROR: $1" >/dev/stderr
+	exit 1
+}
+
+# Check that the version of bash meets the requirements.
+# The 'declare -pf' and 'readarray -t' features require bash v4.4 or later.
+function check_bash_version {
+	local major="${BASH_VERSINFO[0]:-0}"
+	local minor="${BASH_VERSINFO[1]:-0}"
+	if (( "${major}" < 4 || ("${major}" == 4 && "${minor}" < 4) )); then
+		quit "\
+bash v${major}.${minor} detected, but this script requires bash v4.4 or later.
+On macOS, it can be updated with 'brew install bash' ( https://brew.sh/ )
+Sorry for the inconvenience!
+"
+	fi
+}
+
+check_bash_version
+
+# Escape the arguments in a way compatible with the POSIX 'sh'. Alternative to
+# bash's printf '%q' (because bash's printf '%q' may produce bash-specific
+# escaping, for example using the $'a\nb' syntax that interprets ASCII control
+# characters, which is not supported by POSIX 'sh'). Useful with the '--service'
+# flag as we do not assume that balenaOS application containers will have 'bash'
+# installed. Based on: https://stackoverflow.com/a/29824428
+function escape_sh {
+	case $# in 0) return 0; esac
+	while :
+	do
+		printf "'"
+		printf %s "$1" | sed "s/'/'\\\\''/g"
+		shift
+		case $# in 0) break; esac
+		printf "' "
+	done
+	printf "'\n"
+}
+
+function print_help_and_quit {
+	echo "For ssh or scp options, check the manual pages: 'man ssh' or 'man scp'.
+For ssh-uuid or scp-uuid usage, see README at:
+https://github.com/pdcastro/ssh-uuid/blob/master/README.md
+" >/dev/stderr
+	exit
+}
+
+# Check whether the BALENA_USERNAME and BALENA_TOKEN environment variables are set, for
+# the purpose of balenaCloud proxy authentication, and as the username to use for ssh
+# public key authentication. If either variable is not set, attempt to obtain the missing
+# value from the balena CLI's ~/.balena/cachedUsername JSON file. That file is created
+# by running the `balena login` command followed by the `balena whoami` command. If you
+# would rather not depend on the balena CLI, set the environment variables manually with
+# the values found in the balenaCloud web dashboard, Preferences page, Account Details and
+# Access Tokens tabs.
+function get_user_and_token {
+	if [[ -n "${BALENA_USERNAME}" && -n "${BALENA_TOKEN}" ]]; then
+		return
+	fi
+	local cached_usr_file="${BALENARC_DATA_DIRECTORY}/cachedUsername"
+	if [[ ! -r "${cached_usr_file}" ]]; then
+		quit "\
+'BALENA_USERNAME' or 'BALENA_TOKEN' env vars not defined, and file
+'${cached_usr_file}' not found or not readable.
+Set the env vars as per README, or use the balena CLI 'login' and 'whoami'
+commands to ensure that file is created.
+"
+	fi
+	check_tool jq
+	local cached_username
+	local cached_token 
+	cached_username="$(jq -r .username "${cached_usr_file}")"
+	cached_token="$(jq -r .token "${cached_usr_file}")"
+	BALENA_USERNAME="${BALENA_USERNAME:-"${cached_username}"}"
+	BALENA_TOKEN="${BALENA_TOKEN:-"${cached_token}"}"
+}
+
+# This function will execute on the balenaOS host OS
+function remote__get_container_name {
+	local service="$1"
+	local len="${#service}"
+	local -a names
+	readarray -t names <<< "$(balena-engine ps --format '{{.Names}}')"
+	local result=''
+	local name
+	for name in "${names[@]}"; do
+		if [ "${name:0:len+1}" = "${service}_" ]; then
+			result="${name}"
+			break
+		fi
+	done
+	echo "${result}"
+}
+
+# This function will execute on the balenaOS host OS with bash v5
+function remote__main {
+	local service="$1"
+	shift
+	local container_name
+	container_name="$(remote__get_container_name "${service}")"
+	if [ -z "${container_name}" ]; then
+		echo "ERROR: Cannot find a running container for service '${service}'" >/dev/stderr
+		exit 1
+	fi
+	local -a args
+	if [ "$#" = 0 ]; then
+		args=('sh')
+	else
+		IFS=' ' args=('sh' '-c' "$*")
+	fi
+	local tty_flags='-i' # without '-i', STDIN is closed
+	[[ "$#" = 0 || -t 0 ]] && tty_flags='-it'
+	[ -n "${SSUU_DEBUG}" ] && set -x
+	balena-engine exec ${tty_flags} "${container_name}" "${args[@]}"
+	{ local status="$?"; [ -n "${SSUU_DEBUG}" ] && set +x; } 2>/dev/null
+	return "${status}"
+}
+
+# Parse a short flag specification like '-N' or '-CNL', the latter being the
+# abbreviated form for '-C' '-N' '-L'. For each short flag, set a global
+# variable in the format "SSUU_FLAG_${flag}". Examples:
+#   parse_short_flag '-N'
+#   -> SSUU_FLAG_N='-N'
+#
+#   parse_short_flag '-CNL'
+#   -> SSUU_FLAG_C='-CNL'
+#      SSUU_FLAG_N='-CNL'
+#      SSUU_FLAG_L='-CNL'
+function parse_short_flag {
+	local spec="$1" # flag spec like '-N' or '-CNL'
+	local i
+	for (( i=1; i<${#spec}; i++ )); do
+		local flag="${spec:i:1}"
+		if [[ "${flag}" =~ [a-zA-Z] ]]; then
+			declare -g SSUU_FLAG_"${flag}"="${spec}"
+		else
+			break
+		fi
+	done
+}
+
+# Parse the arguments and split them between option arguments and positional
+# arguments.
+# Note: the split happens at the first UUID.balena occurrence which is always
+# correct for `ssh`, but not always correct for `scp`. For the purposes of
+# `scp-uuid` however, this potential incorrectness is not important.
+function parse_args {
+	local args=("$@")
+	local nargs=${#args[@]}
+	local i
+	SSUU_USER=''
+	SSUU_OPT_ARGS=()
+	SSUU_POS_ARGS=()
+	for (( i=0; i<nargs; i++ )); do
+		local arg="${args[i]}"
+		if [ "${arg}" = '--help' ]; then
+			print_help_and_quit
+		fi
+		if [ "${arg}" = '--service' ]; then
+			SSUU_SERVICE="${args[++i]}"
+			continue
+		fi
+		# Is arg a UUID.balena hostname specification?
+		# For ssh:
+		#   '[user@]UUID.balena'
+		#   'ssh://[user@]UUID.balena[:port]'
+		# For scp:
+		#   '[user@]UUID.balena:'
+		#   'scp://[user@]UUID.balena[:port][/path]'
+		# where UUID is a hexadecimal number with exactly 32 or 62 characters,
+		# where 62 is not typo meant to read 64, it really is 62.
+		if [[ "${SSUU_SCP}" = 0 &&
+				"${arg}" =~ ^(ssh://)?((.+)@)?([[:xdigit:]]{32}|[[:xdigit:]]{62})\.balena(:[0-9]+)?$
+			]]; then
+			SSUU_USER="${BASH_REMATCH[3]}"
+			SSUU_POS_ARGS=("${args[@]:i}")
+			break
+		elif [[ "${SSUU_SCP}" = 1 &&
+			"${arg}" =~ ^scp://((.+)@)?([[:xdigit:]]{32}|[[:xdigit:]]{62})\.balena(:[0-9]+)?(/.*)?$
+			]]; then
+			SSUU_USER="${BASH_REMATCH[2]}"
+			if [ -z "${SSUU_USER}" ] && [ -n "${BALENA_USERNAME}" ]; then
+				SSUU_USER="${BALENA_USERNAME}"
+				arg="scp://${BALENA_USERNAME}@${arg#scp://}"
+				args[i]="${arg}"
+			fi
+			SSUU_POS_ARGS=("${args[@]:i}")
+			break
+		elif [[ "${SSUU_SCP}" = 1 &&
+			"${arg}" =~ ^((.+)@)?([[:xdigit:]]{32}|[[:xdigit:]]{62})\.balena:.*$
+			]]; then
+			SSUU_USER="${BASH_REMATCH[2]}"
+			if [ -z "${SSUU_USER}" ] && [ -n "${BALENA_USERNAME}" ]; then
+				SSUU_USER="${BALENA_USERNAME}"
+				arg="${BALENA_USERNAME}@${arg}"
+				args[i]="${arg}"
+			fi
+			SSUU_POS_ARGS=("${args[@]:i}")
+			break
+		fi
+		if [ "${arg:0:1}" = '-' ] && [ "${arg:1:1}" != '-' ]; then
+			parse_short_flag "${arg}"
+		fi
+		SSUU_OPT_ARGS+=("${arg}")
+	done
+	if [ "${#SSUU_POS_ARGS[@]}" = 0 ]; then
+		if [ "${SSUU_SCP}" = '1' ]; then
+			quit "Invalid command line (missing 'UUID.balena:' remote host, including ':' character)"
+		else
+			quit "Invalid command line (missing 'UUID.balena' hostname)"
+		fi
+	fi
+}
+
+function run_ssh {
+	local opt_args=("${SSUU_OPT_ARGS[@]}")  # optional arguments
+	local pos_args=("${SSUU_POS_ARGS[@]}")  # positional arguments
+	local l_arg=()
+	local t_arg=()
+	if [ -n "${SSUU_SERVICE}" ]; then
+		local host="${pos_args[0]}"
+		local remote_cmd=("${pos_args[@]:1}")
+		if [ "${#remote_cmd[@]}" = 0 ]; then
+			# interactive shell, allocate a tty
+			if [ -z "${SSUU_FLAG_N}" ] && [ -z "${SSUU_FLAG_t}" ]; then
+				t_arg=('-t')
+			fi
+		else
+			remote_cmd=( "$(escape_sh "${remote_cmd[@]}")" ) # single element array
+		fi
+		pos_args=(
+			"${host}"
+			# export some functions for remote execution
+			"$(declare -pf remote__get_container_name);"
+			"$(declare -pf remote__main);"
+			"SSUU_DEBUG=${DEBUG}"
+			remote__main
+			"${SSUU_SERVICE}"
+			"${remote_cmd[@]}"
+		)
+	fi
+	if [ -z "${SSUU_USER}" ] && [ -z "${SSUU_FLAG_l}" ] ; then
+		l_arg=('-l' "${BALENA_USERNAME}")
+	fi
+	opt_args=(
+		-o "ProxyCommand='$0' do_proxy %h %p"
+		-p 22222
+		"${l_arg[@]}"
+		"${t_arg[@]}"
+		"${opt_args[@]}"
+	)
+	set +e
+	[ -n "${DEBUG}" ] && set -x
+	# shellcheck disable=SC2029
+	ssh "${opt_args[@]}" "${pos_args[@]}"
+	{ local status="$?"; [ -n "${DEBUG}" ] && set +x; } 2>/dev/null
+	set -e
+	return "${status}"
+}
+
+function print_scp_service_msg {
+	local service="$1"
+	local uuid="$2"
+	echo "\
+scp-uuid does not support the '--service' flag. However, files and folders
+can be copied to a service container with 'ssh-uuid', for example:
+
+# local -> remote
+$ cat local.txt | ssh-uuid --service ${service} ${uuid}.balena cat \\> /data/remote.txt
+
+# remote -> local
+$ ssh-uuid --service ${service} ${uuid}.balena cat /data/remote.txt > local.txt
+
+Or multiple files and folders with 'tar' on the fly:
+
+# local -> remote
+$ tar cz local-folder | ssh-uuid --service ${service} ${uuid}.balena tar xzvC /data/
+
+# remote -> local
+$ ssh-uuid --service ${service} ${uuid}.balena tar czC /data remote-folder | tar xvz
+
+Or multiple files and folders with the powerful 'rsync' tool:
+
+# local -> remote
+$ rsync -av -e 'ssh-uuid --service ${service}' local-folder ${uuid}.balena:/data/
+
+# remote -> local
+$ rsync -av -e 'ssh-uuid --service ${service}' ${uuid}.balena:/data/remote-folder .
+
+In these examples respectively, 'cat' or 'tar' or 'rsync' must be installed both
+on the local workstation and on the remote service container:
+$ apt-get install -y rsync tar  # Debian, Ubuntu, etc
+$ apk add rsync tar  # Alpine
+
+Finally, if you are transferring files to/from a service's named volume (often
+named 'data'), note that named volumes are also exposed on the host OS under
+folder: '/mnt/data/docker/volumes/<fleet-id>_data/_data/'
+As such, it is also possible to scp to/from named volumes without '--service':
+
+# local -> remote
+$ scp-uuid -r local-folder ${uuid}.balena:/mnt/data/docker/volumes/<fleet-id>_data/_data/
+
+# remote -> local
+$ scp-uuid -r ${uuid}.balena:/mnt/data/docker/volumes/<fleet-id>_data/_data/remote-folder .
+" >/dev/stderr
+}
+
+function run_scp {
+	if [ -n "${SSUU_SERVICE}" ]; then
+		if [ -n "${SSUU_FLAG_S}" ]; then
+			quit "The '-S' and '--service' options cannot be used together"
+		fi
+		export SSUU_SERVICE
+		set +e
+		[ -n "${DEBUG}" ] && set -x
+		scp -S ssh-uuid "${SSUU_OPT_ARGS[@]}" "${SSUU_POS_ARGS[@]}"
+		{ local status="$?"; [ -n "${DEBUG}" ] && set +x; } 2>/dev/null
+		set -e
+		return "${status}"
+	fi
+	args=(
+		-P 22222
+		-o "ProxyCommand='$0' do_proxy %h %p"
+		"${SSUU_OPT_ARGS[@]}"
+		"${SSUU_POS_ARGS[@]}"
+	)
+	set +e
+	[ -n "${DEBUG}" ] && set -x
+	scp "${args[@]}"
+	{ local status="$?"; [ -n "${DEBUG}" ] && set +x; } 2>/dev/null
+	set -e
+	return "${status}"
+}
+
+# Run socat
+function do_proxy {
+	local TARGET_HOST="$1"
+	local TARGET_PORT="$2"
+	local PROXY_AUTH_FILE="${BALENARC_DATA_DIRECTORY}/proxy-auth"
+	local SOCAT_PORT
+	SOCAT_PORT="$(get_rand_port_num)"
+	mkdir -p "${BALENARC_DATA_DIRECTORY}" || quit "Cannot write to '${BALENARC_DATA_DIRECTORY}'"
+	echo -n "${BALENA_USERNAME}:${BALENA_TOKEN}" > "${PROXY_AUTH_FILE}" || quit "Cannot write to '${PROXY_AUTH_FILE}'"
+	[ -n "${DEBUG}" ] && set -x
+	socat "TCP-LISTEN:${SOCAT_PORT},bind=127.0.0.1" "OPENSSL:tunnel.balena-cloud.com:443,snihost=tunnel.balena-cloud.com" &
+	{ set +x; } 2>/dev/null
+	sleep 1 # poor man's wait for the background socat process to be ready
+	set +e
+	[ -n "${DEBUG}" ] && set -x
+	socat - "PROXY:127.0.0.1:${TARGET_HOST}:${TARGET_PORT},proxyport=${SOCAT_PORT},proxy-authorization-file=${PROXY_AUTH_FILE}"
+	{ local status="$?"; [ -n "${DEBUG}" ] && set +x; } 2>/dev/null
+	set -e
+	local pid
+	pid="$(jobs -p)"
+	[ -n "${pid}" ] && kill "${pid}" && wait # shutdown background tunnel
+	return "${status}"
+}
+
+# Generate a random, possibly unavailable, TCP port number between
+# 10,000 and 65,535 using a shady, questionable algorithm that assumes,
+# based on annecodtal evidencce, that port numbers lower than 10,000
+# are less likely to be available.
+# If the port number is already in use, socat will produce an error.
+function get_rand_port_num {
+	# In bash, "$RANDOM" produces a random integer between 0 and 32767.
+	# RANDOM * 2 produces an even number reasonably evenly distributed
+	# over the range from 0 to 65534, and then RANDOM % 2 adds 0 or 1.
+	# '% 55536 + 10000' then coerces the range into 10,000 to 65,535.
+	# (This spoils the even distribution, yes, but the real problem is
+	#  ensuring that the port number is not in use. It does not need
+	#  to be random, it needs to be available.)
+	echo $(( (RANDOM * 2 + RANDOM % 2) % 55536 + 10000 ))
+}
+
+function check_tool {
+	which "$1" &>/dev/null || quit "'$1' not found in PATH. Is it installed?"
+}
+
+function main {
+	get_user_and_token
+	if [ "$1" = 'do_proxy' ]; then
+		shift
+		do_proxy "$@"
+	else
+		SSUU_SCP='0'
+		if [ "$(basename "$0")" = 'scp-uuid' ]; then
+			SSUU_SCP='1'
+		fi
+		parse_args "$@"
+		if [ "${SSUU_SCP}" = '1' ]; then
+			run_scp "$@"
+		else
+			run_ssh "$@"
+		fi
+	fi
+}
+
+main "$@"

.github/workflows/tests.yml

@@ -51,8 +51,8 @@ jobs:
             launch_template_version: ${{ vars.AWS_EC2_LT_VERSION || '6' }}
             # https://docs.renovatebot.com/modules/datasource/aws-machine-image/
             # amiFilter=[{"Name":"owner-id","Values":["099720109477"]},{"Name":"name","Values":["ubuntu/images/hvm-ssd-gp3/ubuntu-noble-24.04-amd64-server-*"]},{"region":"us-east-1"}]
-            # currentImageName=unknown
-            ami: ami-04b70fa74e45c3917
+            # currentImageName=ubuntu/images/hvm-ssd-gp3/ubuntu-noble-24.04-amd64-server-20250610
+            ami: ami-020cba7c55df1f615
             subdomain:  ${{ vars.DNS_SUBDOMAIN || 'auto' }}
             dns_tld: ${{ vars.DNS_TLD || 'balena-devices.com' }}
 
@@ -60,9 +60,9 @@ jobs:
           - target: balena-public-pki
             launch_template_version: ${{ vars.AWS_EC2_LT_VERSION || '6' }}
             # https://docs.renovatebot.com/modules/datasource/aws-machine-image/
-            # amiFilter=[{"Name":"owner-id","Values":["491725000532"]},{"Name":"name","Values":["balenaOS-installer-secureboot-*-generic-amd64"]},{"region":"us-east-1"}]
-            # currentImageName=unknown
-            ami: ami-03a3995797dee84fa
+            # amiFilter=[{"Name":"owner-id","Values":["491725000532"]},{"Name":"name","Values":["balenaOS!(-secureboot)-*.*.*-generic-amd64"]},{"region":"us-east-1"}]
+            # currentImageName=balenaOS-6.5.29-generic-amd64
+            ami: ami-0ffdbd60c5229c1e2
             # https://dash.cloudflare.com/001b3ed2352612aaa068aca1b0022736/balena-devices.com/dns
             subdomain:  ${{ vars.DNS_SUBDOMAIN || 'auto' }}
             dns_tld: ${{ vars.DNS_TLD || 'balena-devices.com' }}
@@ -73,13 +73,55 @@ jobs:
       name: ${{ matrix.target }}
 
     steps:
-    - uses: actions/checkout@6d193bf28034eafb982f37bd894289fe649468fc
+    - uses: actions/checkout@09d2acae674a48949e3602304ab46fd20ae0c42f
+      with:
+        persist-credentials: false
+        ref: ${{ github.event.pull_request.head.sha }}
+
+    - name: Setup with_backoff utility function
+      run: |
+        set -ue
+        # This used to come from src/balena-tests/functions, but that path is user-writable which had injection risks
+        # https://coderwall.com/p/--eiqg/exponential-backoff-in-bash
+        function with_backoff() {
+            local max_attempts=${ATTEMPTS-5}
+            local timeout=${TIMEOUT-1}
+            local attempt=0
+            local exitCode=0
+
+            set +e
+            while [[ $attempt < $max_attempts ]]
+            do
+                "$@"
+                exitCode=$?
+
+                if [[ $exitCode == 0 ]]
+                then
+                  break
+                fi
+
+                echo "Failure! Retrying in $timeout.." 1>&2
+                sleep "$timeout"
+                attempt=$(( attempt + 1 ))
+                timeout=$(( timeout * 2 ))
+            done
+
+            if [[ $exitCode != 0 ]]
+            then
+                echo "You've failed me for the last time! ($*)" 1>&2
+            fi
+
+            set -e
+            return $exitCode
+        }
+
+        echo "BASH_FUNC_with_backoff()=$(declare -f with_backoff)" >> $GITHUB_ENV
 
     # https://github.com/unfor19/install-aws-cli-action
     - name: Setup awscli
       uses: unfor19/install-aws-cli-action@e8b481e524a99f37fbd39fdc1dcb3341ab091367 # v1
 
-    - uses: aws-actions/configure-aws-credentials@bd1354327e55c2330d56537b3ac2006a8d97c566
+    - uses: aws-actions/configure-aws-credentials@3bb878b6ab43ba8717918141cd07a0ea68cfe7ea
       with:
         aws-region: ${{ vars.AWS_REGION || 'us-east-1' }}
         role-session-name: github-${{ github.job }}-${{ github.run_id }}-${{ github.run_attempt }}
@@ -99,10 +141,12 @@ jobs:
 
     # https://github.com/balena-io-examples/setup-balena-action
     - name: Setup balena CLI
-      uses: balena-io-examples/setup-balena-action@main
-      with:
+      uses: balena-io-examples/setup-balena-action@a3dc55eb5a1efe3368778f19b9b8a2ac41ddf44c # v0.0.20
+      env:
         # renovate: datasource=github-releases depName=balena-io/balena-cli
-        cli-version: v18.2.17
+        BALENA_CLI_VERSION: v22.1.1
+      with:
+        cli-version: ${{ env.BALENA_CLI_VERSION }}
 
     # https://github.com/pdcastro/ssh-uuid#why
     # https://github.com/pdcastro/ssh-uuid#linux-debian-ubuntu-others
@@ -114,8 +158,6 @@ jobs:
 
         [[ '${{ vars.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
 
-        source src/balena-tests/functions
-
         mkdir -p "${RUNNER_TEMP}/ssh-uuid"
 
         wget -q -O "${RUNNER_TEMP}/ssh-uuid/ssh-uuid" https://raw.githubusercontent.com/pdcastro/ssh-uuid/master/ssh-uuid.sh \
@@ -178,7 +220,7 @@ jobs:
         AWS_DEFAULT_REGION: ${{ vars.AWS_REGION || 'us-east-1' }}
 
     # https://github.com/webfactory/ssh-agent
-    - uses: webfactory/ssh-agent@dc588b651fe13675774614f8e6a936a468676387 # v0.9.0
+    - uses: webfactory/ssh-agent@a6f90b1f127823b31d4d4a8d96047790581349bd # v0.9.1
       with:
         ssh-private-key: ${{ steps.generate-key-pair.outputs.ssh_private_key }}
 
@@ -190,8 +232,6 @@ jobs:
 
         [[ '${{ vars.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
 
-        source src/balena-tests/functions
-
         with_backoff balena login --token '${{ secrets.BALENA_API_KEY }}'
 
         balena_device_uuid="$(openssl rand -hex 16)"
@@ -235,14 +275,11 @@ jobs:
 
         [[ '${{ vars.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
 
-        source src/balena-tests/functions
-
         with_backoff balena login --token '${{ secrets.BALENA_API_KEY }}'
 
         pr_id='${{ github.event.pull_request.id }}'
-        head_sha='${{ github.event.pull_request.head.sha || github.event.head_commit.id }}'
         release_id="$(with_backoff balena releases '${{ matrix.fleet }}' --json \
-          | jq -r --arg pr_id "${pr_id}" --arg head_sha "${head_sha}" '.[]
+          | jq -r --arg pr_id "${pr_id}" --arg head_sha "${COMMIT}" '.[]
           | select(.release_tag[].tag_key=="balena-ci-commit-sha")
           | select(.release_tag[].value==$head_sha)
           | select(.release_tag[].tag_key=="balena-ci-id")
@@ -254,6 +291,9 @@ jobs:
 
         with_backoff balena device ${{ steps.register-test-device.outputs.balena_device_uuid }}
 
+      env:
+        COMMIT: ${{ github.event.pull_request.head.sha  }}
+
     - name: configure balenaOS test device environment
       if: matrix.target == 'balena-public-pki'
       run: |
@@ -261,8 +301,6 @@ jobs:
 
         [[ '${{ vars.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
 
-        source src/balena-tests/functions
-
         with_backoff balena login --token '${{ secrets.BALENA_API_KEY }}'
 
         with_backoff balena env add VERBOSE "${{ vars.VERBOSE || 'false' }}" \
@@ -362,8 +400,6 @@ jobs:
 
         [[ '${{ vars.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
 
-        source src/balena-tests/functions
-
         with_backoff balena login --token '${{ secrets.BALENA_API_KEY }}'
 
         # cert-manager requires it to get whoami information for the user
@@ -385,6 +421,10 @@ jobs:
           --service cert-manager \
           --device '${{ steps.register-test-device.outputs.balena_device_uuid }}'
 
+        with_backoff balena env add AWS_SESSION_TOKEN '${{ env.AWS_SESSION_TOKEN }}' \
+          --service cert-manager \
+          --device '${{ steps.register-test-device.outputs.balena_device_uuid }}'
+
     - name: provision balenaOS ephemeral SUT
       id: balena-sut
       if: matrix.target == 'balena-public-pki'
@@ -393,8 +433,6 @@ jobs:
 
         [[ '${{ vars.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
 
-        source src/balena-tests/functions
-
         # shellcheck disable=SC2046,SC2043
         for subnet_id in ${{ env.AWS_VPC_SUBNET_IDS }}; do
             # spot, on-demand
@@ -442,8 +480,6 @@ jobs:
 
         [[ '${{ vars.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
 
-        source src/balena-tests/functions
-
         function cleanup() {
             aws ec2 describe-instances --instance-ids ${{ steps.balena-sut.outputs.instance_id }} \
               | jq -r .Reservations[].Instances[].StateReason
@@ -495,8 +531,6 @@ jobs:
 
         [[ '${{ vars.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
 
-        source src/balena-tests/functions
-
         function cleanup() {
             aws ec2 describe-instances --instance-ids ${{ steps.balena-sut.outputs.instance_id }} \
               | jq -r .Reservations[].Instances[].StateReason
@@ -559,8 +593,6 @@ jobs:
 
         [[ '${{ vars.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
 
-        source src/balena-tests/functions
-
         function cleanup() {
             aws ec2 describe-instances --instance-ids ${{ steps.balena-sut.outputs.instance_id }} \
               | jq -r .Reservations[].Instances[].StateReason
@@ -604,8 +636,6 @@ jobs:
 
         [[ '${{ vars.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
 
-        source src/balena-tests/functions
-
         function cleanup() {
             aws ec2 describe-instances --instance-ids ${{ steps.balena-sut.outputs.instance_id }} \
               | jq -r .Reservations[].Instances[].StateReason
@@ -677,8 +707,6 @@ jobs:
 
         [[ '${{ vars.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
 
-        source src/balena-tests/functions
-
         function cleanup() {
            rm -f user-data.yml
         }
@@ -854,7 +882,6 @@ jobs:
       env:
         ATTEMPTS: 2
         AWS_DEFAULT_REGION: ${{ vars.AWS_REGION || 'us-east-1' }}
-        COMMIT: ${{ github.event.pull_request.head.sha || github.event.head_commit.id || github.event.pull_request.head.ref }}
 
     - name: SUT&DUT (Ubuntu/compose)
       if: matrix.target == 'compose-private-pki'
@@ -864,8 +891,6 @@ jobs:
 
         [[ '${{ vars.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
 
-        source src/balena-tests/functions
-
         function log_output() {
             rm -f "{HOME}/.ssh/config"
 
@@ -908,7 +933,7 @@ jobs:
         # docs/getting-started.md
         cmds="set -ax \
           && cloud-init status --wait --long && cat </var/log/cloud-init-output.log \
-          && sudo -u balena git clone https://token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git /home/balena/open-balena \
+          && sudo -u balena git clone https://token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.event.pull_request.head.repo.full_name }}.git /home/balena/open-balena \
           && sudo -u balena git config --global --add safe.directory /home/balena/open-balena \
           && cd /home/balena/open-balena \
           && sudo -u balena git checkout ${COMMIT} \
@@ -1013,8 +1038,6 @@ jobs:
 
         [[ '${{ vars.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
 
-        source src/balena-tests/functions
-
         with_backoff balena login --token '${{ secrets.BALENA_API_KEY }}'
 
         with_backoff balena keys | grep ${{ steps.provision-ssh-key.outputs.key_id }} \
@@ -1038,8 +1061,6 @@ jobs:
 
         [[ '${{ vars.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
 
-        source src/balena-tests/functions
-
         with_backoff balena login --token '${{ secrets.BALENA_API_KEY }}'
 
         with_backoff balena device rm ${{ steps.register-test-device.outputs.balena_device_uuid }} --yes
@@ -1055,8 +1076,6 @@ jobs:
 
         [[ '${{ vars.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
 
-        source src/balena-tests/functions
-
         if [[ -n '${{ steps.balena-sut.outputs.instance_id }}' ]]; then
             with_backoff aws ec2 terminate-instances \
               --instance-ids ${{ steps.balena-sut.outputs.instance_id }}
@@ -1073,8 +1092,6 @@ jobs:
 
         [[ '${{ vars.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
 
-        source src/balena-tests/functions
-
         if [[ -n '${{ steps.ubuntu-sut.outputs.instance_id }}' ]]; then
             with_backoff aws ec2 terminate-instances \
               --instance-ids ${{ steps.ubuntu-sut.outputs.instance_id }}
@@ -1091,8 +1108,6 @@ jobs:
 
         [[ '${{ vars.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
 
-        source src/balena-tests/functions
-
         stale_instances=$(mktemp)
         aws ec2 describe-instances --filters \
           Name=tag:Name,Values=open-balena-tests \

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+exclude: ^(.versionbot/|CHANGELOG.md|VERSION|README.md)
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+        args: [--allow-multiple-documents]
+    -   id: check-added-large-files
+
+-   repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.10.0.1
+    hooks:
+    -   id: shellcheck

VERSION

@@ -1 +1 @@
-4.1.117
+4.1.450

balena.yml

@@ -23,4 +23,4 @@ data:
     - generic-amd64
     - genericx86-64-ext
     - intel-nuc
-version: 4.1.117
+version: 4.1.450

docker-compose.yml

@@ -26,7 +26,7 @@ x-default-environment: &default-environment
   DB_PASSWORD: docker
   DB_USER: docker
   LOG_LEVEL: DEBUG
-  PRODUCTION_MODE: 'false'
+  PRODUCTION_MODE: 'true'
 
 x-default-healthcheck-trait: &with-default-healthcheck
   healthcheck:
@@ -79,7 +79,7 @@ services:
       *with-default-privileges,
       *with-default-volumes,
     ]
-    image: balena/open-balena-api:v27.2.1
+    image: balena/open-balena-api:37.3.2
     depends_on:
       - db
       - redis
@@ -119,7 +119,7 @@ services:
       *with-default-healthcheck,
       *with-default-privileges,
     ]
-    image: balena/open-balena-registry:v2.41.6
+    image: balena/open-balena-registry:2.42.0
     volumes:
       - certs-data:/certs
       - resin-data:/balena
@@ -146,7 +146,7 @@ services:
       *with-network-privileges,
       *with-default-privileges,
     ]
-    image: balena/open-balena-vpn:v11.30.47
+    image: balena/open-balena-vpn:11.32.28
     depends_on:
       - api
     environment:
@@ -156,11 +156,13 @@ services:
       VPN_PORT: 443
       # ensure correct service instance IP is registered with the API
       VPN_SERVICE_REGISTER_INTERFACE: eth0
+    devices:
+      - /dev/net/tun
 
   # https://github.com/balena-io/open-balena-db
   db:
     <<: *base-service
-    image: balena/open-balena-db:v5.2.2
+    image: balena/open-balena-db:6.0.0
     volumes:
       - db-data:/var/lib/postgresql/data
     environment:
@@ -175,7 +177,7 @@ services:
       *with-default-healthcheck,
       *with-default-privileges,
     ]
-    image: balena/open-balena-s3:v2.28.55
+    image: balena/open-balena-s3:2.28.75
     volumes:
       - s3-data:/export
       - certs-data:/certs
@@ -189,7 +191,7 @@ services:
   redis:
     <<: *base-service
     # https://redis.io/blog/what-redis-license-change-means-for-our-managed-service-providers/
-    image: redis:7.4-alpine
+    image: redis:8.0-alpine
     volumes:
       - redis-data:/data
     healthcheck:
@@ -233,7 +235,7 @@ services:
       ALIASES: api,ca,cloudlink,db,delta,logs,redis,registry2,s3,stats,tunnel
     labels:
       io.balena.features.balena-socket: 1
-      io.balena.features.supervisor-api	: 1
+      io.balena.features.supervisor-api: 1
 
   # https://github.com/balena-io/cert-manager
   # https://certbot.eff.org/docs/using.html
@@ -259,7 +261,7 @@ services:
   # https://github.com/cloudflare/cfssl/blob/master/doc/api/intro.txt
   balena-ca:
     <<: *base-service
-    image: balena/ca-private:v0.0.14
+    image: balena/ca-private:0.0.15
     volumes:
       - pki-data:/pki
       - certs-data:/certs
@@ -317,7 +319,7 @@ services:
       *with-extended-privileges,
       *with-network-privileges,
     ]
-    # https://hub.docker.com/r/qemux/qemu-docker
+    # https://hub.docker.com/r/qemux/qemu
     # https://github.com/qemus/qemu-docker
     build: src/test-device
     entrypoint:

src/balena-tests/Dockerfile

@@ -1,7 +1,7 @@
 FROM ubuntu:24.04
 
 # renovate: datasource=github-releases depName=balena-io/balena-cli
-ARG BALENA_CLI_VERSION=v19.0.10
+ARG BALENA_CLI_VERSION=v22.1.1
 
 RUN apt-get update && apt-get install -y --no-install-recommends \
 	bash \
@@ -21,11 +21,9 @@ RUN curl -fsSL https://get.docker.com | sh
 WORKDIR /opt
 
 RUN set -x; arch=$(uname -m | sed 's/86_64/64/g') \
-    && wget -q "https://github.com/balena-io/balena-cli/releases/download/${BALENA_CLI_VERSION}/balena-cli-${BALENA_CLI_VERSION}-linux-${arch}-standalone.zip" \
-    && unzip -q "balena-cli-${BALENA_CLI_VERSION}-linux-${arch}-standalone.zip" \
-    && rm -rf "balena-cli-${BALENA_CLI_VERSION}-linux-${arch}-standalone.zip"
+    && wget -qO- "https://github.com/balena-io/balena-cli/releases/download/${BALENA_CLI_VERSION}/balena-cli-${BALENA_CLI_VERSION}-linux-${arch}-standalone.tar.gz" | tar -xzf -
 
-ENV PATH=/opt/balena-cli:${PATH}
+ENV PATH=/opt/balena/bin:${PATH}
 
 COPY functions balena.sh /usr/sbin/
 

src/balena-tests/balena.sh

@@ -1,16 +1,17 @@
 #!/usr/bin/env bash
 
-# shellcheck disable=SC2154,SC2034,SC1090
+# shellcheck disable=SC2034,SC1090
 set -aeu
 
-curl_opts="--retry 3 --fail"
+read -ra curl_opts <<<'--retry 3 --fail'
 if [[ $VERBOSE =~ on|On|Yes|yes|true|True ]]; then
     set -x
-    curl_opts="${curl_opts} --verbose"
+    curl_opts+=('--verbose')
 else
-    curl_opts="${curl_opts} --silent"
+    curl_opts+=('--silent')
 fi
 
+# shellcheck disable=SC1091
 source /usr/sbin/functions
 
 function remove_test_assets() {
@@ -49,10 +50,10 @@ function shutdown_dut() {
 
 function set_update_lock {
     if [[ -n "${BALENA_SUPERVISOR_ADDRESS:-}" ]] && [[ -n "${BALENA_SUPERVISOR_API_KEY:-}" ]]; then
-        while [[ $(curl ${curl_opts} "${BALENA_SUPERVISOR_ADDRESS}/v1/device?apikey=${BALENA_SUPERVISOR_API_KEY}" \
+        while [[ $(curl "${curl_opts[@]}" "${BALENA_SUPERVISOR_ADDRESS}/v1/device?apikey=${BALENA_SUPERVISOR_API_KEY}" \
           -H "Content-Type: application/json" | jq -r '.update_pending') == 'true' ]]; do
 
-            curl ${curl_opts} "${BALENA_SUPERVISOR_ADDRESS}/v1/device?apikey=${BALENA_SUPERVISOR_API_KEY}" \
+            curl "${curl_opts[@]}" "${BALENA_SUPERVISOR_ADDRESS}/v1/device?apikey=${BALENA_SUPERVISOR_API_KEY}" \
               -H "Content-Type: application/json" | jq -r
 
             sleep "$(( (RANDOM % 3) + 3 ))s"
@@ -89,7 +90,7 @@ function update_ca_certificates() {
 }
 
 function wait_for_api() {
-    while ! curl ${curl_opts} "https://api.${DNS_TLD}/ping"; do
+    while ! curl "${curl_opts[@]}" "https://api.${DNS_TLD}/ping"; do
         echo 'waiting for API...'
         sleep "$(( (RANDOM % 5) + 5 ))s"
     done
@@ -163,7 +164,7 @@ function check_device_status() {
         balena_device_uuid="$(cat </balena/config.json | jq -r .uuid)"
 
         if [[ -n $balena_device_uuid ]]; then
-            is_online="$(balena devices --json --fleet "${TEST_FLEET}" \
+            is_online="$(balena device list --json --fleet "${TEST_FLEET}" \
               | jq -r --arg uuid "${balena_device_uuid}" '.[] | select(.uuid==$uuid).is_online == true')"
 
             if [[ $is_online =~ true ]]; then
@@ -183,6 +184,7 @@ function registry_auth() {
     if [[ -n "${REGISTRY_USER:-}" ]] && [[ -n "${REGISTRY_PASS:-}" ]]; then
         with_backoff docker login -u "${REGISTRY_USER}" -p "${REGISTRY_PASS}"
 
+        # shellcheck disable=SC2016
         printf '{"https://index.docker.io/v1/": {"username":"%s", "password":"$s"}}' \
           "${REGISTRY_USER}" "${REGISTRY_PASS}" | jq -r > ~/.balena/secrets.json
     fi
@@ -206,23 +208,21 @@ function deploy_release() {
 }
 
 function get_releases() {
-      with_backoff balena releases --json "${TEST_FLEET}"
+      with_backoff balena release list --json "${TEST_FLEET}"
 }
 
 function get_release_commit() {
-      echo "$(get_releases)" | jq -re \
-        'select((.[].status=="success")
-        and (.[].is_invalidated==false)
-        and (.[].is_final==true)
-        and (.[].release_type=="final"))[0].commit'
+      get_releases | jq -re \
+        '[.[] | select((.status=="success")
+        and (.is_invalidated==false)
+        and (.is_final==true))][0].commit'
 }
 
 function get_release_id() {
-      echo "$(get_releases)" | jq -re \
-        'select((.[].status=="success")
-        and (.[].is_invalidated==false)
-        and (.[].is_final==true)
-        and (.[].release_type=="final"))[0].id'
+      get_releases | jq -re \
+        '[.[] | select((.status=="success")
+        and (.is_invalidated==false)
+        and (.is_final==true))][0].id'
 }
 
 function supervisor_update_target_state() {
@@ -230,7 +230,7 @@ function supervisor_update_target_state() {
     balena_device_uuid="$(cat </balena/config.json | jq -r .uuid)"
 
     if [[ -n "${balena_device_uuid:-}" ]]; then
-        while ! curl ${curl_opts} "https://api.${DNS_TLD}/supervisor/v1/update" \
+        while ! curl "${curl_opts[@]}" "https://api.${DNS_TLD}/supervisor/v1/update" \
           --header "Content-Type: application/json" \
           --header "Authorization: Bearer $(cat <~/.balena/token)" \
           --data "{\"uuid\": \"${balena_device_uuid}\", \"data\": {\"force\": true}}"; do
@@ -263,7 +263,7 @@ function check_running_release() {
 
 function get_os_version() {
     local BALENARC_BALENA_URL
-    BALENARC_BALENA_URL="$(echo "${BALENA_API_URL}" | sed 's#https://api\.##g')"
+    BALENARC_BALENA_URL="${BALENA_API_URL//https:\/\/api\./}"
 
     local os_version
     os_version=${OS_VERSION:-$(with_backoff balena os versions "${DEVICE_TYPE}" | head -n 1)}
@@ -276,13 +276,13 @@ function upload_release_asset() {
         release_id=${1:-1}
         release_asset="$(find / -type f -name '*.png' | head -n 1)"
 
-        curl ${curl_opts} "https://api.${DNS_TLD}/resin/release_asset" \
+        curl "${curl_opts[@]}" "https://api.${DNS_TLD}/resin/release_asset" \
           --header "Authorization: Bearer $(cat <~/.balena/token)" \
           --form "asset=@${release_asset}" \
           --form "release=${release_id}" \
-          --form "asset_key=$((RANDOM))-$(basename ${release_asset})" \
+          --form "asset_key=$((RANDOM))-$(basename "${release_asset}")" \
           | jq -re .asset.href \
-          | xargs curl ${curl_opts} -o "/tmp/$((RANDOM))-$(basename ${release_asset})"
+          | xargs curl "${curl_opts[@]}" -o "/tmp/$((RANDOM))-$(basename "${release_asset}")"
     fi
 }
 

src/cert-manager/Dockerfile

@@ -1,4 +1,4 @@
 # https://github.com/balena-io/cert-manager
-FROM balena/cert-manager:v0.2.2
+FROM balena/cert-manager:0.3.3
 
 COPY *.json /opt/

src/test-device/Dockerfile

@@ -1,9 +1,10 @@
-# https://hub.docker.com/r/qemux/qemu-docker
+# https://hub.docker.com/r/qemux/qemu
 # https://github.com/qemus/qemu-docker
-FROM qemux/qemu-docker:6.00
+FROM ghcr.io/qemus/qemu:7.12
 
 RUN apt-get update && apt-get install -y --no-install-recommends \
-	minicom \
+    minicom \
+    netcat-openbsd \
     && rm -rf /var/lib/apt/lists/*
 
 COPY balena.sh /usr/sbin/

src/test-device/balena.sh

@@ -21,7 +21,14 @@ until test -f "${GUEST_IMAGE%.*}.ready"; do sleep "$(( (RANDOM % 5) + 5 ))s"; do
 tmpimg="$(mktemp)"
 cat <"${GUEST_IMAGE}" >"${tmpimg}"
 
+# https://www.qemu.org/docs/master/system/qemu-manpage.html
+# .. depending on the target architecture: kvm, xen, hvf, nvmm, whpx (default: tcg)
+if test -r /dev/kvm && test -w /dev/kvm; then
+    accel=kvm
+fi
+
 exec /usr/bin/qemu-system-x86_64 \
+  -accel "${accel:-tcg}" \
   -bios /usr/share/ovmf/OVMF.fd \
   -chardev socket,id=serial0,path=/run/console.sock,server=on,wait=off \
   -cpu max \
@@ -30,7 +37,7 @@ exec /usr/bin/qemu-system-x86_64 \
   -device virtio-net-pci,netdev=n1 \
   -drive file="${tmpimg}",media=disk,cache=none,format=raw,if=none,id=disk \
   -m "${MEMORY}" \
-  -machine q35 \
+  -machine type=q35 \
   -netdev "user,id=n1,dns=127.0.0.1,guestfwd=tcp:10.0.2.100:80-cmd:netcat haproxy 80,guestfwd=tcp:10.0.2.100:443-cmd:netcat haproxy 443" \
   -nodefaults \
   -nographic \