MSI: Add support for INSTALLER_UNATTENDED (#1276)

* Add support for INSTALLER_UNATTENDED

* Add news

* Bump briefcase dependency

* Bump briefcase in all other files

* Enable test for INSTALLER_UNATTENDED (MSI)

Author: lrandersson

CONSTRUCT.md

@@ -390,8 +390,9 @@ Path to a post-install script. Some notes:
   `%INSTALLER_PLAT%` environment variables. `%INSTALLER_TYPE%` is set to `EXE`.
   `%INSTALLER_UNATTENDED%` will be `"1"` in silent mode (`/S`), `"0"` otherwise.
 - For Windows `.msi` installers, the script must be a `.bat` file.
-  The same variables as `.exe` installers are available, except
-  `%INSTALLER_TYPE%` is set to `MSI` and `%INSTALLER_UNATTENDED%` is not available.
+  The same variables as `.exe` installers are available.
+  `%INSTALLER_TYPE%` is set to `MSI`.
+  `%INSTALLER_UNATTENDED%` will be `"1"` in silent mode (`msiexec /qn`), `"0"` otherwise.
 
 If necessary, you can activate the installed `base` environment like this:
 

constructor/_schema.py

@@ -561,8 +561,9 @@ class ConstructorConfiguration(BaseModel):
       `%INSTALLER_PLAT%` environment variables. `%INSTALLER_TYPE%` is set to `EXE`.
       `%INSTALLER_UNATTENDED%` will be `"1"` in silent mode (`/S`), `"0"` otherwise.
     - For Windows `.msi` installers, the script must be a `.bat` file.
-      The same variables as `.exe` installers are available, except
-      `%INSTALLER_TYPE%` is set to `MSI` and `%INSTALLER_UNATTENDED%` is not available.
+      The same variables as `.exe` installers are available.
+      `%INSTALLER_TYPE%` is set to `MSI`.
+      `%INSTALLER_UNATTENDED%` will be `"1"` in silent mode (`msiexec /qn`), `"0"` otherwise.
 
     If necessary, you can activate the installed `base` environment like this:
 

constructor/briefcase/pre_uninstall.bat

@@ -44,9 +44,6 @@ set "INSTALLER_NAME={{ installer_name }}"
 set "INSTALLER_VER={{ installer_version }}"
 set "INSTALLER_PLAT={{ installer_platform }}"
 set "INSTALLER_TYPE=MSI"
-rem INSTALLER_UNATTENDED is not available for MSI installers.
-rem Detecting silent mode requires UILevel from WiX, which would need
-rem changes to the briefcase-windows-app-template to pass to this script.
 
 rem Determine install mode from .nonadmin marker file written at install time
 if exist "%BASE_PATH%\.nonadmin" (

constructor/briefcase/run_installation.bat

@@ -61,9 +61,6 @@ set "INSTALLER_NAME={{ installer_name }}"
 set "INSTALLER_VER={{ installer_version }}"
 set "INSTALLER_PLAT={{ installer_platform }}"
 set "INSTALLER_TYPE=MSI"
-rem INSTALLER_UNATTENDED is not available for MSI installers.
-rem Detecting silent mode requires UILevel from WiX, which would need
-rem changes to the briefcase-windows-app-template to pass to this script.
 
 {%- if add_debug %}
 >> "%LOG%" echo ==== run_installation start ====

constructor/data/construct.schema.json

@@ -1053,7 +1053,7 @@
         }
       ],
       "default": null,
