Definições comuns

List of labels ; optional

Arquivos necessários para esta regra no momento da execução. Pode listar destinos de arquivos ou regras. Geral permite qualquer destino.

As saídas e os arquivos de execução padrão dos destinos no atributo data aparecerá na área *.runfiles de qualquer executável que esteja saída ou tem uma dependência de tempo de execução nesse destino. Isso pode incluir dados ou binários usados quando o destino srcs são executadas. Consulte a dependências de dados para mais informações sobre como depender e usar arquivos de dados.

As novas regras precisam definir um atributo data se processarem entradas que podem usar outras entradas no ambiente de execução. Regras funções de implementação também deve preencher o runfiles das saídas e arquivos de execução de qualquer atributo data além de arquivos de execução de qualquer atributo de dependência que forneça dependências de código-fonte ou ambiente de execução.

List of labels ; optional

Dependências deste destino. Em geral, deve listar apenas destinos de regras. (Embora algumas regras permitem que os arquivos sejam listados diretamente em deps, este deve ser evitado sempre que possível.)

Regras específicas de idioma geralmente limitam os destinos listados àqueles com provedores específicos.

a semântica precisa do que significa um alvo depender de outro usando deps são específicos ao tipo de regra e às regras mais detalhes. Para regras que processam código-fonte, deps geralmente especifica as dependências de código usadas pelo código em srcs.

Na maioria das vezes, uma dependência deps é usada para permitir que um módulo use símbolos definidos em outro módulo escrito na mesma linguagem de programação e compilado separadamente. As dependências entre linguagens também são permitidas em vários casos: por exemplo, um destino java_library pode depender do código C++. em um destino cc_library, listando o último no deps. Veja a definição de dependências para mais informações.

List of strings; optional; nonconfigurable

Uma lista de strings do tipo de licença a serem usadas para esse destino específico. Isso faz parte de uma API de licenciamento descontinuada que o Bazel não usa mais. O que não fazer use isso.

List of labels ; optional

São os arquivos processados ou incluídos por esta regra. Geralmente, lista os arquivos diretamente, pode listar destinos de regras (como filegroup ou genrule) para incluem as saídas padrão.

As regras específicas de um idioma geralmente exigem que os arquivos listados tenham determinadas extensões de arquivo.

List of labels ; optional; nonconfigurable

A lista de ambientes para os quais esse destino pode ser criado, além dos ambientes com suporte padrão.

Isso faz parte do sistema de restrições do Bazel, que permite aos usuários declarar quais podem e não podem depender uns dos outros. Por exemplo, implantações externas os binários não devem depender de bibliotecas com código secreto da empresa. Consulte ConstraintSemantics para mais detalhes.

String; optional; nonconfigurable

Uma mensagem de aviso explicativa associada a esse destino. Normalmente, isso é usado para notificar os usuários de que um destino se tornou obsoleto, seja substituído por outra regra, seja particular a um pacote ou seja considerados nocivos por algum motivo. É uma boa ideia incluir alguma referência (como uma página da Web, um número de bug ou exemplo de CLs de migração) para para que você possa 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, ele será É uma boa ideia migrar todos os usuários do destino antigo.

Esse atributo não afeta a forma como as coisas são construídas, 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 deprecation for dependem de um alvo em outro pacote.

As dependências dentro do pacote estão isentas desse aviso. Assim, Por exemplo, criar os testes de uma regra descontinuada não encontrar um aviso.

Se um destino descontinuado depender de outro destino descontinuado, nenhum aviso é emitida.

Depois que as pessoas pararem de usá-lo, o alvo poderá ser removido.

List of strings; optional; nonconfigurable

Uma lista de strings do método de distribuição a serem usadas para esse destino específico. Isso faz parte de uma API de licenciamento descontinuada que o Bazel não usa mais. O que não fazer use isso.

List of labels ; optional; nonconfigurable

Uma lista de constraint_values que precisam estar presentes na plataforma de execução para o destino. Isso está em além das restrições já definidas pelo tipo de regra. As restrições são usadas para restringir a lista de plataformas de execução disponíveis. Para mais detalhes, consulte a descrição resolução do conjunto de ferramentas.

Dictionary of strings; optional

Um dicionário de strings que será adicionado ao exec_properties de uma plataforma selecionada para esse destino. Consulte o exec_properties da regra de platform.

Se uma chave estiver presente nas propriedades no nível da plataforma e no nível do destino, o valor será retirado do destino.

