Reglas de escritura en Windows

Informar un problema Ver código fuente Nightly · 8.0 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

En esta página, se enfoca en escribir reglas compatibles con Windows, los problemas habituales para escribir reglas portátiles y algunas soluciones.

Rutas de acceso

Problemas:

Límite de longitud: La longitud máxima de la ruta de acceso es de 259 caracteres.

Aunque Windows también admite rutas más largas (hasta 32,767 caracteres), muchos programas se compilan con el límite inferior.

Ten en cuenta esto sobre los programas que ejecutas en las acciones.
Directorio de trabajo: También tiene un límite de 259 caracteres.

Los procesos no pueden cd en un directorio de más de 259 caracteres.
Distinción entre mayúsculas y minúsculas: Las rutas de acceso de Windows no distinguen mayúsculas de minúsculas, mientras que las de Unix sí.

Tenlo en cuenta cuando crees líneas de comandos para acciones.
Separadores de ruta: Son barra invertida (\`), not forward slash (/`).

Bazel almacena las rutas de acceso al estilo Unix con separadores /. Aunque algunos programas de Windows admiten rutas de estilo Unix, otros no. Algunos comandos integrados en cmd.exe los admiten, otros no.

Es mejor usar siempre \` separators on Windows: replace/with cuando crees líneas de comandos y variables de entorno para acciones.
Rutas de acceso absolutas: No comienzan con una barra (/).

Las rutas de acceso absolutas en Windows comienzan con una letra de unidad, como C:\foo\bar.txt. No hay una sola raíz del sistema de archivos.

Ten en cuenta esto si tu regla verifica si una ruta es absoluta. Se deben evitar las rutas de acceso absolutas, ya que, a menudo, no son portátiles.

Soluciones:

Mantén las rutas de acceso breves.

Evita los nombres de directorios largos, las estructuras de directorios anidadas en profundidad, los nombres de archivos largos, los nombres de espacios de trabajo largos y los nombres de destino largos.

Todos estos elementos pueden convertirse en componentes de ruta de acceso de los archivos de entrada de las acciones y agotar el límite de longitud de la ruta.
Usa una raíz de salida corta.

Usa la marca --output_user_root=<path> para especificar una ruta de acceso corta para los resultados de Bazel. Una buena idea es tener una unidad (o unidad virtual) solo para los resultados de Bazel (como el archivo D:\`), and adding this line to your.bazelrc):
```
build --output_user_root=D:/
```
o
```
build --output_user_root=C:/_bzl
```
Usa cruces.

En términos generales^[1], los puntos de unión son symlinks de directorio. Los cruces son fáciles de crear y pueden apuntar a directorios (en la misma computadora) con rutas de acceso largas. Si una acción de compilación crea una unión cuya ruta de acceso es corta, pero su destino es largo, las herramientas con límite de ruta de acceso corta pueden acceder a los archivos del directorio de unión.

En los archivos .bat o en cmd.exe, puedes crear uniones de la siguiente manera:
```
mklink /J c:\path\to\junction c:\path\to\very\long\target\path
```
^[1]: Estrictamente hablando, los cruces no son vínculos simbólicos, pero, para las acciones de compilación, puedes considerarlos como vínculos simbólicos de directorio.
Reemplaza / por " en las rutas de acceso de las acciones o las variables de entorno.

Cuando crees la línea de comandos o las variables de entorno para una acción, crea las rutas de acceso al estilo de Windows. Ejemplo:
```
def as_path(p, is_windows):
    if is_windows:
        return p.replace("/", "\\")
    else:
        return p
