MSI: Integration tests (conda#1133)

* Add tests

* Some more fixes

* Test commit to see if this resolves test failure

* Set version back to X also for the other failing test

* Review fixes

* pre-commit

* Add str conversion

* Remove request usage for MSI

Author: lrandersson

.github/workflows/main.yml

@@ -136,6 +136,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"
@@ -154,6 +155,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