Spec-Zone.ru › Bazel 6.1

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

Правила

  • 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 shell.

См. атрибуты, общие для всех правил тестирования (*_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. Java — зарегистрированный товарный знак Oracle и/или её аффилированных компаний.

Последнее обновление 2023-03-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.1.0/reference/be/shell

Spec-Zone.ru

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