Merge pull request #966 from Erotemic/new_podman_support

Podman support on Linux

Author: joerick

.github/workflows/test.yml

@@ -47,6 +47,18 @@ jobs:
       with:
         python-version: ${{ matrix.python_version }}
 
+    # Install podman on this CI instance for podman tests on linux
+    # Snippet from: https://github.com/redhat-actions/podman-login/blob/main/.github/workflows/example.yml
+    - name: Install latest podman
+      if: runner.os == 'Linux'
+      run: |
+        . /etc/os-release
+        echo "deb https://download.opensuse.org/repositories/devel:/kubic:/libcontainers:/stable/xUbuntu_${VERSION_ID}/ /" | sudo tee /etc/apt/sources.list.d/devel:kubic:libcontainers:stable.list
+        curl -sSfL "https://download.opensuse.org/repositories/devel:/kubic:/libcontainers:/stable/xUbuntu_${VERSION_ID}/Release.key" | sudo apt-key add -
+        sudo apt-get update
+        sudo apt-get -y upgrade
+        sudo apt-get -y install podman
+
     - name: Install dependencies
       run: |
         python -m pip install ".[test]"
@@ -70,7 +82,7 @@ jobs:
 
     - name: Test cibuildwheel
       run: |
-        python ./bin/run_tests.py
+        python ./bin/run_tests.py --run-podman
 
   test-emulated:
     name: Test emulated cibuildwheel using qemu

.pre-commit-config.yaml

@@ -61,6 +61,7 @@ repos:
       - pygithub
       - rich
       - tomli
+      - tomli_w
       - types-certifi
       - types-click
       - types-dataclasses

README.md

@@ -130,6 +130,7 @@ Options
 |   | [`CIBW_BEFORE_BUILD`](https://cibuildwheel.readthedocs.io/en/stable/options/#before-build)  | Execute a shell command preparing each wheel's build |
 |   | [`CIBW_REPAIR_WHEEL_COMMAND`](https://cibuildwheel.readthedocs.io/en/stable/options/#repair-wheel-command)  | Execute a shell command to repair each built wheel |
 |   | [`CIBW_MANYLINUX_*_IMAGE`<br/>`CIBW_MUSLLINUX_*_IMAGE`](https://cibuildwheel.readthedocs.io/en/stable/options/#linux-image)  | Specify alternative manylinux / musllinux Docker images |
+|   | [`CIBW_CONTAINER_ENGINE`](https://cibuildwheel.readthedocs.io/en/stable/options/#container-engine)  | Specify which container engine to use when building Linux wheels |
 |   | [`CIBW_DEPENDENCY_VERSIONS`](https://cibuildwheel.readthedocs.io/en/stable/options/#dependency-versions)  | Specify how cibuildwheel controls the versions of the tools it uses |
 | **Testing** | [`CIBW_TEST_COMMAND`](https://cibuildwheel.readthedocs.io/en/stable/options/#test-command)  | Execute a shell command to test each built wheel |
 |   | [`CIBW_BEFORE_TEST`](https://cibuildwheel.readthedocs.io/en/stable/options/#before-test)  | Execute a shell command before testing each wheel |

bin/run_tests.py

@@ -1,33 +1,47 @@
 #!/usr/bin/env python3
 
+import argparse
 import os
 import subprocess
 import sys
 from pathlib import Path
 
 if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "--run-podman", action="store_true", default=False, help="run podman tests (linux only)"
+    )
+    args = parser.parse_args()
+
     # move cwd to the project root
     os.chdir(Path(__file__).resolve().parents[1])
 
-    # run the unit tests
+    # unit tests
     unit_test_args = [sys.executable, "-m", "pytest", "unit_test"]
-    # run the docker unit tests only on Linux
+
     if sys.platform.startswith("linux"):
+        # run the docker unit tests only on Linux
         unit_test_args += ["--run-docker"]
+
+        if args.run_podman:
+            unit_test_args += ["--run-podman"]
+
     subprocess.run(unit_test_args, check=True)
 
-    # run the integration tests
-    subprocess.run(
-        [
-            sys.executable,
-            "-m",
-            "pytest",
-            "--numprocesses=2",
-            "-x",
-            "--durations",
-            "0",
-            "--timeout=2400",
-            "test",
-        ],
-        check=True,
-    )
+    # integration tests
+    integration_test_args = [
+        sys.executable,
+        "-m",
+        "pytest",
+        "--numprocesses=2",
+        "-x",
+        "--durations",
+        "0",
+        "--timeout=2400",
+        "test",
+    ]
+
+    if sys.platform.startswith("linux") and args.run_podman:
+        integration_test_args += ["--run-podman"]
+
+    subprocess.run(integration_test_args, check=True)

cibuildwheel/__main__.py

@@ -46,7 +46,7 @@ def main() -> None:
             auto-detected platform or to run cibuildwheel on your development
             machine. Specifying "macos" or "windows" only works on that
             operating system, but "linux" works on all three, as long as
-            Docker is installed. Default: auto.
+            Docker/Podman is installed. Default: auto.
         """,
     )
 
@@ -91,7 +91,7 @@ def main() -> None:
             Path to the package that you want wheels for. Default: the working
             directory. Can be a directory inside the working directory, or an
             sdist. When set to a directory, the working directory is still
-            considered the 'project' and is copied into the Docker container
+            considered the 'project' and is copied into the build container
             on Linux.  When set to a tar.gz sdist file, --config-file
             and --output-dir are relative to the current directory, and other
             paths are relative to the expanded SDist directory.
@@ -208,7 +208,6 @@ def build_in_directory(args: CommandLineArguments) -> None:
         sys.exit(0)
 
     # Add CIBUILDWHEEL environment variable
-    # This needs to be passed on to the docker container in linux.py
     os.environ["CIBUILDWHEEL"] = "1"
 
     # Python is buffering by default when running on the CI platforms, giving problems interleaving subprocess call output with unflushed calls to 'print'

cibuildwheel/architecture.py

@@ -59,7 +59,7 @@ def auto_archs(platform: PlatformName) -> "Set[Architecture]":
         result = {native_architecture}
 
         if platform == "linux" and native_architecture == Architecture.x86_64:
-            # x86_64 machines can run i686 docker containers
+            # x86_64 machines can run i686 containers
             result.add(Architecture.i686)
 
         if platform == "windows" and native_architecture == Architecture.AMD64: