MSI: Update uninstall scripts

.github/workflows/main.yml

@@ -153,7 +153,7 @@ jobs:
           AZURE_SIGNTOOL_KEY_VAULT_URL: ${{ secrets.AZURE_SIGNTOOL_KEY_VAULT_URL }}
           CONSTRUCTOR_EXAMPLES_KEEP_ARTIFACTS: "${{ runner.temp }}/examples_artifacts"
           CONSTRUCTOR_SIGNTOOL_PATH: "C:/Program Files (x86)/Windows Kits/10/bin/10.0.26100.0/x86/signtool.exe"
-          CONSTRUCTOR_VERBOSE: 1
+          CONSTRUCTOR_VERBOSE: 0
         run: |
           rm -rf coverage.json
           pytest -vv --cov=constructor --cov-branch tests/test_examples.py

constructor/briefcase.py

@@ -4,6 +4,7 @@
 
 import functools
 import logging
+import os
 import re
 import shutil
 import sys
@@ -249,6 +250,10 @@ class Payload:
     archive_name: str = "payload.tar.gz"
     conda_exe_name: str = "_conda.exe"
 
+    # There might be other ways we want to enable `add_debug_logging`, but it has proven
+    # very useful at least for the CI environment.
+    add_debug_logging: bool = bool(os.environ.get("CI")) and os.environ.get("CI") != "0"
+
     @functools.cached_property
     def root(self) -> Path:
         """Create root upon first access and cache it."""
@@ -332,6 +337,8 @@ def render_templates(self) -> list[str: TemplateFile]:
         context: dict[str, str] = {
             "archive_name": self.archive_name,
             "conda_exe_name": self.conda_exe_name,
+            "add_debug": self.add_debug_logging,
+            "register_envs": str(self.info.get("register_envs", True)).lower(),
         }
 
         # Render the templates now using jinja and the defined context

constructor/briefcase/pre_uninstall.bat

@@ -1,9 +1,53 @@
-set "INSTDIR=%cd%"
+@echo {{ 'on' if add_debug else 'off' }}
+setlocal
+
+{%- macro error_block(message, code) -%}
+echo [ERROR] {{ message }}
+{%- if add_debug %}
+>> "%LOG%" echo [ERROR] {{ message }}
+{%- endif %}
+exit /b {{ code }}
+{%- endmacro -%}
+
+rem Assign INSTDIR and normalize the path
+set "INSTDIR=%~dp0.."
+for %%I in ("%INSTDIR%") do set "INSTDIR=%%~fI"
+
 set "BASE_PATH=%INSTDIR%\base"
 set "PREFIX=%BASE_PATH%"
 set "CONDA_EXE=%INSTDIR%\{{ conda_exe_name }}"
 set "PAYLOAD_TAR=%INSTDIR%\{{ archive_name }}"
 
+{%- if add_debug %}
+rem Get the name of the install directory
+for %%I in ("%INSTDIR%") do set "APPNAME=%%~nxI"
+set "LOG=%TEMP%\%APPNAME%-preuninstall.log"
+
+echo ==== pre_uninstall start ==== >> "%LOG%"
+echo SCRIPT=%~f0 >> "%LOG%"
+echo CWD=%CD% >> "%LOG%"
+echo INSTDIR=%INSTDIR% >> "%LOG%"
+echo BASE_PATH=%BASE_PATH% >> "%LOG%"
+echo CONDA_EXE=%CONDA_EXE% >> "%LOG%"
+echo PAYLOAD_TAR=%PAYLOAD_TAR% >> "%LOG%"
+"%CONDA_EXE%" --version >> "%LOG%" 2>&1
+{%- endif %}
+
+{%- set redir = ' >> "%LOG%" 2>&1' if add_debug else '' %}
+{%- set dump_and_exit = 'type "%LOG%" & exit /b %errorlevel%' if add_debug else 'exit /b %errorlevel%' %}
+
+rem Consistency checks
+if not exist "%CONDA_EXE%" (
+  {{ error_block('CONDA_EXE not found: "%CONDA_EXE%"', 10) }}
+)
 rem Recreate an empty payload tar. This file was deleted during installation but the
 rem MSI installer expects it to exist.
 type nul > "%PAYLOAD_TAR%"
+if errorlevel 1 (
+  {{ error_block('Failed to create "%PAYLOAD_TAR%"', '%errorlevel%') }}
+)
+
+"%CONDA_EXE%" constructor uninstall --prefix "%BASE_PATH%"{{ redir }}
+if errorlevel 1 ( {{ dump_and_exit }} )
+
+exit /b 0

constructor/briefcase/run_installation.bat

@@ -1,22 +1,75 @@
-set "INSTDIR=%cd%"
+@echo {{ 'on' if add_debug else 'off' }}
+setlocal
+
+{%- macro error_block(message, code) -%}
+echo [ERROR] {{ message }}
+{%- if add_debug %}
+>> "%LOG%" echo [ERROR] {{ message }}
+{%- endif %}
+exit /b {{ code }}
+{%- endmacro -%}
+
+rem Assign INSTDIR and normalize the path
+set "INSTDIR=%~dp0.."
+for %%I in ("%INSTDIR%") do set "INSTDIR=%%~fI"
+
 set "BASE_PATH=%INSTDIR%\base"
 set "PREFIX=%BASE_PATH%"
 set "CONDA_EXE=%INSTDIR%\{{ conda_exe_name }}"
 set "PAYLOAD_TAR=%INSTDIR%\{{ archive_name }}"
 
