iot-firmware-commission

#!/bin/bash -e

CPWD="$( cd "$(dirname "$0")" ; pwd -P )"

#----------------------------------------------------#
# COMMON ATTRIBUTES                                  #
#----------------------------------------------------#

source $CPWD/scripts/iot-utils

#----------------------------------------------------#
# DEFINES / MACROS                                   #
#----------------------------------------------------#

LOG=$LOGS_DIR/iot-firmware-commission.log

#----------------------------------------------------#
# CMDLINE OPTIONS                                    #
#----------------------------------------------------#

ARGC=$#
ARGV=("$@")

VERBOSE=false
HELP=false
DEBUG_SHELL=false

# Clear args
set --

COUNT=0
while [ $COUNT -lt $ARGC ]; do
	STRIP=${ARGV[COUNT]}

	ID=0
	LONGFORMAT=`echo $STRIP | cut -b 1-2`
	if [ "x$LONGFORMAT" == "x--" ]; then
		STRIP=`echo ${ARGV[COUNT]} | cut -b 2-3`
	else
		ID=`echo $STRIP | cut -b 3-`
		STRIP=`echo $STRIP | cut -b 1-2`
	fi
	

	if [ "x$STRIP" == "x-v" ]; then
		VERBOSE=true
	elif [ "x$STRIP" == "x-h" ]; then
		HELP=true
	elif [ "x$STRIP" == "x-d" ]; then
		DEBUG_SHELL=true
	else
		pl
		pr "Error: Unknown argument"
		COUNT=$ARGC
		HELP=true
	fi
COUNT=$((COUNT+1))
done

log "Started"

pl
pg "iot-firmware-commission ($VERSION)"

if [ "$HELP" == "true" ]; then
	pn "Usage:"
	pl
	pn "Commission existing firmware image for specific domain."
	pl
	pn "iot-firmware-commission [-v] [-h] ..."
	pl
	pn "Help:"
	pl
	pn "-v (--verbose)      Verbose output for operations"
	pn "-h (--help)         Print this"
	pn "-d (--debug-shell)  Interactive shell"
	pl
	exit 0
fi

#----------------------------------------------------#
# PREPARE                                            #
#----------------------------------------------------#

pn
pg ":: Setup & Checks ::"
pn

common_setup

log "Common Setup OK"

#----------------------------------------------------#
# BODY                                               #
#----------------------------------------------------#

pl
pg ":: Device Selection ::"
pl

DEVICE=$(device)

if [ -z "$DEVICE" ] || [ ! -d $IOT_DEVICE_DIR/$DEVICE ]; then

	if [ "x$ADMIN" == "x1" ]; then

		select_device
	else
		err "No default device is set. Without Admin mode we cannot proceed."
	fi
else
	# Default device (Non-admin mode compatible)
	pnn "- Device selected : "
	pg "$DEVICE"
fi

pl
pg ":: Firmware Selection ::"
pl

select_remote_fw "*** Select locally built firmware instead ***"
pl

if [ ! -z "$FIRMWARE_REMOTE" ]; then

	pnn "- Remote Firmware : "
	pg "$S3_DEVICE_FW/$DEVICE/$FIRMWARE_REMOTE.tar.gz"

	pnn "- Firmware Downloading : "
	run mkdir -p $IOT_DOWNLOAD_DIR/$DEVICE
	run rm -rf $IOT_DOWNLOAD_DIR/$DEVICE/${FIRMWARE_REMOTE}*
	download_remote_fw_check "$S3_DEVICE_FW/$DEVICE/$FIRMWARE_REMOTE.tar.gz" $IOT_DOWNLOAD_DIR/$DEVICE/
	pg "Done"

	pnn "- Firmware Decompressing : "
        run tar xvzf $IOT_DOWNLOAD_DIR/$DEVICE/$FIRMWARE_REMOTE.tar.gz -C $IOT_DOWNLOAD_DIR/$DEVICE/
	return_check "Failed to decompress remote firmware."
	pg "Done"

	pnn "- Ready for commissioning : "
	FIRMWARE_BASE=$IOT_DOWNLOAD_DIR/$DEVICE/$FIRMWARE_REMOTE
	pg "Yes"
else
	select_local_fw
	pl
	
	pnn "- Local Firmware : "
	pg "$IOT_BUILD_DIR/$DEVICE/$FIRMWARE_LOCAL"
	
	pnn "- Ready for commissioning : "
	FIRMWARE_BASE=$IOT_BUILD_DIR/$DEVICE/$FIRMWARE_LOCAL
	pg "Yes"
fi

pl
pg ":: Domain Selection ::"
pl

DOMAIN=$(domain)

if [ -z "$DOMAIN" ] || [ ! -d $MASTER_DB/$DOMAIN ]; then

	if [ "x$ADMIN" == "x1" ]; then

		CUST_WILDCARD="*** All Customers IDs and Site IDs (dangerous) ***"
		select_domain_cust "$CUST_WILDCARD"
		pl

		if [ ! -z "$CUST" ]; then
			SITE_WILDCARD="*** All Site IDs for selected Customer ID (dangerous) ***"
			select_domain_site "$SITE_WILDCARD"
			pl

			pnn "- Domain selected : "
			if [ -z "$SITE" ]; then
				pg "$CUST/*"
			else
				pg "$CUST/$SITE"
			fi
			pl
		else
			SITE=
			pnn "- Domain selected : "
			pg "*/*"
			pl
		fi

		domain_iterate
	else
		err "No default domain is set. Without Admin mode we cannot proceed."
	fi
else
	# Single Default domain (Non-admin mode compatible)
	DOMAINS=($DOMAIN)
	pnn "- Domain selected : "
	pg "$DOMAIN"
	pl
