Regras gerais

Regras

• alias
• config_setting
• grupo de arquivos
• genquery
• regra geral
• starlark_doc_extract
• test_suite

alias

alias(name, actual, compatible_with, deprecation, features, restricted_to, tags, target_compatible_with, testonly, visibility)

A regra alias cria outro nome para o qual a regra pode ser referenciada.

A atribuição de aliases só funciona para destinos "normais". Em particular, package_group e test_suite não podem ter alias.

A atribuição de alias pode ser útil em grandes repositórios, em que renomear um destino exigiria alterações em muitos arquivos. Também é possível usar a regra de alias para armazenar uma chamada de função select se quiser reutilizar essa lógica para vários destinos.

A regra de alias tem a própria declaração de visibilidade. Em todos os outros aspectos, ele se comporta como a regra a que faz referência (por exemplo, testonly no alias é ignorado, e a condição somente teste da regra referenciada é usada), com algumas pequenas exceções:

• Os testes não são executados se o alias é mencionado na linha de comando. Para definir um alias que execute o teste referenciado, use uma regra test_suite com um único destino no atributo tests.
• Ao definir grupos de ambiente, os aliases para as regras environment não são compatíveis. Eles também não são compatíveis com a opção de linha de comando --target_environment.

Exemplos

filegroup(
    name = "data",
    srcs = ["data.txt"],
)

alias(
    name = "other",
    actual = ":data",
)

Argumentos

config_setting

config_setting(name, constraint_values, define_values, deprecation, distribs, features, flag_values, licenses, tags, testonly, values, visibility)

Corresponde a um estado de configuração esperado (expresso como sinalizações de build ou restrições de plataforma) para acionar atributos configuráveis. Consulte Selecionar para saber como consumir essa regra e Atributos configuráveis para uma visão geral do recurso geral.

Exemplos

O código a seguir corresponde a qualquer build que defina --compilation_mode=opt ou -c opt (explicitamente na linha de comando ou implicitamente de arquivos .bazelrc):

  config_setting(
      name = "simple",
      values = {"compilation_mode": "opt"}
  )
  

O código a seguir corresponde a qualquer build destinado ao ARM e aplica a definição personalizada FOO=bar (por exemplo, bazel build --cpu=arm --define FOO=bar ...):

  config_setting(
      name = "two_conditions",
      values = {
          "cpu": "arm",
          "define": "FOO=bar"
      }
  )
  

O exemplo a seguir corresponde a qualquer build que defina uma sinalização definida pelo usuário --//custom_flags:foo=1, seja explicitamente na linha de comando ou implicitamente de arquivos .bazelrc:

  config_setting(
      name = "my_custom_flag_is_set",
      flag_values = { "//custom_flags:foo": "1" },
  )
  

O exemplo a seguir corresponde a qualquer build destinado a uma plataforma com arquitetura x86_64 e glibc versão 2.25, supondo a existência de um constraint_value com o rótulo //example:glibc_2_25. Observe que uma plataforma ainda corresponde se define valores de restrição adicionais além desses dois.

  config_setting(
      name = "64bit_glibc_2_25",
      constraint_values = [
          "@platforms//cpu:x86_64",
          "//example:glibc_2_25",
      ]
  )
  

Observações

• Consulte select para saber o que acontece quando vários config_settings correspondem ao estado de configuração atual.
• Para flags compatíveis com formas abreviadas (por exemplo, --compilation_mode x -c), as definições de values precisam usar o formato completo. Elas fazem correspondência automática com as invocações usando qualquer um dos formatos.
• Se uma flag assumir vários valores, como --copt=-Da --copt=-Db ou uma flag Starlark do tipo lista, values = { "flag": "a" } vai fazer a correspondência se "a" estiver presente em qualquer lugar da lista real.

  values = { "myflag": "a,b" } funciona da mesma maneira: isso corresponde a --myflag=a --myflag=b, --myflag=a --myflag=b --myflag=c, --myflag=a,b e --myflag=c,b,a. A semântica exata varia entre as sinalizações. Por exemplo, --copt não oferece suporte a vários valores na mesma instância: --copt=a,b produz ["a,b"] enquanto --copt=a --copt=b produz ["a", "b"]. Portanto, values = { "copt": "a,b" } corresponde ao primeiro, mas não ao último. Mas --ios_multi_cpus (para regras da Apple) faz: -ios_multi_cpus=a,b e ios_multi_cpus=a --ios_multi_cpus=b produzem ["a", "b"]. Verifique as definições de sinalização e teste suas condições com cuidado para analisar as expectativas exatas.

