Ubuntu – Error Azure Device Update when handler is microsoft/script:1

After restarting the Virtual Machine that I was using for testing, I encountered a different error:

"The install script doesn't create a result file '/var/lib/adu/downloads/aebe0066-67ba-4d78-a247-2656d91dd7c8/action_download_aduc_result.json'."

According to the responses on the issue I opened on GitHub, I noticed that I wasn't writing the result to the result file, which is mandatory

https://github.com/Azure/iot-hub-device-update/issues/667.

Following the documentation and the example script I rewrote the script and the import manifest and it worked properly:

script_test.importmanifest.json:

{
  "compatibility": [
    {
      "manufacturer": "hp",
      "model": "elite"
    }
  ],
  "createdDateTime": "2024-11-15T14:30:05Z",
  "files": [
    {
      "filename": "script_test.sh",
      "hashes": {
        "sha256": "WRgOrX+fgPECHrmEX1i6XmnghiYwe+4PGPv0Tjm2vpQ="
      },
      "sizeInBytes": 5902
    }
  ],
  "instructions": {
    "steps": [
      {
        "files": [
          "script_test.sh"
        ],
        "handler": "microsoft/script:1",
        "handlerProperties": {
          "arguments": "",
          "scriptFileName": "script_test.sh",
                    "installedCriteria": "1.0"
        },
        "type": "inline"
      }
    ]
  },
  "manifestVersion": "5.0",
  "updateId": {
    "name": "scriptupdate",
    "provider": "me",
    "version": "51.0.0"
  }
}

script_test.sh

#!/bin/bash

# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.

# Ensure that getopt starts from first option if ". <script.sh>" was used.
OPTIND=1

# Ensure we don't end the user's terminal session if invoked from source (".").
if [[ $0 != "${BASH_SOURCE[0]}" ]]; then
    ret='return'
else
    ret='exit'
fi

# Output formatting.

# Log level: 0=debug, 1=info, 2=warning, 3=error, 4=none
log_level=1

warn() { echo -e "33[1;33mWarning:33[0m $*" >&2; }

error() { echo -e "33[1;31mError:33[0m $*" >&2; }

header() { echo -e "e[4me[1me[1;32m$*e[0m"; }

bullet() { echo -e "e[1;34m*e[0m $*"; }

# Log debug prefix - blue
log_debug_pref="33[1;30m[D]33[0m"

# Log info prefix - blue
log_info_pref="33[1;34m[I]33[0m"

# Log warning prefix - yellow
log_warn_pref="33[1;33m[W]33[0m"

# Log error prefix - red
log_error_pref="33[1;31m[E]33[0m"

#
# Install poicy
#
#install_error_policy="abort"
#install_reboot_policy="none"

# component_props will contain a map of property.
declare -A component_props

#
# Files and Folders information
#
workfolder=
output_file=
log_file=
result_file=

#
# Device Update specific arguments
#
do_install_action=

#
# Remaining aguments and parameters
#
PARAMS=

#
# Output, Logs, and Result helper functions.
#
_timestamp=

update_timestamp() {
    # See https://man7.org/linux/man-pages/man1/date.1.html
    _timestamp="$(date +'%Y/%m/%d:%H%M%S')"
}

log_debug() {
    if [ $log_level -gt 0 ]; then
        return
    fi
    log "$log_debug_pref" "$@"
}

log_info() {
    if [ $log_level -gt 1 ]; then
        return
    fi
    log "$log_info_pref" "$@"
}

log_warn() {
    if [ $log_level -gt 2 ]; then
        return
    fi
    log "$log_warn_pref" "$@"
}

log_error() {
    if [ $log_level -gt 3 ]; then
        return
    fi
    log "$log_error_pref" "$@"
}

log() {
    update_timestamp
    if [ -z "$log_file" ]; then
        echo -e "[$_timestamp]" "$@" >&1
    else
        echo "[$_timestamp]" "$@" >> "$log_file"
    fi
}