fi

pg ":: Domain Settings Verification ::"
pl


DOMAINS_MAX=${#DOMAINS[@]}
DOMAINS_COUNT=0

while [ $DOMAINS_COUNT -lt $DOMAINS_MAX ] ; do

	DOMAIN_NEXT=${DOMAINS[$DOMAINS_COUNT]}

	CUST=$(dirname $DOMAIN_NEXT)
	SITE=$(basename $DOMAIN_NEXT)
	
	pnn "- Domain ($DOMAIN_NEXT) settings location valid : "
	if [ -d $MASTER_DB/$DOMAIN_NEXT/settings ]; then
		pg "Yes"
	else
		err "Settings folder does not exist"
	fi
	
	pnn "- Domain ($DOMAIN_NEXT) Netplan verification : "
	netplan_verify $CUST $SITE
	pg "Done"

	DOMAINS_COUNT=$((DOMAINS_COUNT + 1))
done

pl
pg ":: Domain Settings Cloud Update ::"
pl

DOMAINS_COUNT=0

while [ $DOMAINS_COUNT -lt $DOMAINS_MAX ] ; do

	DOMAIN_NEXT=${DOMAINS[$DOMAINS_COUNT]}

	CUST=$(dirname $DOMAIN_NEXT)
	SITE=$(basename $DOMAIN_NEXT)

	pnn "- Domain ($DOMAIN_NEXT) publish settings : "
	update_settings_check
	pg "Done"

	pnn "- Domain ($DOMAIN_NEXT) change status : "
	pg "$SETTINGS_UPDATE_STATUS"
	
	DOMAINS_COUNT=$((DOMAINS_COUNT + 1))

done

pl
pg ":: Domain Payload Verification ::"
pl

DOMAINS_MAX=${#DOMAINS[@]}
DOMAINS_COUNT=0

while [ $DOMAINS_COUNT -lt $DOMAINS_MAX ] ; do

	DOMAIN_NEXT=${DOMAINS[$DOMAINS_COUNT]}

	CUST=$(dirname $DOMAIN_NEXT)
	SITE=$(basename $DOMAIN_NEXT)
	
	pnn "- Domain ($DOMAIN_NEXT) payload location valid : "
	if [ -d $MASTER_DB/$DOMAIN_NEXT/payload ]; then
		pg "Yes"
	else
		err "Payload folder does not exist."
	fi
	
	pnn "- Domain ($DOMAIN_NEXT) payload size check : "
	S=$(du -hs --block-size=1M $MASTER_DB/$CUST/$SITE/payload | sed -n 's/^\([0-9.]*\).*/\1/p')
	if [ $S -gt $FIRMWARE_PAYLOAD_MAX_SIZE ]; then
		err "Payload exceeds ${FIRMWARE_PAYLOAD_MAX_SIZE}MiB ($CUST/$SITE/payload)"
	fi
	pg "Done"

	DOMAINS_COUNT=$((DOMAINS_COUNT + 1))
done

pl
pg ":: Domain Payload Cloud Update ::"
pl

DOMAINS_COUNT=0

while [ $DOMAINS_COUNT -lt $DOMAINS_MAX ] ; do

	DOMAIN_NEXT=${DOMAINS[$DOMAINS_COUNT]}

	CUST=$(dirname $DOMAIN_NEXT)
	SITE=$(basename $DOMAIN_NEXT)

	pnn "- Domain ($DOMAIN_NEXT) publish payload : "
	update_payload_check
	pg "Done"

	pnn "- Domain ($DOMAIN_NEXT) change status : "
	pg "$PAYLOAD_UPDATE_STATUS"
	
	DOMAINS_COUNT=$((DOMAINS_COUNT + 1))

done

pl
pg ":: Commissioning Image(s) ::"
pl

if [ ! -f $IOT_DEVICE_DIR/$DEVICE/device-commission ]; then
	err "Cannot locate commission script for device: $DEVICE"
fi

source $IOT_DEVICE_DIR/$DEVICE/device-commission

DOMAINS_COUNT=0

while [ $DOMAINS_COUNT -lt $DOMAINS_MAX ] ; do

	DOMAIN_NEXT=${DOMAINS[$DOMAINS_COUNT]}

	CUST=$(dirname $DOMAIN_NEXT)
	SITE=$(basename $DOMAIN_NEXT)

        pnn "- Domain selected for commissioning : "
        pg "$DOMAIN_NEXT"

        pnn "- Creating domain specific firmware image : "

	mkdir -p $IOT_FW_DIR/$CUST/$SITE
	rm -rf $IOT_FW_DIR/$CUST/$SITE/tmp.img
	rm -rf $IOT_FW_DIR/$CUST/$SITE/$(basename $FIRMWARE_BASE .img)*

	FIRMWARE_NAME=$IOT_FW_DIR/$CUST/$SITE/tmp.img
	cp -f $FIRMWARE_BASE $FIRMWARE_NAME

        pg "Done"

	log "Commissioning Temp Image Name: $FIRMWARE_NAME"

	device_commission

	FIRMWARE_NAME_FINAL=$IOT_FW_DIR/$CUST/$SITE/$(basename $FIRMWARE_BASE .img)-commissioned.img
	mkdir -p $(dirname $FIRMWARE_NAME_FINAL)
	rm -rf $FIRMWARE_NAME_FINAL
	mv $FIRMWARE_NAME $FIRMWARE_NAME_FINAL

	log "Commissioning Final Image Name: $FIRMWARE_NAME_FINAL"

	pnn "- Commmissioned and ready for flashing : "
	pg "$FIRMWARE_NAME_FINAL"
	pl

	DOMAINS_COUNT=$((DOMAINS_COUNT + 1))

done

pl