MSI: Integration tests

.github/workflows/main.yml

@@ -134,6 +134,7 @@ jobs:
         run: conda list
       - name: conda config
         run: conda config --show-sources
+
       - name: Run unit tests
         run: |
           pytest -vv --cov=constructor --cov-branch tests/ -m "not examples"
@@ -152,6 +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
         run: |
           rm -rf coverage.json
           pytest -vv --cov=constructor --cov-branch tests/test_examples.py

constructor/briefcase.py

@@ -5,12 +5,17 @@
 import logging
 import re
 import shutil
+import sys
 import sysconfig
 import tempfile
 from pathlib import Path
 from subprocess import run
 
-import tomli_w
+IS_WINDOWS = sys.platform == "win32"
+if IS_WINDOWS:
+    import tomli_w
+else:
+    tomli_w = None  # This file is only intended for Windows use
 
 from . import preconda
 from .utils import DEFAULT_REVERSE_DOMAIN_ID, copy_conda_exe, filename_dist
@@ -100,6 +105,16 @@ def get_bundle_app_name(info, name):
     return bundle, app_name
 
 
+def get_license(info):
+    """Retrieve the specified license as a dict or return a placeholder if not set."""
+
+    if "license_file" in info:
+        return {"file": info["license_file"]}
+
+    placeholder_license = Path(__file__).parent / "nsis" / "placeholder_license.txt"
+    return {"file": str(placeholder_license)}  # convert to str for TOML serialization
+
+
 # Create a Briefcase configuration file. Using a full TOML writer rather than a Jinja
 # template allows us to avoid escaping strings everywhere.
 def write_pyproject_toml(tmp_dir, info):
@@ -110,7 +125,7 @@ def write_pyproject_toml(tmp_dir, info):
         "project_name": name,
         "bundle": bundle,
         "version": version,