```

Variables de entorno

Problemas:

Distinción entre mayúsculas y minúsculas: Los nombres de las variables de entorno de Windows no distinguen mayúsculas de minúsculas.

Por ejemplo, en Java, System.getenv("SystemRoot") y System.getenv("SYSTEMROOT") generan el mismo resultado. (Esto también se aplica a otros idiomas).
Hermeticity: Las acciones deben usar la menor cantidad posible de variables de entorno personalizadas.

Las variables de entorno forman parte de la clave de caché de la acción. Si una acción usa variables de entorno que cambian con frecuencia o son personalizadas para los usuarios, la regla es menos compatible con la caché.

Soluciones:

Solo usa nombres de variables de entorno en mayúsculas.

Esto funciona en Windows, macOS y Linux.

Minimiza los entornos de acción.

Cuando uses ctx.actions.run, configura el entorno en ctx.configuration.default_shell_env. Si la acción necesita más variables de entorno, colócalas todas en un diccionario y pásalas a la acción. Ejemplo:

load("@bazel_skylib//lib:dicts.bzl", "dicts")

def _make_env(ctx, output_file, is_windows):
    out_path = output_file.path
    if is_windows:
        out_path = out_path.replace("/", "\\")
    return dicts.add(ctx.configuration.default_shell_env, {"MY_OUTPUT": out_path})

Acciones

Problemas:

Resultados ejecutables: Cada archivo ejecutable debe tener una extensión ejecutable.

Las extensiones más comunes son .exe (archivos binarios) y .bat (secuencias de comandos por lotes).

Ten en cuenta que las secuencias de comandos de shell (.sh) NO se pueden ejecutar en Windows. No puedes especificarlas como executable de ctx.actions.run. Tampoco hay un permiso +x que puedan tener los archivos, por lo que no puedes ejecutar archivos arbitrarios como en Linux.
Comandos de Bash: Para mejorar la portabilidad, evita ejecutar comandos de Bash directamente en acciones.

Bash está muy extendido en sistemas similares a Unix, pero a menudo no está disponible en Windows. Bazel en sí depende cada vez menos de Bash (MSYS2), por lo que, en el futuro, es menos probable que los usuarios tengan instalado MSYS2 junto con Bazel. Para que las reglas sean más fáciles de usar en Windows, evita ejecutar comandos de Bash en acciones.
Finales de línea: Windows usa CRLF (\r\n) y los sistemas similares a Unix usan LF (\n).

Ten esto en cuenta cuando compares archivos de texto. Ten en cuenta la configuración de Git, en especial los finales de línea, cuando realices un checkout o una confirmación. (consulta la configuración de core.autocrlf de Git).

Soluciones:

Usa una regla específica sin Bash.

native.genrule() es un wrapper para los comandos de Bash y, a menudo, se usa para resolver problemas simples, como copiar un archivo o escribir un archivo de texto. Puedes evitar depender de Bash (y reinventar la rueda): comprueba si bazel-skylib tiene una regla específica para tus necesidades. Ninguno de ellos depende de Bash cuando se compila o prueba en Windows.

Ejemplos de reglas de compilación:
- copy_file() (fuente, documentación): Copia un archivo en otro lugar y, de manera opcional, lo hace ejecutable.
- write_file() (fuente, documentación): Escribe un archivo de texto con los finales de línea deseados (auto, unix o windows), lo que, de manera opcional, lo hace ejecutable (si es una secuencia de comandos).
- run_binary() (fuente, documentación): Ejecuta un objeto binario (o una regla *_binary) con entradas y resultados esperados como una acción de compilación (este es un wrapper de reglas de compilación para ctx.actions.run).
- native_binary() (fuente, documentación): Une un binario nativo en una regla *_binary, que puedes bazel run o usar en el atributo tool de run_binary() o en el atributo tools de native.genrule().
Ejemplos de reglas de prueba:
- diff_test() (fuente, documentación): Prueba que compara el contenido de dos archivos.
- native_test() (fuente, documentación): une un binario nativo en una regla *_test, que puedes bazel test
En Windows, considera usar secuencias de comandos .bat para tareas triviales.

En lugar de secuencias de comandos .sh, puedes resolver tareas triviales con secuencias de comandos .bat.

Por ejemplo, si necesitas una secuencia de comandos que no haga nada, que imprima un mensaje o que salga con un código de error fijo, será suficiente con un archivo .bat simple. Si tu regla muestra un proveedor DefaultInfo(), el campo executable puede hacer referencia a ese archivo .bat en Windows.

Y, como las extensiones de archivo no importan en macOS y Linux, siempre puedes usar .bat como la extensión, incluso para las secuencias de comandos de shell.

Ten en cuenta que no se pueden ejecutar archivos .bat vacíos. Si necesitas una secuencia de comandos vacía, escribe un espacio en ella.
Usa Bash de forma coherente.

En las reglas de compilación y prueba de Starlark, usa ctx.actions.run_shell para ejecutar secuencias de comandos y comandos Bash como acciones.

En las macros de Starlark, une las secuencias de comandos y los comandos de Bash en un native.sh_binary() o native.genrule(). Bazel verificará si Bash está disponible y ejecutará la secuencia de comandos o el comando a través de Bash.

En las reglas del repositorio de Starlark, intenta evitar Bash por completo. Actualmente, Bazel no ofrece ninguna forma de ejecutar comandos de Bash de manera coherente en las reglas del repositorio.

Borra archivos

Problemas:

No se pueden borrar archivos mientras están abiertos.

Los archivos abiertos no se pueden borrar (de forma predeterminada), y los intentos generan errores de “Acceso denegado”. Si no puedes borrar un archivo, es posible que un proceso en ejecución aún lo tenga abierto.
No se puede borrar el directorio de trabajo de un proceso en ejecución.

Los procesos tienen un controlador abierto a su directorio de trabajo, y el directorio no se puede borrar hasta que finaliza el proceso.

Soluciones:

En tu código, intenta cerrar los archivos con rapidez.

En Java, usa try-with-resources. En Python, usa with open(...) as f:. En principio, intenta cerrar los controladores lo antes posible.