-      "description": "Path to a post-install script. Some notes:\n- For Unix `.sh` installers, the shebang line is respected if present;  otherwise, the script is run by the POSIX shell `sh`. Note that the use  of a shebang can reduce the portability of the installer. The  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.\n- 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}` will be `\"1\"` for command line installs, `\"0\"` otherwise.\n- 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.\n- For Windows `.msi` installers, the script must be a `.bat` file.  The same variables as `.exe` installers are available, except  `%INSTALLER_TYPE%` is set to `MSI` and `%INSTALLER_UNATTENDED%` is not available.\nIf necessary, you can activate the installed `base` environment like this:\n- Unix: `. \"$PREFIX/etc/profile.d/conda.sh\" && conda activate \"$PREFIX\"`\n- Windows: `call \"%PREFIX%\\Scripts\\activate.bat\"`",
+      "description": "Path to a post-install script. Some notes:\n- For Unix `.sh` installers, the shebang line is respected if present;  otherwise, the script is run by the POSIX shell `sh`. Note that the use  of a shebang can reduce the portability of the installer. The  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.\n- 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}` will be `\"1\"` for command line installs, `\"0\"` otherwise.\n- 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.\n- For Windows `.msi` installers, the script must be a `.bat` file.  The same variables as `.exe` installers are available.  `%INSTALLER_TYPE%` is set to `MSI`.  `%INSTALLER_UNATTENDED%` will be `\"1\"` in silent mode (`msiexec /qn`), `\"0\"` otherwise.\nIf necessary, you can activate the installed `base` environment like this:\n- Unix: `. \"$PREFIX/etc/profile.d/conda.sh\" && conda activate \"$PREFIX\"`\n- Windows: `call \"%PREFIX%\\Scripts\\activate.bat\"`",
       "title": "Post Install"
     },
     "post_install_desc": {

dev/extra-requirements-windows.txt

@@ -1,3 +1,3 @@
-conda-forge::briefcase>=0.3.26
+conda-forge::briefcase>=0.4.3
 conda-forge::nsis>=3.08=*_log_*
 conda-forge::tomli-w>=1.2.0

docs/source/construct-yaml.md

@@ -390,8 +390,9 @@ Path to a post-install script. Some notes:
   `%INSTALLER_PLAT%` environment variables. `%INSTALLER_TYPE%` is set to `EXE`.
   `%INSTALLER_UNATTENDED%` will be `"1"` in silent mode (`/S`), `"0"` otherwise.
 - For Windows `.msi` installers, the script must be a `.bat` file.
-  The same variables as `.exe` installers are available, except
-  `%INSTALLER_TYPE%` is set to `MSI` and `%INSTALLER_UNATTENDED%` is not available.
+  The same variables as `.exe` installers are available.
+  `%INSTALLER_TYPE%` is set to `MSI`.
+  `%INSTALLER_UNATTENDED%` will be `"1"` in silent mode (`msiexec /qn`), `"0"` otherwise.
 
 If necessary, you can activate the installed `base` environment like this:
 

examples/scripts/post_install.bat

@@ -3,8 +3,7 @@ if not "%INSTALLER_NAME%" == "Scripts" exit 1
 if not "%INSTALLER_VER%" == "1.0.0" exit 1
 if not "%INSTALLER_PLAT%" == "win-64" exit 1
 if not "%INSTALLER_TYPE%" == "EXE" if not "%INSTALLER_TYPE%" == "MSI" exit 1
-rem INSTALLER_UNATTENDED is not yet set by MSI installers (see conda/constructor#1276).
-if "%INSTALLER_TYPE%" == "EXE" if not "%INSTALLER_UNATTENDED%" == "1" 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

examples/scripts/pre_install.bat

@@ -2,8 +2,7 @@ if not "%INSTALLER_NAME%" == "Scripts" exit 1
 if not "%INSTALLER_VER%" == "1.0.0" exit 1
 if not "%INSTALLER_PLAT%" == "win-64" exit 1
 if not "%INSTALLER_TYPE%" == "EXE" if not "%INSTALLER_TYPE%" == "MSI" exit 1
-rem INSTALLER_UNATTENDED is not yet set by MSI installers (see conda/constructor#1276).
-if "%INSTALLER_TYPE%" == "EXE" if not "%INSTALLER_UNATTENDED%" == "1" 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

news/1276-msi-installer-unattended

@@ -0,0 +1,19 @@
+### Enhancements
+
+* <news item>
+
+### Bug fixes
+
+* <news item>
+
+### Deprecations
+
+* <news item>
+
+### Docs
+
+* Updated docs to clarify the use of `INSTALLER_UNATTENDED` within the context of MSI installers, and updated minimum `briefcase` version to `0.4.3`. (#1278)
+
+### Other
+
+* <news item>