Nesta seção, definimos vários termos e conceitos comuns a muitas funções ou regras de criação.
Conteúdo
- Tokenização do Bourne Shell
- Expansão de rótulos
- Atributos típicos definidos pela maioria das regras de build
- Atributos comuns a todas as regras de build
- Atributos comuns a todas as regras de teste (*_test)
- Atributos comuns a todas as regras binárias (*_binary)
- Atributos configuráveis
- Destinos de saída implícitos
Tokenização Bourne Shell
Alguns atributos de string de algumas regras são divididos em várias palavras de acordo com as regras de tokenização do shell Bourne: espaços sem aspas delimitam palavras separadas, e caracteres de aspas simples e duplas e barras invertidas são usados para impedir a tokenização.
Os atributos sujeitos a essa tokenização são explicitamente indicados como tal nas definições neste documento.
Os atributos sujeitos à expansão de variável "Make" e a tokenização de shell Bourne são normalmente usados para passar opções arbitrárias para compiladores e outras ferramentas. Exemplos desses atributos são
cc_library.copts
e java_library.javacopts
.
Juntas, essas substituições permitem que uma única variável de string se expanda em uma lista específica da configuração de palavras de opção.
Expansão de rótulos
Alguns atributos de string de poucas regras estão sujeitos à expansão de rótulo: se essas strings contiverem um rótulo válido como uma substring, como //mypkg:target
, e esse rótulo for um pré-requisito declarado da regra atual, ele será expandido para o nome do caminho do arquivo representado pelo //mypkg:target
de destino.
Os exemplos de atributos incluem genrule.cmd
e
cc_binary.linkopts
. Os detalhes podem variar significativamente em cada caso, em relação a problemas como: se rótulos relativos são expandidos, como os rótulos que se expandem para vários arquivos são tratados etc. Consulte a documentação de atributos da regra para mais detalhes.
Atributos típicos definidos pela maioria das regras de compilação
Esta seção descreve os atributos que são definidos por muitas regras de build, mas não por todas.
Atributo | Descrição |
---|---|
data |
Lista de rótulos. O padrão é Arquivos necessários para essa regra no momento da execução. Pode listar segmentações por arquivo ou regras. Geralmente, qualquer destino.
As saídas e os arquivos de execução padrão dos destinos no atributo
As novas regras vão definir um atributo |
deps |
Lista de rótulos. O padrão é
Dependências para esse destino. Em geral, lista apenas os destinos de regra. Embora
algumas regras permitam que os arquivos sejam listados diretamente em As regras específicas do idioma geralmente limitam os destinos listados àqueles com provedores específicos.
A semântica precisa do que um destino significa depender de outra usando
Na maioria das vezes, uma dependência |
licenses |
Lista de strings. Não configurável.
O padrão é Uma lista de strings do tipo licença a serem usadas para esse destino específico. Ela faz parte de uma API de licenciamento descontinuada que o Bazel não usa mais. Não use isso. |
srcs |
Lista de rótulos. O padrão é
São os arquivos processados ou incluídos por essa regra. Geralmente, lista arquivos diretamente, mas
pode listar destinos de regras (como As regras específicas do idioma geralmente exigem que os arquivos listados tenham extensões específicas de arquivo. |
Atributos comuns a todas as regras de build
Esta seção descreve os atributos que são adicionados implicitamente a todas as regras de build.
Atributo | Descrição |
---|---|
compatible_with |
Lista de rótulos,
não configurável. O padrão é A lista de ambientes para os quais este destino pode ser criado, além dos ambientes compatíveis com o padrão. Isso faz parte do sistema de restrições do Bazel, que permite que os usuários declarem quais destinos podem ou não depender uns dos outros. Por exemplo, binários implantáveis externamente não podem depender de bibliotecas com código secreto da empresa. Consulte ConstraintSemantics para mais detalhes. |
deprecation |
String nonconfigurable. O padrão é Uma mensagem de aviso explicativa associada ao destino. Normalmente, isso é usado para notificar os usuários de que um destino se tornou obsoleto ou foi substituído por outra regra, é particular para um pacote ou é considerado nocivo por algum motivo. É uma boa ideia incluir alguma referência (como uma página da Web, um número de bug ou exemplos de CLs de migração) para que seja possível descobrir facilmente quais alterações são necessárias para evitar a mensagem. Se houver um novo destino que possa ser usado como substituição, é uma boa ideia migrar todos os usuários do destino antigo.
Esse atributo não tem efeito na forma como as coisas são criadas, mas
pode afetar a saída de diagnóstico de uma ferramenta de build. A ferramenta de build emite um
aviso quando uma regra com um atributo As dependências intrapacotes estão isentas desse aviso, de modo que, por exemplo, a criação dos testes de uma regra descontinuada não encontre um aviso. Se um destino descontinuado depender de outro destino descontinuado, nenhuma mensagem de aviso será emitida. Depois que as pessoas pararem de usá-lo, a segmentação poderá ser removida. |
distribs |
Lista de strings. Não configurável.
O padrão é Uma lista de strings de método de distribuição a serem usadas para este destino específico. Ela faz parte de uma API de licenciamento descontinuada que o Bazel não usa mais. Não use isso. |
exec_compatible_with |
Lista de rótulos,
não configurável. O padrão é
Uma lista de
|
exec_properties |
Dicionário de strings. O padrão é Um dicionário de strings que serão adicionadas ao Se uma chave estiver presente nas propriedades no nível da plataforma e do destino, o valor será retirado do destino. |
features |
Lista de strings de recursos. O padrão é Um recurso é uma tag de string que pode ser ativada ou desativada em um destino. O significado de um recurso depende da própria regra. Esse atributo |
restricted_to |
Lista de rótulos,
não configurável. O padrão é A lista de ambientes para os quais esse destino pode ser criado em vez de ambientes compatíveis com o padrão.
Isso faz parte do sistema de restrições do Bazel. Consulte
|
tags |
Lista de strings. Não configurável.
O padrão é
Tags podem ser usadas em qualquer regra. Tags nas regras
O Bazel modifica o comportamento do código de sandbox se encontrar as seguintes
palavras-chave no atributo
As tags em testes geralmente são usadas para anotar o papel de um teste no processo de depuração e lançamento. Normalmente, as tags são mais úteis para testes C++ e Python, que não têm capacidade de anotação no ambiente de execução. O uso de tags e elementos de tamanho oferece flexibilidade na montagem de conjuntos de testes com base na política de check-in da base de código.
O Bazel modifica o comportamento de execução do teste se encontra as seguintes palavras-chave no
atributo
|
target_compatible_with |
Lista de rótulos. O padrão é
Uma lista de
Os destinos que dependem transitivamente de destinos incompatíveis também são considerados incompatíveis. Elas também são ignoradas para criação e teste. Uma lista vazia (que é o padrão) significa que o destino é compatível com todas as plataformas.
Todas as regras diferentes das regras do espaço de trabalho aceitam esse
atributo.
Para algumas regras, esse atributo não tem efeito. Por exemplo, especificar
Consulte a página Plataformas para mais informações sobre a incompatibilidade de pular destinos. |
testonly |
Booleano, não configurável. O padrão é
Se for
Igualmente, uma regra que não seja
Os testes (regras Esse atributo significa que o destino não pode estar contido em binários lançados para produção. Como o testonly é aplicado no tempo de compilação, não no ambiente de execução, e se propaga viralmente pela árvore de dependências, ele precisa ser aplicado de forma criteriosa. Por exemplo, stubs e fakes que são úteis para testes de unidade também podem ser úteis para testes de integração envolvendo os mesmos binários que serão lançados para produção e, portanto, provavelmente não podem ser marcados como somente teste. Por outro lado, as regras que são perigosas até mesmo para vincular, talvez por modificarem incondicionalmente o comportamento normal, precisam ser marcadas como somente teste. |
toolchains |
Lista de rótulos,
não configurável. O padrão é
O conjunto de destinos cujas Criar variáveis este destino tem
permissão para acessar. Esses destinos são instâncias de regras que fornecem
Observe que isso é diferente do conceito de resolução do conjunto de ferramentas, usado pelas implementações de regras para configuração dependente da plataforma. Não é possível usar esse
atributo para determinar qual |
visibility |
Lista de rótulos;
não configurável.
O padrão é
O atributo |
Atributos comuns a todas as regras de teste (*_test)
Esta seção descreve os atributos comuns a todas as regras de teste.
Atributo | Descrição | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
args |
Lista de strings, sujeita à substituição $(location) e "Make variables" e à tokenização do shell Bourne. O padrão é Argumentos de linha de comando que o Bazel transmite para o destino quando
executado com
Esses argumentos são passados antes de qualquer valor |
||||||||||||||||||||
env |
Dicionário de strings. Os valores estão sujeitos à substituição $(location) e "Make variables". O padrão é
Especifica outras variáveis de ambiente a serem definidas quando o teste é executado por
Esse atributo só se aplica a regras nativas, como |
||||||||||||||||||||
env_inherit |
Lista de strings. O padrão é Especifica outras variáveis de ambiente a serem herdadas do
ambiente externo quando o teste é executado por
Esse atributo só se aplica a regras nativas, como |
||||||||||||||||||||
size |
String Especifica o "peso" de um destino de teste: quanto tempo/recursos é necessário para executar. Os testes de unidade são considerados "pequenos", os de integração são "médios" e os testes de ponta a ponta são considerados "grandes" ou
"enormes". O Bazel usa o tamanho para determinar um tempo limite padrão, que pode ser substituído usando o
atributo Os tamanhos dos testes correspondem aos seguintes tempos limite padrão e presumimos o uso máximo de recursos locais:
A variável de ambiente
|
||||||||||||||||||||
timeout |
String O tempo que se espera que o teste seja executado antes de retornar.
Embora o atributo de tamanho de um teste controle a estimativa de recursos, o tempo limite
de um teste pode ser definido de forma independente. Se não for especificado explicitamente, o
tempo limite será baseado no tamanho do teste. O tempo limite
do teste pode ser substituído pela sinalização
Para momentos diferentes dos acima, o tempo limite do teste pode ser substituído pela
flag bazel
A variável de ambiente
|
||||||||||||||||||||
flaky |
Booleano, não configurável. O padrão é Marca o teste como instável. Se definido, executa o teste até três vezes, marcando-o como falha apenas em caso de falha todas as vezes. Por padrão, esse atributo é definido como falso e o teste é executado apenas uma vez. O uso desse atributo geralmente não é recomendado. Os testes precisam ser aprovados de forma confiável quando as declarações deles são mantidas. |
||||||||||||||||||||
shard_count |
Número inteiro não negativo menor ou igual a 50. O padrão é Especifica o número de fragmentos paralelos a serem usados para executar o teste. Se definido, esse valor substituirá qualquer heurística usada para determinar o número de fragmentos paralelos com que o teste será executado. Esse parâmetro pode ser necessário para ativar a fragmentação
em algumas regras de teste. Consulte também Se a fragmentação de testes estiver ativada, a variável de ambiente A fragmentação exige que o executor de testes ofereça suporte ao protocolo de fragmentação de testes. Caso contrário, ele provavelmente vai executar todos os testes em cada fragmento, o que não é o que você quer. Consulte Testar fragmentação na enciclopédia de testes para ver mais detalhes sobre a fragmentação. |
||||||||||||||||||||
local |
Booleano, não configurável. O padrão é Força o teste a ser executado localmente, sem sandbox. Definir essa opção como "True" (verdadeira) equivale a fornecer "local" como uma tag
( |
Atributos comuns a todas as regras binárias (*_binary)
Esta seção descreve os atributos comuns a todas as regras binárias.
Atributo | Descrição |
---|---|
args |
Lista de strings, sujeita à substituição
$(location) e
"Criar variável" e
tokenização do shell Bourne,
não configurável.
O padrão é
Argumentos de linha de comando que o Bazel transmitirá para o destino quando ele for executado
pelo comando
OBSERVAÇÃO: os argumentos não são transmitidos quando você executa o destino
fora do Bazel (por exemplo, executando o binário manualmente em
|
env |
Dicionário de strings. Os valores estão sujeitos à substituição $(location) e "Make variables". O padrão é Especifica outras variáveis de ambiente a serem definidas quando o destino é
executado por
Esse atributo só se aplica a regras nativas, como
OBSERVAÇÃO: as variáveis de ambiente não são definidas quando você executa o destino
fora do Bazel (por exemplo, executando manualmente o binário em
|
output_licenses |
Lista de strings. O padrão é As licenças dos arquivos de saída gerados por este binário. Ela faz parte de uma API de licenciamento descontinuada que o Bazel não usa mais. Não use isso. |
Atributos configuráveis
A maioria dos atributos é "configurável", o que significa que os valores podem mudar quando o destino é criado de maneiras diferentes. Especificamente, os atributos configuráveis podem variar com base nas sinalizações passadas para a linha de comando do Bazel ou na dependência downstream que está solicitando o destino. Isso pode ser usado, por exemplo, para personalizar o destino de várias plataformas ou modos de compilação.
O exemplo a seguir declara origens diferentes para arquiteturas de destino
diferentes. A execução de bazel build :multiplatform_lib --cpu x86
criará o destino usando x86_impl.cc
, enquanto a substituição de --cpu arm
fará com que ele use arm_impl.cc
.
cc_library( name = "multiplatform_lib", srcs = select({ ":x86_mode": ["x86_impl.cc"], ":arm_mode": ["arm_impl.cc"] }) ) config_setting( name = "x86_mode", values = { "cpu": "x86" } ) config_setting( name = "arm_mode", values = { "cpu": "arm" } )
A função select()
escolhe entre diferentes valores alternativos para um atributo configurável com base nos critérios config_setting
ou constraint_value
que a configuração de destino atende.
O Bazel avalia os atributos configuráveis após o processamento de macros e antes
das regras de processamento (tecnicamente, entre as
fases de carregamento e análise).
Qualquer processamento antes da avaliação de select()
não sabe qual ramificação o select()
escolhe. As macros, por exemplo, não podem mudar o comportamento delas com base na ramificação escolhida, e bazel query
só pode fazer suposições conservadoras sobre as dependências configuráveis de um destino. Consulte
estas perguntas frequentes
para saber mais sobre o uso de select()
com regras e macros.
Os atributos marcados como nonconfigurable
na documentação não podem
usar esse recurso. Normalmente, um atributo não é configurável porque o Bazel precisa saber o valor dele internamente antes de determinar como resolver um select()
.
Consulte Atributos de build configuráveis para conferir uma visão geral detalhada.
Destinos de saída implícitos
As saídas implícitas em C++ foram descontinuadas. Evite usá-lo em outros idiomas sempre que possível. Ainda não temos um caminho de descontinuação, mas eles também vão ser descontinuados.
Ao definir uma regra de build em um arquivo BUILD, você declara explicitamente um novo destino de regra nomeado em um pacote. Muitas funções de regra de compilação também envolvem implicitamente um ou mais destinos de arquivo de saída, cujo conteúdo e significado são específicos da regra.
Por exemplo, ao declarar explicitamente uma regra java_binary(name='foo', ...)
, você também declara implicitamente o destino foo_deploy.jar
de um arquivo de saída como membro do mesmo pacote.
Esse destino específico é um arquivo Java independente adequado para implantação.
Destinos de saída implícitos são membros de primeira classe do gráfico de destino
global. Assim como outros destinos, eles são criados sob demanda,
quando especificados no comando de build de nível superior ou quando
são pré-requisitos necessários para outros destinos de build. Elas podem ser referenciadas como dependências nos arquivos BUILD e podem ser observadas na saída de ferramentas de análise, como bazel query
.
Para cada tipo de regra de build, a documentação da regra contém uma seção especial que detalha os nomes e o conteúdo de todas as saídas implícitas envolvidas por uma declaração desse tipo de regra.
Uma distinção importante, mas um pouco sutil, entre os
dois namespaces usados pelo sistema de build:
os rótulos identificam destinos,
que podem ser regras ou arquivos, e os destinos de arquivos podem ser divididos em
destinos de arquivos de origem (ou entrada) e destinos de arquivos
derivados (ou de saída). Esses são os itens que você pode mencionar em arquivos BUILD, criar a partir da linha de comando ou examinar usando bazel query
. Esse é o namespace de destino. Cada destino de arquivo corresponde
a um arquivo real no disco (o "namespace do sistema de arquivos").
Cada destino de regra pode corresponder a zero, um ou mais arquivos reais no disco.
Pode haver arquivos no disco sem destino correspondente. Por exemplo, arquivos de objetos .o
produzidos durante a compilação em C++ não podem ser referenciados dentro dos arquivos BUILD ou da linha de comando.
Dessa forma, a ferramenta de build pode ocultar determinados detalhes de implementação de
como ela faz o trabalho. Isso é explicado com mais detalhes na Referência do conceito BUILD.