-echo "Unpacking payload..."
-"%CONDA_EXE%" constructor extract --prefix "%INSTDIR%" --tar-from-stdin < "%PAYLOAD_TAR%"
-"%CONDA_EXE%" constructor --prefix "%BASE_PATH%" --extract-conda-pkgs
-
+set CONDA_EXTRA_SAFETY_CHECKS=no
 set CONDA_PROTECT_FROZEN_ENVS=0
-set "CONDA_ROOT_PREFIX=%BASE_PATH%"
+set CONDA_REGISTER_ENVS={{ register_envs }}
 set CONDA_SAFETY_CHECKS=disabled
-set CONDA_EXTRA_SAFETY_CHECKS=no
+set "CONDA_ROOT_PREFIX=%BASE_PATH%"
 set "CONDA_PKGS_DIRS=%BASE_PATH%\pkgs"
 
-"%CONDA_EXE%" install --offline --file "%BASE_PATH%\conda-meta\initial-state.explicit.txt" -yp "%BASE_PATH%"
+{%- if add_debug %}
+rem Get the name of the install directory
+for %%I in ("%INSTDIR%") do set "APPNAME=%%~nxI"
+set "LOG=%TEMP%\%APPNAME%-postinstall.log"
+
+echo ==== run_installation start ==== >> "%LOG%"
+echo SCRIPT=%~f0 >> "%LOG%"
+echo CWD=%CD% >> "%LOG%"
+echo INSTDIR=%INSTDIR% >> "%LOG%"
+echo BASE_PATH=%BASE_PATH% >> "%LOG%"
+echo CONDA_EXE=%CONDA_EXE% >> "%LOG%"
+echo PAYLOAD_TAR=%PAYLOAD_TAR% >> "%LOG%"
+{%- endif %}
+
+{%- set redir = ' >> "%LOG%" 2>&1' if add_debug else '' %}
+{%- set dump_and_exit = 'type "%LOG%" & exit /b %errorlevel%' if add_debug else 'exit /b %errorlevel%' %}
+
+rem Consistency checks
+if not exist "%CONDA_EXE%" (
+  {{ error_block('CONDA_EXE not found: "%CONDA_EXE%"', 10) }}
+)
+if not exist "%PAYLOAD_TAR%" (
+  {{ error_block('PAYLOAD_TAR not found: "%PAYLOAD_TAR%"', 11) }}
+)
+
+echo Unpacking payload...
+rem "%CONDA_EXE%" constructor extract --prefix "%INSTDIR%" --tar-from-stdin < "%PAYLOAD_TAR%"{{ redir }}
+"%CONDA_EXE%" constructor --prefix "%INSTDIR%" --extract-tarball < "%PAYLOAD_TAR%"{{ redir }}
+if errorlevel 1 ( {{ dump_and_exit }} )
+
+rem "%CONDA_EXE%" constructor --prefix "%BASE_PATH%" --extract-conda-pkgs{{ redir }}
+"%CONDA_EXE%" constructor --prefix "%BASE_PATH%" --extract-conda-pkgs{{ redir }}
+if errorlevel 1 ( {{ dump_and_exit }} )
+
+if not exist "%BASE_PATH%" (
+  {{ error_block('"%BASE_PATH%" not found!', 12) }}
+)
+
+"%CONDA_EXE%" install --offline --file "%BASE_PATH%\conda-meta\initial-state.explicit.txt" -yp "%BASE_PATH%"{{ redir }}
+if errorlevel 1 ( {{ dump_and_exit }} )
 
 rem Delete the payload to save disk space.
 rem A truncated placeholder of 0 bytes is recreated during uninstall
 rem because MSI expects the file to be there to clean the registry.
 del "%PAYLOAD_TAR%"
+if errorlevel 1 ( {{ dump_and_exit }} )
+
+exit /b 0

examples/register_envs/construct.yaml

@@ -3,7 +3,7 @@
 
 name: RegisterEnvs
 version: 1.0.0
-installer_type: {{ "exe" if os.name == "nt" else "all" }}
+installer_type: all
 channels:
   - https://repo.anaconda.com/pkgs/main/
 specs:

tests/test_briefcase.py

@@ -238,10 +238,12 @@ def test_payload_conda_exe():
 
 
 @pytest.mark.skipif(sys.platform != "win32", reason="Windows only")
-def test_payload_templates_are_rendered():
+@pytest.mark.parametrize("debug_logging", [True, False])
+def test_payload_templates_are_rendered(debug_logging):
     """Test that templates are rendered when the payload is prepared."""
     info = mock_info.copy()
     payload = Payload(info)
+    payload.add_debug_logging = debug_logging
     rendered_templates = payload.render_templates()
     assert len(rendered_templates) == 2  # There should be at least two files
     for f in rendered_templates:
@@ -250,3 +252,26 @@ def test_payload_templates_are_rendered():
         assert "{{" not in text and "}}" not in text
         assert "{%" not in text and "%}" not in text
         assert "{#" not in text and "#}" not in text
+
+
+@pytest.mark.skipif(sys.platform != "win32", reason="Windows only")
+@pytest.mark.parametrize("debug_logging", [True, False])
+def test_templates_debug_mode(debug_logging):
+    """Test that debug logging affects template generation."""
+    info = mock_info.copy()
+    payload = Payload(info)
+    payload.add_debug_logging = debug_logging
+    rendered_templates = payload.render_templates()
+    assert len(rendered_templates) == 2  # There should be at least two files
+
+    for f in rendered_templates:
+        assert f.dst.is_file()
+
+        with open(f.dst) as open_file:
+            lines = open_file.readlines()
+
+        # Check the first line.
+        expected = "@echo on\n" if debug_logging else "@echo off\n"
+        assert lines[0] == expected
+        # If debug_logging is True, we expect to find %LOG%, otherwise not.
+        assert debug_logging == any("%LOG%" in line for line in lines)