En este artículo, se explica la zona de pruebas en Bazel, la instalación de sandboxfs y la depuración
de tu entorno de zona de pruebas.
La zona de pruebas es una estrategia de restricción de permisos que aísla los procesos entre sí o de los recursos de un sistema. Para Bazel, esto significa restringir el acceso al sistema de archivos.
La zona de pruebas del sistema de archivos de Bazel ejecuta procesos en un directorio de trabajo que solo contiene entradas conocidas, de modo que los compiladores y otras herramientas no vean los archivos fuente a los que no deberían acceder, a menos que conozcan las rutas de acceso absolutas.
La zona de pruebas no oculta el entorno del host de ninguna manera. Los procesos pueden acceder libremente a todos los archivos del sistema de archivos. Sin embargo, en las plataformas que admiten espacios de nombres de usuario, los procesos no pueden modificar ningún archivo fuera de su directorio de trabajo. Esto garantiza que el gráfico de compilación no tenga dependencias ocultas que puedan afectar la reproducibilidad de la compilación.
Más específicamente, Bazel construye un directorio execroot/ para cada acción,
que actúa como el directorio de trabajo de la acción en el momento de la ejecución. execroot/
contiene todos los archivos de entrada de la acción y sirve como contenedor para cualquier
salida generada. Luego, Bazel usa una técnica proporcionada por el sistema operativo, los contenedores en Linux y sandbox-exec en macOS, para restringir la acción dentro de execroot/.
Motivos para usar la zona de pruebas
Sin la zona de pruebas de acciones, Bazel no sabe si una herramienta usa archivos de entrada no declarados (archivos que no se enumeran de forma explícita en las dependencias de una acción). Cuando cambia uno de los archivos de entrada no declarados, Bazel sigue creyendo que la compilación está actualizada y no volverá a compilar la acción. Esto puede generar una compilación incremental incorrecta.
La reutilización incorrecta de las entradas de caché crea problemas durante el almacenamiento en caché remoto. Una entrada de caché incorrecta en una caché compartida afecta a todos los desarrolladores del proyecto, y borrar toda la caché remota no es una solución viable.
La zona de pruebas imita el comportamiento de la ejecución remota. Si una compilación funciona bien con la zona de pruebas, es probable que también funcione con la ejecución remota. Si haces que la ejecución remota suba todos los archivos necesarios (incluidas las herramientas locales), puedes reducir significativamente los costos de mantenimiento de los clústeres de compilación en comparación con tener que instalar las herramientas en cada máquina del clúster cada vez que quieras probar un compilador nuevo o hacer un cambio en una herramienta existente.
Qué estrategia de zona de pruebas usar
Puedes elegir qué tipo de zona de pruebas usar, si corresponde, con las marcas de estrategia. El uso de la estrategia sandboxed hace que Bazel elija una de las implementaciones de zona de pruebas que se enumeran a continuación y prefiera una zona de pruebas específica del SO a la genérica menos hermética.
Los trabajadores persistentes se ejecutan en una zona de pruebas genérica si pasas la marca --worker_sandboxing.
La estrategia local (también conocida como standalone) no realiza ningún tipo de zona de pruebas.
Simplemente ejecuta la línea de comandos de la acción con el directorio de trabajo configurado en el execroot de tu espacio de trabajo.
processwrapper-sandbox es una estrategia de zona de pruebas que no requiere ninguna función “avanzada” y debería funcionar en cualquier sistema POSIX de forma predeterminada. Compila un directorio de zona de pruebas que consta de symlinks que apuntan a los archivos de origen originales, ejecuta la línea de comandos de la acción con el directorio de trabajo establecido en este directorio en lugar del execroot y, luego, mueve los artefactos de salida conocidos fuera de la zona de pruebas al execroot y borra la zona de pruebas. Esto evita que la acción use accidentalmente archivos de entrada que no estén declarados y que cubra el execroot con archivos de salida desconocidos.
linux-sandbox va un paso más allá y se basa en processwrapper-sandbox. Al igual que lo que hace Docker en segundo plano, usa los espacios de nombres de Linux (espacios de nombres de usuario, activación, PID, red y IPC) para aislar la acción del host. Es decir, hace que todo el sistema de archivos sea de solo lectura, excepto el directorio de zona de pruebas, de modo que la acción no pueda modificar accidentalmente nada en el sistema de archivos del host. Esto evita situaciones como que una prueba con errores rm
-rf el directorio $HOME por accidente. De manera opcional, también puedes evitar que la acción acceda a la red. linux-sandbox usa espacios de nombres de PID para evitar que la acción vea cualquier otro proceso y para finalizar de forma confiable todos los procesos (incluso los demonios que genera la acción) al final.
darwin-sandbox es similar, pero para macOS. Usa la herramienta sandbox-exec de Apple para lograr aproximadamente lo mismo que la zona de pruebas de Linux.
Tanto linux-sandbox como darwin-sandbox no funcionan en una situación "anidada" debido a las restricciones en los mecanismos que proporcionan los sistemas operativos. Como Docker también usa espacios de nombres de Linux para su magia de contenedores, no puedes ejecutar linux-sandbox fácilmente dentro de un contenedor de Docker, a menos que uses
docker run --privileged. En macOS, no puedes ejecutar sandbox-exec dentro de un proceso que ya está en zona de pruebas. Por lo tanto, en estos casos, Bazel recurre automáticamente a processwrapper-sandbox.
Si prefieres obtener un error de compilación, por ejemplo, para no compilar accidentalmente con una estrategia de ejecución menos estricta, modifica de forma explícita la lista de estrategias de ejecución que intenta usar Bazel (por ejemplo, bazel build
--spawn_strategy=worker,linux-sandbox).
La ejecución dinámica suele requerir una zona de pruebas para la ejecución local. Para inhabilitarlo, pasa la marca --experimental_local_lockfree_output. La ejecución dinámica pone en la zona de pruebas de forma silenciosa los trabajadores persistentes.
Desventajas de la zona de pruebas
La zona de pruebas genera costos adicionales de configuración y desmantelamiento. El tamaño de este costo depende de muchos factores, como la forma de la compilación y el rendimiento del SO host. En Linux, las compilaciones en zona de pruebas rara vez son más lentas que un par de por ciento. La configuración de
--reuse_sandbox_directoriespuede mitigar el costo de configuración y desmantelamiento.La zona de pruebas inhabilita de manera eficaz cualquier caché que pueda tener la herramienta. Puedes mitigar esto mediante el uso de trabajadores persistentes, a costa de garantías de zona de pruebas más débiles.
Los trabajadores multiplexados requieren compatibilidad explícita con trabajadores para que se ejecuten en la zona de pruebas. Los trabajadores que no admiten la zona de pruebas de multiplexación se ejecutan como trabajadores de monoplexión en la ejecución dinámica, lo que puede costar memoria adicional.
sandboxfs
sandboxfs es un sistema de archivos FUSE que expone una vista arbitraria del sistema de archivos subyacente sin penalizaciones de tiempo. Bazel usa sandboxfs para generar execroot/ de forma instantánea para cada acción, lo que evita el costo de emitir miles de llamadas al sistema. Ten en cuenta que la E/S adicional dentro de execroot/ puede ser más lenta debido a la sobrecarga de FUSE.
Instala sandboxfs
Sigue estos pasos para instalar sandboxfs y realizar una compilación de Bazel con él:
Descargar
Descarga e instala
sandboxfs para que el objeto binario sandboxfs termine en tu PATH.
Ejecuta sandboxfs
- Instala OSXFUSE (solo para macOS).
Ejecutar (solo para macOS):
sudo sysctl -w vfs.generic.osxfuse.tunables.allow_other=1Deberás hacerlo después de la instalación y después de cada reinicio para asegurarte de que los servicios principales del sistema macOS funcionen a través de sandboxfs.
Ejecuta una compilación de Bazel con
--experimental_use_sandboxfs.bazel build target --experimental_use_sandboxfs
Solución de problemas
Si ves local en lugar de darwin-sandbox o linux-sandbox como una anotación para las acciones que se ejecutan, es posible que la zona de pruebas esté inhabilitada. Pasa --genrule_strategy=sandboxed --spawn_strategy=sandboxed para habilitarlo.
Depuración
Sigue las estrategias que se indican a continuación para depurar problemas con el entorno de pruebas.
Espacios de nombres desactivados
En algunas plataformas, como los nodos de clúster de Google Kubernetes Engine o Debian, los espacios de nombres de usuario se desactivan de forma predeterminada debido a problemas de seguridad. Si el archivo /proc/sys/kernel/unprivileged_userns_clone existe y contiene un 0, puedes activar los espacios de nombres de usuario ejecutando lo siguiente:
sudo sysctl kernel.unprivileged_userns_clone=1Fallas en la ejecución de reglas
Es posible que la zona de pruebas no ejecute reglas debido a la configuración del sistema. Si ves un
mensaje como namespace-sandbox.c:633: execvp(argv[0], argv): No such file or
directory, intenta desactivar la zona de pruebas con --strategy=Genrule=local para
genrules y --spawn_strategy=local para otras reglas.
Depuración detallada para errores de compilación
Si tu compilación falló, usa --verbose_failures y --sandbox_debug para que Bazel muestre el comando exacto que se ejecutó cuando falló la compilación, incluida la parte que configura la zona de pruebas.
Ejemplo de mensaje de error:
ERROR: path/to/your/project/BUILD:1:1: compilation of rule
'//path/to/your/project:all' failed:
Sandboxed execution failed, which may be legitimate (such as a compiler error),
or due to missing dependencies. To enter the sandbox environment for easier
debugging, run the following command in parentheses. On command failure, a bash
shell running inside the sandbox will then automatically be spawned
namespace-sandbox failed: error executing command
(cd /some/path && \
exec env - \
LANG=en_US \
PATH=/some/path/bin:/bin:/usr/bin \
PYTHONPATH=/usr/local/some/path \
/some/path/namespace-sandbox @/sandbox/root/path/this-sandbox-name.params --
/some/path/to/your/some-compiler --some-params some-target)
Ahora, puedes inspeccionar el directorio de zona de pruebas generado y ver qué archivos creó Bazel, y volver a ejecutar el comando para ver cómo se comporta.
Ten en cuenta que Bazel no borra el directorio de zona de pruebas cuando usas --sandbox_debug. A menos que estés depurando de forma activa, debes inhabilitar --sandbox_debug porque llena el disco con el tiempo.