Общие определения

List of labels ; optional; nonconfigurable

Список сред, для которых этот целевой объект может быть скомпилирован, помимо сред, поддерживаемых по умолчанию.

Это часть системы ограничений Bazel, которая позволяет пользователям объявлять, какие целевые объекты могут и не могут зависеть друг от друга. Например, внешние исполняемые файлы не должны зависеть от библиотек с конфиденциальным кодом компании. Подробнее см. ConstraintSemantics.

String; optional; nonconfigurable

Объяснительное предупреждение, связанное с этим целевым объектом. Обычно это используется для уведомления пользователей о том, что целевой объект устарел или заменён другой задачей, является закрытым для пакета, или, возможно, вредным по какой-то причине. Желательно включить ссылку (например, на веб-страницу, номер ошибки или примеры исправлений), чтобы легко найти необходимые изменения для устранения сообщения. Если есть новая цель, которая может быть использована как полная замена, рекомендуется просто мигрировать всех пользователей старой цели.

Этот атрибут не влияет на способ построения, но может повлиять на диагностические сообщения инструмента сборки. Инструмент сборки выводит предупреждение, когда правило с атрибутом deprecation используется целевым объектом в другом пакете.

Внутрипакетные зависимости исключены из этого предупреждения, так что, например, построение тестов устаревшего правила не вызовет предупреждение.

После того как люди перестанут его использовать, цель можно удалить.

List of strings; optional; nonconfigurable

Список строк метода распространения, используемых для данной цели. Это часть устаревшего API лицензирования, которым Bazel больше не пользуется. Не используйте это.

List of labels ; optional; nonconfigurable

Список constraint_values, которые должны быть присутствовать в платформе выполнения для данного целевого объекта. Это дополняет любые ограничения, уже установленные типом правила. Ограничения используются для ограничения списка доступных платформ выполнения. Подробнее см. описание разрешения цепочки инструментов.

Dictionary of strings; optional

Словарь строк, которые будут добавлены к exec_properties платформы, выбранной для данного целевого объекта. См. exec_properties правила platform.

Если ключ присутствует как в свойствах платформы, так и в свойствах целевого объекта, значение будет взято из целевого объекта.

List of feature strings; optional

Функция — это строковый тег, который можно включить или отключить для целевого объекта. Значение функции зависит от самого правила.

Этот features атрибут комбинируется с features атрибутом уровня пакета package. Например, если функции ["a", "b"] включены на уровне пакета, а features атрибут целевого объекта содержит ["-a", "c"], функции, включенные для правила, будут "b" и "c". Пример.

List of labels ; optional; nonconfigurable

Список сред, для которых этот целевой объект может быть скомпилирован, вместо сред, поддерживаемых по умолчанию.

Это часть системы ограничений Bazel. См. compatible_with для получения дополнительной информации.

List of strings; optional; nonconfigurable

Теги могут быть использованы для любого правила. Теги для правил тестов и test_suite правил полезны для категоризации тестов. Теги для целевых объектов, не являющихся тестами, используются для управления изолированным выполнением genrule и Starlark действий, а также для парсинга человеком и/или внешними инструментами.

Bazel изменяет поведение своего кода изоляции, если находит следующие ключевые слова в атрибуте tags любого тестового или genrule целевого объекта, или в ключах execution_requirements для любого Starlark действия.

• no-sandbox ключевое слово приводит к тому, что действие или тест никогда не будут изолированы; он всё ещё может быть кэширован или выполнен удалённо - используйте no-cache или no-remote, чтобы предотвратить один или оба этих варианта.
• no-cache ключевое слово приводит к тому, что действие или тест никогда не будут кэшированы (удаленно или локально)
• no-remote-cache ключевое слово приводит к тому, что действие или тест никогда не будут кэшированы удалённо (но могут быть кэшированы локально; они также могут быть выполнены удалённо). Примечание: для целей этого тега кеш на диске считается локальным кешем, а кеши http и gRPC — удалёнными. Если указан комбинированный кеш (т. е. кеш с локальными и удалёнными компонентами), он обрабатывается как удалённый кеш и полностью отключается, если не задан --incompatible_remote_results_ignore_disk, в этом случае будут использоваться локальные компоненты.
• no-remote-exec ключевое слово приводит к тому, что действие или тест никогда не будут выполняться удалённо (но могут быть кэшированы удалённо).
• no-remote ключевое слово предотвращает выполнение действия или теста удалённо или кэширование удалённо. Это эквивалентно использованию как no-remote-cache, так и no-remote-exec.
• no-remote-cache-upload ключевое слово отключает этап загрузки удалённого кэширования спавна. Оно не отключает удалённое выполнение.
• local ключевое слово препятствует удалённому кэшированию, удалённому выполнению или выполнению действия или теста внутри изолированной среды. Для genrules и тестов, маркировка правила атрибутом local = True имеет тот же эффект.
• requires-network ключевое слово разрешает доступ к внешней сети изнутри изолированной среды. Этот тег действует только в том случае, если изоляция включена.
• block-network ключевое слово блокирует доступ к внешней сети изнутри изолированной среды. В этом случае разрешается только общение с localhost. Этот тег действует только в том случае, если изоляция включена.
• requires-fakeroot выполняет тест или действие как пользователь и группа 0 (т. е. root-пользователь). Поддерживается только в Linux. Этот тег имеет приоритет над параметром командной строки --sandbox_fake_username.

