Git Bisect para depuração

A depuração pode ser difícil. Às vezes, um erro aparece e você não sabe qual alteração o causou.

git bisect é um comando poderoso do Git que ajuda a localizar a confirmação exata que introduziu um erro. Ele usa um algoritmo de busca binária para reduzir rapidamente milhares de confirmações.

Imagine que o seu projeto tenha 100 confirmações e que um erro tenha surgido em algum ponto entre a primeira e a última. Verificar cada uma manualmente é demorado!

git bisect funciona como um jogo de "adivinhe o número":

• Você informa ao Git uma confirmação "boa" (em que o erro não estava presente).
• Você informa ao Git uma confirmação "ruim" (em que o erro está presente).
• O Git escolhe uma confirmação aproximadamente no meio e pede que você a teste.
• Você a marca como "boa" ou "ruim", e o Git reduz pela metade o espaço de busca.

Para começar, você precisa informar ao Git que está iniciando uma sessão de busca binária. Este comando inicializa o processo:

git bisect start

Depois de iniciar, você especificará uma confirmação "ruim" conhecida (em que o erro existe) e uma confirmação "boa" conhecida (em que o erro definitivamente não existia).

Com frequência, a confirmação "ruim" é o seu HEAD atual, e uma confirmação "boa" pode ser uma etiqueta de versão mais antiga ou uma confirmação de alguns dias atrás.

Depois de iniciar git bisect, você define o intervalo da busca:

• Confirmação ruim: é uma confirmação em que você sabe que o erro existe. Use git bisect bad <commit-hash> ou simplesmente git bisect bad se ela for o seu HEAD atual.
• Confirmação boa: é uma confirmação em que você sabe que o erro NÃO existia. Use git bisect good <commit-hash>.

Em seguida, o Git fará automaticamente o checkout de uma confirmação no meio desse intervalo.

Depois que você marcar as confirmações boa e ruim, o Git fará automaticamente o checkout de uma confirmação no meio do intervalo. Sua tarefa é testar o código nessa confirmação selecionada.

• Se o erro IS estiver presente, digite git bisect bad.
• Se o erro IS NOT estiver presente, digite git bisect good.

O Git escolherá outra confirmação intermediária no intervalo restante. Você repetirá esse processo até que o Git encontre a primeira confirmação "ruim".

Vamos imaginar um "erro" simples em um script. Simularemos um histórico de projeto em que um pequeno erro foi introduzido.

Este é o nosso script "bom" inicial:

main.sh

Agora, digamos que uma confirmação posterior tenha alterado acidentalmente o laço para seq 1 4, fazendo com que a soma ficasse incorreta (10 em vez de 6).

Começaríamos assim:

git bisect start

Em seguida, marcaríamos o nosso HEAD atual (em que o erro existe) como ruim:

git bisect bad HEAD

E uma confirmação mais antiga, que sabemos que funcionava, como boa:

git bisect good <old_good_commit_hash>

O Git nos orientará, fazendo o checkout das confirmações. Executaríamos ./main.sh, verificaríamos se a soma é 6 ou 10 e então digitaríamos git bisect good ou git bisect bad, conforme o caso.

Testar cada confirmação manualmente ainda pode consumir muito tempo se o teste for complexo. git bisect run permite automatizar esse processo!

Você fornece um script que termina com:

• 0 (zero) se a confirmação for boa.
• 125 se a confirmação tiver de ser ignorada.
• Qualquer outro valor diferente de zero (por exemplo, 1) se a confirmação for ruim.

O Git executará esse script em cada confirmação testada até encontrar o erro.

Quando git bisect identificar com sucesso a primeira confirmação ruim, ele informará o hash e a mensagem dessa confirmação.

Depois de encontrar a causa e entender o problema, é essencial redefinir o seu repositório para o estado original anterior ao início da busca binária:

git bisect reset

Este comando leva você de volta à confirmação em que estava quando iniciou a busca binária, limpando o estado temporário desse processo.

Você acabou de executar git bisect start, marcou o seu HEAD atual como ruim e uma confirmação mais antiga como boa. O Git fez o checkout de uma confirmação intermediária.

Você executa os seus testes e o erro IS PRESENT nessa confirmação intermediária.

Parabéns! Você aprendeu a usar git bisect:

• É uma ferramenta poderosa para encontrar a confirmação exata que introduziu um erro.
• Usa uma busca binária para obter eficiência.
• Você define confirmações "boas" (sem erros) e "ruins" (com erros).
• Você pode automatizar o processo de testes com git bisect run <script>.
• Lembre-se sempre de executar git bisect reset para limpar tudo depois da busca!