Fix .desktop files installed by PEX scies. (#3099)

Fix `.desktop` files installed by `--scie-icon` / `--scie-desktop-file`
PEX scies to be more robust. They now work even if the original PEX
scie they were installed by is (re)moved as well as properly handling a
`SCIE_BASE` with spaces in the path.

Author: jsirois

CHANGES.md

@@ -1,5 +1,13 @@
 # Release Notes
 
+## 2.88.1
+
+This release fixes `.desktop` files installed by `--scie-icon` and `--scie-desktop-file` PEX scies
+to be more robust. They now work even if the original PEX scie they were installed by is (re)moved
+as well as properly handling a `SCIE_BASE` with spaces in the path.
+
+* Fix `.desktop` files installed by PEX scies. (#3099)
+
 ## 2.88.0
 
 This release adds support for `--pip-version 26.0.1`.

pex/scie/configure-binding.py

@@ -67,14 +67,35 @@ def _desktop_install_path(app_name):
 def desktop_install(
     app_name,  # type: str
     desktop_file,  # type: str
+    scie_jump,  # type: str
+    scie_lift,  # type: str
+    scie_exe,  # type: str
     icon=None,  # type: Optional[str]
 ):
     # type: (...) -> None
 
     desktop_install_path = _desktop_install_path(app_name)
-    os.makedirs(os.path.dirname(desktop_install_path))
+
+    try:
+        os.makedirs(os.path.dirname(desktop_install_path))
+    except OSError as e:
+        if e.errno != errno.EEXIST:
+            raise
+
+    def maybe_quote(value):
+        # type: (str) -> str
+        if " " in value:
+            return '"{value}"'.format(value=value)
+        return value
+
     with open(desktop_file) as in_fp, open(desktop_install_path, "w") as out_fp:
-        fmt_dict = dict(name=app_name, exe=os.environ["SCIE"])
+        fmt_dict = dict(
+            name=app_name,
+            exe=scie_exe,
+            default_exec="{scie_jump} --launch={scie_lift}".format(
+                scie_jump=maybe_quote(scie_jump), scie_lift=maybe_quote(scie_lift)
+            ),
+        )
         if icon:
             fmt_dict.update(icon=icon)
         out_fp.write(in_fp.read().format(**fmt_dict))
@@ -101,6 +122,9 @@ def desktop_uninstall(app_name):
 def prompt_desktop_install(
     app_name,  # type: str
     desktop_file,  # type: str
+    scie_jump,  # type: str
+    scie_lift,  # type: str
+    scie_exe,  # type: str
     icon=None,  # type: Optional[str]
 ):
     # type: (...) -> None
@@ -115,7 +139,14 @@ def prompt_desktop_install(
         message="Install a desktop entry?",
         detail="This will make it easier to launch {app_name}.".format(app_name=app_name),
     ):
-        desktop_install(app_name=app_name, desktop_file=desktop_file, icon=icon)
+        desktop_install(
+            app_name=app_name,
+            desktop_file=desktop_file,
+            scie_jump=scie_jump,
+            scie_lift=scie_lift,
+            scie_exe=scie_exe,
+            icon=icon,
+        )
 
 
 if __name__ == "__main__":
@@ -127,6 +158,9 @@ def prompt_desktop_install(
     )
     parser.add_argument("--venv-bin-dir", help="The platform-specific venv bin dir name.")
     parser.add_argument("--desktop-file", help="An optional application .desktop file.")
+    parser.add_argument("--scie-name", help="The name of the scie.")
+    parser.add_argument("--scie-jump", help="The path of this scie's scie-jump tip extracted.")
+    parser.add_argument("--scie-lift", help="The path of this scie's lift manifest extracted.")
     parser.add_argument("--icon", help="An optional application icon file.")
     parser.add_argument(
         "--no-prompt-desktop-install",
@@ -154,22 +188,32 @@ def prompt_desktop_install(
         )
 
     if options.desktop_file:
-        scie_name = os.path.basename(os.environ["SCIE_ARGV0"])
+        exe = os.environ["SCIE"]
         override_install_desktop_file = os.environ.get("CONFIGURE_DESKTOP_INSTALL", "").lower()
         if override_install_desktop_file == "prompt" or (
             not override_install_desktop_file and options.prompt_desktop_install
         ):
             prompt_desktop_install(
-                app_name=scie_name, desktop_file=options.desktop_file, icon=options.icon
+                app_name=options.scie_name,
+                desktop_file=options.desktop_file,
+                scie_jump=options.scie_jump,
+                scie_lift=options.scie_lift,
+                scie_exe=exe,
+                icon=options.icon,
             )
         elif override_install_desktop_file in ("1", "true") or (
             not override_install_desktop_file and not options.prompt_desktop_install
         ):
             desktop_install(
-                app_name=scie_name, desktop_file=options.desktop_file, icon=options.icon
+                app_name=options.scie_name,
+                desktop_file=options.desktop_file,
+                scie_jump=options.scie_jump,
+                scie_lift=options.scie_lift,
+                scie_exe=exe,
+                icon=options.icon,
             )
         elif override_install_desktop_file == "uninstall":
-            desktop_uninstall(app_name=scie_name)
+            desktop_uninstall(app_name=options.scie_name)
 
     write_bindings(
         env_file=os.environ["SCIE_BINDING_ENV"],

pex/scie/model.py

@@ -374,7 +374,7 @@ def generate_desktop_file(
         parser.ensure_set("Version", default="1.0")
         parser.ensure_set("Type", default="Application")
         parser.ensure_set("Name", default=app_name)
-        parser.ensure_set("Exec", default="{exe}")
+        parser.ensure_set("Exec", default="{default_exec}")
         if self.icon:
             parser.ensure_set("Icon", default="{icon}")
 

pex/scie/science.py

@@ -69,7 +69,7 @@ def qualified_binary_name(self, binary_name):
 
 
 SCIENCE_RELEASES_URL = "https://github.com/a-scie/lift/releases"
-MIN_SCIENCE_VERSION = Version("0.17.2")
+MIN_SCIENCE_VERSION = Version("0.18.1")
 SCIENCE_REQUIREMENT = SpecifierSet("~={min_version}".format(min_version=MIN_SCIENCE_VERSION))
 
 
@@ -84,7 +84,7 @@ def _science_binary_url(suffix=""):
 
 
 PTEX_VERSION = "1.7.0"
-SCIE_JUMP_VERSION = "1.9.2"
+SCIE_JUMP_VERSION = "1.11.2"
 
 
 class Filenames(Enum["Filenames.Value"]):
@@ -125,7 +125,7 @@ def _is_free_threaded_pex(pex_info):
 
 def create_manifests(
     configuration,  # type: ScieConfiguration
-    name,  # type: str
+    app_name,  # type: str
     pex,  # type: PEX
     use_platform_suffix=None,  # type: Optional[bool]
 ):
@@ -332,7 +332,7 @@ def create_cmd(named_entry_point):
     )
 
     lift_template = {
-        "name": name,
+        "name": app_name,
         "load_dotenv": configuration.options.load_dotenv,
         "scie_jump": scie_jump_config,
     }  # type: Dict[str, Any]
@@ -410,7 +410,7 @@ def configuration_binding(
 
         manifest_path = os.path.join(
             safe_mkdtemp(),
-            interpreter.platform.qualified_file_name("{name}-lift.toml".format(name=name)),
+            interpreter.platform.qualified_file_name("{name}-lift.toml".format(name=app_name)),
         )
 
         version_str = interpreter.version_str
@@ -450,7 +450,16 @@ def configuration_binding(
             )
         if interpreter.platform.os is Os.LINUX and configuration.options.desktop_app:
             extra_configure_binding_args.extend(
-                ("--desktop-file", Filenames.DESKTOP_FILE.placeholder)
+                (
+                    "--desktop-file",
+                    Filenames.DESKTOP_FILE.placeholder,
+                    "--scie-name",
+                    app_name,
+                    "--scie-jump",
+                    "{scie.jump}",
+                    "--scie-lift",
+                    "{scie.lift}",
+                )
             )
             if not configuration.options.desktop_app.prompt_install:
                 extra_configure_binding_args.append("--no-prompt-desktop-install")

pex/version.py

@@ -1,4 +1,4 @@
 # Copyright 2015 Pex project contributors.
 # Licensed under the Apache License, Version 2.0 (see LICENSE).
 
-__version__ = "2.88.0"
+__version__ = "2.88.1"

tests/integration/scie/test_pex_scie.py

@@ -350,7 +350,7 @@ def test_specified_science_binary(tmpdir):
 
     local_science_binary = os.path.join(str(tmpdir), "science")
     with open(local_science_binary, "wb") as write_fp, URLFetcher().get_body_stream(
-        "https://github.com/a-scie/lift/releases/download/v0.17.2/{binary}".format(
+        "https://github.com/a-scie/lift/releases/download/v0.18.1/{binary}".format(
             binary=SysPlatform.CURRENT.qualified_binary_name("science")
         )
     ) as read_fp:
@@ -394,7 +394,7 @@ def test_specified_science_binary(tmpdir):
         cached_science_binaries
     ), "Expected the local science binary to be used but not cached."
     assert (
-        "0.17.2"
+        "0.18.1"
         == subprocess.check_output(args=[local_science_binary, "--version"]).decode("utf-8").strip()
     )
 

tests/integration/test_scie_desktop_install.py

@@ -3,7 +3,6 @@
 
 from __future__ import absolute_import
 
-import json
 import os
 import subprocess
 from textwrap import dedent
@@ -179,7 +178,9 @@ def test_desktop_file(tmpdir):
             dedent(
                 """\
                 [Test]
-                Data={{"name": "{name}", "exe": "{exe}", "icon": "{icon}"}}
+                name={name}
+                exe={exe}
+                icon={icon}
 
                 [Desktop Entry]
                 Name=Slartibartfast
@@ -188,9 +189,9 @@ def test_desktop_file(tmpdir):
             )
         )
 
-    icon = tmpdir.join("file.ico")
+    icon_path = tmpdir.join("file.ico")
     icon_contents = "1/137"
-    with open(icon, "w") as fp:
+    with open(icon_path, "w") as fp:
         fp.write(icon_contents)
 
     run_pex_command(
@@ -206,29 +207,67 @@ def test_desktop_file(tmpdir):
             "eager",
             "--scie-only",
             "--scie-icon",
-            icon,
+            icon_path,
             "--scie-desktop-file",
             desktop_file,
             "--no-scie-prompt-desktop-install",
         ]
     ).assert_success()
 
-    xdg_data_home = safe_mkdir(tmpdir.join("XDG_DATA_HOME"))
-    scie_base = tmpdir.join("nce")
-    env = make_env(SCIE_BASE=scie_base, XDG_DATA_HOME=xdg_data_home)
-    assert b"| Moo! |" in subprocess.check_output(args=[scie, "Moo!"], env=env)
+    def assert_desktop_entry(
+        scie_base,  # type: str
+        xdg_data_home,  # type: str
+    ):
+        env = make_env(SCIE_BASE=scie_base, XDG_DATA_HOME=xdg_data_home)
+        assert b"| Moo! |" in subprocess.check_output(args=[scie, "Moo!"], env=env)
 
-    parser = DesktopFileParser.create(os.path.join(xdg_data_home, "applications", "cowsay.desktop"))
-    assert "Slartibartfast" == parser.get("Desktop Entry", "Name")
-    assert "DoesNotExist.png" == parser.get("Desktop Entry", "Icon")
+        parser = DesktopFileParser.create(
+            os.path.join(xdg_data_home, "applications", "cowsay.desktop")
+        )
+        assert "Slartibartfast" == parser.get("Desktop Entry", "Name")
+        assert "DoesNotExist.png" == parser.get("Desktop Entry", "Icon")
 
-    data = json.loads(parser.get("Test", "Data"))
-    assert parser.get("Desktop Entry", "Exec") == data.pop("exe")
-    assert "cowsay" == data.pop("name")
+        executable = parser.get("Desktop Entry", "Exec")
+        assert executable != scie
+        assert scie == parser.get("Test", "exe")
 
-    icon = data.pop("icon")
-    assert scie_base == commonpath((scie_base, icon))
-    with open(icon) as fp:
-        assert icon_contents == fp.read()
+        def assert_quoting(string):
+            # type: (str) -> str
 
-    assert not data
+            if " " not in string:
+                return string
+
+            prefix, unquoted, suffix = string.split('"')
+            assert not prefix, "Expected {string} to be quoted but found prefix {prefix}.".format(
+                string=string, prefix=prefix
+            )
+            assert not suffix, "Expected {string} to be quoted but found prefix {suffix}.".format(
+                string=string, suffix=suffix
+            )
+            return unquoted
+
+        exe, arg = executable.split()
+        exe = assert_quoting(exe)
+
+        option, value = arg.split("=")
+        assert "--launch" == option
+        value = assert_quoting(value)
+
+        assert b"| Moo? |" in subprocess.check_output(
+            args=[exe, "{option}={value}".format(option=option, value=value)] + ["Moo?"], env=env
+        )
+
+        assert "cowsay" == parser.get("Test", "name")
+
+        icon = parser.get("Test", "icon")
+        assert scie_base == commonpath((scie_base, icon))
+        with open(icon) as fp:
+            assert icon_contents == fp.read()
+
+    assert_desktop_entry(
+        scie_base=tmpdir.join("nce-no-space"),
+        xdg_data_home=safe_mkdir(tmpdir.join("XDG_DATA_HOME")),
+    )
+    assert_desktop_entry(
+        scie_base=tmpdir.join("nce-space"), xdg_data_home=safe_mkdir(tmpdir.join("XDG DATA HOME"))
+    )