output() {
    update_timestamp
    if [ -z "$output_file" ]; then
        echo "[$_timestamp]" "$@" >&1
    else
        echo "[$_timestamp]" "$@" >> "$output_file"
    fi
}

#
# Write result json string to result file.
#
result() {
    # NOTE: don't insert timestamp in result file.
    if [ -z "$result_file" ]; then
        echo "$@" >&1
    else
        echo "$@" > "$result_file"
    fi
}

log "Log begin:"
output "Output begin:"

#
# Parsing arguments
#
while [[ $1 != "" ]]; do
    case $1 in

    #
    # Component-related arguments.
    #
    # Following arguments and parameters will be populated by the Script Step Handler.
    #

    #
    # Device Update specific arguments.
    #
    --action-install)
        shift
        log_info "Will runscript as 'installer' script."
        do_install_action=yes
        ;;

    #
    # Update artifacts
    #

    --work-folder)
        shift
        if [[ -z $1 || $1 == -* ]]; then
            error "--work-folder parameter is mandatory."
            $ret 1
        fi
        workfolder="$1"
        echo "Workfolder: $workfolder"
        shift
        ;;

    #
    # Output-related arguments.
    #
    # --out-file <file_path>, --result-file <file_path>, --log-file <file_path>
    #
    --output-file)
        shift
        if [[ -z $1 || $1 == -* ]]; then
            error "--out-file parameter is mandatory."
            $ret 1
        fi
        output_file="$1"

        #
        #Create output file path.
        #
        # Delete existing log.
        rm -f -r "$output_file"
        # Create dir(s) recursively (include filename, well remove it in the following line...).
        mkdir -p "$output_file"
        shift
        ;;

    --result-file)
        shift
        if [[ -z $1 || $1 == -* ]]; then
            error "--result-file parameter is mandatory."
            $ret 1
        fi
        result_file="$1"
        #
        #Create result file path.
        #
        # Delete existing log.
        rm -f -r "$result_file"
        # Create dir(s) recursively (include filename, well remove it in the following line...).
        touch "$result_file"
        shift
        ;;

    --log-file)
        shift
        if [[ -z $1 || $1 == -* ]]; then
            error "--log-file parameter is mandatory."
            $ret 1
        fi
        log_file="$1"
        shift
        ;;
    --log-level)
        shift
        if [[ -z $1 || $1 == -* ]]; then
            error "--log-level parameter is mandatory."
            $ret 1
        fi
        log_level=$1
        shift
        ;;

    -h | --help)
        print_help
        $ret 0
        ;;

    *) # preserve positional arguments
        PARAMS="$PARAMS $1"
        shift
        ;;
    esac
done

#
# Main
#

resultCode=0
extendedResultCode=1
resultDetails=""

# Update apt-get
sudo apt-get update

# Install cowsay
sudo apt-get install cowsay

# Create a directory
mkdir -p /home/azureuser/this_was_create_by_adu

# Create a text file with specified content inside the directory
echo "this file was generated by adu on $(TZ='UTC-1' date '+%Y-%m-%d %H:%M:%S %Z')" > /home/azureuser/this_was_create_by_adu/generated_file.txt

# Confirmation message
if [ -d "/home/azureuser/this_was_create_by_adu" ] && [ -f "/home/azureuser/this_was_create_by_adu/generated_file.txt" ]; then
    log_info "Both directory and file exist."
    resultCode=600
    extendedResultCode=0
    resultDetails="folder and file created"
    ret_val=0
else
    log_info "Either the directory or file does not exist."
    resultDetails="Folder and/or file have been not created"
    exit 1
fi

# Prepare ADUC_Result json.
aduc_result_json="{"resultCode":$resultCode, "extendedResultCode":$extendedResultCode,"resultDetails":"$resultDetails"}"

# Show output.
output "Result:" "$aduc_result_json"

# Write ADUC_Result to result file.

result "$aduc_result_json"

exit 0