List of feature strings; optional

Um recurso é uma tag de string que pode ser ativada ou desativada em um destino. A significado de um atributo depende da própria regra.

Esse atributo features é combinado com o atributo features no nível do pacote. Por exemplo, se os atributos ["a", "b"] estão ativados no nível do pacote, e o objeto O atributo features contém ["-a", "c"], os recursos ativados para o regra será "b" e "c". Confira um exemplo.

List of labels ; optional; nonconfigurable

A lista de ambientes para os quais o destino pode ser criado, em vez de ambientes com suporte padrão.

Isso faz parte do sistema de restrições do Bazel. Consulte compatible_with para mais detalhes.

List of strings; optional; nonconfigurable

As tags podem ser usadas em qualquer regra. Tags no teste e As regras test_suite são úteis para categorizar os testes. Tags em destinos que não são de teste são usadas para controlar a execução no sandbox de genrules e Starlark ações humanas e para análise feita por humanos e/ou por ferramentas externas.

O Bazel modifica o comportamento do código de sandbox se encontrar o seguinte: palavras-chave no atributo tags de qualquer teste ou genrule destino, ou as chaves de execution_requirements para qualquer Starlark à ação.

• no-sandbox palavra-chave resulta na ação ou teste nunca sendo no sandbox; ele ainda poderá ser armazenado em cache ou executado remotamente. Use no-cache ou no-remote para evitar ambos.
• no-cache palavra-chave resulta na ação ou teste nunca sendo em cache (remotamente ou localmente)
• no-remote-cache palavra-chave resulta na ação ou teste nunca sendo armazenados em cache remotamente, mas que podem ser armazenados localmente ou executados remotamente. Observação: para esta tag, o Disk-cache é considerado um cache local, enquanto os caches HTTP e gRPC são considerados remotos. Se um cache combinado for especificado (por exemplo, um cache com componentes locais e remotos), ele é tratado como um cache remoto e totalmente desativado, a menos que --incompatible_remote_results_ignore_disk é definido e, nesse caso, os componentes locais serão usados.
• no-remote-exec palavra-chave resulta na ação ou teste nunca sendo são executados remotamente (mas podem ser armazenados em cache remotamente).
• A palavra-chave no-remote impede que a ação ou o teste seja executado remotamente ou armazenados em cache remotamente. Isso equivale a usar no-remote-cache e no-remote-exec.
• A palavra-chave no-remote-cache-upload desativa o upload de parte do armazenamento em cache remoto de um spawn. não desativa a execução remota.
• A palavra-chave local impede que a ação ou o teste seja armazenado em cache remotamente executados remotamente ou dentro da sandbox. Para regras gerais e testes, a marcação da regra com local = True tem o mesmo efeito.
• A palavra-chave requires-network permite acesso ao de dentro da sandbox. Esta tag só tem efeito se estiver no sandbox está ativado.
• A palavra-chave block-network bloqueia o acesso ao de dentro da sandbox. Nesse caso, apenas as comunicações com localhost é permitido. Esta tag só tem efeito se o sandbox for ativado.
• requires-fakeroot executa o teste ou a ação como UID e gid 0 (ou seja, a raiz usuário). Isso só é compatível com Linux. Essa tag tem prioridade Opção de linha de comando --sandbox_fake_username.

As tags em testes geralmente são usadas para anotar a função de um teste na sua o processo de depuração e lançamento. Normalmente, as tags são mais úteis para C++ e Python testes, que não têm a capacidade de anotação de tempo de execução. O uso de tags e tamanhos oferece flexibilidade na montagem de conjuntos de testes baseados na base de código e a política de check-in.

O Bazel modifica o comportamento de execução do teste se encontrar as seguintes palavras-chave na Atributo tags da regra de teste:

