Ho letto alcuni articoli dicendo che git bisect
è fantastico. Tuttavia, non sono un madrelingua e non riesco a capire perché sia fantastico.
Qualcuno potrebbe dimostrare con un esempio di codice:
- Come usarlo?
- È proprio come
svn blame
?
Ho letto alcuni articoli dicendo che git bisect
è fantastico. Tuttavia, non sono un madrelingua e non riesco a capire perché sia fantastico.
Qualcuno potrebbe dimostrare con un esempio di codice:
svn blame
?Risposte:
L'idea alla base git bisect
è quella di eseguire una ricerca binaria nella storia per trovare una regressione particolare. Immagina di avere la seguente storia di sviluppo:
... --- 0 --- 1 --- 2 --- 3 --- 4* --- 5 --- current
Sai che il tuo programma non funziona correttamente durante la current
revisione e che funzionava durante la revisione 0
. Così la regressione è stato probabilmente introdotto in uno dei commit 1
, 2
, 3
, 4
, 5
, current
.
Potresti provare a controllare ogni commit, crearlo, verificare se la regressione è presente o meno. Se è presente un numero elevato di commit, questo può richiedere molto tempo. Questa è una ricerca lineare. Possiamo fare di meglio facendo una ricerca binaria. Questo è ciò che fa il git bisect
comando. Ad ogni passaggio tenta di ridurre della metà il numero di revisioni potenzialmente dannose.
Utilizzerai il comando in questo modo:
$ git stash save
$ git bisect start
$ git bisect bad
$ git bisect good 0
Bisecting: 2 revisions left to test after this (roughly 2 steps)
[< ... sha ... >] 3
Dopo questo comando, git
eseguirà il checkout di un commit. Nel nostro caso, sarà commesso 3
. Devi creare il tuo programma e verificare se la regressione è presente o meno. Dovrai inoltre indicare git
lo stato di questa revisione con git bisect bad
se è presente la regressione o git bisect good
se non lo è.
Supponiamo che la regressione sia stata introdotta in commit 4
. Quindi la regressione non è presente in questa revisione e lo diciamo a git
.
$ make
$ make test
... ... ...
$ git bisect good
Bisecting: 0 revisions left to test after this (roughly 1 step)
[< ... sha ... >] 5
Verificherà quindi un altro commit. O 4
o 5
(in quanto vi sono solo due commit). Supponiamo che sia stato scelto 5
. Dopo una build testiamo il programma e vediamo che la regressione è presente. Quindi lo diciamo a git
:
$ make
$ make test
... ... ...
$ git bisect bad
Bisecting: 0 revisions left to test after this (roughly 0 steps)
[< ... sha ... >] 4
Ci prova l'ultima revisione, 4
. E poiché è quello che ha introdotto la regressione, lo diciamo a git
:
$ make
$ make test
... ... ...
$ git bisect bad
< ... sha ... > is the first bad commit
< ... commit message ... >
In questa semplice situazione, abbiamo solo dovuto prova 3 versioni ( 3
, 4
, 5
) invece di 4 ( 1
, 2
, 3
, 4
). Questa è una piccola vittoria, ma è perché la nostra storia è così piccola. Se l'intervallo di ricerca è di N commit, dovremmo aspettarci di testare 1 + log2 N commit git bisect
invece di circa N / 2 commit con una ricerca lineare.
Una volta trovato il commit che ha introdotto la regressione, puoi studiarlo per trovare il problema. Una volta fatto, si usa git bisect reset
per riportare tutto allo stato originale prima di usare il git bisect
comando.
git bisect bad <rev> [<rev>...]
per contrassegnare revisioni specifiche come non valide (o valide git bisect good <rev> [<rev>...]
). rev
può essere qualsiasi identificatore di revisione come un nome di ramo, un tag, un hash di commit (o prefisso univoco di hash di commit), ...
git bisect reset
git bisect run
bisect automaticoSe si dispone di uno ./test
script automatizzato con stato di uscita 0 se il test è OK, è possibile trovare automaticamente il bug con bisect run
:
git checkout KNOWN_BAD_COMMIT
git bisect start
# Confirm that our test script is correct, and fails on the bad commit.
./test
# Should output != 0.
echo $?
# Tell Git that the current commit is bad.
git bisect bad
# Same for a known good commit in the past.
git checkout KNOWN_GOOD_COMMIT
./test
# Should output 0.
echo $?
# After this, git automatically checks out to the commit
# in the middle of KNOWN_BAD_COMMIT and KNOWN_GOOD_COMMIT.
git bisect good
# Bisect automatically all the way to the first bad or last good rev.
git bisect run ./test
# End the bisect operation and checkout to master again.
git bisect reset
Ciò presuppone ovviamente che se lo script di test ./test
viene rintracciato git, che non scompare in alcuni commit precedenti durante la bisection.
Ho scoperto che molto spesso puoi scappare semplicemente copiando lo script in-tree fuori dall'albero, e possibilmente giocando con PATH
variabili simili a, ed eseguendolo invece da lì.
Ovviamente, se l'infrastruttura di test da cui test
dipende si interrompe su commit precedenti, allora non c'è soluzione e dovrai fare le cose manualmente, decidendo come testare i commit uno per uno.
Ho scoperto tuttavia che l'utilizzo di questa automazione spesso funziona e può essere un enorme risparmio di tempo per i test più lenti che si trovano nel tuo backlog di attività, in cui puoi semplicemente lasciarlo funzionare durante la notte e possibilmente avere il tuo bug identificato entro la mattina successiva, vale la pena il tentativo.
Rimani sul primo commit non riuscito dopo bisect invece di tornare a master
:
git bisect reset HEAD
start
+ iniziale bad
e good
in una volta sola:
git bisect start KNOWN_BAD_COMMIT KNOWN_GOOD_COMMIT~
equivale a:
git checkout KNOWN_BAD_COMMIT
git bisect start
git bisect bad
git bisect good KNOWN_GOOD_COMMIT
Guarda cosa è stato testato finora (da manuale good
e bad
o run
):
git bisect log
Uscita campione:
git bisect log
git bisect start
# bad: [00b9fcdbe7e7d2579f212b51342f4d605e53253d] 9
git bisect bad 00b9fcdbe7e7d2579f212b51342f4d605e53253d
# good: [db7ec3d602db2d994fe981c0da55b7b85ca62566] 0
git bisect good db7ec3d602db2d994fe981c0da55b7b85ca62566
# good: [2461cd8ce8d3d1367ddb036c8f715c7b896397a5] 4
git bisect good 2461cd8ce8d3d1367ddb036c8f715c7b896397a5
# good: [8fbab5a3b44fd469a2da3830dac5c4c1358a87a0] 6
git bisect good 8fbab5a3b44fd469a2da3830dac5c4c1358a87a0
# bad: [dd2c05e71c246f9bcbd2fbe81deabf826c54be23] 8
git bisect bad dd2c05e71c246f9bcbd2fbe81deabf826c54be23
# bad: [c536b1b7242d5fcf92cd87e9a534bedb1c0c9c05] 7
git bisect bad c536b1b7242d5fcf92cd87e9a534bedb1c0c9c05
# first bad commit: [c536b1b7242d5fcf92cd87e9a534bedb1c0c9c0
Mostra riferimenti positivi e negativi sul registro git per ottenere una migliore nozione del tempo:
git log --decorate --pretty=fuller --simplify-by-decoration master
Questo mostra solo i commit con un riferimento corrispondente, che riduce il rumore in modo radicale, ma include riferimenti generati automaticamente:
refs/bisect/good*
refs/bisect/bad*
che ci dicono quali impegni abbiamo contrassegnato come buoni o cattivi.
Considera questo repository di prova se vuoi giocare con il comando.
Qualche volta:
In questi casi, ad esempio supponendo che l'errore si verifichi sempre entro 5 secondi, e se siamo pigri a rendere il test più specifico come dovremmo, possiamo usare timeout
come in:
#!/usr/bin/env bash
timeout 5 test-command
if [ $? -eq 1 ]; then
exit 1
fi
Funziona da quando timeout
esce 124
mentre il fallimento delle test-command
uscite 1
.
git bisect run
è un po 'esigente riguardo agli stati di uscita:
qualcosa sopra 127 fa fallire la bisection con qualcosa del tipo:
git bisect run failed:
exit code 134 from '../test -aa' is < 0 or >= 128
In particolare, una C assert(0)
porta a a SIGABRT
ed esce con lo stato 134, molto fastidioso.
125 è magico e fa saltare la corsa git bisect skip
.
L'intenzione è quella di aiutare a saltare le build rotte a causa di motivi non correlati.
Vedi man git-bisect
per i dettagli.
Quindi potresti voler usare qualcosa come:
#!/usr/bin/env bash
set -eu
./build
status=0
./actual-test-command || status=$?
if [ "$status" -eq 125 ] || [ "$status" -gt 127 ]; then
status=1
fi
exit "$status"
Testato su git 2.16.1.
test_script
suite di test ben costruita + modulare ed eseguirlo dal file separato mentre si esegue la bisecatura. Una volta risolto, unisci il test nella suite di test principale.
bisect run
particolarmente utile quando il test impiega molto tempo per terminare e sono abbastanza sicuro che il sistema di test non si romperà. In questo modo, posso semplicemente lasciarlo in esecuzione sullo sfondo, o durante la notte se occupa troppe risorse, senza perdere il tempo di cambiare il contesto del cervello.
$ git bisect start
$ git bisect bad
$ git bisect good <goodcommit>
Bisecting: X revisions left to test after this (roughly Y steps)
Il problema esiste ancora?
$ git bisect bad
$ git bisect good
<abcdef> is the first bad commit
git bisect reset
git bisect good
per passare al commit successivo.
Solo per aggiungere un ulteriore punto:
Possiamo specificare un nome file o un percorso git bisect start
nel caso in cui sappiamo che il bug proviene da file particolari. Ad esempio, supponiamo di sapere che le modifiche che hanno causato la regressione erano nella directory com / workingDir, quindi possiamo eseguirle. git bisect start com/workingDir
Ciò significa che verranno controllati solo i commit che hanno cambiato il contenuto di questa directory e ciò rende le cose ancora più veloci.
Inoltre, se è difficile stabilire se un determinato commit è positivo o negativo, è possibile eseguire git bisect skip
, il che lo ignorerà. Dato che ci sono abbastanza altri commit, git bisect ne userà un altro per restringere la ricerca.
$ git bisect ..
basicamente uno strumento Git per il debug . Esegue il debug di "Git Bisect" eseguendo i commit precedenti dall'ultimo (noto) commit funzionante. Usa la ricerca binaria per passare attraverso tutti quei commit, per arrivare a quello che ha introdotto la regressione / bug.
$ git bisect start
# Avvio bisect
$ git bisect bad
# affermando che il commit corrente (v1.5) ha il punto di regressione / impostazione 'cattivo'
$ git bisect good v1.0
# menzionandolo l'ultimo buon impegno di lavoro (senza regressione)
Questa menzione di punti "cattivi" e "buoni" aiuterà git bisect (ricerca binaria) a scegliere l'elemento centrale (commit v1.3). Se la regressione è presente su commit v1.3, la imposterai come il nuovo punto 'cattivo', ovvero ( Buono -> v1.0 e Cattivo -> v1.3 )
$ git bisect bad
o allo stesso modo se il commit v1.3 è privo di bug, lo imposterai come il nuovo 'buon punto', ovvero (* buono -> v1.3 e cattivo -> v1.6).
$ git bisect good
Nota: i termini good
e bad
non sono i soli che è possibile utilizzare per contrassegnare un commit con o senza una determinata proprietà.
Git 2.7 (Q4 2015) ha introdotto nuove git bisect
opzioni.
git bisect start [--term-{old,good}=<term> --term-{new,bad}=<term>]
[--no-checkout] [<bad> [<good>...]] [--] [<paths>...]
Con l'aggiunta della documentazione:
A volte non stai cercando il commit che ha introdotto una rottura, ma piuttosto un commit che ha causato un cambiamento tra qualche altro stato "vecchio" e "nuovo" .
Ad esempio, potresti cercare il commit che ha introdotto una correzione particolare.
Oppure potresti cercare il primo commit in cui i nomi dei file del codice sorgente sono stati finalmente convertiti nello standard di denominazione della tua azienda. O qualunque cosa.In questi casi può essere molto confuso usare i termini "buono" e "cattivo" per riferirsi a "lo stato prima della modifica" e "lo stato dopo la modifica".
Quindi, invece, puoi usare i termini "
old
" e "new
", rispettivamente, al posto di "good
" e "bad
".
(Ma nota che non puoi mescolare "good
" e "bad
" con "old
" e "new
" in una singola sessione.)In questo uso più generale, si fornisce
git bisect
un "new
" commit con alcune proprietà e un "old
" commit che non ha quella proprietà.Ogni volta che si
git bisect
verifica un commit, si verifica se quel commit ha la proprietà:
In tal caso, contrassegnare il commit come "new
"; altrimenti, contrassegnalo come "old
".Al termine della sezione,
git bisect
segnalerà quale commit ha introdotto la proprietà.
Vedi commit 06e6a74 , commit 21b55e3 , commit fe67687 (29 giu 2015) di Matthieu Moy ( moy
) .
Vedi commit 21e5cfd (29 giu 2015) di Antoine Delaite ( CanardChouChinois
) .
(Unito da Junio C Hamano - gitster
- in commit 22dd6eb , 05 ott 2015)