Update scie-pants to scie-jump 0.11.1. (#199)

This pulls in a fix for handling of regex env var removal when the
ambient env contains non-utf8 entries. Out of the 4 ways Pants can be
run, threeare still broken, but these breaks are inside Pants itself.
Two breaks occur when using pantsd. There is one in the native client
and one in the `PyNailgunClient`. Another occurs using `--no-pants`
with the native client. For more about those issues, see:
pantsbuild/pants#19199

Fixes #198

Author: jsirois

CHANGES.md

@@ -1,5 +1,10 @@
 # Release Notes
 
+## 0.8.2
+
+This release fixes handling of environment variables when non-utf8 variables are present in the
+ambient environment.
+
 ## 0.8.1
 
 This release adjusts the `PANTS_SHA` and `PANTS_VERSION` environment variables to be ignored, if

Cargo.lock

@@ -6,7 +6,7 @@ members = [
 [package]
 name = "scie-pants"
 description = "Protects your Pants from the elements."
-version = "0.8.1"
+version = "0.8.2"
 edition = "2021"
 authors = [
     "John Sirois <[email protected]>",

Cargo.toml

@@ -17,6 +17,7 @@ lazy_static = "1.4"
 log = { workspace = true }
 once_cell = "1.17"
 pretty_env_logger = "0.5"
+regex = "1.8"
 sha2 = "0.10"
 tempfile = { workspace = true }
 termcolor = "1.2"

package/Cargo.toml

@@ -8,7 +8,7 @@ Python Build Tool: A BusyBox that provides `python`, `pip`, `pex`, `pex3` and `p
 version = "0.7.0"
 
 [lift.scie-jump]
-version = "0.11.0"
+version = "0.11.1"
 
 [[lift.interpreters]]
 id = "cpython"

package/pbt.toml

@@ -12,7 +12,7 @@ version = "0.7.0"
 lazy_argv1 = "{scie.env.PANTS_BOOTSTRAP_URLS={scie.lift}}"
 
 [lift.scie-jump]
-version = "0.11.0"
+version = "0.11.1"
 
 [[lift.interpreters]]
 id = "cpython38"

package/scie-pants.toml

@@ -2,11 +2,13 @@
 // Licensed under the Apache License, Version 2.0 (see LICENSE).
 
 use std::env;
+use std::ffi::OsString;
 use std::io::Write;
 use std::path::{Path, PathBuf};
 use std::process::{Command, Output, Stdio};
 
 use anyhow::{Context, Result};
+use regex::Regex;
 use tempfile::TempDir;
 use termcolor::{Color, WriteColor};
 
@@ -130,6 +132,9 @@ pub(crate) fn run_integration_tests(
         test_caching_issue_129(scie_pants_scie);
         test_custom_pants_toml_issue_153(scie_pants_scie);
         test_pants_native_client_perms_issue_182(scie_pants_scie);
+
+        #[cfg(unix)]
+        test_non_utf8_env_vars_issue_198(scie_pants_scie);
     }
 
     // Max Python supported is 3.8 and only Linux and macOS x86_64 wheels were released.
@@ -888,3 +893,81 @@ fn test_pants_native_client_perms_issue_182(scie_pants_scie: &Path) {
         decode_output(output.unwrap().stdout).unwrap().trim()
     );
 }
+
+#[cfg(unix)]
+fn test_non_utf8_env_vars_issue_198(scie_pants_scie: &Path) {
+    integration_test!(
+        "Verifying scie-pants is robust to environments with non-utf8 env vars present ({issue})",
+        issue = issue_link(198)
+    );
+
+    let tmpdir = create_tempdir().unwrap();
+
+    let pants_release = "2.17.0a1";
+    let pants_toml_content = format!(
+        r#"
+        [GLOBAL]
+        pants_version = "{pants_release}"
+        "#
+    );
+    let pants_toml = tmpdir.path().join("pants.toml");
+    write_file(&pants_toml, false, pants_toml_content).unwrap();
+
+    use std::os::unix::ffi::OsStringExt;
+    env::set_var("FOO", OsString::from_vec(vec![b'B', 0xa5, b'R']));
+
+    let err = execute(
+        Command::new(scie_pants_scie)
+            .arg("-V")
+            .env("RUST_LOG", "trace")
+            .stderr(Stdio::piped())
+            .current_dir(&tmpdir),
+    )
+    .unwrap_err();
+    let error_text = err.to_string();
+    // N.B.: This is a very hacky way to confirm the `scie-jump` is done processing env vars and has
+    // exec'd the `scie-pants` native client; which then proceeds to choke on env vars in the same
+    // way scie-jump <= 0.11.0 did using `env::vars()`.
+    assert!(Regex::new(concat!(
+        r#"exe: ".*/bindings/venvs/2\.17\.0a1/lib/python3\.9/"#,
+        r#"site-packages/pants/bin/native_client""#
+    ))
+    .unwrap()
+    .find(&error_text)
+    .is_some());
+    assert!(error_text.contains("[DEBUG TimerFinished] jump::prepare_boot(), Elapsed="));
+    assert!(error_text
+        .contains(r#"panicked at 'called `Result::unwrap()` on an `Err` value: "B\xA5R"'"#));
+
+    // The error path we test below requires flowing through the pantsd path via PyNailgunClient.
+    let err = execute(
+        Command::new(scie_pants_scie)
+            .arg("--pantsd")
+            .arg("-V")
+            .env("PANTS_NO_NATIVE_CLIENT", "1")
+            .stderr(Stdio::piped())
+            .current_dir(&tmpdir),
+    )
+    .unwrap_err();
+    // Here we're asking the native client to exit very early before it processed `env::vars()`; so
+    // the execution makes it into Python code that calls
+    // `PyNailgunClient(...).execute(command, args, modified_env)`. That's Rust code implementing a
+    // Python extension object that also wrongly assumes utf8 when converting env vars.
+    assert!(err.to_string().contains(concat!(
+        r#"UnicodeEncodeError: 'utf-8' codec can't encode character '\udca5' in "#,
+        "position 1: surrogates not allowed"
+    )));
+
+    let output = execute(
+        Command::new(scie_pants_scie)
+            .arg("--no-pantsd")
+            .arg("-V")
+            .env("PANTS_NO_NATIVE_CLIENT", "1")
+            .stdout(Stdio::piped())
+            .current_dir(&tmpdir),
+    )
+    .unwrap();
+    assert_eq!(pants_release, decode_output(output.stdout).unwrap().trim());
+
+    env::remove_var("FOO");
+}