From 4913cbed6adf526f06cd9e0e4c61688be1f1caac Mon Sep 17 00:00:00 2001
From: Ivan Grokhotkov <ivan@espressif.com>
Date: Mon, 8 Jun 2020 19:14:48 +0200
Subject: [PATCH] tools: export.sh: fix compatibility with dash shell

* fix constructs invalid in dash
* clean shellcheck warnings and disable false positive ones

Closes https://github.com/espressif/esp-idf/issues/5366
---
 export.sh | 38 +++++++++++++++++++++++---------------
 1 file changed, 23 insertions(+), 15 deletions(-)

diff --git a/export.sh b/export.sh
index 1a543135c..88285cab8 100644
--- a/export.sh
+++ b/export.sh
@@ -1,6 +1,6 @@
 # This script should be sourced, not executed.
 
-function realpath_int() {
+realpath_int() {
     wdir="$PWD"; [ "$PWD" = "/" ] && wdir=""
     arg=$1
     case "$arg" in
@@ -12,24 +12,30 @@ function realpath_int() {
 }
 
 
-function idf_export_main() {
+idf_export_main() {
     # The file doesn't have executable permissions, so this shouldn't really happen.
     # Doing this in case someone tries to chmod +x it and execute...
-    if [[ -n "${BASH_SOURCE}" && ( "${BASH_SOURCE[0]}" == "${0}" ) ]]; then
+
+    # shellcheck disable=SC2128,SC2169,SC2039 # ignore array expansion warning
+    if [ -n "${BASH_SOURCE}" ] && [ "${BASH_SOURCE[0]}" = "${0}" ]
+    then
         echo "This script should be sourced, not executed:"
+        # shellcheck disable=SC2039  # reachable only with bash
         echo ". ${BASH_SOURCE[0]}"
         return 1
     fi
 
-    if [[ -z "${IDF_PATH}" ]]
+    if [ -z "${IDF_PATH}" ]
     then
         # IDF_PATH not set in the environment.
         # If using bash or zsh, try to guess IDF_PATH from script location.
         self_path=""
-        if [[ -n "${BASH_SOURCE}" ]]
+
+        # shellcheck disable=SC2128  # ignore array expansion warning
+        if [ -n "${BASH_SOURCE}" ]
         then
             self_path="${BASH_SOURCE}"
-        elif [[ -n "${ZSH_VERSION}" ]]
+        elif [ -n "${ZSH_VERSION}" ]
         then
             self_path="${(%):-%x}"
         else
@@ -38,28 +44,29 @@ function idf_export_main() {
             return 1
         fi
 
+        # shellcheck disable=SC2169,SC2169,SC2039  # unreachable with 'dash'
         if [[ "$OSTYPE" == "darwin"* ]]; then
             # convert possibly relative path to absolute
-            script_dir="$(realpath_int ${self_path})"
+            script_dir="$(realpath_int "${self_path}")"
             # resolve any ../ references to make the path shorter
-            script_dir="$(cd ${script_dir}; pwd)"
+            script_dir="$(cd "${script_dir}" || exit 1; pwd)"
         else
             # convert to full path and get the directory name of that
-            script_name="$(readlink -f ${self_path})"
-            script_dir="$(dirname ${script_name})"
+            script_name="$(readlink -f "${self_path}")"
+            script_dir="$(dirname "${script_name}")"
         fi
         export IDF_PATH="${script_dir}"
         echo "Setting IDF_PATH to '${IDF_PATH}'"
     else
         # IDF_PATH came from the environment, check if the path is valid
-        if [[ ! -d "${IDF_PATH}" ]]
+        if [ ! -d "${IDF_PATH}" ]
         then
             echo "IDF_PATH is set to '${IDF_PATH}', but it is not a valid directory."
             echo "If you have set IDF_PATH manually, check if the path is correct."
             return 1
         fi
         # Check if this path looks like an IDF directory
-        if [[ ! -f "${IDF_PATH}/tools/idf.py" || ! -f "${IDF_PATH}/tools/idf_tools.py" ]]
+        if [ ! -f "${IDF_PATH}/tools/idf.py" ] || [ ! -f "${IDF_PATH}/tools/idf_tools.py" ]
         then
             echo "IDF_PATH is set to '${IDF_PATH}', but it doesn't look like an ESP-IDF directory."
             echo "If you have set IDF_PATH manually, check if the path is correct."
@@ -76,12 +83,12 @@ function idf_export_main() {
     # Call idf_tools.py to export tool paths
     export IDF_TOOLS_EXPORT_CMD=${IDF_PATH}/export.sh
     export IDF_TOOLS_INSTALL_CMD=${IDF_PATH}/install.sh
-    idf_exports=$(${IDF_PATH}/tools/idf_tools.py export) || return 1
+    idf_exports=$("${IDF_PATH}/tools/idf_tools.py" export) || return 1
     eval "${idf_exports}"
 
     echo "Using Python interpreter in $(which python)"
     echo "Checking if Python packages are up to date..."
-    python ${IDF_PATH}/tools/check_python_dependencies.py || return 1
+    python "${IDF_PATH}/tools/check_python_dependencies.py" || return 1
 
 
     # Allow calling some IDF python tools without specifying the full path
@@ -92,9 +99,10 @@ function idf_export_main() {
     IDF_ADD_PATHS_EXTRAS="${IDF_ADD_PATHS_EXTRAS}:${IDF_PATH}/components/app_update"
     export PATH="${IDF_ADD_PATHS_EXTRAS}:${PATH}"
 
-    if [[ -n "$BASH" ]]
+    if [ -n "$BASH" ]
     then
         path_prefix=${PATH%%${old_path}}
+        # shellcheck disable=SC2169,SC2039  # unreachable with 'dash'
         paths="${path_prefix//:/ }"
         if [ -n "${paths}" ]; then
             echo "Added the following directories to PATH:"