mirror of
https://github.com/armbian/build.git
synced 2025-08-12 06:06:58 +02:00
301 lines
13 KiB
Bash
301 lines
13 KiB
Bash
function create_artifact_functions() {
|
|
declare -a funcs=(
|
|
"cli_adapter_pre_run" "cli_adapter_config_prep"
|
|
"prepare_version"
|
|
"get_default_oci_target"
|
|
"is_available_in_local_cache" "is_available_in_remote_cache" "obtain_from_remote_cache"
|
|
"deploy_to_remote_cache"
|
|
"build_from_sources"
|
|
)
|
|
for func in "${funcs[@]}"; do
|
|
declare impl_func="artifact_${chosen_artifact_impl}_${func}"
|
|
if [[ $(type -t "${impl_func}") == function ]]; then
|
|
declare cmd
|
|
cmd="$(
|
|
cat <<- ARTIFACT_DEFINITION
|
|
function artifact_${func}() {
|
|
display_alert "Calling artifact function" "${impl_func}() \$*" "debug"
|
|
${impl_func} "\$@"
|
|
}
|
|
ARTIFACT_DEFINITION
|
|
)"
|
|
eval "${cmd}"
|
|
else
|
|
exit_with_error "Missing artifact implementation function '${impl_func}'"
|
|
fi
|
|
done
|
|
|
|
# If ${chosen_artifact} is in ${DONT_BUILD_ARTIFACTS}, override the build function with an error.
|
|
if [[ "${DONT_BUILD_ARTIFACTS}" = *"${chosen_artifact}"* ]]; then
|
|
display_alert "Artifact '${chosen_artifact}' is in DONT_BUILD_ARTIFACTS, overriding build function with error" "DONT_BUILD_ARTIFACTS=${chosen_artifact}" "debug"
|
|
declare cmd
|
|
cmd="$(
|
|
cat <<- ARTIFACT_DEFINITION
|
|
function artifact_build_from_sources() {
|
|
exit_with_error "Artifact '${chosen_artifact}' is in DONT_BUILD_ARTIFACTS."
|
|
}
|
|
ARTIFACT_DEFINITION
|
|
)"
|
|
eval "${cmd}"
|
|
else
|
|
display_alert "Artifact '${chosen_artifact}' is not in DONT_BUILD_ARTIFACTS, using default build function" "DONT_BUILD_ARTIFACTS!=${chosen_artifact}" "debug"
|
|
fi
|
|
}
|
|
|
|
function initialize_artifact() {
|
|
declare -g chosen_artifact="${1}"
|
|
|
|
# cant be empty, or have spaces nor commas
|
|
[[ "x${chosen_artifact}x" == "xx" ]] && exit_with_error "Artifact name is empty"
|
|
[[ "${chosen_artifact}" == *" "* ]] && exit_with_error "Artifact name cannot contain spaces"
|
|
[[ "${chosen_artifact}" == *","* ]] && exit_with_error "Artifact name cannot contain commas"
|
|
|
|
armbian_register_artifacts
|
|
declare -g chosen_artifact_impl="${ARMBIAN_ARTIFACTS_TO_HANDLERS_DICT["${chosen_artifact}"]}"
|
|
[[ "x${chosen_artifact_impl}x" == "xx" ]] && exit_with_error "Unknown artifact '${chosen_artifact}'"
|
|
display_alert "artifact" "${chosen_artifact} :: ${chosen_artifact_impl}()" "info"
|
|
create_artifact_functions
|
|
}
|
|
|
|
function obtain_complete_artifact() {
|
|
declare -g artifact_name="undetermined"
|
|
declare -g artifact_type="undetermined"
|
|
declare -g artifact_version="undetermined"
|
|
declare -g artifact_version_reason="undetermined"
|
|
declare -g artifact_base_dir="undetermined"
|
|
declare -g artifact_final_file="undetermined"
|
|
declare -g artifact_final_file_basename="undetermined"
|
|
declare -g artifact_full_oci_target="undetermined"
|
|
declare -A -g artifact_map_packages=()
|
|
declare -A -g artifact_map_debs=()
|
|
|
|
# Check if REVISION is set, otherwise exit_with_error
|
|
[[ "x${REVISION}x" == "xx" ]] && exit_with_error "REVISION is not set"
|
|
|
|
# Contentious; it might be that prepare_version is complex enough to warrant more than 1 logging section.
|
|
LOG_SECTION="artifact_prepare_version" do_with_logging artifact_prepare_version
|
|
|
|
debug_var artifact_name
|
|
debug_var artifact_type
|
|
debug_var artifact_version
|
|
debug_var artifact_version_reason
|
|
debug_var artifact_base_dir
|
|
debug_var artifact_final_file
|
|
debug_dict artifact_map_packages
|
|
debug_dict artifact_map_debs
|
|
|
|
# sanity checks. artifact_version/artifact_version_reason/artifact_final_file *must* be set
|
|
[[ "x${artifact_name}x" == "xx" || "${artifact_name}" == "undetermined" ]] && exit_with_error "artifact_name is not set after artifact_prepare_version"
|
|
[[ "x${artifact_type}x" == "xx" || "${artifact_type}" == "undetermined" ]] && exit_with_error "artifact_type is not set after artifact_prepare_version"
|
|
[[ "x${artifact_version}x" == "xx" || "${artifact_version}" == "undetermined" ]] && exit_with_error "artifact_version is not set after artifact_prepare_version"
|
|
[[ "x${artifact_version_reason}x" == "xx" || "${artifact_version_reason}" == "undetermined" ]] && exit_with_error "artifact_version_reason is not set after artifact_prepare_version"
|
|
[[ "x${artifact_base_dir}x" == "xx" || "${artifact_base_dir}" == "undetermined" ]] && exit_with_error "artifact_base_dir is not set after artifact_prepare_version"
|
|
[[ "x${artifact_final_file}x" == "xx" || "${artifact_final_file}" == "undetermined" ]] && exit_with_error "artifact_final_file is not set after artifact_prepare_version"
|
|
|
|
# validate artifact_type... it must be one of the supported types
|
|
case "${artifact_type}" in
|
|
deb | deb-tar)
|
|
# validate artifact_version begins with a digit
|
|
[[ "${artifact_version}" =~ ^[0-9] ]] || exit_with_error "${artifact_type}: artifact_version '${artifact_version}' does not begin with a digit"
|
|
;;
|
|
tar.zst)
|
|
: # valid, no restrictions on tar.zst versioning
|
|
;;
|
|
*)
|
|
exit_with_error "artifact_type '${artifact_type}' is not supported"
|
|
;;
|
|
esac
|
|
|
|
# set those as outputs for GHA
|
|
github_actions_add_output artifact_name "${artifact_name}"
|
|
github_actions_add_output artifact_type "${artifact_type}"
|
|
github_actions_add_output artifact_version "${artifact_version}"
|
|
github_actions_add_output artifact_version_reason "${artifact_version_reason}"
|
|
github_actions_add_output artifact_final_file "${artifact_final_file}"
|
|
|
|
# ensure artifact_base_dir exists
|
|
mkdir -p "${artifact_base_dir}"
|
|
|
|
# compute artifact_final_file relative to ${SRC} but don't use realpath
|
|
declare -g artifact_file_relative="${artifact_final_file#${SRC}/}"
|
|
github_actions_add_output artifact_file_relative "${artifact_file_relative}"
|
|
|
|
# just the file name, sans any path
|
|
declare -g artifact_final_file_basename="undetermined"
|
|
artifact_final_file_basename="$(basename "${artifact_final_file}")"
|
|
github_actions_add_output artifact_final_file_basename "${artifact_final_file_basename}"
|
|
|
|
debug_var artifact_final_file_basename
|
|
debug_var artifact_file_relative
|
|
|
|
# @TODO: possibly stop here if only for up-to-date-checking
|
|
|
|
# Determine OCI coordinates. OCI_TARGET_BASE overrides the default proposed by the artifact.
|
|
declare artifact_oci_target_base="undetermined"
|
|
if [[ -n "${OCI_TARGET_BASE}" ]]; then
|
|
artifact_oci_target_base="${OCI_TARGET_BASE}"
|
|
else
|
|
artifact_get_default_oci_target
|
|
fi
|
|
|
|
[[ -z "${artifact_oci_target_base}" ]] && exit_with_error "No artifact_oci_target_base defined."
|
|
|
|
declare -g artifact_full_oci_target="${artifact_oci_target_base}${artifact_name}:${artifact_version}"
|
|
|
|
declare -g artifact_exists_in_local_cache="undetermined"
|
|
declare -g artifact_exists_in_remote_cache="undetermined"
|
|
|
|
if [[ "${ARTIFACT_IGNORE_CACHE}" != "yes" ]]; then
|
|
LOG_SECTION="artifact_is_available_in_local_cache" do_with_logging artifact_is_available_in_local_cache
|
|
debug_var artifact_exists_in_local_cache
|
|
|
|
# If available in local cache, we're done (except for deb-tar which needs unpacking...)
|
|
if [[ "${artifact_exists_in_local_cache}" == "yes" ]]; then
|
|
display_alert "artifact" "exists in local cache: ${artifact_name} ${artifact_version}" "debug"
|
|
if [[ "${skip_unpack_if_found_in_caches:-"no"}" == "yes" ]]; then
|
|
display_alert "artifact" "skipping unpacking as requested" "info"
|
|
else
|
|
LOG_SECTION="unpack_artifact_from_local_cache" do_with_logging unpack_artifact_from_local_cache
|
|
fi
|
|
|
|
if [[ "${ignore_local_cache:-"no"}" == "yes" ]]; then
|
|
display_alert "artifact" "ignoring local cache as requested" "info"
|
|
else
|
|
display_alert "artifact" "present in local cache: ${artifact_name} ${artifact_version}" "cachehit"
|
|
return 0
|
|
fi
|
|
fi
|
|
|
|
LOG_SECTION="artifact_is_available_in_remote_cache" do_with_logging artifact_is_available_in_remote_cache
|
|
debug_var artifact_exists_in_remote_cache
|
|
|
|
if [[ "${artifact_exists_in_remote_cache}" == "yes" ]]; then
|
|
display_alert "artifact" "exists in remote cache: ${artifact_name} ${artifact_version}" "debug"
|
|
if [[ "${skip_unpack_if_found_in_caches:-"no"}" == "yes" ]]; then
|
|
display_alert "artifact" "skipping obtain from remote & unpacking as requested" "info"
|
|
return 0
|
|
fi
|
|
LOG_SECTION="artifact_obtain_from_remote_cache" do_with_logging artifact_obtain_from_remote_cache
|
|
LOG_SECTION="unpack_artifact_from_local_cache" do_with_logging unpack_artifact_from_local_cache
|
|
display_alert "artifact" "obtained from remote cache: ${artifact_name} ${artifact_version}" "cachehit"
|
|
return 0
|
|
fi
|
|
fi
|
|
|
|
if [[ "${artifact_exists_in_local_cache}" != "yes" && "${artifact_exists_in_remote_cache}" != "yes" ]]; then
|
|
# Not found in any cache, so we need to build it.
|
|
# @TODO: if deploying to remote cache, force high compression, DEB_COMPRESS="xz"
|
|
artifact_build_from_sources # definitely will end up having its own logging sections
|
|
|
|
# pack the artifact to local cache (eg: for deb-tar)
|
|
LOG_SECTION="pack_artifact_to_local_cache" do_with_logging pack_artifact_to_local_cache
|
|
|
|
# Sanity check: the artifact_final_file should exist now.
|
|
if [[ ! -f "${artifact_final_file}" ]]; then
|
|
exit_with_error "Artifact file ${artifact_final_file} did not exist, after artifact_build_from_sources()."
|
|
else
|
|
display_alert "Artifact file exists" "${artifact_final_file} YESSS" "debug"
|
|
fi
|
|
fi
|
|
|
|
if [[ "${deploy_to_remote:-"no"}" == "yes" ]]; then
|
|
LOG_SECTION="artifact_deploy_to_remote_cache" do_with_logging artifact_deploy_to_remote_cache
|
|
fi
|
|
}
|
|
|
|
# This is meant to be run after config, inside default build.
|
|
function build_artifact_for_image() {
|
|
initialize_artifact "${WHAT}"
|
|
obtain_complete_artifact
|
|
}
|
|
|
|
function pack_artifact_to_local_cache() {
|
|
if [[ "${artifact_type}" == "deb-tar" ]]; then
|
|
declare -a files_to_tar=()
|
|
run_host_command_logged tar -C "${artifact_base_dir}" -cvf "${artifact_final_file}" "${artifact_map_debs[@]}"
|
|
display_alert "Created deb-tar artifact" "deb-tar: ${artifact_final_file}" "info"
|
|
fi
|
|
}
|
|
|
|
function unpack_artifact_from_local_cache() {
|
|
if [[ "${artifact_type}" == "deb-tar" ]]; then
|
|
declare any_missing="no"
|
|
declare deb_name
|
|
for deb_name in "${artifact_map_debs[@]}"; do
|
|
declare new_name_full="${artifact_base_dir}/${deb_name}"
|
|
if [[ ! -f "${new_name_full}" ]]; then
|
|
display_alert "Unpacking artifact" "deb-tar: ${artifact_final_file_basename} missing: ${new_name_full}" "debug"
|
|
any_missing="yes"
|
|
fi
|
|
done
|
|
if [[ "${any_missing}" == "yes" ]]; then
|
|
display_alert "Unpacking artifact" "deb-tar: ${artifact_final_file_basename}" "info"
|
|
run_host_command_logged tar -C "${artifact_base_dir}" -xvf "${artifact_final_file}"
|
|
fi
|
|
# sanity check? did unpacking produce the expected files?
|
|
declare any_missing="no"
|
|
declare deb_name
|
|
for deb_name in "${artifact_map_debs[@]}"; do
|
|
declare new_name_full="${artifact_base_dir}/${deb_name}"
|
|
if [[ ! -f "${new_name_full}" ]]; then
|
|
display_alert "Unpacking artifact" "after unpack deb-tar: ${artifact_final_file_basename} missing: ${new_name_full}" "err"
|
|
any_missing="yes"
|
|
fi
|
|
done
|
|
if [[ "${any_missing}" == "yes" ]]; then
|
|
display_alert "Files missing from deb-tar" "this is a bug, please report it. artifact_name: '${artifact_name}' artifact_version: '${artifact_version}'" "err"
|
|
fi
|
|
fi
|
|
return 0
|
|
}
|
|
|
|
function upload_artifact_to_oci() {
|
|
# check artifact_full_oci_target is set
|
|
if [[ -z "${artifact_full_oci_target}" ]]; then
|
|
exit_with_error "artifact_full_oci_target is not set"
|
|
fi
|
|
|
|
display_alert "Pushing to OCI" "'${artifact_final_file}' -> '${artifact_full_oci_target}'" "info"
|
|
oras_push_artifact_file "${artifact_full_oci_target}" "${artifact_final_file}" "${artifact_name} - ${artifact_version} - ${artifact_version_reason} - type: ${artifact_type}"
|
|
}
|
|
|
|
function is_artifact_available_in_local_cache() {
|
|
artifact_exists_in_local_cache="no" # outer scope
|
|
if [[ -f "${artifact_final_file}" ]]; then
|
|
artifact_exists_in_local_cache="yes" # outer scope
|
|
fi
|
|
return 0
|
|
}
|
|
|
|
function is_artifact_available_in_remote_cache() {
|
|
# check artifact_full_oci_target is set
|
|
if [[ -z "${artifact_full_oci_target}" ]]; then
|
|
exit_with_error "artifact_full_oci_target is not set"
|
|
fi
|
|
|
|
declare oras_has_manifest="undetermined"
|
|
declare oras_manifest_json="undetermined"
|
|
declare oras_manifest_description="undetermined"
|
|
oras_get_artifact_manifest "${artifact_full_oci_target}"
|
|
|
|
display_alert "oras_has_manifest" "${oras_has_manifest}" "debug"
|
|
display_alert "oras_manifest_description" "${oras_manifest_description}" "debug"
|
|
display_alert "oras_manifest_json" "${oras_manifest_json}" "debug"
|
|
|
|
if [[ "${oras_has_manifest}" == "yes" ]]; then
|
|
display_alert "Artifact is available in remote cache" "${artifact_full_oci_target} - '${oras_manifest_description}'" "info"
|
|
artifact_exists_in_remote_cache="yes"
|
|
else
|
|
display_alert "Artifact is not available in remote cache" "${artifact_full_oci_target}" "info"
|
|
artifact_exists_in_remote_cache="no"
|
|
fi
|
|
|
|
return 0
|
|
}
|
|
|
|
function obtain_artifact_from_remote_cache() {
|
|
display_alert "Obtaining artifact from remote cache" "${artifact_full_oci_target} into ${artifact_final_file_basename}" "info"
|
|
oras_pull_artifact_file "${artifact_full_oci_target}" "${artifact_base_dir}" "${artifact_final_file_basename}"
|
|
return 0
|
|
}
|