• exclusive forçará a execução do teste no "exclusivo" , garantindo que nenhum outro teste esteja sendo executado no ao mesmo tempo. Esses testes serão executados em série após todo o build atividade e testes não exclusivos foram concluídos. A execução remota é desativado para esses testes porque o Bazel não tem controle sobre o que é em execução em uma máquina remota.
• exclusive-if-local forçará a execução do teste no "exclusivo" se ele for executado localmente, mas executará o teste em paralelo caso seja a execução remota.
• A palavra-chave manual excluirá o destino da expansão de caracteres curinga de padrão de destino (..., :*, :all etc.) e regras test_suite que não listam o teste explicitamente ao calcular o conjunto de destinos de nível superior para criação/execução para os comandos build, test e coverage. Ele não afetar o caractere curinga de destino ou a expansão do conjunto de testes em outros contextos, incluindo o query. manual não implica que um destino precisa não podem ser criados/executados automaticamente por sistemas contínuos de compilação/teste. Por exemplo, pode ser desejável excluir um destino de bazel test ... porque exige configurações Flags do Bazel, mas ainda incluídas em testes contínuos ou de pré-envio configurados corretamente é executado.
• external palavra-chave forçará o teste a ser incondicionalmente executado (independentemente de --cache_test_results ).

List of labels ; optional

