Spec-Zone.ru › Bazel 6.2

Правила оболочки

Правила

  • sh_binary
  • sh_library
  • sh_test

sh_binary

sh_binary(name, deps, srcs, data, args, compatible_with, deprecation, distribs, env, exec_compatible_with, exec_properties, features, licenses, output_licenses, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

Правило sh_binary используется для объявления исполняемых скриптов оболочки. (sh_binary — неточное название: его выходы необязательно являются двоичными файлами.) Это правило гарантирует, что все зависимости построены и отображаются в области runfiles во время выполнения. Рекомендуется называть ваши правила sh_binary() по имени скрипта без расширения (например, .sh); имя правила и имя файла должны различаться. sh_binary учитывает shebang, поэтому можно использовать любой доступный интерпретатор (например, #!/bin/zsh)

Пример

Для простого скрипта оболочки без зависимостей и некоторых файлах данных:

sh_binary(
    name = "foo",
    srcs = ["foo.sh"],
    data = glob(["datafiles/*.txt"]),
)

Аргументы

Атрибуты
name

Name; required

Уникальное имя для этой цели.

deps

List of labels; optional

Список целей «библиотеки», которые должны быть объединены в эту цель. См. общие замечания о deps в Типичные атрибуты, определенные большинством правил сборки.

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

srcs

List of labels; required

Файл, содержащий скрипт оболочки.

Этот атрибут должен быть списком из одного элемента, содержащего скрипт оболочки. Этот скрипт должен быть исполняемым и может быть исходным файлом или сгенерированным файлом. Все остальные файлы, необходимые во время выполнения (будь то скрипты или данные), должны принадлежать атрибуту data.

sh_library

sh_library(name, deps, srcs, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)

Основное использование этого правила заключается в объединении логической «библиотеки», состоящей из связанных скриптов — программ на интерпретируемом языке, не требующем компиляции или компоновки, например, оболочки Bourne — и любых данных, которые этим программам нужны во время выполнения. Такие «библиотеки» затем могут быть использованы из атрибута data одного или нескольких правил sh_binary.

Вы можете использовать правило filegroup для объединения файлов данных.

В интерпретируемых языках программирования не всегда существует четкое различие между «кодом» и «данными»: в конце концов, программа — это всего лишь «данные» с точки зрения интерпретатора. По этой причине это правило имеет три атрибута, которые по сути являются эквивалентными: srcs, deps и data. Текущая реализация не различает элементы этих списков. Все три атрибута принимают правила, исходные файлы и сгенерированные файлы. Тем не менее, рекомендуется использовать эти атрибуты для их обычного назначения (как и с другими правилами).

Примеры

sh_library(
    name = "foo",
    data = [
        ":foo_service_script",  # an sh_binary with srcs
        ":deploy_foo",  # another sh_binary with srcs
    ],
)

Аргументы

Атрибуты
name

Name; required

Уникальное имя для этой цели.

deps

List of labels; optional

Список целей «библиотеки», которые должны быть объединены в эту цель. См. общие замечания о deps в Типичные атрибуты, определенные большинством правил сборки.

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

srcs

List of labels; optional

Список входных файлов.

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

sh_test

sh_test(name, deps, srcs, data, args, compatible_with, deprecation, distribs, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, licenses, local, restricted_to, shard_count, size, tags, target_compatible_with, testonly, timeout, toolchains, visibility)

Правило sh_test() создаёт тест, написанный как скрипт оболочки Bourne.

См. атрибуты, общие для всех правил тестирования (*_test).

Примеры

sh_test(
    name = "foo_integration_test",
    size = "small",
    srcs = ["foo_integration_test.sh"],
    deps = [":foo_sh_lib"],
    data = glob(["testdata/*.txt"]),
)

Аргументы

Атрибуты
name

Name; required

Уникальное имя для этой цели.

deps

List of labels; optional

Список целей «библиотеки», которые должны быть объединены в эту цель. См. общие замечания о deps в Типичные атрибуты, определенные большинством правил сборки.

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

srcs

List of labels; required

Файл, содержащий скрипт оболочки.

Этот атрибут должен быть списком из одного элемента, содержащего скрипт оболочки. Этот скрипт должен быть исполняемым и может быть исходным файлом или сгенерированным файлом. Все остальные файлы, необходимые во время выполнения (будь то скрипты или данные), должны принадлежать атрибуту data .

За исключением случаев, когда указано иное, содержимое этой страницы лицензируется в соответствии с лицензией Creative Commons Attribution 4.0, а примеры кода лицензируются в соответствии с лицензией Apache 2.0. Подробности см. в Политике Google Developers Site Policies. Java является зарегистрированным товарным знаком Oracle и/или его аффилированных лиц.

Последнее обновление 2023-05-15 UTC.

Licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License.
https://bazel.build/versions/6.2.0/reference/be/shell

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API