Reglas generales

Reglas

• alias
• config_setting
• filegroup
• genquery
• genrule
• starlark_doc_extract
• test_suite

alias

alias(name, actual, compatible_with, deprecation, features, restricted_to, tags, target_compatible_with, testonly, visibility)

La regla alias crea otro nombre al que se puede hacer referencia.

La asignación de alias solo funciona para objetivos “comunes”. En particular, no se pueden crear alias para package_group ni test_suite.

Los alias pueden ser útiles en repositorios grandes en los que cambiar el nombre de un destino requeriría realizar cambios en muchos archivos. También puedes usar la regla de alias para almacenar una llamada a la función select si deseas volver a usar esa lógica para varios objetivos.

La regla de alias tiene su propia declaración de visibilidad. En todos los demás aspectos, se comporta como la regla a la que hace referencia (p.ej., solo se ignora en el alias de prueba; en su lugar se usa el carácter de solo prueba de la regla a la que se hace referencia) con algunas excepciones menores:

• Las pruebas no se ejecutan si se menciona su alias en la línea de comandos. Para definir un alias que ejecute la prueba a la que se hace referencia, usa una regla test_suite con un solo objetivo en su atributo tests.
• Cuando se definen grupos de entornos, no se admiten los alias de las reglas environment. Tampoco se admiten en la opción de línea de comandos --target_environment.

Ejemplos

filegroup(
    name = "data",
    srcs = ["data.txt"],
)

alias(
    name = "other",
    actual = ":data",
)

Argumentos

config_setting

config_setting(name, constraint_values, define_values, deprecation, distribs, features, flag_values, licenses, tags, testonly, values, visibility)

Coincide con un estado de configuración esperado (expresado como marcas de compilación o restricciones de plataforma) con el fin de activar atributos configurables. Consulta select para obtener información sobre cómo consumir esta regla y Atributos configurables para obtener una descripción general de la función general.

Ejemplos

El siguiente comando coincide con cualquier compilación que establezca --compilation_mode=opt o -c opt (ya sea de forma explícita en la línea de comandos o implícitamente desde los archivos .bazelrc):

  config_setting(
      name = "simple",
      values = {"compilation_mode": "opt"}
  )
  

La siguiente coincide con cualquier compilación que se oriente a ARM y aplique el FOO=bar de definición personalizada (por ejemplo, bazel build --cpu=arm --define FOO=bar ...):

  config_setting(
      name = "two_conditions",
      values = {
          "cpu": "arm",
          "define": "FOO=bar"
      }
  )
  

El siguiente comando coincide con cualquier compilación que establezca la marca definida por el usuario --//custom_flags:foo=1 (ya sea de forma explícita en la línea de comandos o implícitamente desde los archivos .bazelrc):

  config_setting(
      name = "my_custom_flag_is_set",
      flag_values = { "//custom_flags:foo": "1" },
  )
  

La siguiente expresión coincide con cualquier compilación que se oriente a una plataforma con una arquitectura x86_64 y la versión 2.25 de glibc, siempre que exista un constraint_value con la etiqueta //example:glibc_2_25. Ten en cuenta que una plataforma seguirá coincidiendo si define valores de restricción adicionales más allá de estos dos.

  config_setting(
      name = "64bit_glibc_2_25",
      constraint_values = [
          "@platforms//cpu:x86_64",
          "//example:glibc_2_25",
      ]
  )
  

Notas

• Consulta la selección para saber qué sucede cuando varios config_setting coinciden con el estado de configuración actual.
• En el caso de las marcas que admiten formas abreviadas (p. ej., --compilation_mode en comparación con -c), las definiciones de values deben usar la forma completa. Estas coinciden automáticamente con invocaciones con cualquiera de los formatos.
• Si una marca toma varios valores (como --copt=-Da --copt=-Db o una marca de Starlark de tipo lista), values = { "flag": "a" } coincide si "a" está presente en cualquier lugar de la lista real.

  values = { "myflag": "a,b" } funciona de la misma manera: coincide con --myflag=a --myflag=b, --myflag=a --myflag=b --myflag=c, --myflag=a,b y --myflag=c,b,a. La semántica exacta varía entre las marcas. Por ejemplo, --copt no admite varios valores en la misma instancia: --copt=a,b produce ["a,b"], mientras que --copt=a --copt=b produce ["a", "b"] (por lo que values = { "copt": "a,b" } coincide con el primero, pero no con el segundo). Sin embargo, --ios_multi_cpus (para las reglas de Apple) sí: -ios_multi_cpus=a,b y ios_multi_cpus=a --ios_multi_cpus=b producen ["a", "b"]. Verifica las definiciones de las marcas y prueba tus condiciones con cuidado para verificar las expectativas exactas.

