Include the native client in the pantsbuild wheel.

.github/workflows/test-cron.yaml

@@ -54,7 +54,7 @@ jobs:
       uses: actions/cache@v3
       with:
         key: Linux-ARM64-engine-${{ steps.get-engine-hash.outputs.hash }}-v1
-        path: '.pants
+        path: 'src/python/pants/bin/native_client
 
           src/python/pants/engine/internals/native_engine.so
 
@@ -90,7 +90,7 @@ jobs:
       uses: actions/upload-artifact@v3
       with:
         name: native_binaries.${{ matrix.python-version }}.Linux-ARM64
-        path: '.pants
+        path: 'src/python/pants/bin/native_client
 
           src/python/pants/engine/internals/native_engine.so
 
@@ -155,7 +155,7 @@ jobs:
       uses: actions/cache@v3
       with:
         key: Linux-x86_64-engine-${{ steps.get-engine-hash.outputs.hash }}-v1
-        path: '.pants
+        path: 'src/python/pants/bin/native_client
 
           src/python/pants/engine/internals/native_engine.so
 
@@ -191,7 +191,7 @@ jobs:
       uses: actions/upload-artifact@v3
       with:
         name: native_binaries.${{ matrix.python-version }}.Linux-x86_64
-        path: '.pants
+        path: 'src/python/pants/bin/native_client
 
           src/python/pants/engine/internals/native_engine.so
 
@@ -268,7 +268,7 @@ jobs:
       uses: actions/cache@v3
       with:
         key: macOS11-x86_64-engine-${{ steps.get-engine-hash.outputs.hash }}-v1
-        path: '.pants
+        path: 'src/python/pants/bin/native_client
 
           src/python/pants/engine/internals/native_engine.so
 
@@ -304,7 +304,7 @@ jobs:
       uses: actions/upload-artifact@v3
       with:
         name: native_binaries.${{ matrix.python-version }}.macOS11-x86_64
-        path: '.pants
+        path: 'src/python/pants/bin/native_client
 
           src/python/pants/engine/internals/native_engine.so
 

.github/workflows/test.yaml

@@ -58,7 +58,7 @@ jobs:
       uses: actions/cache@v3
       with:
         key: Linux-ARM64-engine-${{ steps.get-engine-hash.outputs.hash }}-v1
-        path: '.pants
+        path: 'src/python/pants/bin/native_client
 
           src/python/pants/engine/internals/native_engine.so
 
@@ -93,7 +93,7 @@ jobs:
       uses: actions/upload-artifact@v3
       with:
         name: native_binaries.${{ matrix.python-version }}.Linux-ARM64
-        path: '.pants
+        path: 'src/python/pants/bin/native_client
 
           src/python/pants/engine/internals/native_engine.so
 
@@ -158,7 +158,7 @@ jobs:
       uses: actions/cache@v3
       with:
         key: Linux-x86_64-engine-${{ steps.get-engine-hash.outputs.hash }}-v1
-        path: '.pants
+        path: 'src/python/pants/bin/native_client
 
           src/python/pants/engine/internals/native_engine.so
 
@@ -193,7 +193,7 @@ jobs:
       uses: actions/upload-artifact@v3
       with:
         name: native_binaries.${{ matrix.python-version }}.Linux-x86_64
-        path: '.pants
+        path: 'src/python/pants/bin/native_client
 
           src/python/pants/engine/internals/native_engine.so
 
@@ -270,7 +270,7 @@ jobs:
       uses: actions/cache@v3
       with:
         key: macOS11-x86_64-engine-${{ steps.get-engine-hash.outputs.hash }}-v1
-        path: '.pants
+        path: 'src/python/pants/bin/native_client
 
           src/python/pants/engine/internals/native_engine.so
 
@@ -305,7 +305,7 @@ jobs:
       uses: actions/upload-artifact@v3
       with:
         name: native_binaries.${{ matrix.python-version }}.macOS11-x86_64
-        path: '.pants
+        path: 'src/python/pants/bin/native_client
 
           src/python/pants/engine/internals/native_engine.so
 

build-support/bin/generate_github_workflows.py

@@ -65,7 +65,7 @@ def hashFiles(path: str) -> str:
 
 
 NATIVE_FILES = [
-    ".pants",
+    "src/python/pants/bin/native_client",
     "src/python/pants/engine/internals/native_engine.so",
     "src/python/pants/engine/internals/native_engine.so.metadata",
 ]