Uma lista de constraint_values que devem estar presentes na plataforma de destino para que o destino seja considerado compatíveis. Isso é um complemento às restrições já definidas pelo tipo de regra. Se a plataforma de destino não atender a todas as restrições listadas, o destino é considerado incompatível. Destinos incompatíveis são pulada para criação e teste quando o padrão de destino é expandido (por exemplo, //..., :all). Quando explicitamente especificado no linha de comando, destinos incompatíveis fazem com que o Bazel imprima um erro e cause uma falha no build ou teste.

Os destinos que dependem transitivamente de destinos incompatíveis são eles mesmos considerados incompatíveis. Eles também são pulados na criação e nos testes.

Uma lista vazia (que é o padrão) significa que o destino é compatível com todas as plataformas.

Todas as regras, exceto as Regras do Workspace, têm suporte para isso. . Para algumas regras, esse atributo não tem efeito. Por exemplo, especificar target_compatible_with para um cc_toolchain não é útil.

Consulte a Plataformas para mais informações sobre como pular destinos incompatíveis.

Boolean; optional; default False except for test and test suite targets; nonconfigurable

Se for "True", somente destinos somente de teste (como testes) poderão depender dele.

Igualmente, uma regra que não seja testonly não pode dependem de qualquer regra que seja testonly.

Testes (*_test regras) e pacotes de teste (regras test_suite) são testonly por padrão.

Esse atributo significa que o destino não deve ser em binários lançados para produção.

Como testonly é aplicado no tempo de build, não no ambiente de execução, e se propaga viralmente pela árvore de dependências, ela deve ser aplicada criteriosamente. Para exemplo, stubs e falsificações 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 portanto, provavelmente não deve ser marcado como testonly. Por outro lado, regras que é perigoso até mesmo vincular, talvez porque eles incondicionalmente substituem o comportamento normal, precisam ser marcadas como somente teste.

List of labels ; optional; nonconfigurable

O conjunto de destinos cujas Make variables esse destino está. tem permissão de acesso. Essas metas são instâncias de regras que fornecem TemplateVariableInfo ou destinos especiais para tipos de conjunto de ferramentas criados no Bazel. Esses incluem:

• @bazel_tools//tools/cpp:current_cc_toolchain
• @bazel_tools//tools/jdk:current_java_runtime

Observe que isso é diferente do conceito de resolução do conjunto de ferramentas usado por implementações de regras para configuração dependente da plataforma. Não é possível usar para determinar quais cc_toolchain ou java_toolchain específicas destino usará.

List of labels ; optional; default default_visibility from package if specified, or //visibility:private otherwise; nonconfigurable

O atributo visibility em um destino controla se ele pode ser usado em outros pacotes. Consulte a documentação visibilidade.

List of strings; optional; subject to $(location) and "Make variable" substitution, and Bourne shell tokenization

argumentos de linha de comando que o Bazel passa para o destino quando é executada com bazel test.

Esses argumentos são transmitidos antes de qualquer valor --test_arg especificado na linha de comando bazel test.

Dictionary of strings; optional; values are subject to $(location) and "Make variable" substitution

Especifica as variáveis de ambiente adicionais a serem definidas quando o teste é executado pelo bazel test:

Esse atributo só se aplica a regras nativas, como cc_test, py_test e sh_test. Isso não se aplica a Regras de teste definidas pelo Starlark. Para suas próprias regras do Starlark, adicione um "env" e usá-lo para preencher um TestEnvironment (link em inglês) Provedor.

List of strings; optional

Especifica variáveis de ambiente adicionais para herdar do ambiente externo quando o teste é executado por bazel test.

Esse atributo só se aplica a regras nativas, como cc_test, py_test, e sh_test. Isso não se aplica às regras de teste definidas pelo Starlark.

String "enormous", "large" "medium" or "small", default is "medium"; optional; nonconfigurable

Especifica o "peso" de um destino de teste: por quanto tempo/recursos ele precisa para ser executado.

Os testes de unidade são considerados "pequenos", os testes de integração são "médios" e os testes completos são "grandes". ou "enorme". O Bazel usa o tamanho para determinar um tempo limite padrão, que pode ser substituído usando o timeout. O tempo limite é para todos os testes no destino BUILD, não para cada para teste individual. Quando o teste é executado localmente, o size também é usado para fins de programação: o Bazel tenta respeitar --local_{ram,cpu}_resources e não sobrecarregar a máquina local com a execução de vários testes pesados ao mesmo tempo.

Os tamanhos dos testes correspondem aos seguintes tempos limite padrão e recursos locais de pico presumidos de uso:

A variável de ambiente TEST_SIZE será definida como o valor desse atributo ao gerar o teste.

String "short", "moderate", "long", "eternal" (with the default derived from the test's size attribute); nonconfigurable

Por quanto tempo o teste deve ser executado antes de retornar.

Enquanto o atributo de tamanho de um teste controla a estimativa de recursos, o tempo limite pode ser definido de forma independente. Se não for especificado explicitamente, o tempo limite é baseado no tamanho do teste. O teste tempo limite pode ser substituído pela sinalização --test_timeout, por exemplo: para que funcionam sob certas condições lentas. Testar valores de tempo limite correspondem aos seguintes períodos:

Para horas diferentes dos acima, o tempo limite do teste pode ser substituído pelo valor-chave Flag --test_timeout do Bazel, por exemplo para execução manual que são consideradas lentas. Os valores --test_timeout em segundos. Por exemplo, --test_timeout=120 definirá o teste tempo limite para dois minutos.

A variável de ambiente TEST_TIMEOUT será definida como o tempo limite do teste (em segundos) ao gerar o teste.

Boolean; optional; default False; nonconfigurable

Marca o teste como instável.

Se definido, executa o teste até três vezes, marcando-o como com falha apenas se falha todas as vezes. Por padrão, esse atributo é definido como falso, e o teste é executada apenas uma vez. O uso deste atributo geralmente não é recomendado. os testes devem passar de maneira confiável quando as declarações forem mantidas.

Non-negative integer less than or equal to 50; optional

Especifica o número de fragmentos paralelos usar para executar o teste.

Esse valor substituirá qualquer heurística usada para determinar o número de os fragmentos paralelos com os quais executar o teste. Para alguns testes esse parâmetro pode ser necessário para ativar a fragmentação em primeiro lugar. Consulte também --test_sharding_strategy.

Se a fragmentação de testes estiver ativada, a variável de ambiente TEST_TOTAL_SHARDS será definida com esse valor ao gerar o teste.

A fragmentação exige que o executor de testes ofereça suporte ao protocolo de fragmentação de testes. Se não tiver, o mais provável é que ele execute todos os testes em todos os fragmentos, o que não é o que você quer.

Consulte Fragmentação de testes na Enciclopédia de teste para obter detalhes sobre fragmentação.

Boolean; default False; nonconfigurable

Força o teste a ser executado localmente, sem sandbox.

Configurar esta opção como "True" é equivalente a fornecer informações "locais" como uma tag (tags=["local"]).

List of strings; optional; subject to $(location) and "Make variable" substitution, and Bourne shell tokenization; nonconfigurable

Argumentos de linha de comando que o Bazel passa para o destino quando é executado. seja pelo comando run ou como teste. Esses argumentos são transmitidos antes dos especificados na bazel run ou linha de comando bazel test.

OBSERVAÇÃO: os argumentos não são passados quando você executa o comando fora do Bazel (por exemplo, executando manualmente o binário bazel-bin/).

Dictionary of strings; optional; values are subject to $(location) and "Make variable" substitution

Especifica as variáveis de ambiente adicionais a serem definidas quando o destino for executado por bazel run.

Esse atributo só se aplica a regras nativas, como cc_binary, py_binary, e sh_binary. Ele não se aplica a regras executáveis definidas pelo Starlark.

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 bazel-bin/).

List of strings; optional

As licenças dos arquivos de saída que esse binário gera. Isso faz parte de uma API de licenciamento descontinuada que o Bazel não usa mais. O que não fazer use isso.