Правила рабочей области

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

Примечание: помимо собственных правил рабочей области, Bazel также включает различные правила рабочей области Starlark, в частности, те, которые предназначены для работы с git-репозиториями или архивами, размещенными в сети.

Правила

• bind
• local_repository
• new_local_repository

bind

bind(name, actual, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)

Предупреждение: использование bind() не рекомендуется. См. "Рассмотрите возможность удаления bind" для подробного обсуждения проблем и альтернатив. В частности, рассмотрите использование repo_mapping атрибутов репозитория.

Предупреждение: select() нельзя использовать в bind(). См. Раздел вопросов и ответов по настраиваемым атрибутам для получения дополнительной информации.

Присваивает целевому объекту псевдоним в пакете //external.

Пакет //external не является "обычным" пакетом: в нём нет каталога external/, поэтому его можно рассматривать как "виртуальный пакет", содержащий все привязанные целевые объекты.

Примеры

Чтобы присвоить целевому объекту псевдоним, необходимо bind его в файле WORKSPACE. Например, предположим, что есть целевой объект java_library под названием //third_party/javacc-v2. Его можно присвоить, добавив следующее в файл WORKSPACE:

bind(
    name = "javacc-latest",
    actual = "//third_party/javacc-v2",
)

Теперь целевые объекты могут зависеть от //external:javacc-latest вместо //third_party/javacc-v2. Если javacc-v3 будет выпущен, правило bind можно обновить, и все файлы BUILD, зависящие от //external:javacc-latest, теперь будут зависеть от javacc-v3 без необходимости редактирования.

Bind также можно использовать для обеспечения доступности целевых объектов во внешних репозиториях для вашей рабочей области. Например, если в файле WORKSPACE импортирован удаленный репозиторий под названием @my-ssl и у него есть целевой объект cc_library //src:openssl-lib, вы можете создать псевдоним для этого целевого объекта, используя bind.

bind(
    name = "openssl",
    actual = "@my-ssl//src:openssl-lib",
)

Затем в файле BUILD в вашей рабочей области привязанный целевой объект может использоваться следующим образом:

cc_library(
    name = "sign-in",
    srcs = ["sign_in.cc"],
    hdrs = ["sign_in.h"],
    deps = ["//external:openssl"],
)

Внутри sign_in.cc и sign_in.h, к заголовочным файлам, экспонируемым //external:openssl, можно обратиться, используя путь относительно корня их репозитория. Например, если определение правила для @my-ssl//src:openssl-lib выглядит так:

cc_library(
    name = "openssl-lib",
    srcs = ["openssl.cc"],
    hdrs = ["openssl.h"],
)

Тогда включения sign_in.cc могут выглядеть так:

#include "sign_in.h"
#include "src/openssl.h"

Аргументы

Атрибуты
name	Name; required Уникальное имя для этого целевого объекта.
actual	Label; optional Целевой объект, который необходимо сделать псевдонимом. Этот целевой объект должен существовать, но может быть любого типа правила (включая bind). Если этот атрибут опущен, правила, ссылающиеся на этот целевой объект в //external, просто не увидят это зависимость. Обратите внимание, что это отличается от полного пропуска правила bind: это ошибка, если зависимость //external не имеет связанного с ней правила bind.

local_repository

local_repository(name, path, repo_mapping)

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

Примеры

Предположим, что текущий репозиторий — это клиент чата, расположенный в каталоге ~/chat-app. Он хочет использовать библиотеку SSL, определённую в другом репозитории: ~/ssl. Библиотека SSL имеет целевой объект //src:openssl-lib.

Пользователь может добавить зависимость от этого целевого объекта, добавив следующие строки в ~/chat-app/WORKSPACE:

local_repository(
    name = "my-ssl",
    path = "/home/user/ssl",
)

Целевые объекты будут указывать @my-ssl//src:openssl-lib в качестве зависимости, чтобы зависеть от этой библиотеки.

Аргументы

