En esta sección, se definen varios términos y conceptos comunes a muchas funciones o reglas de compilación.
Contenido
- Asignación de token de shell Bourne
- Expansión de etiquetas
- Atributos típicos definidos por la mayoría de las reglas de compilación
- Atributos comunes a todas las reglas de compilación
- Atributos comunes a todas las reglas de prueba (*_test)
- Atributos comunes a todas las reglas binarias (*_binary)
- Atributos configurables
- Objetivos de salida implícitos
Asignación de token de shell Bourne
Ciertos atributos de string de algunas reglas se dividen en varias palabras de acuerdo con las reglas de asignación de token de la shell Bourne: los espacios sin comillas delimitan palabras separadas, y los caracteres de comillas simples y dobles y las barras inversas se usan para evitar la asignación de token.
Los atributos que están sujetos a esta asignación de token se indican de forma explícita como tales en sus definiciones en este documento.
Por lo general, los atributos sujetos a la expansión de variables "Make" y a la asignación de token de shell Bourne se usan para pasar opciones arbitrarias a compiladores y otras herramientas. Algunos ejemplos de estos atributos son cc_library.copts y java_library.javacopts.
Juntas, estas sustituciones permiten que una sola variable de string se expanda en una lista de palabras opción específica de la configuración.
Expansión de etiquetas
Algunos atributos de string de muy pocas reglas están sujetos a expansión de etiquetas: si esas strings contienen una etiqueta válida como subcadena, como //mypkg:target, y esa etiqueta es un requisito declarado de la regla actual, se expande al nombre de ruta del archivo representado por el //mypkg:target de destino.
Los atributos de ejemplo incluyen genrule.cmd y cc_binary.linkopts. Los detalles pueden variar de manera significativa en cada caso debido a problemas como la expansión de las etiquetas relativas, la manera en que se tratan las etiquetas que se expanden a varios archivos, etc. Consulta la documentación de los atributos de las reglas para obtener información específica.
Atributos típicos definidos por la mayoría de las reglas de compilación
En esta sección, se describen los atributos definidos por muchas reglas de compilación, pero no por todos.
| Atributo | Descripción |
|---|---|
data |
Lista de etiquetas; el valor predeterminado es Archivos que necesita esta regla en el tiempo de ejecución. Puede enumerar las orientaciones de archivo o regla. Por lo general, permite cualquier destino.
Los resultados y los archivos de ejecución predeterminados de los destinos del atributo
Las reglas nuevas deben definir un atributo |
deps |
Lista de etiquetas; el valor predeterminado es
Dependencias para este destino. Por lo general, solo deben enumerar los objetivos de la regla. (Aunque algunas reglas permiten que los archivos se enumeren directamente en Por lo general, las reglas específicas para un lenguaje limitan los destinos enumerados a aquellos con proveedores específicos.
La semántica precisa de lo que significa que un destino dependa de otro mediante
Por lo general, se usa una dependencia |
licenses |
Lista de strings; no configurable; el valor predeterminado es Una lista de cadenas de tipo de licencia que se usarán para este destino en particular. Esto forma parte de una API de licencias obsoleta que Bazel ya no usa. No lo uses. |
srcs |
Lista de etiquetas; el valor predeterminado es
Archivos procesados o incluidos por esta regla. Por lo general, enumera los archivos directamente, pero
puede enumerar los objetivos de las reglas (como A menudo, las reglas específicas para un lenguaje requieren que los archivos de la lista tengan extensiones de archivo particulares. |
Atributos comunes a todas las reglas de compilación
En esta sección, se describen los atributos que se agregan de forma implícita a todas las reglas de compilación.
| Atributo | Descripción |
|---|---|
compatible_with |
Lista de etiquetas; no configurable; el valor predeterminado es La lista de entornos para los que se puede compilar este destino, además de los entornos compatibles de forma predeterminada. Esto es parte del sistema de restricciones de Bazel, que permite a los usuarios declarar qué destinos pueden y no pueden depender unos de otros. Por ejemplo, los objetos binarios que se pueden implementar de forma externa no deberían depender de bibliotecas con código secreto de la empresa. Consulta ConstraintSemantics para obtener más información. |
deprecation |
String; no configurable; el valor predeterminado es Un mensaje de advertencia explicativo asociado con este destino. Por lo general, se usa para notificar a los usuarios que un objetivo se volvió obsoleto, o que fue sustituido por otra regla, que es privado para un paquete o que se considera perjudicial por algún motivo. Es una buena idea incluir alguna referencia (como una página web, un número de error o ejemplos de CL de migración) para que puedas encontrar con facilidad los cambios necesarios para evitar el mensaje. Si hay un destino nuevo que se puede usar como reemplazo gradual, es una buena idea migrar todos los usuarios del destino anterior.
Este atributo no afecta la forma en que se compilan los elementos, pero puede afectar el resultado del diagnóstico de la herramienta de compilación. La herramienta de compilación emite una advertencia cuando una regla con un atributo Las dependencias dentro del paquete están exentas de esta advertencia, por ejemplo, cuando se compilan las pruebas de una regla obsoleta, no se muestra una advertencia. Si un destino obsoleto depende de otro, no se emite ningún mensaje de advertencia. Una vez que las personas dejen de usarlo, el objetivo se puede quitar. |
distribs |
Lista de strings; no configurable; el valor predeterminado es Una lista de cadenas de método de distribución que se usarán para este destino específico. Esto forma parte de una API de licencias obsoleta que Bazel ya no usa. No lo uses. |
exec_compatible_with |
Lista de etiquetas; no configurable; el valor predeterminado es
Una lista de |
exec_properties |
Diccionario de cadenas; el valor predeterminado es Es un diccionario de cadenas que se agregará al Si una clave está presente en las propiedades del nivel de la plataforma y del objetivo, el valor se tomará del destino. |
features |
Lista de cadenas feature; el valor predeterminado es Un componente es una etiqueta de cadena que se puede habilitar o inhabilitar en un objetivo. El significado de un atributo depende de la regla en sí. Este atributo |
restricted_to |
Lista de etiquetas; no configurable; el valor predeterminado es Es la lista de entornos para los que se puede compilar este destino, en lugar de los entornos compatibles de forma predeterminada.
Esto es parte del sistema de restricciones de Bazel. Consulta |
tags |
Lista de strings; no configurable; el valor predeterminado es
Las etiquetas se pueden usar en cualquier regla. Las etiquetas de prueba y de reglas
Bazel modifica el comportamiento de su código de zona de pruebas si encuentra las siguientes palabras clave en el atributo
Por lo general, se usan etiquetas en las pruebas para anotar la función de una prueba en el proceso de depuración y lanzamiento. Por lo general, las etiquetas son más útiles para las pruebas de C++ y Python, que no tienen capacidad de anotación de tiempo de ejecución. El uso de etiquetas y elementos de tamaño brinda flexibilidad para ensamblar conjuntos de pruebas en función de la política de registro de la base de código.
Bazel modifica el comportamiento de ejecución de pruebas si encuentra las siguientes palabras clave en el atributo
|
target_compatible_with |
Lista de etiquetas; el valor predeterminado es
Es una lista de Los objetivos que dependen de manera transitiva de destinos incompatibles se consideran incompatibles. También se omiten para la compilación y las pruebas. Una lista vacía (predeterminada) significa que el destino es compatible con todas las plataformas.
Todas las reglas que no sean reglas de Workspace admiten este atributo.
En algunas reglas, este atributo no tiene efecto. Por ejemplo, especificar
Consulta la página Plataformas para obtener más información sobre la omisión de destinos incompatibles. |
testonly |
Booleano; no configurable; el valor predeterminado es
Si es
De forma equivalente, una regla que no sea
Las pruebas (reglas Este atributo tiene como objetivo indicar que el destino no debe contener objetos binarios que se lanzan a producción. Debido a que solo el test solo se aplica durante el tiempo de compilación y no de ejecución, y se propaga de forma viral por el árbol de dependencias, se debe aplicar con cuidado. Por ejemplo, los stubs y falsos que son útiles para las pruebas de unidades también pueden ser útiles para las pruebas de integración que involucran los mismos objetos binarios que se lanzarán a producción y, por lo tanto, es probable que no se marquen como solo de prueba. Por el contrario, las reglas que son peligrosas para vincular, quizás porque anulan de forma incondicional el comportamiento normal, definitivamente deben marcarse como solo de prueba. |
toolchains |
Lista de etiquetas; no configurable; el valor predeterminado es
Es el conjunto de objetivos a cuyas variables Make puede acceder este destino. Estos destinos son instancias de reglas que proporcionan
Ten en cuenta que esto es distinto del concepto de resolución de la cadena de herramientas que usan las implementaciones de reglas para la configuración que depende de la plataforma. No puedes usar este atributo para determinar qué |
visibility |
Lista de etiquetas;
no configurable;
el valor predeterminado es
El atributo |
Atributos comunes a todas las reglas de prueba (*_test)
En esta sección, se describen los atributos comunes a todas las reglas de prueba.
| Atributo | Descripción | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
args |
Lista de cadenas; sujeta a la sustitución $(location) y "Make variable", y asignación de token de shell Borne; el valor predeterminado es Argumentos de la línea de comandos que Bazel pasa al destino cuando se ejecuta
con
Estos argumentos se pasan antes que cualquier valor de |
||||||||||||||||||||
env |
Diccionario de cadenas; los valores están sujetos a la sustitución $(location) y "Make variable"; el valor predeterminado es
Especifica las variables de entorno adicionales que se establecerán cuando
Este atributo solo se aplica a reglas nativas, como |
||||||||||||||||||||
env_inherit |
Lista de cadenas; el valor predeterminado es Especifica las variables de entorno adicionales que se heredarán del entorno externo cuando
Este atributo solo se aplica a reglas nativas, como |
||||||||||||||||||||
size |
Cadena Especifica la “pesidad” de un objetivo de prueba, es decir, cuánto tiempo o recursos necesita para ejecutarse. Las pruebas de unidades se consideran “pequeñas”, las pruebas de integración son “medianas” y las pruebas de extremo a extremo son “grandes” o “enormes”. Bazel usa el tamaño para determinar un tiempo de espera predeterminado, que se puede anular con el atributo Los tamaños de prueba corresponden a los siguientes tiempos de espera predeterminados y a los usos máximos estimados de recursos locales:
La variable de entorno |
||||||||||||||||||||
timeout |
Cadena El tiempo que se espera que se ejecute la prueba antes de que se muestre.
Si bien el atributo de tamaño de una prueba controla la estimación de recursos, el tiempo de espera
de una prueba se puede establecer de forma independiente. Si no se especifica de forma explícita, el tiempo de espera se basa en el tamaño de la prueba. El tiempo de espera
de la prueba se puede anular con la marca
En tiempos distintos de los anteriores, el tiempo de espera de la prueba se puede anular con la
marca de Bazel
La variable de entorno |
||||||||||||||||||||
flaky |
Booleano; no configurable; el valor predeterminado es Marca la prueba como inestable. Si se configura, ejecuta la prueba hasta tres veces y la marca como con errores solo si falla cada vez. Según la configuración predeterminada, este atributo se establece como falso y la prueba se ejecuta solo una vez. Ten en cuenta que, en general, no se recomienda el uso de este atributo; las pruebas deben ser exitosas cuando se mantienen sus aserciones. |
||||||||||||||||||||
shard_count |
Número entero no negativo menor o igual que 50; el valor predeterminado es Especifica la cantidad de fragmentos paralelos que se usarán para ejecutar la prueba. Si se establece, este valor anulará cualquier heurística usada para determinar la cantidad de fragmentos paralelos con los que se ejecutará la prueba. Ten en cuenta que, para algunas reglas de prueba, es posible que este parámetro sea necesario para habilitar la fragmentación en primer lugar. Consulta también Si la fragmentación de pruebas está habilitada, la variable de entorno La fragmentación requiere que el ejecutor de pruebas sea compatible con el protocolo de fragmentación de pruebas. Si no es así, es probable que ejecute todas las pruebas en cada fragmento, que no es lo que deseas. Consulta Fragmentación de pruebas en la enciclopedia de pruebas para obtener detalles sobre la fragmentación. |
||||||||||||||||||||
local |
Booleano; no configurable; el valor predeterminado es Fuerza la ejecución local de la prueba, sin zona de pruebas. Si configuras esta opción como verdadera, equivale a proporcionar "local" como una etiqueta ( |
Atributos comunes a todas las reglas binarias (*_binary)
En esta sección, se describen los atributos que son comunes a todas las reglas binarias.
| Atributo | Descripción |
|---|---|
args |
Lista de strings; sujeta a la sustitución $(location) y “Make variable”, y asignación de token de shell Borne; no configurable; el valor predeterminado es
Argumentos de la línea de comandos que Bazel pasará al destino cuando se ejecute
mediante el comando
NOTA: Los argumentos no se pasan cuando ejecutas el destino
fuera de Bazel (por ejemplo, cuando ejecutas el objeto binario de forma manual en
|
env |
Diccionario de cadenas; los valores están sujetos a la sustitución $(location) y "Make variable"; el valor predeterminado es Especifica las variables de entorno adicionales que se establecerán cuando
Este atributo solo se aplica a reglas nativas, como
NOTA: Las variables de entorno no se configuran cuando ejecutas el destino
fuera de Bazel (por ejemplo, cuando ejecutas el objeto binario de forma manual en
|
output_licenses |
Lista de cadenas; el valor predeterminado es Las licencias de los archivos de salida que genera este objeto binario. Esto forma parte de una API de licencias obsoleta que Bazel ya no usa. No lo uses. |
Atributos configurables
La mayoría de los atributos son “configurables”, lo que significa que sus valores pueden cambiar cuando el destino se crea de diferentes maneras. Específicamente, los atributos configurables pueden variar según las marcas que se pasan a la línea de comandos de Bazel o la dependencia descendente que solicita el destino. Se puede usar, por ejemplo, para personalizar el destino para varias plataformas o modos de compilación.
En el siguiente ejemplo, se declaran diferentes orígenes para distintas arquitecturas de destino. La ejecución de bazel build :multiplatform_lib --cpu x86 compilará el destino con x86_impl.cc, mientras que, en cambio, sustituir --cpu arm hará que use arm_impl.cc.
cc_library(
name = "multiplatform_lib",
srcs = select({
":x86_mode": ["x86_impl.cc"],
":arm_mode": ["arm_impl.cc"]
})
)
config_setting(
name = "x86_mode",
values = { "cpu": "x86" }
)
config_setting(
name = "arm_mode",
values = { "cpu": "arm" }
)
La función select() elige entre diferentes valores alternativos para un atributo configurable según los criterios config_setting o constraint_value que satisface la configuración del destino.
Bazel evalúa los atributos configurables después de procesar macros y antes de
procesar las reglas (de manera técnica, entre las
fases de carga y análisis).
Cualquier procesamiento anterior a la evaluación de select() no sabe qué rama elige la select(). Por ejemplo, las macros no pueden cambiar su comportamiento en función de la rama elegida, y bazel query solo puede realizar conjeturas conservadoras sobre las dependencias configurables de un destino. Consulta
estas preguntas frecuentes para obtener más información sobre el uso de select() con reglas y macros.
Los atributos marcados como nonconfigurable en su documentación no pueden usar esta función. Por lo general, un atributo no se puede configurar porque, de forma interna, Bazel necesita conocer su valor antes de determinar cómo resolver un select().
Consulta Atributos de compilación configurables para obtener una descripción general detallada.
Objetivos de salida implícitos
Los resultados implícitos en C++ dejaron de estar disponibles. Evita usarlo en otros idiomas cuando sea posible. Aún no contamos con una ruta de baja, pero con el tiempo también se darán de baja.
Cuando defines una regla de compilación en un archivo BUILD, declaras
de forma explícita un destino de regla nuevo con nombre en un paquete. Muchas funciones de las reglas de compilación también implican de forma implícita uno o más objetivos de archivo de salida, cuyos contenidos y significados son específicos de las reglas.
Por ejemplo, cuando declaras explícitamente una regla java_binary(name='foo', ...), también declaras de forma implícita un destino de archivo de salida foo_deploy.jar como miembro del mismo paquete.
(Este destino específico es un archivo Java autónomo adecuado para la implementación).
Los objetivos de salida implícitos son miembros de primera clase del gráfico de destino global. Al igual que otros destinos, se compilan según demanda, ya sea cuando se especifica en el comando de compilación de nivel superior o cuando son requisitos previos para otros destinos de compilación. Se puede hacer referencia a ellas como dependencias en los archivos BUILD y se pueden observar en el resultado de las herramientas de análisis, como bazel query.
Para cada tipo de regla de compilación, la documentación de la regla incluye una sección especial que detalla los nombres y el contenido de las salidas implícitas relacionadas con una declaración de ese tipo de regla.
Es una distinción importante, pero un tanto sutil, entre los dos espacios de nombres que usa el sistema de compilación: las etiquetas identifican destinos, que pueden ser reglas o archivos, y los destinos de archivo se pueden dividir en destinos de archivo de origen (o de entrada) y objetivos de archivo derivado (o de salida). Estos son los elementos que puedes mencionar en los archivos BUILD, compilar desde la línea de comandos o examinar con bazel query; este es el espacio de nombres de destino. Cada destino de archivo corresponde a un archivo real en el disco (el “espacio de nombres del sistema de archivos”) y cada destino de regla puede corresponder a cero, uno o más archivos reales en el disco.
Es posible que haya archivos en el disco que no tengan un destino correspondiente. Por ejemplo, no se puede hacer referencia a los archivos de objeto .o producidos durante la compilación de C++ desde los archivos BUILD ni desde la línea de comandos.
De esta manera, la herramienta de compilación puede ocultar ciertos detalles de implementación sobre cómo hace su trabajo. Esto se explica con más detalle en la referencia del concepto de COMPILACIÓN.