• Se você precisar definir condições que não sejam modeladas por flags de build integradas, use flags definidas pelo Starlark. Também é possível usar --define, mas isso oferece um suporte mais fraco e não é recomendado. Clique aqui para ver mais informações.
• Evite repetir definições de config_setting idênticas em pacotes diferentes. Em vez disso, referencie um config_setting comum definido em um pacote canônico.
• values, define_values e constraint_values podem ser usados em qualquer combinação no mesmo config_setting, mas pelo menos um deles precisa ser definido para qualquer config_setting.

Argumentos

            config_setting(
                name = "a_and_b",
                values = {
                    "define": "a=1",
                    "define": "b=2",
                })
          

            config_setting(
                name = "a_and_b",
                define_values = {
                    "a": "1",
                    "b": "2",
                })
          

grupo de arquivos

filegroup(name, srcs, data, compatible_with, deprecation, distribs, features, licenses, output_group, restricted_to, tags, target_compatible_with, testonly, visibility)

Use filegroup para dar um nome conveniente a uma coleção de destinos. Elas podem ser referenciadas em outras regras.

É recomendável usar filegroup em vez de referenciar diretórios diretamente. O segundo não é confiável, porque o sistema de compilação não tem conhecimento total de todos os arquivos abaixo do diretório. Portanto, ele pode não ser recompilado quando esses arquivos forem alterados. Quando combinado com o glob, o filegroup pode garantir que todos os arquivos sejam explicitamente conhecidos pelo sistema de build.

Exemplos

Para criar um filegroup que consiste em dois arquivos de origem,

filegroup(
    name = "mygroup",
    srcs = [
        "a_file.txt",
        "some/subdirectory/another_file.txt",
    ],
)

Ou use um glob para monitorar um diretório de dados de teste:

filegroup(
    name = "exported_testdata",
    srcs = glob([
        "testdata/*.dat",
        "testdata/logs/**/*.log",
    ]),
)

Para usar essas definições, faça referência ao filegroup com um rótulo de qualquer regra:

cc_library(
    name = "my_library",
    srcs = ["foo.cc"],
    data = [
        "//my_package:exported_testdata",
        "//my_package:mygroup",
    ],
)

Argumentos

Genquery

genquery(name, deps, data, compatible_with, compressed_output, deprecation, distribs, exec_compatible_with, exec_properties, expression, features, licenses, opts, restricted_to, scope, strict, tags, target_compatible_with, testonly, visibility)

genquery() executa uma consulta especificada na linguagem de consulta Blaze e despeja o resultado em um arquivo.

Para manter o build consistente, a consulta só pode visitar o fechamento transitivo dos destinos especificados no atributo scope. As consultas que violam essa regra falharão durante a execução se strict não for especificado ou for verdadeiro. Se strict for falso, os destinos fora do escopo serão simplesmente ignorados com um aviso. A maneira mais fácil de garantir que isso não aconteça é mencionar os mesmos rótulos no escopo e na expressão de consulta.