• Si necesitas definir condiciones que no estén modeladas con marcas de compilación integradas, usa las marcas definidas por Starlark. También puedes usar --define, pero esta opción ofrece una compatibilidad más débil y no se recomienda. Consulta aquí para obtener más información.
• Evita repetir definiciones de config_setting idénticas en diferentes paquetes. En su lugar, haz referencia a un config_setting común que se definió en un paquete canónico.
• values, define_values y constraint_values se pueden usar con cualquier combinación en el mismo config_setting, pero se debe establecer al menos uno para un config_setting dado.

Argumentos

            config_setting(
                name = "a_and_b",
                values = {
                    "define": "a=1",
                    "define": "b=2",
                })
          

            config_setting(
                name = "a_and_b",
                define_values = {
                    "a": "1",
                    "b": "2",
                })
          

grupo de archivos

filegroup(name, srcs, data, compatible_with, deprecation, distribs, features, licenses, output_group, restricted_to, tags, target_compatible_with, testonly, visibility)

Usa filegroup para asignar un nombre conveniente a una colección de objetivos. Luego, se puede hacer referencia a ellos desde otras reglas.

Se recomienda usar filegroup en lugar de hacer referencia a directorios directamente. Este último no tiene sonido, ya que el sistema de compilación no tiene conocimiento completo de todos los archivos que se encuentran debajo del directorio, por lo que es posible que no se vuelva a compilar cuando estos archivos cambien. Cuando se combina con glob, filegroup puede garantizar que el sistema de compilación conozca todos los archivos de forma explícita.

Ejemplos

Para crear un filegroup que consta de dos archivos fuente, haz lo siguiente:

filegroup(
    name = "mygroup",
    srcs = [
        "a_file.txt",
        "some/subdirectory/another_file.txt",
    ],
)

O bien, usa un glob para agrupar un directorio testdata:

filegroup(
    name = "exported_testdata",
    srcs = glob([
        "testdata/*.dat",
        "testdata/logs/**/*.log",
    ]),
)

Para usar estas definiciones, haz referencia a filegroup con una etiqueta de cualquier regla:

cc_library(
    name = "my_library",
    srcs = ["foo.cc"],
    data = [
        "//my_package:exported_testdata",
        "//my_package:mygroup",
    ],
)

Argumentos

genquery

genquery(name, deps, data, compatible_with, compressed_output, deprecation, distribs, exec_compatible_with, exec_properties, expression, features, licenses, opts, restricted_to, scope, strict, tags, target_compatible_with, testonly, visibility)

genquery() ejecuta una consulta especificada en el lenguaje de consulta Blaze y vuelca el resultado en un archivo.

Para mantener la coherencia de la compilación, la consulta solo puede visitar la clausura transitiva de los destinos especificados en el atributo scope. Las consultas que infrinjan esta regla fallarán durante la ejecución si strict no se especifica o es verdadero (si strict es falso, los objetivos fuera del alcance simplemente se omitirán con una advertencia). La forma más fácil de asegurarse de que esto no suceda es mencionar las mismas etiquetas en el alcance que en la expresión de consulta.

