feat: support passenv (#914)

* feat: support passenv

* refactor: environment-pass and spaces

* docs: document environment pass

* Add unit test for passing through awkward env variable values

* Remove unused as_shell_commands method from environment

* Fix passthrough edge case by avoiding bash for passthrough assignments

* Fix mypy error in test

* Fix unit test

* Apply suggestions from code review

Co-authored-by: Joe Rickerby <joerick@mac.com>

unit_test/docker_container_test.py

@@ -8,7 +8,7 @@ from pathlib import Path, PurePath
 import pytest
 
 from cibuildwheel.docker_container import DockerContainer
-from cibuildwheel.environment import EnvironmentAssignment
+from cibuildwheel.environment import EnvironmentAssignmentBash
 
 # for these tests we use manylinux2014 images, because they're available on
 # multi architectures and include python3.8
@@ -198,5 +198,5 @@ def test_dir_operations(tmp_path: Path):
 @pytest.mark.docker
 def test_environment_executor():
     with DockerContainer(docker_image=DEFAULT_IMAGE) as container:
-        assignment = EnvironmentAssignment("TEST=$(echo 42)")
+        assignment = EnvironmentAssignmentBash("TEST=$(echo 42)")
         assert assignment.evaluated_value({}, container.environment_executor) == "42"

unit_test/environment_test.py

@@ -7,30 +7,24 @@ def test_basic_parsing():
     environment_recipe = parse_environment("VAR=1 VBR=2")
 
     environment_dict = environment_recipe.as_dictionary(prev_environment={})
-    environment_cmds = environment_recipe.as_shell_commands()
 
     assert environment_dict == {"VAR": "1", "VBR": "2"}
-    assert environment_cmds == ["export VAR=1", "export VBR=2"]
 
 
 def test_quotes():
     environment_recipe = parse_environment("A=1 VAR=\"1 NOT_A_VAR=2\" VBR='vbr'")
 
     environment_dict = environment_recipe.as_dictionary(prev_environment={})
-    environment_cmds = environment_recipe.as_shell_commands()
 
     assert environment_dict == {"A": "1", "VAR": "1 NOT_A_VAR=2", "VBR": "vbr"}
-    assert environment_cmds == ["export A=1", 'export VAR="1 NOT_A_VAR=2"', "export VBR='vbr'"]
 
 
 def test_inheritance():
     environment_recipe = parse_environment("PATH=$PATH:/usr/local/bin")
 
     environment_dict = environment_recipe.as_dictionary(prev_environment={"PATH": "/usr/bin"})
-    environment_cmds = environment_recipe.as_shell_commands()
 
     assert environment_dict == {"PATH": "/usr/bin:/usr/local/bin"}
-    assert environment_cmds == ["export PATH=$PATH:/usr/local/bin"]
 
 
 def test_shell_eval():
@@ -40,40 +34,32 @@ def test_shell_eval():
     env_copy.pop("VAR", None)
 
     environment_dict = environment_recipe.as_dictionary(prev_environment=env_copy)
-    environment_cmds = environment_recipe.as_shell_commands()
 
     assert environment_dict["VAR"] == "a   test string"
-    assert environment_cmds == ['export VAR="$(echo "a   test" string)"']
 
 
 def test_shell_eval_and_env():
     environment_recipe = parse_environment('VAR="$(echo "$PREV_VAR" string)"')
 
     environment_dict = environment_recipe.as_dictionary(prev_environment={"PREV_VAR": "1 2 3"})
-    environment_cmds = environment_recipe.as_shell_commands()
 
     assert environment_dict == {"PREV_VAR": "1 2 3", "VAR": "1 2 3 string"}
-    assert environment_cmds == ['export VAR="$(echo "$PREV_VAR" string)"']
 
 
 def test_empty_var():
     environment_recipe = parse_environment("CFLAGS=")
 
     environment_dict = environment_recipe.as_dictionary(prev_environment={"CFLAGS": "-Wall"})
-    environment_cmds = environment_recipe.as_shell_commands()
 
     assert environment_dict == {"CFLAGS": ""}
-    assert environment_cmds == ["export CFLAGS="]
 
 
 def test_no_vars():
     environment_recipe = parse_environment("")
 
     environment_dict = environment_recipe.as_dictionary(prev_environment={})
-    environment_cmds = environment_recipe.as_shell_commands()
 
     assert environment_dict == {}
-    assert environment_cmds == []
 
 
 def test_no_vars_pass_through():

unit_test/options_test.py

@@ -1,5 +1,7 @@
 import platform as platform_module
 
+import pytest
+
 from cibuildwheel.__main__ import get_build_identifiers
 from cibuildwheel.environment import parse_environment
 from cibuildwheel.options import Options, _get_pinned_docker_images
@@ -15,6 +17,8 @@ test-command = "pyproject"
 
 manylinux-x86_64-image = "manylinux1"
 
+environment-pass = ["EXAMPLE_ENV"]
+
 [tool.cibuildwheel.macos]
 test-requires = "else"
 
@@ -66,3 +70,47 @@ test_command: 'pyproject'
     assert local.manylinux_images is not None
     assert local.test_command == "pyproject-override"
     assert local.manylinux_images["x86_64"] == pinned_x86_64_docker_image["manylinux2014"]
+
+
+def test_passthrough(tmp_path, monkeypatch):
+    with tmp_path.joinpath("pyproject.toml").open("w") as f:
+        f.write(PYPROJECT_1)
+
+    args = get_default_command_line_arguments()
+    args.package_dir = str(tmp_path)
+
+    monkeypatch.setattr(platform_module, "machine", lambda: "x86_64")
+    monkeypatch.setenv("EXAMPLE_ENV", "ONE")
+
+    options = Options(platform="linux", command_line_arguments=args)
+
+    default_build_options = options.build_options(identifier=None)
+
+    assert default_build_options.environment.as_dictionary(prev_environment={}) == {
+        "FOO": "BAR",
+        "EXAMPLE_ENV": "ONE",
+    }
+
+
+@pytest.mark.parametrize(
+    "env_var_value",
+    [
+        "normal value",
+        '"value wrapped in quotes"',
+        "an unclosed single-quote: '",
+        'an unclosed double-quote: "',
+        "string\nwith\ncarriage\nreturns\n",
+        "a trailing backslash \\",
+    ],
+)
+def test_passthrough_evil(tmp_path, monkeypatch, env_var_value):
+    args = get_default_command_line_arguments()
+    args.package_dir = str(tmp_path)
+
+    monkeypatch.setattr(platform_module, "machine", lambda: "x86_64")
+    monkeypatch.setenv("CIBW_ENVIRONMENT_PASS_LINUX", "ENV_VAR")
+    options = Options(platform="linux", command_line_arguments=args)
+
+    monkeypatch.setenv("ENV_VAR", env_var_value)
+    parsed_environment = options.build_options(identifier=None).environment
+    assert parsed_environment.as_dictionary(prev_environment={}) == {"ENV_VAR": env_var_value}