A única diferença entre as consultas permitidas aqui e na linha de comando é que as consultas que contêm especificações de destino de caracteres curinga (por exemplo, //pkg:* ou //pkg:all) não são permitidas aqui. Há dois motivos para isso: primeiro, porque genquery precisa especificar um escopo para evitar que destinos fora do fechamento transitivo da consulta influenciem a saída e, segundo, porque os arquivos BUILD não são compatíveis com dependências de caracteres curinga (por exemplo, deps=["//a/..."] não é permitido).

A saída do genquery é ordenada lexicograficamente para impor a saída determinística, com exceção de --output=graph|minrank|maxrank ou quando somepath é usado como a função de nível superior.

O nome do arquivo de saída é o nome da regra.

Exemplos

Neste exemplo, gravamos a lista dos rótulos no fechamento transitivo do destino especificado em um arquivo.

genquery(
    name = "kiwi-deps",
    expression = "deps(//kiwi:kiwi_lib)",
    scope = ["//kiwi:kiwi_lib"],
)

Argumentos

regra geral

genrule(name, srcs, outs, cmd, cmd_bash, cmd_bat, cmd_ps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, executable, features, licenses, local, message, output_licenses, output_to_bindir, restricted_to, tags, target_compatible_with, testonly, toolchains, tools, visibility)

Um genrule gera um ou mais arquivos usando um comando Bash definido pelo usuário.

As regras gerais são regras de criação genéricas que podem ser usadas se não houver uma regra específica para a tarefa. Por exemplo, é possível executar um Bash de uma linha. No entanto, se você precisar compilar arquivos C++, siga as regras cc_* existentes, porque todo o trabalho pesado já foi feito para você.

Observe que a regra geral exige um shell para interpretar o argumento de comando. Também é fácil referenciar programas arbitrários disponíveis no PATH. No entanto, isso torna o comando não hermético e pode não ser reproduzível. Se você precisar executar apenas uma ferramenta, use o run_binary.

Não use uma regra geral para executar testes. Há distribuições especiais para testes e resultados de testes, incluindo políticas de armazenamento em cache e variáveis de ambiente. Os testes geralmente precisam ser executados após a conclusão da compilação e na arquitetura de destino, enquanto as regras gerais são executadas durante a criação e na arquitetura exec (as duas podem ser diferentes). Se você precisar de uma regra de teste de uso geral, use sh_test.

Considerações sobre compilação cruzada

Consulte o manual do usuário para mais informações sobre a compilação cruzada.

Enquanto as regras gerais são executadas durante uma build, as saídas delas geralmente são usadas após a criação, para implantação ou teste. Considere o exemplo de compilação de código C para um microcontrolador: o compilador aceita arquivos-fonte C e gera um código que é executado em um microcontrolador. Obviamente, o código gerado não pode ser executado na CPU usada para criá-lo, mas o próprio compilador C (se compilado da origem) precisará fazer isso.

O sistema de build usa a configuração "exec" para descrever as máquinas em que o build é executado e a configuração de destino para descrever as máquinas em que a saída do build precisa ser executada. Ele oferece opções para configurar cada um deles e segrega os arquivos correspondentes em diretórios separados para evitar conflitos.

Para genrules, o sistema de build garante que as dependências sejam criadas corretamente: srcs são criadas (se necessário) para a configuração target, tools são criadas para a configuração exec e a saída é considerada para a configuração target. Ele também fornece variáveis "Make" que os comandos de regra possam passar para as ferramentas correspondentes.

É intencional que a regra geral não defina nenhum atributo deps: outras regras integradas usam metainformações dependentes de idioma transmitidas entre as regras para determinar automaticamente como lidar com regras dependentes, mas esse nível de automação não é possível para regras gerais. As regras gerais funcionam exclusivamente no nível de arquivo e de arquivos de execução.

Casos especiais

Compilação Exec-exec: em alguns casos, o sistema de build precisa executar regras gerais de maneira que a saída também possa ser executada durante o build. Se, por exemplo, uma regra geral compilar um compilador personalizado que será usado posteriormente por outra regra, o primeiro precisará produzir a saída para a configuração "exec", porque é nele que o compilador será executado na outra regra. Nesse caso, o sistema de compilação faz a coisa certa automaticamente: ele cria srcs e outs da primeira genrule para a configuração exec em vez da configuração de destino. Para mais informações, consulte o manual do usuário.

Ferramentas JDK e C++: para usar uma ferramenta do JDK ou do pacote do compilador C++, o sistema de build fornece um conjunto de variáveis para uso. Consulte a variável"Make" para mais detalhes.

Ambiente de regra geral

O comando genrule é executado por um shell Bash configurado para falhar quando um comando ou um pipeline falha, usando set -e -o pipefail.

A ferramenta de build executa o comando Bash em um ambiente de processo limpo que define apenas as principais variáveis, como PATH, PWD, TMPDIR e algumas outras. Para garantir que os builds sejam reproduzíveis, a maioria das variáveis definidas no ambiente shell do usuário não é transmitida para o comando do genrule. No entanto, o Bazel (mas não o Blaze) transmite o valor da variável de ambiente PATH do usuário. Qualquer alteração no valor de PATH fará com que o Bazel execute novamente o comando na próxima compilação.

Um comando genrule não pode acessar a rede, exceto para conectar processos que são filhos do próprio comando, embora isso não esteja aplicado no momento.

O sistema de compilação exclui automaticamente todos os arquivos de saída existentes, mas cria todos os diretórios pais necessários antes de executar uma regra geral. Ele também remove todos os arquivos de saída em caso de falha.

Recomendações gerais

• Certifique-se de que as ferramentas executadas por uma regra geral sejam deterministas e herméticas. Eles não podem gravar carimbos de data/hora na saída e precisam usar uma ordem estável para conjuntos e mapas, além de gravar somente caminhos de arquivo relativos para a saída, sem caminhos absolutos. Não seguir essa regra levará a um comportamento de compilação inesperado (o Bazel não recriará uma regra geral que você imaginava) e degradar o desempenho do cache.
• Use $(location) extensivamente para saídas, ferramentas e fontes. Devido à segregação dos arquivos de saída para diferentes configurações, as regras gerais não podem depender de caminhos absolutos e/ou codificados.
• Escreva uma macro Starlark comum caso as regras gerais iguais ou muito semelhantes sejam usadas em vários locais. Se a regra geral for complexa, considere implementá-la em um script ou como uma regra Starlark. Isso melhora a legibilidade e a capacidade de teste.
• Certifique-se de que o código de saída indique corretamente o sucesso ou a falha da regra geral.
• Não grave mensagens informativas em stdout ou stderr. Embora seja útil para a depuração, isso pode facilmente se tornar ruído. Uma regra geral bem-sucedida deve ser silenciosa. Por outro lado, uma regra geral com falha emite boas mensagens de erro.
• $$ evaluates to a $, a literal dollar-sign, so in order to invoke a shell command containing dollar-signs such as ls $(dirname $x), one must escape it thus: ls $$(dirname $$x).
• Evite criar links simbólicos e diretórios. Ele não copia a estrutura de diretório/link simbólico criada por regras gerais, e a verificação de dependências dos diretórios não é instável.
• Ao fazer referência à regra geral em outras regras, é possível usar o rótulo dela ou de arquivos de saída individuais. Às vezes, a única abordagem é mais legível, às vezes a outra: referenciar as saídas pelo nome no srcs de uma regra de consumo evita a seleção não intencional de outras saídas da regra geral, mas pode ser tedioso se a regra geral produzir muitas saídas.

Exemplos

Este exemplo gera foo.h. Não há origens porque o comando não recebe nenhuma entrada. O "binário" executado pelo comando é um script Perl no mesmo pacote que a regra geral.

genrule(
    name = "foo",
    srcs = [],
    outs = ["foo.h"],
    cmd = "./$(location create_foo.pl) > \"$@\"",
    tools = ["create_foo.pl"],
)

O exemplo a seguir mostra como usar um filegroup e as saídas de outro genrule. Observe que o uso de $(SRCS) em vez de diretivas $(location) explícitas também funciona. Este exemplo usa as últimas para demonstração.

genrule(
    name = "concat_all_files",
    srcs = [
        "//some:files",  # a filegroup with multiple files in it ==> $(locations)
        "//other:gen",   # a genrule with a single output ==> $(location)
    ],
    outs = ["concatenated.txt"],
    cmd = "cat $(locations //some:files) $(location //other:gen) > $@",
)

Argumentos

starlark_doc_extract

starlark_doc_extract(name, deps, src, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, render_main_repo_name, restricted_to, symbol_names, tags, target_compatible_with, testonly, visibility)

starlark_doc_extract() extrai a documentação de regras, funções (incluindo macros), aspectos e provedores definidos ou reexportados em um determinado arquivo .bzl ou .scl. A saída dessa regra é um .proto binário ModuleInfo, conforme definido em stardoc_output.proto na árvore de origem do Bazel.

Destinos de saída implícitos

• name.binaryproto (a saída padrão): um proto binário ModuleInfo.
• name.textproto (criado apenas se solicitado explicitamente): a versão .proto de texto de name.binaryproto.

Aviso: não há garantia de que o formato de saída desta regra seja estável. Ele é destinado principalmente para uso interno pelo Stardoc.

Argumentos

test_suite

test_suite(name, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, target_compatible_with, testonly, tests, visibility)

Uma test_suite define um conjunto de testes considerados "úteis" para humanos. Isso permite que os projetos definam conjuntos de testes, como "testes que precisam ser executados antes do check-in", "testes de estresse do nosso projeto" ou "todos os testes pequenos". O comando blaze test respeita esse tipo de organização: para uma invocação como blaze test //some/test:suite, o Blaze primeiro enumera todos os destinos de teste incluídos transitivamente pelo destino //some/test:suite (chamamos de "expansão test_suite"). Em seguida, o Blaze cria e testa esses destinos.

Exemplos

Um pacote para executar todos os testes pequenos no pacote atual.

test_suite(
    name = "small_tests",
    tags = ["small"],
)

Um pacote que executa um conjunto específico de testes:

test_suite(
    name = "smoke_tests",
    tests = [
        "system_unittest",
        "public_api_unittest",
    ],
)

Um pacote para executar todos os testes no pacote atual que não são instáveis.

test_suite(
    name = "non_flaky_test",
    tags = ["-flaky"],
)

Argumentos