La única diferencia entre las consultas permitidas aquí y en la línea de comandos es que aquí no se permiten las consultas que contienen especificaciones de destino de comodines (p. ej., //pkg:* o //pkg:all). Los motivos son dobles: primero, porque genquery debe especificar un alcance para evitar que los destinos fuera del cierre transitivo de la consulta influyan en su resultado y, segundo, porque los archivos BUILD no admiten dependencias de comodín (p. ej., no se permite deps=["//a/..."]).

El resultado de genquery se ordena de forma léxica para aplicar un resultado determinista, a excepción de --output=graph|minrank|maxrank o cuando se usa somepath como la función de nivel superior.

El nombre del archivo de salida es el nombre de la regla.

Ejemplos

En este ejemplo, se escribe la lista de las etiquetas en el cierre transitivo del objetivo especificado en un archivo.

genquery(
    name = "kiwi-deps",
    expression = "deps(//kiwi:kiwi_lib)",
    scope = ["//kiwi:kiwi_lib"],
)

Argumentos

genrule

genrule(name, srcs, outs, cmd, cmd_bash, cmd_bat, cmd_ps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, executable, features, licenses, local, message, output_licenses, output_to_bindir, restricted_to, tags, target_compatible_with, testonly, toolchains, tools, visibility)

Un genrule genera uno o más archivos con un comando Bash definido por el usuario.

Las genrules son reglas de compilación genéricas que puedes usar si no hay una regla específica para la tarea. Por ejemplo, puedes ejecutar una frase en Bash. Sin embargo, si necesitas compilar archivos C++, sigue las reglas de cc_* existentes, ya que se hizo todo el trabajo pesado por ti.

Ten en cuenta que genrule requiere un shell para interpretar el argumento del comando. También es fácil hacer referencia a programas arbitrarios disponibles en PATH. Sin embargo, esto hace que el comando no sea hermético y que no se pueda reproducir. Si solo necesitas ejecutar una sola herramienta, considera usar run_binary en su lugar.

No uses una genrule para ejecutar pruebas. Existen dispensaciones especiales para las pruebas y los resultados de las pruebas, incluidas las políticas de almacenamiento en caché y las variables de entorno. Por lo general, las pruebas deben ejecutarse después de que se complete la compilación y en la arquitectura de destino, mientras que genrules se ejecuta durante la compilación y en la arquitectura de ejecución (las dos pueden ser diferentes). Si necesitas una regla de prueba para uso general, usa sh_test.

Consideraciones sobre la compilación cruzada

Consulta el manual del usuario para obtener más información sobre la compilación cruzada.

Si bien genrules se ejecuta durante una compilación, sus resultados suelen usarse después de la compilación, para la implementación o las pruebas. Considera el ejemplo de la compilación de código C para un microcontrolador: el compilador acepta archivos fuente C y genera código que se ejecuta en un microcontrolador. Obviamente, el código generado no se puede ejecutar en la CPU que se usó para compilarlo, pero el compilador C (si se compila desde la fuente) sí puede hacerlo.

El sistema de compilación usa la configuración de ejecución para describir las máquinas en las que se ejecuta la compilación y la configuración de destino para describir las máquinas en las que se debe ejecutar el resultado de la compilación. Proporciona opciones para configurar cada uno de ellos y segrega los archivos correspondientes en directorios separados para evitar conflictos.

En el caso de genrules, el sistema de compilación se asegura de que las dependencias se compilen de forma adecuada: srcs se compila (si es necesario) para la configuración de target, tools se compila para la configuración de exec y el resultado se considera para la configuración de target. También proporciona variadas variables de "Make" que los comandos genrule pueden pasar a las herramientas correspondientes.

Es intencional que genrule no defina ningún atributo deps: otras reglas integradas usan metainformación dependiente del lenguaje que se pasa entre las reglas para determinar automáticamente cómo controlar las reglas dependientes, pero este nivel de automatización no es posible para genrules. Las genrules funcionan solo a nivel de archivo y runfiles.

Casos especiales

Compilación exec-exec: En algunos casos, el sistema de compilación debe ejecutar genrules para que el resultado también se pueda ejecutar durante la compilación. Por ejemplo, si una genrule compila algún compilador personalizado que luego usa otra genrule, el primero debe producir la salida para la configuración exec, ya que allí es donde se ejecutará el compilador en la otra genrule. En este caso, el sistema de compilación hace lo correcto automáticamente: compila srcs y outs de la primera genrule para la configuración de exec en lugar de la configuración de destino. Consulta el manual del usuario para obtener más información.

Herramientas de JDK y C++: Para usar una herramienta del JDK o del paquete de compiladores de C++, el sistema de compilación proporciona un conjunto de variables que se pueden usar. Consulta Variable "Make" para obtener más detalles.

Entorno de genrule

El comando genrule se ejecuta en una shell de Bash que está configurada para fallar cuando falla un comando o una canalización, con set -e -o pipefail.

La herramienta de compilación ejecuta el comando Bash en un entorno de proceso limpio que solo define variables principales, como PATH, PWD, TMPDIR y algunas otras. Para garantizar que las compilaciones se puedan reproducir, la mayoría de las variables definidas en el entorno de shell del usuario no se pasan al comando de genrule. Sin embargo, Bazel (pero no Blaze) pasa el valor de la variable de entorno PATH del usuario. Cualquier cambio en el valor de PATH hará que Bazel vuelva a ejecutar el comando en la próxima compilación.

Un comando genrule no debe acceder a la red, excepto para conectar procesos que sean secundarios del comando en sí, aunque esto no se aplica actualmente.

El sistema de compilación borra automáticamente los archivos de salida existentes, pero crea los directorios superiores necesarios antes de ejecutar una genrule. También quita los archivos de salida en caso de que se produzca una falla.

Consejos generales

• Asegúrate de que las herramientas que ejecuta una genrule sean deterministas y herméticas. No deben escribir marcas de tiempo en el resultado, y deben usar un orden estable para conjuntos y mapas, además de escribir solo rutas de acceso de archivo relativas al resultado, no absolutas. Si no se sigue esta regla, se generará un comportamiento de compilación inesperado (Bazel no volverá a compilar una genrule que esperabas) y se degradará el rendimiento de la caché.
• Usa $(location) de forma extensa para los resultados, las herramientas y las fuentes. Debido a la segregación de archivos de salida para diferentes configuraciones, genrules no puede depender de rutas de acceso absolutas o hard-coded.
• Escribe una macro Starlark común en caso de que se usen las mismas reglas de generación o reglas muy similares en varios lugares. Si la genrule es compleja, considera implementarla en una secuencia de comandos o como una regla de Starlark. Esto mejora la legibilidad y la capacidad de prueba.
• Asegúrate de que el código de salida indique correctamente el éxito o el fracaso de la genrule.
• No escribas mensajes informativos en stdout ni stderr. Si bien es útil para la depuración, esto puede convertirse fácilmente en ruido. Una genrule correcta debería ser silenciosa. Por otro lado, una genrule que falle debería emitir buenos mensajes de error.
• $$ evaluates to a $, a literal dollar-sign, so in order to invoke a shell command containing dollar-signs such as ls $(dirname $x), one must escape it thus: ls $$(dirname $$x).
• Evita crear symlinks y directorios. Bazel no copia la estructura de directorios o symlinks que crea genrules, y su verificación de dependencias de directorios no es sólida.
• Cuando hagas referencia a genrule en otras reglas, puedes usar la etiqueta de genrule o las etiquetas de los archivos de salida individuales. A veces, un enfoque es más legible, a veces el otro: hacer referencia a salidas por nombre en el srcs de una regla de consumo evitará que se tomen otros resultados de genrule de forma no intencional, pero puede ser tedioso si genrule produce muchos resultados.

Ejemplos

En este ejemplo, se genera foo.h. No hay fuentes, ya que el comando no toma ninguna entrada. El "binario" que ejecuta el comando es una secuencia de comandos de Perl en el mismo paquete que genrule.

genrule(
    name = "foo",
    srcs = [],
    outs = ["foo.h"],
    cmd = "./$(location create_foo.pl) > \"$@\"",
    tools = ["create_foo.pl"],
)

En el siguiente ejemplo, se muestra cómo usar un filegroup y las salidas de otro genrule. Ten en cuenta que usar $(SRCS) en lugar de directivas $(location) explícitas también funcionaría. En este ejemplo, se usa la última opción a modo de demostración.

genrule(
    name = "concat_all_files",
    srcs = [
        "//some:files",  # a filegroup with multiple files in it ==> $(locations)
        "//other:gen",   # a genrule with a single output ==> $(location)
    ],
    outs = ["concatenated.txt"],
    cmd = "cat $(locations //some:files) $(location //other:gen) > $@",
)

Argumentos

starlark_doc_extract

starlark_doc_extract(name, deps, src, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, render_main_repo_name, restricted_to, symbol_names, tags, target_compatible_with, testonly, visibility)

starlark_doc_extract() extrae documentación para reglas, funciones (incluidas las macros), aspectos y proveedores definidos o reexportados en un archivo .bzl o .scl determinado. El resultado de esta regla es un proto binario ModuleInfo como se define en stardoc_output.proto en el árbol de fuentes de Bazel.

Objetivos de salida implícitos

• name.binaryproto (el resultado predeterminado): Es un proto binario ModuleInfo.
• name.textproto (solo se compila si se solicita de forma explícita): la versión de proto de texto de name.binaryproto.

Advertencia: No se garantiza que el formato de salida de esta regla sea estable. Su objetivo principal es el uso interno de Stardoc.

Argumentos

test_suite

test_suite(name, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, target_compatible_with, testonly, tests, visibility)

Un test_suite define un conjunto de pruebas que se consideran "útiles" para los humanos. Esto permite que los proyectos definan conjuntos de pruebas, como "pruebas que debes ejecutar antes del registro", "pruebas de esfuerzo de nuestro proyecto" o "todas las pruebas pequeñas". El comando blaze test respeta este tipo de organización: en una invocación como blaze test //some/test:suite, Blaze primero enumera todos los destinos de prueba incluidos de forma transitiva en el destino //some/test:suite (que llamamos "expansión del paquete de prueba"), luego, Blaze compila y prueba esos destinos.

Ejemplos

Un conjunto de pruebas para ejecutar todas las pruebas pequeñas del paquete actual.

test_suite(
    name = "small_tests",
    tags = ["small"],
)

Un paquete de pruebas que ejecuta un conjunto específico de pruebas:

test_suite(
    name = "smoke_tests",
    tests = [
        "system_unittest",
        "public_api_unittest",
    ],
)

Un paquete de pruebas para ejecutar todas las pruebas del paquete actual que no sean inestables.

test_suite(
    name = "non_flaky_test",
    tags = ["-flaky"],
)

Argumentos