build/lib/functions/cli/cli-artifact.sh

#!/usr/bin/env bash
#
# SPDX-License-Identifier: GPL-2.0
#
# Copyright (c) 2013-2023 Igor Pecovnik, igor@armbian.com
#
# This file is a part of the Armbian Build Framework
# https://github.com/armbian/build/

function cli_artifact_pre_run() {
	case "${ARMBIAN_COMMAND}" in
		download-artifact)
			display_alert "download-only mode:" "won't build '${WHAT}'" "info"
			DONT_BUILD_ARTIFACTS="${WHAT}"
			;;
	esac

	initialize_artifact "${WHAT}"
	# Run the pre run adapter
	artifact_cli_adapter_pre_run
}

function cli_artifact_run() {
	: "${chosen_artifact:?chosen_artifact is not set}"
	: "${chosen_artifact_impl:?chosen_artifact_impl is not set}"

	if [[ "${CONFIG_DEFS_ONLY}" != "yes" ]]; then
		# Make sure ORAS tooling is installed before starting.
		run_tool_oras
	fi

	display_alert "artifact" "${chosen_artifact}" "debug"
	display_alert "artifact" "${chosen_artifact} :: ${chosen_artifact_impl}()" "debug"
	declare -g artifact_version_requires_aggregation="no" # marker
	artifact_cli_adapter_config_prep                      # only if in cli.

	# if asked by _config_prep to aggregate, and HOSTRELEASE is not set, obtain it.
	if [[ "${artifact_version_requires_aggregation}" == "yes" ]] && [[ -z "${HOSTRELEASE}" ]]; then
		obtain_hostrelease_only # Sets HOSTRELEASE
	fi

	# When run in GHA, assume we're checking/updating the remote cache only.
	# Local cache is ignored, and if found, it's not unpacked, either from local or remote.
	# If remote cache is found, does nothing.
	declare default_update_remote_only="no"
	if [[ "${CI}" == "true" ]] && [[ "${GITHUB_ACTIONS}" == "true" ]]; then
		display_alert "Running in GitHub Actions, assuming we're updating remote cache only" "GHA remote-only" "info"
		default_update_remote_only="yes"
	fi

	declare skip_unpack_if_found_in_caches="${skip_unpack_if_found_in_caches:-"${default_update_remote_only}"}"
	declare ignore_local_cache="${ignore_local_cache:-"${default_update_remote_only}"}"
	declare deploy_to_remote="${deploy_to_remote:-"${default_update_remote_only}"}"

	case "${ARMBIAN_COMMAND}" in
		download-artifact)
			display_alert "Running in download-artifact mode" "download-artifact" "ext"
			skip_unpack_if_found_in_caches="no"
			ignore_local_cache="no"
			deploy_to_remote="no"
			;;
		*)
			# @TODO: rpardini: i'm braindead. I really can't make sense of my own code!
			# If OCI_TARGET_BASE is explicitly set, ignore local, skip if found in remote, and deploy to remote after build.
			if [[ -n "${OCI_TARGET_BASE}" ]]; then
				skip_unpack_if_found_in_caches="yes"
				ignore_local_cache="yes"
				deploy_to_remote="yes"

				# Pass ARTIFACT_USE_CACHE=yes to actually use the cache versions, but don't deploy to remote.
				# @TODO this is confusing. each op should be individually controlled...
				# what we want is:
				# 1: - check remote, if not found, check local, if not found, build, then deploy to remote
				#      - if remote found, do nothing.
				#      - if local found, deploy it to remote (for switching targets)
				# 2: - get from remote -> get local -> build, then DON'T deploy to remote
				if [[ "${ARTIFACT_USE_CACHE}" == "yes" ]]; then
					skip_unpack_if_found_in_caches="no"
					ignore_local_cache="no"
					deploy_to_remote="no"
				fi
			fi
			;;
	esac

	# Force artifacts download we need to populate repository
	if [[ "${FORCE_ARTIFACTS_DOWNLOAD}" == "yes" ]]; then
		skip_unpack_if_found_in_caches="no"
	fi

	# display a summary of the 3 vars above: skip_unpack_if_found_in_caches, ignore_local_cache, deploy_to_remote
	display_alert "CLI Artifact summary" "skip_unpack_if_found_in_caches=${skip_unpack_if_found_in_caches}, ignore_local_cache=${ignore_local_cache}, deploy_to_remote=${deploy_to_remote}" "info"

	if [[ "${ARTIFACT_BUILD_INTERACTIVE}" == "yes" ]]; then # Set by `kernel-config`, `kernel-patch`, `uboot-config`, `uboot-patch`, etc.
		display_alert "Running artifact build in interactive mode" "log file will be incomplete" "info"
		do_with_default_build obtain_complete_artifact
	else
		do_with_default_build obtain_complete_artifact < /dev/null
	fi
}