-        "license": ({"file": info["license_file"]} if "license_file" in info else {"text": ""}),
+        "license": get_license(info),
         "app": {
             app_name: {
                 "formal_name": f"{info['name']} {info['version']}",
@@ -130,6 +145,9 @@ def write_pyproject_toml(tmp_dir, info):
 
 
 def create(info, verbose=False):
+    if not IS_WINDOWS:
+        raise Exception(f"Invalid platform '{sys.platform}'. Only Windows is supported.")
+
     tmp_dir = Path(tempfile.mkdtemp())
     write_pyproject_toml(tmp_dir, info)
 
@@ -150,7 +168,6 @@ def create(info, verbose=False):
         raise FileNotFoundError(
             f"Dependency 'briefcase' does not seem to be installed.\nTried: {briefcase}"
         )
-
     logger.info("Building installer")
     run(
         [briefcase, "package"] + (["-v"] if verbose else []),

constructor/briefcase/run_installation.bat

@@ -1,10 +1,10 @@
-set PREFIX=%cd%
-_conda constructor --prefix %PREFIX% --extract-conda-pkgs
+set "PREFIX=%cd%"
+_conda constructor --prefix "%PREFIX%" --extract-conda-pkgs
 
 set CONDA_PROTECT_FROZEN_ENVS=0
 set CONDA_ROOT_PREFIX=%PREFIX%
 set CONDA_SAFETY_CHECKS=disabled
 set CONDA_EXTRA_SAFETY_CHECKS=no
 set CONDA_PKGS_DIRS=%PREFIX%\pkgs
 
-_conda install --offline --file %PREFIX%\conda-meta\initial-state.explicit.txt -yp %PREFIX%
+_conda install --offline --file "%PREFIX%\conda-meta\initial-state.explicit.txt" -yp "%PREFIX%"

examples/azure_signtool/construct.yaml

@@ -2,7 +2,7 @@
 "$schema": "../../constructor/data/construct.schema.json"
 
 name: Signed_AzureSignTool
-version: X
+version: 1.0.0
 installer_type: exe
 channels:
   - https://repo.anaconda.com/pkgs/main/

examples/custom_nsis_template/construct.yaml

@@ -2,7 +2,7 @@
 "$schema": "../../constructor/data/construct.schema.json"
 
 name: custom
-version: X
+version: 1.0.0
 ignore_duplicate_files: True
 installer_filename: {{ name }}-installer.exe
 installer_type: exe

examples/customize_controls/construct.yaml

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

examples/customized_welcome_conclusion/construct.yaml

@@ -2,7 +2,7 @@
 "$schema": "../../constructor/data/construct.schema.json"
 
 name: CustomizedWelcomeConclusion
-version: X
+version: 1.0.0
 installer_type: all
 channels:
   - https://repo.anaconda.com/pkgs/main/

examples/exe_extra_pages/construct.yaml

@@ -7,7 +7,7 @@
 {% set name = "extraPageSingle" %}
 {% endif %}
 name: {{ name }}
-version: X
+version: 1.0.0
 installer_type: all
 channels:
   - https://repo.anaconda.com/pkgs/main/

examples/extra_envs/construct.yaml

@@ -2,8 +2,8 @@
 "$schema": "../../constructor/data/construct.schema.json"
 
 name: ExtraEnvs
-version: X
-installer_type: all
+version: 1.0.0
+installer_type: {{ "exe" if os.name == "nt" else "all" }}
 channels:
   - https://conda.anaconda.org/conda-forge
 specs:

examples/extra_files/construct.yaml

@@ -2,7 +2,7 @@
 "$schema": "../../constructor/data/construct.schema.json"
 
 name: ExtraFiles
-version: X
+version: 1.0.0
 installer_type: all
 license_file: TEST_LICENSE.txt
 check_path_spaces: False

examples/from_env_txt/construct.yaml

@@ -2,7 +2,7 @@
 "$schema": "../../constructor/data/construct.schema.json"
 
 name: EnvironmentTXT
-version: X
+version: 1.0.0
 installer_type: all
 environment_file: env.txt
 initialize_by_default: false

examples/from_env_yaml/construct.yaml

@@ -2,8 +2,8 @@
 "$schema": "../../constructor/data/construct.schema.json"
 
 name: EnvironmentYAML
-version: X
-installer_type: all
+version: 1.0.0
+installer_type: {{ "exe" if os.name == "nt" else "all" }}
 environment_file: env.yaml
 initialize_by_default: false
 register_python: False

examples/from_existing_env/construct.yaml

@@ -1,7 +1,7 @@
 # yaml-language-server: $schema=../../constructor/data/construct.schema.json
 "$schema": "../../constructor/data/construct.schema.json"
 name: Existing
-version: X
+version: 1.0.0
 installer_type: all
 environment: {{ os.environ.get("CONSTRUCTOR_TEST_EXISTING_ENV", os.environ["CONDA_PREFIX"]) }}
 channels:

examples/from_explicit/construct.yaml

@@ -2,7 +2,7 @@
 "$schema": "../../constructor/data/construct.schema.json"
 
 name: Explicit
-version: X
+version: 1.0.0
 installer_type: all
 environment_file: explicit_linux-64.txt
 initialize_by_default: false

examples/initialization/construct.yaml

@@ -18,4 +18,4 @@ initialize_by_default: true
 register_python: false
 check_path_spaces: true
 check_path_length: false
-installer_type: all
+installer_type: {{ "exe" if os.name == "nt" else "all" }}

examples/miniforge-mamba2/construct.yaml

@@ -21,7 +21,7 @@ specs:
   - miniforge_console_shortcut 1.*  # [win]
 
 # Added for extra testing
-installer_type: all
+installer_type: {{ "exe" if os.name == "nt" else "all" }}
 post_install: test_install.sh  # [unix]
 post_install: test_install.bat  # [win]
 initialize_by_default: false

examples/miniforge/construct.yaml

@@ -21,7 +21,7 @@ specs:
   - miniforge_console_shortcut 1.*  # [win]
 
 # Added for extra testing
-installer_type: all
+installer_type: {{ "exe" if os.name == "nt" else "all" }}
 post_install: test_install.sh  # [unix]
 post_install: test_install.bat  # [win]
 initialize_by_default: false

examples/mirrored_channels/construct.yaml

@@ -2,7 +2,7 @@
 "$schema": "../../constructor/data/construct.schema.json"
 
 name: Mirrors
-version: X
+version: 1.0.0
 
 channels:
   - conda-forge

examples/noconda/constructor_input.yaml

@@ -2,7 +2,7 @@
 "$schema": "../../constructor/data/construct.schema.json"
 
 name: NoConda
-version: X
+version: 1.0.0
 installer_type: all
 channels:
   - https://repo.anaconda.com/pkgs/main/

examples/outputs/construct.yaml

@@ -2,7 +2,7 @@
 "$schema": "../../constructor/data/construct.schema.json"
 
 name: Outputs
-version: X
+version: 1.0.0
 installer_type: sh  # [unix]
 installer_type: exe  # [win]
 channels:

examples/protected_base/construct.yaml

@@ -2,8 +2,8 @@
 "$schema": "../../constructor/data/construct.schema.json"
 
 name: ProtectedBaseEnv
-version: X
-installer_type: all
+version: 1.0.0
+installer_type: {{ "exe" if os.name == "nt" else "all" }}
 
 channels:
   - defaults

examples/register_envs/construct.yaml

@@ -2,8 +2,8 @@
 "$schema": "../../constructor/data/construct.schema.json"
 
 name: RegisterEnvs
-version: X
-installer_type: all
+version: 1.0.0
+installer_type: {{ "exe" if os.name == "nt" else "all" }}
 channels:
   - https://repo.anaconda.com/pkgs/main/
 specs:

examples/scripts/construct.yaml

@@ -2,8 +2,8 @@
 "$schema": "../../constructor/data/construct.schema.json"
 
 name: Scripts
-version: X
-installer_type: all
+version: 1.0.0
+installer_type: {{ "exe" if os.name == "nt" else "all" }}
 channels:
   - https://repo.anaconda.com/pkgs/main/
 specs:

examples/scripts/post_install.bat

@@ -1,6 +1,6 @@
 echo Added by post-install script > "%PREFIX%\post_install_sentinel.txt"
 if not "%INSTALLER_NAME%" == "Scripts" exit 1
-if not "%INSTALLER_VER%" == "X" exit 1
+if not "%INSTALLER_VER%" == "1.0.0" exit 1
 if not "%INSTALLER_PLAT%" == "win-64" exit 1
 if not "%INSTALLER_TYPE%" == "EXE" exit 1
 if not "%INSTALLER_UNATTENDED%" == "1" exit 1

examples/scripts/post_install.sh

@@ -15,7 +15,7 @@ echo "CUSTOM_VARIABLE_2=${CUSTOM_VARIABLE_2}"
 echo "PREFIX=${PREFIX}"
 
 test "${INSTALLER_NAME}" = "Scripts"
-test "${INSTALLER_VER}" = "X"
+test "${INSTALLER_VER}" = "1.0.0"
 # shellcheck disable=SC2016 # String interpolation disabling is deliberate
 test "${CUSTOM_VARIABLE_1}" = 'FIR$T-CUSTOM_'\''STRING'\'' WITH SPACES AND @*! "CHARACTERS"'
 # shellcheck disable=SC2016 # String interpolation disabling is deliberate

examples/scripts/pre_install.bat

@@ -1,5 +1,5 @@
 if not "%INSTALLER_NAME%" == "Scripts" exit 1
-if not "%INSTALLER_VER%" == "X" exit 1
+if not "%INSTALLER_VER%" == "1.0.0" exit 1
 if not "%INSTALLER_PLAT%" == "win-64" exit 1
 if not "%INSTALLER_TYPE%" == "EXE" exit 1
 if not "%INSTALLER_UNATTENDED%" == "1" exit 1

examples/scripts/pre_install.sh

@@ -12,7 +12,7 @@ echo "CUSTOM_VARIABLE_2=${CUSTOM_VARIABLE_2}"
 echo "PREFIX=${PREFIX}"
 
 test "${INSTALLER_NAME}" = "Scripts"
-test "${INSTALLER_VER}" = "X"
+test "${INSTALLER_VER}" = "1.0.0"
 # shellcheck disable=SC2016 # String interpolation disabling is deliberate
 test "${CUSTOM_VARIABLE_1}" = 'FIR$T-CUSTOM_'\''STRING'\'' WITH SPACES AND @*! "CHARACTERS"'
 # shellcheck disable=SC2016 # String interpolation disabling is deliberate

examples/shortcuts/construct.yaml

@@ -3,7 +3,7 @@
 
 name: MinicondaWithShortcuts
 version: X
-installer_type: all
+installer_type: {{ "exe" if os.name == "nt" else "all" }}
 
 channels:
   - conda-test/label/menuinst-tests

examples/signing/construct.yaml

@@ -2,7 +2,7 @@
 "$schema": "../../constructor/data/construct.schema.json"
 
 name: Signed
-version: X
+version: 1.0.0
 installer_type: all
 channels:
   - https://repo.anaconda.com/pkgs/main/

examples/virtual_specs_failed/construct.yaml

@@ -22,4 +22,4 @@ initialize_by_default: false
 register_python: false
 check_path_spaces: false
 check_path_length: false
-installer_type: all
+installer_type: {{ "exe" if os.name == "nt" else "all" }}

examples/virtual_specs_ok/construct.yaml

@@ -22,4 +22,4 @@ initialize_by_default: false
 register_python: false
 check_path_spaces: false
 check_path_length: false
-installer_type: all
+installer_type: {{ "exe" if os.name == "nt" else "all" }}