Merge pull request #414 from balena-os/run-from-app-uuid-and-release-commit

Add option to specify target OS by App UUID and release commit

Author: flowzone-app[bot]

upgrade-2.x.sh

@@ -1091,6 +1091,17 @@ function post_update_fixes() {
 
 ###
 # Script start
+#
+# There are two patterns of required input arguments to invoke this script:
+# --hostos-version, --balenaos-registry
+#   Used by balenaProxy push to device. Queries for target image URI.
+#
+# --app-uuid, --release-commit, --target-image-uri (optional)
+#   Used by Supervisor pull from balenaCloud. Queries for target version, and
+#   target-image-uri as needed, and parses registry from the target URI.
+#
+# Note: --target-image-uri value may not be stable long-term, so we cannot use
+# it alone as the source of target version.
 ###
 
 # If no arguments passed, just display the help
@@ -1164,6 +1175,13 @@ while [[ $# -gt 0 ]]; do
             help
             exit 0
             ;;
+        --app-uuid)
+            if [ -z "$2" ]; then
+                log ERROR "\"$1\" argument needs a value."
+            fi
+            app_uuid=$2
+            shift
+            ;;
         --force-slug)
             if [ -z "$2" ]; then
                 log ERROR "\"$1\" argument needs a value."
@@ -1185,6 +1203,13 @@ while [[ $# -gt 0 ]]; do
             esac
             shift
             ;;
+        --release-commit)
+            if [ -z "$2" ]; then
+                log ERROR "\"$1\" argument needs a value."
+            fi
+            release_commit=$2
+            shift
+            ;;
         --resinos-registry | --balenaos-registry)
             if [ -z "$2" ]; then
                 log ERROR "\"$1\" argument needs a value."
@@ -1216,6 +1241,13 @@ while [[ $# -gt 0 ]]; do
         --stop-all)
             STOP_ALL="yes"
             ;;
+        --target-image-uri)
+            if [ -z "$2" ]; then
+                log ERROR "\"$1\" argument needs a value."
+            fi
+            target_image=$2
+            shift
+            ;;
         --assume-supported)
             log WARN "The --assume-supported flag is deprecated, and has no effect."
             ;;
@@ -1231,13 +1263,22 @@ _prepare_locking
 # Try to get lock, and exit if cannot, meaning another instance is running already
 exlock_now || exit 9
 
-if [ -z "$target_version" ]; then
-    log ERROR "--hostos-version is required."
+# Enforce required arguments. See comment above at 'Script start'.
+if [ -z "$target_version" ] && [ -z "$app_uuid" ]; then
+    log ERROR "Either --hostos-version or --app-uuid is required."
 fi
-
-if [ -z "${REGISTRY_ENDPOINT}" ]; then
+if [ -n "$target_version" ] && [ -n "$app_uuid" ]; then
+    log ERROR "Only one of --hostos-version and --app-uuid may be specified."
+fi
+if [ -n "$target_version" ] && [ -z "${REGISTRY_ENDPOINT}" ]; then
     log ERROR "--balenaos-registry is required."
 fi
+if [ -n "$app_uuid" ] && [ -z "$release_commit" ]; then
+    log ERROR "--release-commit is required."
+fi
+if [ -z "$app_uuid" ] && [ -n "$target_image" ]; then
+    log ERROR "--target-image-uri is useful only with --app-uuid."
+fi
 
 progress 25 "Preparing OS update"
 
@@ -1250,6 +1291,46 @@ FETCHED_SLUG=$(CURL_CA_BUNDLE="${TMPCRT}" ${CURL} -H "Authorization: Bearer ${AP
 SLUG=${FORCED_SLUG:-$FETCHED_SLUG}
 HOST_OS_VERSION=${META_BALENA_VERSION:-${VERSION_ID}}
 
+# Must query for target version and perhaps for target image, which includes registry
+# endpoint, if started from app UUID.
+if [ -n "$app_uuid" ]; then
+    # Retrieve version for the provided app UUID and release commit. Verify that
+    # the release succeeded and has not been invalidated. We expect at most a
+    # single release. Catch command failure for handling below.
+    _query_res=$(CURL_CA_BUNDLE="${TMPCRT}" ${CURL} \
+        -H "Content-Type: application/json" -H "Authorization: Bearer ${APIKEY}" \
+        "${API_ENDPOINT}/v7/release?\$select=raw_version&\$filter=commit%20eq%20%27${release_commit}%27%20and%20(belongs_to__application/any(bta:bta/is_host%20and%20bta/uuid%20eq%20%27${app_uuid}%27))%20and%20status%20eq%20'success'%20and%20is_invalidated%20eq%20false" || echo "fail")
+
+    # Verify the result includes a json row.
+    _has_row=$(echo "${_query_res}" | jq -r ".d[]" || echo "")
+    if [ -z "$_has_row" ]; then
+        if [ "${_query_res}" = "fail" ]; then
+            log ERROR "Target release query from app UUID failed"
+        else
+            log ERROR "Target release query from app UUID not found or not valid"
+        fi
+    fi
+    target_version=$(echo "${_query_res}" | jq -r ".d[] | .raw_version")
+
+    # We do not expect registry endpoint is defined separately, so must query
+    # for optional target image here if not defined already -- so we can parse
+    # for the endpoint below.
+    if [ -z "${target_image}" ]; then
+        target_image=$(get_image_location "${target_version}")
+        if [ -z "${target_image}" ]; then
+            log ERROR "Zero or multiple matching target hostapp releases found, update attempt has failed..."
+        fi
+    fi
+
+    # Not expecting a backslash in domain name, so:
+    # shellcheck disable=SC2162
+    read -d "/" REGISTRY_ENDPOINT <<<"$target_image"    
+    if [ -z "${REGISTRY_ENDPOINT}" ] || [ "${REGISTRY_ENDPOINT}" = "${target_image}" ]; then
+        log ERROR "Target image URI expected '/': ${target_image}"
+    fi
+    log "Registry endpoint from target release: ${REGISTRY_ENDPOINT}"
+fi
+
 if version_gt "${target_version}" "${minimum_hostapp_target_version}" || [ "${target_version}" == "${minimum_hostapp_target_version}" ]; then
     log "Target version supports hostapps, no device type support check required."
 else
@@ -1300,9 +1381,12 @@ if [ "${SLUG}" = "raspberrypi4-64" ] && \
     fi
 fi
 
-target_image=$(get_image_location "${target_version}")
+# Already retrieved if script inputs from App UUID and release commit.
 if [ -z "${target_image}" ]; then
-    log ERROR "Zero or multiple matching target hostapp releases found, update attempt has failed..."
+    target_image=$(get_image_location "${target_version}")
+    if [ -z "${target_image}" ]; then
+        log ERROR "Zero or multiple matching target hostapp releases found, update attempt has failed..."
+    fi
 fi
 
 # starting with the balena engine, we can use native deltas