Теги для тестов обычно используются для аннотации роли теста в вашем процессе отладки и выпуска. Как правило, теги наиболее полезны для C++ и Python тестов, которые не имеют возможностей для временной аннотации. Использование тегов и элементов размера обеспечивает гибкость в сборке наборов тестов, основанных на политике проверки кода.

Bazel изменяет поведение запуска тестов, если находит следующие ключевые слова в атрибуте tags правила теста:

• exclusive заставит тест выполняться в режиме "исключительности", гарантируя, что в то же время не будут выполняться другие тесты. Такие тесты будут выполняться последовательно после всех операций сборки и неисключительных тестов. Удаленное выполнение отключено для таких тестов, потому что Bazel не контролирует, что выполняется на удалённой машине.
• exclusive-if-local заставит тест выполняться в режиме "исключительности", если он выполняется локально, но выполнит тест параллельно, если он выполняется удалённо.
• manual ключевое слово исключит целевой объект из расширения шаблонов целевых объектов (..., :*, :all, и т. д.) и test_suite правил, которые не указывают тест явно при вычислении набора целевых объектов верхнего уровня для сборки/выполнения команд build, test, и coverage. Это не влияет на расширение шаблонов целевых объектов или наборов тестов в других контекстах, включая команду query. Обратите внимание, что manual не означает, что целевой объект не должен автоматически собираться/выполняться системами непрерывной сборки/тестирования. Например, может быть желательно исключить целевой объект из bazel test ..., потому что он требует определённых флагов Bazel, но всё ещё включать его в правильно настроенные presubmit или непрерывные тесты.
• external ключевое слово принудительно выполнит тест (независимо от значения --cache_test_results).

List of labels ; optional

Список constraint_valueов, которые должны присутствовать в целевой платформе для того, чтобы этот целевой объект считался совместимым. Это дополняет любые ограничения, уже установленные типом правила. Если целевая платформа не удовлетворяет всем перечисленным ограничениям, целевой объект считается несовместимым. Несовместимые целевые объекты пропускаются при сборке и тестировании при расширении шаблона целевых объектов (например, //..., :all). При явном указании в командной строке несовместимые целевые объекты заставляют Bazel вывести ошибку и вызвать сбой сборки или теста.

Целевые объекты, которые транзитивно зависят от несовместимых целевых объектов, сами считаются несовместимыми. Они также пропускаются при сборке и тестировании.

Пустой список (по умолчанию) означает, что целевой объект совместим со всеми платформами.

Все правила, кроме правил рабочего пространства, поддерживают этот атрибут. Для некоторых правил этот атрибут не имеет эффекта. Например, указание target_compatible_with для cc_toolchain не имеет смысла.

См. страницу Платформы для получения дополнительной информации о пропуске несовместимых целевых объектов.

Boolean; optional; default False except for test and test suite targets; nonconfigurable

Если True, только цели testonly (например, тесты) могут зависеть от этой цели.

Эквивалентно, правило, которое не testonly не разрешается зависеть от любого правила, которое testonly.

Тесты (*_test правила) и наборы тестов (test_suite правила) по умолчанию testonly.

Этот атрибут предназначен для того, чтобы цель не содержалась в бинарных файлах, которые выпускаются в производство.

Поскольку testonly применяется во время сборки, а не во время выполнения, и распространяется вирусно по дереву зависимостей, его следует применять с осторожностью. Например, заглушки и фикстуры, которые полезны для модульных тестов, могут быть полезны и для интеграционных тестов, которые используют те же самые бинарные файлы, которые будут выпущены в производство, и поэтому, вероятно, не должны помечаться как testonly. Напротив, правила, которые опасно даже подключать, возможно, потому что они безусловно переопределяют стандартное поведение, определенно должны быть помечены как testonly.

List of labels ; optional; nonconfigurable

Набор целей, к чьим переменным Make у этой цели есть доступ. Эти цели являются экземплярами правил, которые предоставляют TemplateVariableInfo или специальными целями для типов инструментальных цепочек, встроенных в Bazel. Они включают:

• @bazel_tools//tools/cpp:current_cc_toolchain
• @bazel_tools//tools/jdk:current_java_runtime

Обратите внимание, что это отличается от понятия разрешения инструментальных цепочек, которое используется реализациями правил для платформенно-зависимой конфигурации. Вы не можете использовать этот атрибут для определения того, какую конкретную cc_toolchain или java_toolchain цель будет использовать.

List of labels ; optional; default default_visibility from package if specified, or //visibility:private otherwise; nonconfigurable

Атрибут visibility для цели определяет, может ли цель использоваться в других пакетах. См. документацию по видимости.