Hermeticidade

Esta página aborda a hermética, os benefícios de usar builds herméticos e estratégias para identificar comportamentos não herméticos nos seus builds.

Informações gerais

Quando recebe o mesmo código-fonte de entrada e a mesma configuração de produto, um sistema de build hermético sempre retorna a mesma saída, isolando o build das mudanças no sistema host.

Para isolar o build, os builds herméticos são insensíveis a bibliotecas e outros softwares instalados na máquina host local ou remota. Elas dependem de versões específicas das ferramentas de build, como compiladores e dependências, como bibliotecas. Isso torna o processo de build independente, já que não depende de serviços externos ao ambiente de build.

Os dois aspectos importantes da hermética são:

  • Isolamento: os sistemas de build herméticos tratam as ferramentas como código-fonte. Eles fazem o download de cópias de ferramentas e gerenciam o armazenamento e o uso nas árvores de arquivos gerenciadas. Isso cria isolamento entre a máquina host e o usuário local, incluindo as versões de idiomas instaladas.
  • Identidade de origem: sistemas de build herméticos tentam garantir a mesma entrada. Repositórios de código, como o Git, identificam conjuntos de mutações de código com um código hash exclusivo. Os sistemas de build herméticos usam esse hash para identificar mudanças na entrada do build.

Vantagens

Os principais benefícios de builds herméticos são:

  • Velocidade: a saída de uma ação pode ser armazenada em cache, e a ação não precisa ser executada novamente, a menos que as entradas mudem.
  • Execução paralela: para determinadas entradas e saídas, o sistema de compilação pode construir um gráfico de todas as ações para calcular a execução eficiente e paralela. O sistema de build carrega as regras e calcula um gráfico de ações e entradas de hash para procurar no cache.
  • Vários builds: é possível criar vários builds herméticos na mesma máquina, cada um usando ferramentas e versões diferentes.
  • Reprodutibilidade: builds herméticos são bons para solucionar problemas porque você sabe as condições exatas que produziram o build.

Identificar a não hermética

Se você está se preparando para mudar para o Bazel, a migração será mais fácil se você melhorar a hermética das builds atuais com antecedência. Algumas fontes comuns de não hermética em builds são:

  • Processamento arbitrário em arquivos .mk
  • Ações ou ferramentas que criam arquivos de maneira não determinista, geralmente envolvendo IDs de build ou carimbos de data/hora
  • Binários do sistema que diferem entre os hosts (como binários /usr/bin, caminhos absolutos e compiladores C++ do sistema para configuração automática de regras C++ nativas)
  • Gravar na árvore de origem durante a criação. Isso evita que a mesma árvore de origem seja usada para outro destino. O primeiro build grava na árvore de origem, corrigindo a árvore de origem para o destino A. Então, a tentativa de criar o destino B pode falhar.

Como solucionar problemas de builds não herméticos

Começando com a execução local, os problemas que afetam as ocorrências em cache local revelam ações não herméticas.

  • Garanta builds sequenciais nulos: se você executar make e tiver um build bem-sucedido, a execução do build novamente não recriará nenhum destino. Se você executar cada etapa de build duas vezes ou em sistemas diferentes, comparar um hash do conteúdo do arquivo e receber resultados diferentes, o build não será reproduzível.
  • Execute as etapas para depurar ocorrências em cache local de várias máquinas clientes em potencial para garantir que você capture todos os casos de vazamento nas ações.
  • Execute uma versão dentro de um contêiner do Docker que contém apenas a árvore de origem registrada e a lista explícita de ferramentas de host. As falhas de build e as mensagens de erro identificarão dependências implícitas do sistema.
  • Descubra e corrija problemas de hermética usando regras de execução remota.
  • Ative o sandbox estrito no nível por ação, já que as ações em um build podem ter estado e afetar o build ou a saída.
  • As regras do espaço de trabalho permitem que os desenvolvedores adicionem dependências a espaços de trabalho externos, mas são avançadas o suficiente para permitir que o processamento arbitrário ocorra no processo. É possível receber um registro de algumas ações potencialmente não herméticas nas regras do espaço de trabalho do Bazel adicionando a sinalização --experimental_workspace_rules_log_file=PATH ao comando do Bazel.

Hermética com Bazel

Para mais informações sobre como outros projetos tiveram sucesso usando builds herméticos com o Bazel, consulte estas palestras do BazelCon: