Add hack/update-template-rocky.sh

hack/update-template-rocky.sh

@@ -0,0 +1,299 @@
+#!/usr/bin/env bash
+
+set -eu -o pipefail
+
+# Functions in this script assume error handling with 'set -e'.
+# To ensure 'set -e' works correctly:
+# - Use 'set +e' before assignments and '$(set -e; <function>)' to capture output without exiting on errors.
+# - Avoid calling functions directly in conditions to prevent disabling 'set -e'.
+# - Use 'shopt -s inherit_errexit' (Bash 4.4+) to avoid repeated 'set -e' in all '$(...)'.
+shopt -s inherit_errexit || error_exit "inherit_errexit not supported. Please use bash 4.4 or later."
+
+function rocky_print_help() {
+	cat <<HELP
+$(basename "${BASH_SOURCE[0]}"): Update the Rocky Linux image location in the specified templates
+
+Usage:
+  $(basename "${BASH_SOURCE[0]}") [--version-major <major version>] <template.yaml>...
+
+Description:
+  This script updates the Rocky Linux image location in the specified templates.
+  If the image location in the template contains a minor version, release date, and job id in the URL,
+  the script replaces it with the latest available minor version, release date, and job id.
+
+  Image location basename format:
+
+    Rocky-<major version>-GenericCloud[.latest|-<type>.latest|-<major version>.<minor version>-<date>.<job id?>].<arch>.qcow2
+
+  Published Rocky Linux image information is fetched from the following URLs:
+
+    https://dl.rockylinux.org/pub/rocky/<major version>/images/<arch>/
+
+  To parsing html, this script requires 'htmlq' or 'pup' command.      
+  The downloaded files will be cached in the Lima cache directory.
+
+Examples:
+  Update the Rocky Linux image location in templates/**.yaml:
+  $ $(basename "${BASH_SOURCE[0]}") templates/**.yaml
+
+  Update the Rocky Linux image location in ~/.lima/rocky/lima.yaml:
+  $ $(basename "${BASH_SOURCE[0]}") ~/.lima/rocky/lima.yaml
+  $ limactl factory-reset rocky
+
+  Update the Rocky Linux image location to major version 9 in ~/.lima/rocky/lima.yaml:
+  $ $(basename "${BASH_SOURCE[0]}") --version-major 9 ~/.lima/rocky/lima.yaml
+  $ limactl factory-reset rocky
+
+Flags:
+  --version-major <version>     Use the specified version. The version must be 8 or later.
+  -h, --help              Print this help message
+HELP
+}
+
+# print the URL spec for the given location
+function rocky_url_spec_from_location() {
+	local location=$1 jq_filter url_spec
+	jq_filter='capture("
+		^https://dl\\.rockylinux\\.org/pub/rocky/(?<path_version>\\d+(\\.\\d+)?)/images/(?<path_arch>[^/]+)/
+		Rocky-(?<major_version>\\d+)-(?<target_vendor>.*)
+		(
+			-(?<type>.*)-(?<major_minor_version>\\d+\\.\\d+)-(?<date_and_ci_job_id>\\d{8}\\.\\d+)|
+			-(?<type_latest>.*)\\.latest|
+			\\.latest
+		)\\.(?<arch>[^.]+).(?<file_extension>.*)$
+	";"x")
+	'
+	url_spec=$(jq -e -r "${jq_filter}" <<<"\"${location}\"")
+
+	jq -e '.path_arch == .arch' <<<"${url_spec}" >/dev/null ||
+		error_exit "Validation failed: .path_arch != .arch: ${location}"
+	echo "${url_spec}"
+}
+
+readonly rocky_jq_filter_directory='"https://dl.rockylinux.org/pub/rocky/\(.path_version)/images/\(.path_arch)/"'
+readonly rocky_jq_filter_filename='
+	"Rocky-\(.major_version)-\(.target_vendor)\(
+		if .date_and_ci_job_id then
+			"-\(.type)-\(.major_minor_version)-\(.date_and_ci_job_id)"
+		else
+			if .type then
+				"-\(.type_latest).latest"
+			else
+				".latest"
+			end
+		end
+	).\(.arch).\(.file_extension)"
+'
+
+# print the location for the given URL spec
+function rocky_location_from_url_spec() {
+	local -r url_spec=$1
+	jq -e -r "${rocky_jq_filter_directory} + ${rocky_jq_filter_filename}" <<<"${url_spec}" ||
+		error_exit "Failed to get the location for ${url_spec}"
+}
+
+function rocky_image_directory_from_url_spec() {
+	local -r url_spec=$1
+	jq -e -r "${rocky_jq_filter_directory}" <<<"${url_spec}" ||
+		error_exit "Failed to get the image directory for ${url_spec}"
+}
+
+function rocky_image_filename_from_url_spec() {
+	local -r url_spec=$1
+	jq -e -r "${rocky_jq_filter_filename}" <<<"${url_spec}" ||
+		error_exit "Failed to get the image filename for ${url_spec}"
+}
+
+#
+function rocky_latest_image_entry_for_url_spec() {
+	local url_spec=$1 arch major_version_url_spec major_version_image_directory downloaded_page links_in_page latest_minor_version_info
+	arch=$(jq -r '.arch' <<<"${url_spec}")
+	# to detect minor version updates, we need to get the major version URL
+	major_version_url_spec=$(jq -e -r '.path_version = .major_version' <<<"${url_spec}")
+	major_version_image_directory=$(rocky_image_directory_from_url_spec "${major_version_url_spec}")
+	downloaded_page=$(download_to_cache "${major_version_image_directory}")
+	if command -v htmlq >/dev/null; then
+		links_in_page=$(htmlq 'pre a' --attribute href <"${downloaded_page}")
+	elif command -v pup >/dev/null; then
+		links_in_page=$(pup 'pre a attr{href}' <"${downloaded_page}")
+	else
+		error_exit "Please install 'htmlq' or 'pup' to list images from ${major_version_image_directory}"
+	fi
+	latest_minor_version_info=$(jq -e -Rrs --argjson spec "${url_spec}" '
+		[
+			split("\n").[] |
+			capture(
+				"^Rocky-\($spec.major_version)-\($spec.target_vendor)-\($spec.type)" +
+				"-(?<major_minor_version>\($spec.major_version)\\.\\d+)" +
+				"-(?<date_and_ci_job_id>\\d{8}\\.\\d+)\\.\($spec.arch)\\.\($spec.file_extension)$"
+				;"x"
+			) |
+			.version_number_array = ([.major_minor_version | scan("\\d+") | tonumber])
+		] | sort_by(.version_number_array, .date_and_ci_job_id) | last
+	' <<<"${links_in_page}")
+	[[ -n ${latest_minor_version_info} ]] || return
+	local newer_url_spec location sha256sum_location downloaded_sha256sum filename digest
+	# prefer the major_minor_version in the path
+	newer_url_spec=$(jq -e -r ". + ${latest_minor_version_info} | .path_version = .major_minor_version" <<<"${url_spec}")
+	location=$(rocky_location_from_url_spec "${newer_url_spec}")
+	sha256sum_location="${location}.CHECKSUM"
+	downloaded_sha256sum=$(download_to_cache "${sha256sum_location}")
+	filename=$(rocky_image_filename_from_url_spec "${newer_url_spec}")
+	digest="sha256:$(awk "/SHA256 \(${filename}\) =/{print \$4}" "${downloaded_sha256sum}")"
+	[[ -n ${digest} ]] || error_exit "Failed to get the SHA256 digest for ${filename}"
+	json_vars location arch digest
+}
+
+function rocky_cache_key_for_image_kernel() {
+	local location=$1 overriding=${3:-"{}"} url_spec
+	url_spec=$(rocky_url_spec_from_location "${location}" | jq -r ". + ${overriding}")
+	jq -r '["rocky", .major_minor_version // .major_version, .target_vendor,
+		if .date_and_ci_job_id then "timestamped" else "latest" end,
+		.arch, .file_extension] | join(":")' <<<"${url_spec}"
+}
+
+function rocky_image_entry_for_image_kernel() {
+	local location=$1 kernel_is_not_supported=$2 overriding=${3:-"{}"} url_spec image_entry=''
+	[[ ${kernel_is_not_supported} == "null" ]] || echo "Updating kernel information is not supported on Rocky Linux" >&2
+	url_spec=$(rocky_url_spec_from_location "${location}" | jq -r ". + ${overriding}")
+	if jq -e '.date_and_ci_job_id' <<<"${url_spec}" >/dev/null; then
+		image_entry=$(rocky_latest_image_entry_for_url_spec "${url_spec}")
+	else
+		image_entry=$(
+			# shellcheck disable=SC2030
+			location=$(rocky_location_from_url_spec "${url_spec}")
+			location=$(validate_url_without_redirect "${location}")
+			arch=$(jq -r '.path_arch' <<<"${url_spec}")
+			json_vars location arch
+		)
+	fi
+	# shellcheck disable=SC2031
+	if [[ -z ${image_entry} ]]; then
+		error_exit "Failed to get the ${url_spec} image location for ${location}"
+	elif jq -e ".location == \"${location}\"" <<<"${image_entry}" >/dev/null; then
+		echo "Image location is up-to-date: ${location}" >&2
+	else
+		echo "${image_entry}"
+	fi
+}
+
+# check if the script is executed or sourced
+# shellcheck disable=SC1091
+if [[ ${BASH_SOURCE[0]} == "${0}" ]]; then
+	scriptdir=$(dirname "${BASH_SOURCE[0]}")
+	# shellcheck source=./cache-common-inc.sh
+	. "${scriptdir}/cache-common-inc.sh"
+
+	if ! command -v htmlq >/dev/null && ! command -v pup >/dev/null; then
+		error_exit "Please install 'htmlq' or 'pup' to list images from https://dl.rockylinux.org/pub/rocky/<version>/images/<arch>/"
+	fi
+	# shellcheck source=/dev/null # avoid shellcheck hangs on source looping
+	. "${scriptdir}/update-template.sh"
+else
+	# this script is sourced
+	if ! command -v htmlq >/dev/null && ! command -v pup >/dev/null; then
+		echo "Please install 'htmlq' or 'pup' to list images from https://dl.rockylinux.org/pub/rocky/<version>/images/<arch>/" >&2
+	elif [[ -v SUPPORTED_DISTRIBUTIONS ]]; then
+		SUPPORTED_DISTRIBUTIONS+=("rocky")
+	else
+		declare -a SUPPORTED_DISTRIBUTIONS=("rocky")
+	fi
+	return 0
+fi
+
+declare -a templates=()
+declare overriding="{}"
+while [[ $# -gt 0 ]]; do
+	case "$1" in
+	-h | --help)
+		rocky_print_help
+		exit 0
+		;;
+	-d | --debug) set -x ;;
+	--version-major)
+		if [[ -n $2 && $2 != -* ]]; then
+			overriding=$(
+				major_version="${2%%.*}"
+				[[ ${major_version} -ge 8 ]] || error_exit "Rocky Linux major version must be 8 or later"
+				# shellcheck disable=2034
+				path_version="${major_version}"
+				json_vars path_version major_version <<<"${overriding}"
+			)
+			shift
+		else
+			error_exit "--version-major requires a value"
+		fi
+		;;
+	--version-major=*)
+		overriding=$(
+			major_version="${1#*=}"
+			major_version="${major_version%%.*}"
+			[[ ${major_version} -ge 8 ]] || error_exit "Rocky Linux major version must be 8 or later"
+			# shellcheck disable=2034
+			path_version="${major_version}"
+			json_vars path_version major_version <<<"${overriding}"
+		)
+		;;
+	*.yaml) templates+=("$1") ;;
+	*)
+		error_exit "Unknown argument: $1"
+		;;
+	esac
+	shift
+	[[ -z ${overriding} ]] && overriding="{}"
+done
+
+if [[ ${#templates[@]} -eq 0 ]]; then
+	rocky_print_help
+	exit 0
+fi
+
+declare -A image_entry_cache=()
+
+for template in "${templates[@]}"; do
+	echo "Processing ${template}"
+	# 1. extract location by parsing template using arch
+	yq_filter="
+		.images[] | [.location, .kernel.location, .kernel.cmdline] | @tsv
+	"
+	parsed=$(yq eval "${yq_filter}" "${template}")
+
+	# 3. get the image location
+	arr=()
+	while IFS= read -r line; do arr+=("${line}"); done <<<"${parsed}"
+	locations=("${arr[@]}")
+	for ((index = 0; index < ${#locations[@]}; index++)); do
+		[[ ${locations[index]} != "null" ]] || continue
+		set -e
+		IFS=$'\t' read -r location kernel_location kernel_cmdline <<<"${locations[index]}"
+		set +e # Disable 'set -e' to avoid exiting on error for the next assignment.
+		cache_key=$(
+			set -e # Enable 'set -e' for the next command.
+			rocky_cache_key_for_image_kernel "${location}" "${kernel_location}" "${overriding}"
+		) # Check exit status separately to prevent disabling 'set -e' by using the function call in the condition.
+		# shellcheck disable=2181
+		[[ $? -eq 0 ]] || continue
+		image_entry=$(
+			set -e # Enable 'set -e' for the next command.
+			if [[ -v image_entry_cache[${cache_key}] ]]; then
+				echo "${image_entry_cache[${cache_key}]}"
+			else
+				rocky_image_entry_for_image_kernel "${location}" "${kernel_location}" "${overriding}"
+			fi
+		) # Check exit status separately to prevent disabling 'set -e' by using the function call in the condition.
+		# shellcheck disable=2181
+		[[ $? -eq 0 ]] || continue
+		set -e
+		image_entry_cache[${cache_key}]="${image_entry}"
+		if [[ -n ${image_entry} ]]; then
+			[[ ${kernel_cmdline} != "null" ]] &&
+				jq -e 'has("kernel")' <<<"${image_entry}" >/dev/null &&
+				image_entry=$(jq ".kernel.cmdline = \"${kernel_cmdline}\"" <<<"${image_entry}")
+			echo "${image_entry}" | jq
+			limactl edit --log-level error --set "
+				.images[${index}] = ${image_entry}|
+				(.images[${index}] | ..) style = \"double\"
+			" "${template}"
+		fi
+	done
+done

hack/update-template.sh

@@ -154,6 +154,8 @@ if [[ ${BASH_SOURCE[0]} == "${0}" ]]; then
 	. "${scriptdir}/update-template-centos-stream.sh"
 	# shellcheck source=./update-template-almalinux.sh
 	. "${scriptdir}/update-template-almalinux.sh"
+	# shellcheck source=./update-template-rocky.sh
+	. "${scriptdir}/update-template-rocky.sh"
 else
 	# this script is sourced
 	return 0