Атрибуты
name	Name; required Уникальное имя для этого целевого объекта.
path	String; required Путь к каталогу локального репозитория. Этот путь должен указывать на каталог, содержащий файл WORKSPACE репозитория. Путь может быть абсолютным или относительным к файлу WORKSPACE основного репозитория.
repo_mapping	Dictionary: String -> String; optional Словарь из локального имени репозитория в глобальное имя репозитория. Это позволяет контролировать разрешение зависимостей рабочей области для зависимостей этого репозитория. Например, запись "@foo": "@bar" объявляет, что всякий раз, когда этот репозиторий зависит от "@foo" (например, зависимость от "@foo//some:target" ), он должен фактически разрешать эту зависимость в глобально объявленном "@bar" ("@bar//some:target").

new_local_repository

new_local_repository(name, build_file, build_file_content, path, repo_mapping, workspace_file, workspace_file_content)

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

Это правило создаёт репозиторий Bazel, создавая файл WORKSPACE и подкаталог, содержащий ссылки на файл BUILD и заданный путь. Файл сборки должен создавать целевые объекты относительно path. Для каталогов, уже содержащих файл WORKSPACE и файл BUILD, можно использовать правило local_repository.

Примеры

Предположим, что текущий репозиторий — это клиент чата, расположенный в каталоге ~/chat-app. Он хочет использовать библиотеку SSL, определённую в другом каталоге: ~/ssl.

Пользователь может добавить зависимость, создав файл BUILD для библиотеки SSL (~/chat-app/BUILD.my-ssl) со следующим содержимым:

java_library(
    name = "openssl",
    srcs = glob(['*.java'])
    visibility = ["//visibility:public"],
)

Затем они могут добавить следующие строки в ~/chat-app/WORKSPACE:

new_local_repository(
    name = "my-ssl",
    path = "/home/user/ssl",
    build_file = "BUILD.my-ssl",
)

Это создаст репозиторий @my-ssl, который создаёт символическую ссылку на /home/user/ssl. Целевые объекты могут зависеть от этой библиотеки, добавив @my-ssl//:openssl в зависимости целевого объекта.

Вы также можете использовать new_local_repository для включения отдельных файлов, а не только каталогов. Например, предположим, что у вас есть файл jar по адресу /home/username/Downloads/piano.jar. Вы можете добавить только этот файл в свою сборку, добавив следующее в файл WORKSPACE:

new_local_repository(
    name = "piano",
    path = "/home/username/Downloads/piano.jar",
    build_file = "BUILD.piano",
)

И создав следующий файл BUILD.piano:

java_import(
    name = "play-music",
    jars = ["piano.jar"],
    visibility = ["//visibility:public"],
)

Тогда целевые объекты могут зависеть от @piano//:play-music для использования piano.jar.

Аргументы

Атрибуты
name	Name; required Уникальное имя для этого целевого объекта.
build_file	String; optional Файл, используемый в качестве файла BUILD для этого каталога. Должен быть указан либо build_file, либо build_file_content. Этот атрибут является меткой, относительной к основной рабочей области. Файл не обязательно должен именоваться BUILD, но может.
build_file_content	String; optional Содержимое файла BUILD для этого репозитория. Должен быть указан либо build_file, либо build_file_content.
path	String; required Путь в локальной файловой системе. Этот путь может быть абсолютным или относительным к файлу WORKSPACE основного репозитория.
repo_mapping	Dictionary: String -> String; optional Словарь из локального имени репозитория в глобальное имя репозитория. Это позволяет контролировать разрешение зависимостей рабочей области для зависимостей этого репозитория. Например, запись "@foo": "@bar" объявляет, что всякий раз, когда этот репозиторий зависит от "@foo" (например, зависимость от "@foo//some:target" ), он должен фактически разрешать эту зависимость в глобально объявленном "@bar" ("@bar//some:target").
workspace_file	String; optional Файл, используемый в качестве файла WORKSPACE для этого репозитория. Должен быть указан либо workspace_file, либо workspace_file_content, но не оба. Этот атрибут является меткой, относительной к основной рабочей области. Файл не обязательно должен именоваться WORKSPACE, но может.
workspace_file_content	String; optional Содержимое файла WORKSPACE для этого репозитория. Должен быть указан либо workspace_file, либо workspace_file_content, но не оба.