Como chamar o Bazel usando scripts

-1-

É possível chamar o Bazel a partir de scripts para executar uma compilação, executar testes ou consultar o gráfico de dependência. O Bazel foi projetado para permitir a criação de scripts eficazes, mas esta seção lista alguns detalhes que precisam ser considerados para tornar seus scripts mais robustos.

Escolher a base de saída

A opção --output_base controla onde o processo do Bazel precisa gravar as saídas de uma compilação, bem como vários arquivos de trabalho usados internamente pelo Bazel. Um deles é um bloqueio que protege contra mutações simultâneas da base de saída por vários processos do Bazel.

A escolha do diretório base de saída correto para o script depende de vários fatores. Se você precisar colocar as saídas de build em um local específico, isso determinará a base de saída que você precisa usar. Se você estiver fazendo uma chamada "somente leitura" para o Bazel (como bazel query), os fatores de bloqueio serão mais importantes. Em particular, se você precisar executar várias instâncias do script ao mesmo tempo, será necessário dar a cada uma uma base de saída diferente (ou aleatória).

Se você usar o valor base de saída padrão, estará disputando o mesmo bloqueio usado pelos comandos interativos do Bazel do usuário. Se o usuário emitir comandos de longa duração, como builds, o script precisará aguardar a conclusão desses comandos antes de continuar.

Observações sobre o modo de servidor

Por padrão, o Bazel usa um processo do servidor de longa duração como otimização. Ao executar o Bazel em um script, não se esqueça de chamar shutdown quando terminar de usar o servidor ou especifique --max_idle_secs=5 para que os servidores inativos sejam encerrados imediatamente.

Que código de saída vou receber?

Ele tenta diferenciar falhas causadas pelo código-fonte em consideração de erros externos que impedem a execução correta. A execução do Bazel pode resultar nos seguintes códigos de saída:

Códigos de saída comuns a todos os comandos:

  • 0: sucesso
  • 2: problema na linha de comando, combinação de comandos ou sinalizações inválidas ou ilegais ou variáveis de ambiente incorretas. Sua linha de comando precisa ser modificada.
  • 8: o build foi interrompido, mas foi encerrado com um encerramento ordenado.
  • 9: o bloqueio do servidor é mantido e --noblock_for_lock foi transmitido.
  • 32: falha de ambiente externo nesta máquina.

  • 33: o Bazel ficou sem memória e falhou. Você precisa modificar sua linha de comando.

  • 34: reservado para uso interno do Google.

  • 35: reservado para uso interno do Google.

  • 36: problema ambiental local, suspeita de ser permanente.

  • 37: exceção não processada / erro interno do Bazel.

  • 38: reservado para uso interno do Google.

  • 39: os blobs exigidos pelo Bazel são removidos do cache remoto.

  • 41-44: reservado para uso interno do Google.

  • 45: erro ao publicar os resultados no serviço de evento de build.

  • 47: reservado para uso interno do Google.

Códigos de retorno para os comandos bazel build, bazel test:

  • 1 - Falha na criação.
  • 3: build OK, mas alguns testes falharam ou expiraram.
  • 4: o build foi bem-sucedido, mas nenhum teste foi encontrado, mesmo que o teste tenha sido solicitado.

Para bazel run:

  • 1 - Falha na criação.
  • Se a compilação for bem-sucedida, mas o subprocesso executado retornar um código de saída diferente de zero, ele também será o código de saída do comando.

Para bazel query:

  • 3: sucesso parcial, mas a consulta encontrou um ou mais erros no conjunto de arquivos BUILD de entrada e, portanto, os resultados da operação não são 100% confiáveis. Isso provavelmente se deve a uma opção --keep_going na linha de comando.
  • 7: falha no comando.

Versões futuras do Bazel podem adicionar outros códigos de saída, substituindo o código de saída de falha genérico 1 por um valor diferente de zero com um significado específico. No entanto, todos os valores de saída diferentes de zero sempre constituirão um erro.

Como ler o arquivo .bazelrc

Por padrão, o Bazel lê o arquivo .bazelrc no diretório base do espaço de trabalho ou no diretório inicial do usuário. Independentemente de isso ser desejável ou não para seu script. Se ele precisar ser perfeitamente hermético (como em builds de lançamento), desative a leitura do arquivo .bazelrc usando a opção --bazelrc=/dev/null. Se você quiser executar um build usando as configurações preferidas do usuário, o comportamento padrão é melhor.

Registro de comando

A saída do Bazel também está disponível em um arquivo de registro de comando, que pode ser encontrado com este comando:

bazel info command_log

O arquivo de registros de comando contém os streams intercalados stdout e stderr do comando mais recente do Bazel. Observe que executar bazel info substituirá o conteúdo desse arquivo, já que ele se tornará o comando mais recente do Bazel. No entanto, o local do arquivo de registro do comando não será alterado, a menos que você altere a configuração das opções --output_base ou --output_user_root.

Analisando saída

A saída do Bazel é muito fácil de analisar para vários fins. Duas opções que podem ser úteis para seu script são --noshow_progress, que suprime mensagens de progresso, e --show_result n, que controla se as mensagens "criar atualizadas" são ou não impressas. Essas mensagens podem ser analisadas para descobrir quais destinos foram criados e o local dos arquivos de saída criados. Especifique um valor muito alto de n se você confiar nessas mensagens.

Como solucionar problemas de desempenho por meio da criação de perfil

Consulte a seção Criação de perfil de desempenho.