Files
update/software/scripts/chroot_mounts.sh
Heitor Matsui af0a86e357 Improve logging for deploy start shell scripts
This commit improves logging during deploy start by:
1. Creating a common module to be sourced by shell scripts to
   load general-use functions, thus reducing code duplication
   between the scripts
2. Replacing plain "echo" commands on the scripts by logging
   functions present on the common module
3. Adding timestamps to the log messages
4. Centralizing all scripts logs into software.log, favouring
   the troubleshooting, now that log lines contain timestamps
   and the process/script that generated them

This commit also deletes the ostree_mounts.yaml file since
it would be used by apt-ostree integration, which was dropped.

Test Plan
PASS: run deploy start successfully and verify that deploy start
      log messages are logged with the expected format

Story: 2010676
Task: 49607

Change-Id: I0bdebde8147faa5b29a642e35bfaf26e9862ed0a
Signed-off-by: Heitor Matsui <heitorvieira.matsui@windriver.com>
2024-02-28 11:07:03 -03:00

133 lines
3.2 KiB
Bash

#!/bin/bash
#
# Copyright (c) 2023-2024 Wind River Systems, Inc.
#
# SPDX-License-Identifier: Apache-2.0
#
script_dir=$(dirname $0)
shell_utils=${script_dir}/shell-utils
if [ -f $shell_utils ]; then
source $shell_utils
else
echo "ERROR: ${shell_utils} module not found."
exit 1
fi
DEV_PATH=/dev
PLATFORM_PATH=/opt/platform
RABBIT_PATH=/var/lib/rabbitmq
POSTGRES_PATH=/var/lib/postgresql
PLATFORM_CONF_PATH=/etc/platform
TMP_PATH=/tmp
USR_PATH=/usr
ETC_PATH=/etc
PROC_PATH=/proc
LOG_PATH=/var/log
OSTREE_DEPLOYMENT_BRANCH="$1"
# src:dst
mount_points=(
"${DEV_PATH}:${OSTREE_DEPLOYMENT_BRANCH}/${DEV_PATH}"
"${PLATFORM_PATH}:${OSTREE_DEPLOYMENT_BRANCH}/${PLATFORM_PATH}"
"${RABBIT_PATH}:${OSTREE_DEPLOYMENT_BRANCH}/${RABBIT_PATH}"
"${POSTGRES_PATH}:${OSTREE_DEPLOYMENT_BRANCH}/${POSTGRES_PATH}"
"${PROC_PATH}:${OSTREE_DEPLOYMENT_BRANCH}/${PROC_PATH}"
"${LOG_PATH}:${OSTREE_DEPLOYMENT_BRANCH}/${LOG_PATH}"
"${OSTREE_DEPLOYMENT_BRANCH}/${USR_PATH}/${ETC_PATH}:${OSTREE_DEPLOYMENT_BRANCH}/${ETC_PATH}"
"${PLATFORM_CONF_PATH}:${TMP_PATH}/${PLATFORM_CONF_PATH}"
)
handle_error() {
local exit_code="$1"
local error_message="$2"
log "$error_message" >&2
log "Please check the error details and take appropriate action for recovery." >&2
# attempt to unmount if there were successful mounts before the error
umount_all
exit "$exit_code"
}
mount_all() {
for mnt in ${mount_points[@]}; do
# split source and destination, squeeze multiple '/'
src_dst=($(echo ${mnt//:/ } | tr -s "/"))
src=${src_dst[0]}
dst=${src_dst[1]}
info "Bind mounting ${src} -> ${dst}"
sudo mkdir -p ${dst}
sudo mount --bind ${src} ${dst} || handle_error 1 "Failed to bind mount ${src} to ${dst}"
done
return 0
}
umount_all() {
local rc=0
for mnt in ${mount_points[@]}; do
# split source and destination, squeeze multiple '/'
src_dst=($(echo ${mnt//:/ } | tr -s "/"))
src=${src_dst[0]}
dst=${src_dst[1]}
info "Unmounting $dst"
umount_output=$(sudo umount $dst 2>&1)
if [ $? -ne 0 ]; then
# ignore messages that are not harmful
if [[ ! $umount_output =~ ("not mounted"|"no mount point specified") ]]; then
error "$umount_output"
rc=1
fi
fi
done
return $rc
}
check_all() {
local rc=0
local mounted=()
for mnt in ${mount_points[@]}; do
# split source and destination, squeeze multiple '/'
src_dst=($(echo ${mnt//:/ } | tr -s "/"))
src=${src_dst[0]}
dst=${src_dst[1]}
mount | grep -w $dst 2>&1 > /dev/null
if [[ $? -eq 0 ]]; then
rc=1
mounted+=(${dst})
fi
done
if [[ ${#mounted[@]} -gt 0 ]]; then
info "Mounted mount points:"
for mnt in ${mounted[@]}; do
info $mnt
done
fi
return $rc
}
if [ -z "$1" ]; then
error "OSTree deployment branch parameter is missing."
exit 1
fi
if [[ $# -eq 2 ]]; then
if [[ $2 == "-u" ]]; then
umount_all
rc=$?
elif [[ $2 == "-c" ]]; then
check_all
rc=$?
fi
else
mount_all
rc=$?
fi
exit $rc