build-support/bin/rust/bootstrap_code.sh

@@ -31,9 +31,9 @@ case "${KERNEL}" in
 esac
 
 readonly NATIVE_ENGINE_BINARY="native_engine.so"
+export NATIVE_CLIENT_BINARY="${REPO_ROOT}/src/python/pants/bin/native_client"
 readonly NATIVE_ENGINE_RESOURCE="${REPO_ROOT}/src/python/pants/engine/internals/${NATIVE_ENGINE_BINARY}"
 readonly NATIVE_ENGINE_RESOURCE_METADATA="${NATIVE_ENGINE_RESOURCE}.metadata"
-readonly NATIVE_CLIENT_PATH="${REPO_ROOT}/.pants"
 readonly NATIVE_CLIENT_TARGET="${NATIVE_ROOT}/target/${MODE}/pants"
 
 function _build_native_code() {
@@ -55,7 +55,7 @@ function bootstrap_native_code() {
     engine_version_in_metadata="$(sed -n 's/^engine_version: //p' "${NATIVE_ENGINE_RESOURCE_METADATA}")"
   fi
 
-  if [[ -f "${NATIVE_ENGINE_RESOURCE}" && -f "${NATIVE_CLIENT_PATH}" &&
+  if [[ -f "${NATIVE_ENGINE_RESOURCE}" && -f "${NATIVE_CLIENT_BINARY}" &&
     "${engine_version_calculated}" == "${engine_version_in_metadata}" ]]; then
     return 0
   fi
@@ -79,9 +79,9 @@ function bootstrap_native_code() {
   # Create the native engine resource.
   # NB: On Mac Silicon, for some reason, first removing the old native_engine.so is necessary to avoid the Pants
   #  process from being killed when recompiling.
-  rm -f "${NATIVE_ENGINE_RESOURCE}" "${NATIVE_CLIENT_PATH}"
+  rm -f "${NATIVE_ENGINE_RESOURCE}" "${NATIVE_CLIENT_BINARY}"
   cp "${native_binary}" "${NATIVE_ENGINE_RESOURCE}"
-  cp "${NATIVE_CLIENT_TARGET}" "${NATIVE_CLIENT_PATH}"
+  cp "${NATIVE_CLIENT_TARGET}" "${NATIVE_CLIENT_BINARY}"
 
   # Create the accompanying metadata file.
   local -r metadata_file=$(mktemp -t pants.native_engine.metadata.XXXXXX)

pants

@@ -41,7 +41,6 @@ source "${HERE}/build-support/pants_venv"
 source "${HERE}/build-support/bin/rust/bootstrap_code.sh"
 
 function exec_pants_bare() {
-  PANTS_NATIVE_EXE="${HERE}/.pants"
   PANTS_PY_EXE="${HERE}/src/python/pants/bin/pants_loader.py"
   PANTS_SRCPATH="${HERE}/src/python"
 
@@ -51,7 +50,7 @@ function exec_pants_bare() {
 
   if [ -n "${USE_NATIVE_PANTS}" ]; then
     set +e
-    "${PANTS_NATIVE_EXE}" "$@"
+    "${NATIVE_CLIENT_BINARY}" "$@"
     result=$?
     # N.B.: The native pants client currently relies on pantsd being up. If it's not, it will fail
     # with exit code 75 (EX_TEMPFAIL in /usr/include/sysexits.h) and we should fall through to the

src/python/pants/BUILD

@@ -18,6 +18,8 @@ python_distribution(
     dependencies=[
         "./__main__.py",
         ":resources",
+        # Include the native client binary in the distribution.
+        "src/python/pants/bin:native_client",
     ],
     # Because we have native code, this will cause the wheel to use whatever the ABI is for the
     # interpreter used to run setup.py, e.g. `cp36m-macosx_10_15_x86_64`.

src/python/pants/bin/.gitignore

@@ -0,0 +1 @@
+/native_client

src/python/pants/bin/BUILD

@@ -98,5 +98,9 @@ pex_binary(
     strip_pex_env=False,
 )
 
+resources(
+    name="native_client",
+    sources=["native_client"],
+)
 
 python_tests(name="tests")