Set INSTALLER_UNATTENDED for user scripts (#885)

Co-authored-by: Marco Esters <[email protected]>
conda · Oct 30, 2024 · 447e0f2 · 447e0f2
1 parent 8c9dded
commit 447e0f2
Show file tree

Hide file tree

Showing 11 changed files with 54 additions and 0 deletions.
diff --git a/CONSTRUCT.md b/CONSTRUCT.md
@@ -476,13 +476,16 @@ Path to a post-install script. Some notes:
   installation path is available as `${PREFIX}`. Installer metadata is
   available in the `${INSTALLER_NAME}`, `${INSTALLER_VER}`, `${INSTALLER_PLAT}`
   environment variables. `${INSTALLER_TYPE}` is set to `SH`.
+  `${INSTALLER_UNATTENDED}` will be `"1"` in batch mode (`-b`), `"0"` otherwise.
 - For PKG installers, the shebang line is respected if present;
   otherwise, `bash` is used. The same variables mentioned for `sh`
   installers are available here. `${INSTALLER_TYPE}` is set to `PKG`.
+  `${INSTALLER_UNATTENDED}` is not supported and always set to `"?"`.
 - For Windows `.exe` installers, the script must be a `.bat` file.
   Installation path is available as `%PREFIX%`. Metadata about
   the installer can be found in the `%INSTALLER_NAME%`, `%INSTALLER_VER%`,
   `%INSTALLER_PLAT%` environment variables. `%INSTALLER_TYPE%` is set to `EXE`.
+  `%INSTALLER_UNATTENDED%` will be `"1"` in silent mode (`/S`), `"0"` otherwise.
 
 If necessary, you can activate the installed `base` environment like this:
 

diff --git a/constructor/construct.py b/constructor/construct.py
@@ -350,13 +350,16 @@
   installation path is available as `${PREFIX}`. Installer metadata is
   available in the `${INSTALLER_NAME}`, `${INSTALLER_VER}`, `${INSTALLER_PLAT}`
   environment variables. `${INSTALLER_TYPE}` is set to `SH`.
+  `${INSTALLER_UNATTENDED}` will be `"1"` in batch mode (`-b`), `"0"` otherwise.
 - For PKG installers, the shebang line is respected if present;
   otherwise, `bash` is used. The same variables mentioned for `sh`
   installers are available here. `${INSTALLER_TYPE}` is set to `PKG`.
+  `${INSTALLER_UNATTENDED}` is not supported and always set to `"?"`.
 - For Windows `.exe` installers, the script must be a `.bat` file.
   Installation path is available as `%PREFIX%`. Metadata about
   the installer can be found in the `%INSTALLER_NAME%`, `%INSTALLER_VER%`,
   `%INSTALLER_PLAT%` environment variables. `%INSTALLER_TYPE%` is set to `EXE`.
+  `%INSTALLER_UNATTENDED%` will be `"1"` in silent mode (`/S`), `"0"` otherwise.
 
 If necessary, you can activate the installed `base` environment like this:
 

diff --git a/constructor/header.sh b/constructor/header.sh
@@ -179,6 +179,9 @@ while getopts "bifhkp:sut" x; do
     esac
 done
 
+# For pre- and post-install scripts
+export INSTALLER_UNATTENDED="$BATCH"
+
 # For testing, keep the package cache around longer
 CLEAR_AFTER_TEST=0
 if [ "$TEST" = "1" ] && [ "$KEEP_PKGS" = "0" ]; then

diff --git a/constructor/nsis/main.nsi.tmpl b/constructor/nsis/main.nsi.tmpl
@@ -1250,6 +1250,11 @@ Section "Install"
     System::Call 'kernel32::SetEnvironmentVariable(t,t)i("INSTALLER_VER", "${VERSION}").r0'
     System::Call 'kernel32::SetEnvironmentVariable(t,t)i("INSTALLER_PLAT", "${PLATFORM}").r0'
     System::Call 'kernel32::SetEnvironmentVariable(t,t)i("INSTALLER_TYPE", "EXE").r0'
+    ${If} ${Silent}
+        System::Call 'kernel32::SetEnvironmentVariable(t,t)i("INSTALLER_UNATTENDED", "1").r0'
+    ${Else}
+        System::Call 'kernel32::SetEnvironmentVariable(t,t)i("INSTALLER_UNATTENDED", "0").r0'
+    ${EndIf}
 
     ${If} '@VIRTUAL_SPECS@' != ''
     # We need to specify CONDA_SOLVER=classic for conda-standalone
@@ -1452,6 +1457,11 @@ Section "Uninstall"
     System::Call 'kernel32::SetEnvironmentVariable(t,t)i("INSTALLER_VER", "$0").r0'
     System::Call 'kernel32::SetEnvironmentVariable(t,t)i("INSTALLER_PLAT", "${PLATFORM}").r0'
     System::Call 'kernel32::SetEnvironmentVariable(t,t)i("INSTALLER_TYPE", "EXE").r0'
+    ${If} ${Silent}
+        System::Call 'kernel32::SetEnvironmentVariable(t,t)i("INSTALLER_UNATTENDED", "1").r0'
+    ${Else}
+        System::Call 'kernel32::SetEnvironmentVariable(t,t)i("INSTALLER_UNATTENDED", "0").r0'
+    ${EndIf}
 
     !insertmacro AbortRetryNSExecWaitLibNsisCmd "pre_uninstall"
     !insertmacro AbortRetryNSExecWaitLibNsisCmd "rmpath"

diff --git a/constructor/osx/run_user_script.sh b/constructor/osx/run_user_script.sh
@@ -30,6 +30,7 @@ export INSTALLER_NAME="__NAME__"
 export INSTALLER_VER="__VERSION__"
 export INSTALLER_PLAT="__PLAT__"
 export INSTALLER_TYPE="PKG"
+export INSTALLER_UNATTENDED="?"
 export PRE_OR_POST="__PRE_OR_POST__"
 _SCRIPT_ENV_VARIABLES_=''  # Templated extra environment variable(s)
 

diff --git a/docs/source/construct-yaml.md b/docs/source/construct-yaml.md
@@ -476,13 +476,16 @@ Path to a post-install script. Some notes:
   installation path is available as `${PREFIX}`. Installer metadata is
   available in the `${INSTALLER_NAME}`, `${INSTALLER_VER}`, `${INSTALLER_PLAT}`
   environment variables. `${INSTALLER_TYPE}` is set to `SH`.
+  `${INSTALLER_UNATTENDED}` will be `"1"` in batch mode (`-b`), `"0"` otherwise.
 - For PKG installers, the shebang line is respected if present;
   otherwise, `bash` is used. The same variables mentioned for `sh`
   installers are available here. `${INSTALLER_TYPE}` is set to `PKG`.
+  `${INSTALLER_UNATTENDED}` is not supported and always set to `"?"`.
 - For Windows `.exe` installers, the script must be a `.bat` file.
   Installation path is available as `%PREFIX%`. Metadata about
   the installer can be found in the `%INSTALLER_NAME%`, `%INSTALLER_VER%`,
   `%INSTALLER_PLAT%` environment variables. `%INSTALLER_TYPE%` is set to `EXE`.
+  `%INSTALLER_UNATTENDED%` will be `"1"` in silent mode (`/S`), `"0"` otherwise.
 
 If necessary, you can activate the installed `base` environment like this:
 

diff --git a/examples/scripts/post_install.bat b/examples/scripts/post_install.bat
@@ -3,6 +3,7 @@ if not "%INSTALLER_NAME%" == "Scripts" exit 1
 if not "%INSTALLER_VER%" == "X" exit 1
 if not "%INSTALLER_PLAT%" == "win-64" exit 1
 if not "%INSTALLER_TYPE%" == "EXE" exit 1
+if not "%INSTALLER_UNATTENDED%" == "1" exit 1
 if "%PREFIX%" == "" exit 1
 if not "%CUSTOM_VARIABLE_1%" == "FIR$T-CUSTOM_STRING WITH SPACES AND @*! CHARACTERS" exit 1
 if not "%CUSTOM_VARIABLE_2%" == "$ECOND-CUSTOM_STRING WITH SPACES AND @*! CHARACTERS" exit 1

diff --git a/examples/scripts/post_install.sh b/examples/scripts/post_install.sh
@@ -9,6 +9,7 @@ echo "INSTALLER_NAME=${INSTALLER_NAME}"
 echo "INSTALLER_VER=${INSTALLER_VER}"
 echo "INSTALLER_PLAT=${INSTALLER_PLAT}"
 echo "INSTALLER_TYPE=${INSTALLER_TYPE}"
+echo "INSTALLER_UNATTENDED=${INSTALLER_UNATTENDED}"
 echo "CUSTOM_VARIABLE_1=${CUSTOM_VARIABLE_1}"
 echo "CUSTOM_VARIABLE_2=${CUSTOM_VARIABLE_2}"
 echo "PREFIX=${PREFIX}"
@@ -20,6 +21,10 @@ test "${CUSTOM_VARIABLE_1}" = 'FIR$T-CUSTOM_'\''STRING'\'' WITH SPACES AND @*! "
 # shellcheck disable=SC2016 # String interpolation disabling is deliberate
 test "${CUSTOM_VARIABLE_2}" = '$ECOND-CUSTOM_'\''STRING'\'' WITH SPACES AND @*! "CHARACTERS"'
 
+if [[ "${INSTALLER_TYPE}" == "SH" ]]; then
+    test "${INSTALLER_UNATTENDED}" = "1"
+fi
+
 if [[ $(uname -s) == Linux ]]; then
     if [[ ${INSTALLER_PLAT} != linux-* ]]; then
         exit 1

diff --git a/examples/scripts/pre_install.bat b/examples/scripts/pre_install.bat
@@ -2,6 +2,7 @@ if not "%INSTALLER_NAME%" == "Scripts" exit 1
 if not "%INSTALLER_VER%" == "X" exit 1
 if not "%INSTALLER_PLAT%" == "win-64" exit 1
 if not "%INSTALLER_TYPE%" == "EXE" exit 1
+if not "%INSTALLER_UNATTENDED%" == "1" exit 1
 if "%PREFIX%" == "" exit 1
 if not "%CUSTOM_VARIABLE_1%" == "FIR$T-CUSTOM_STRING WITH SPACES AND @*! CHARACTERS" exit 1
 if not "%CUSTOM_VARIABLE_2%" == "$ECOND-CUSTOM_STRING WITH SPACES AND @*! CHARACTERS" exit 1

diff --git a/examples/scripts/pre_install.sh b/examples/scripts/pre_install.sh
@@ -6,6 +6,7 @@ echo "INSTALLER_NAME=${INSTALLER_NAME}"
 echo "INSTALLER_VER=${INSTALLER_VER}"
 echo "INSTALLER_PLAT=${INSTALLER_PLAT}"
 echo "INSTALLER_TYPE=${INSTALLER_TYPE}"
+echo "INSTALLER_UNATTENDED=${INSTALLER_UNATTENDED}"
 echo "CUSTOM_VARIABLE_1=${CUSTOM_VARIABLE_1}"
 echo "CUSTOM_VARIABLE_2=${CUSTOM_VARIABLE_2}"
 echo "PREFIX=${PREFIX}"
@@ -17,6 +18,10 @@ test "${CUSTOM_VARIABLE_1}" = 'FIR$T-CUSTOM_'\''STRING'\'' WITH SPACES AND @*! "
 # shellcheck disable=SC2016 # String interpolation disabling is deliberate
 test "${CUSTOM_VARIABLE_2}" = '$ECOND-CUSTOM_'\''STRING'\'' WITH SPACES AND @*! "CHARACTERS"'
 
+if [[ "${INSTALLER_TYPE}" == "SH" ]]; then
+    test "${INSTALLER_UNATTENDED}" = "1"
+fi
+
 if [[ $(uname -s) == Linux ]]; then
     if [[ ${INSTALLER_PLAT} != linux-* ]]; then
         exit 1

diff --git a/news/885-installer-unattended b/news/885-installer-unattended
@@ -0,0 +1,19 @@
+### Enhancements
+
+* Export `INSTALLER_UNATTENDED` environment variable so pre- and post-install scripts can detect if the installer is running in batch/silent mode or not. (#882 via #885)
+
+### Bug fixes
+
+* <news item>
+
+### Deprecations
+
+* <news item>
+
+### Docs
+
+* <news item>
+
+### Other
+
+* <news item>