Add installer attributes for name, version, platform, and type to .installer.info (#1260)

* Add installer attributes for name, version, platform, and type to .constructor-build.info

* Add news item for PR 1260

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Revert changes for .constructor-build.info file

* Add installer name, version, platform, and type to .installer.info file

* Change 'platform' to '_platform' for 'info.get()' call

* Add test statements for .installer.info to 'test_example_miniforge'

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Reduce if-else statements in 'test_example_miniforge'

* Move installer_name and installer_version to parameterized values in 'test_example_miniforge'

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update tests/test_examples.py

Co-authored-by: Marco Esters <mesters@anaconda.com>

* Check installer platform against 'cc_platform' for testing .installer.info values

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Marco Esters <mesters@anaconda.com>

Author: 3 people

constructor/nsis/main.nsi.tmpl

@@ -1502,6 +1502,7 @@ Section "Install"
     SetOutPath "$INSTDIR"
     File {{ conda_exe }}
     File {{ pre_uninstall }}
+    File {{ installer_info }}
 
 {%- for path, files in EXTRA_FILES | items %}
     SetOutPath "{{ path }}"

constructor/preconda.py

@@ -49,6 +49,7 @@
     import ruamel_json as json
 
 files = (
+    ".installer.info",
     "pkgs/.constructor-build.info",
     "pkgs/urls",
     "pkgs/urls.txt",
@@ -165,6 +166,15 @@ def write_files(info: dict, workspace: str):
     with open(join(pkgs_dir, ".constructor-build.info"), "w") as fo:
         json.dump(system_info(), fo)
 
+    out = {
+        "name": info.get("name"),
+        "version": info.get("version"),
+        "platform": info.get("_platform"),
+        "type": info.get("installer_type"),
+    }
+    with open(join(workspace, ".installer.info"), "w") as fo:
+        json.dump(out, fo)
+
     all_urls = info["_urls"].copy()
     for env_info in info.get("_extra_envs_info", {}).values():
         all_urls += env_info["_urls"]

constructor/winexe.py

@@ -187,6 +187,7 @@ def make_nsi(
         "pre_install": "@pre_install.bat",
         "post_install": "@post_install.bat",
         "pre_uninstall": "@pre_uninstall.bat",
+        "installer_info": "@.installer.info",
         "index_cache": "@" + join("pkgs", "cache"),
         "repodata_record": "@" + join("pkgs", "repodata_record.json"),
     }

news/1260-installer-attributes

@@ -0,0 +1,20 @@
+### Enhancements
+
+* <news item>
+
+### Bug fixes
+
+* <news item>
+
+### Deprecations
+
+* <news item>
+
+### Docs
+
+* <news item>
+
+### Other
+
+* Add the `installer` name, version, platform and type attributes to a `.installer.info` file in the main `workspace` directory,
+  so this information can be persistently stored. (#1250)

tests/test_examples.py

@@ -22,6 +22,7 @@
 from conda.models.version import VersionOrder as Version
 from ruamel.yaml import YAML
 
+from constructor.conda_interface import cc_platform
 from constructor.utils import (
     StandaloneExe,
     check_version,
@@ -570,8 +571,14 @@ def test_example_mirrored_channels(tmp_path, request):
     ),
     reason="Known issue with conda-standalone<=23.10: shortcuts are created but not removed.",
 )
-@pytest.mark.parametrize("example", ("miniforge", "miniforge-mamba2"))
-def test_example_miniforge(tmp_path, request, example):
+@pytest.mark.parametrize(
+    "example, installer_name, installer_version",
+    [
+        ("miniforge", "Miniforge3", "25.0.0-1"),
+        ("miniforge-mamba2", "Miniforge3-mamba2", "25.1.1-0"),
+    ],
+)
+def test_example_miniforge(tmp_path, request, example, installer_name, installer_version):
     input_path = _example_path(example)
     for installer, install_dir in create_installer(input_path, tmp_path):
         if installer.suffix == ".sh":
@@ -596,9 +603,16 @@ def test_example_miniforge(tmp_path, request, example):
             # Check that key metadata files are in place
             assert install_dir.glob("conda-meta/*.json")
             assert install_dir.glob("pkgs/cache/*.json")  # enables offline installs
+            # Check that the installer info file is in place
+            info_file = install_dir / ".installer.info"
+            assert info_file.is_file()
+            installer_info = json.loads(info_file.read_text())
+            assert installer_info["name"] == installer_name
+            assert installer_info["version"] == installer_version
+            assert installer_info["platform"] == cc_platform
+            assert installer_info["type"] == installer.suffix[1:]
             if installer.suffix == ".pkg" and ON_CI:
-                basename = "Miniforge3" if example == "miniforge" else "Miniforge3-mamba2"
-                _sentinel_file_checks(input_path, Path(os.environ["HOME"]) / basename)
+                _sentinel_file_checks(input_path, Path(os.environ["HOME"]) / installer_name)
             if installer.suffix == ".exe":
                 for key in ("ProgramData", "AppData"):
                     start_menu_dir = Path(