Web și dezvoltare

Git Bisect: Găsește Commit-ul care a introdus o eroare

Git Bisect: Find the Commit That Introduced a Bug

O funcționalitate a funcționat ieri, dar eșuează azi. Învață cum să folosești Git bisect pentru a identifica commit-ul care a introdus o regresie, pentru a testa reviziile automat și pentru a investiga rezultatul în siguranță.

Git Bisect: Găsiți commit-ul care a introdus bug-ul

Un site web a funcționat săptămâna trecută. Astăzi, un calcul de checkout este greșit, un component JavaScript nu răspunde mai sau un endpoint PHP returne date neașteptate.

Știți că bug-ul a apărut undeva în istoricul Git, dar depozitarul conține zeci sau sute de commit-uri de la ultima versiune funcțională. Deschiderea fiecărui commit și citirea fiecărei diff este rare cea mai rapidă soluție.

Git include un instrument conceput exact pentru această situație: git bisect. În loc să examinezi fiecare commit, el folosește o căutare binară pentru a identifica revizia care a introdus mai întâi problema. Cu un test fiabil, poți automatiza investigația.

Încest tutorial, vei crea un mic proiect PHP, intenționat introduci o regresie, o localizezi cu Git bisect și înveți cum să aplici aceeași tehnică la proiecte reale.

1. Cum funcționează Git bisect

Închipui-ți că aplicația ta a funcționat la commit A, dar eșuează la commit H. Git bisect are nevoie de două puncte de referință: un commit bun, unde caracteristica cu siguranță funcționa, și un commit rău, unde bug-ul cu siguranță există.

El check-out o revizie intermediară. Tu o testezi, raportezi dacă funcționează, și Git reduce intervalul de căutare rămas. Pentru aproximativ 128 de commit-uri candidate, căutarea binară necesită în mod tipic circa sapă testări în loc să inspectezi toate cele 128, presupunând că comportamentul poate fi clasificat consistent.

Documentația oficială Git descrie procesul și limitările sale.

2. Creați o regresie PHP reproducibilă

Vom construi o mică funcție de calcul al prețului. Nu este necesar niciun framework, bază de date, pachet Composer sau server web. Ai nevoie de Git și PHP CLI instalate, și Git trebuie să aibă numele și adresa ta de email configurate pentru commit-uri.

Creați un director și inițializați un depozit:

mkdir git-bisect-demo
cd git-bisect-demo
git init

Creați price.php:

<?php

declare(strict_types=1);

function finalPrice(int $price, int $discount): int
{
    return $price - $discount;
}

Comportamentul așteptat este simplu: finalPrice(100, 20) returnează 80.

Commit-ul acestei versiuni funcționale:

git add price.php
git commit -m "Add working price calculation"

În continuare, creați o schimbare nespecifică:

echo "# Price Calculator" > README.md
git add README.md
git commit -m "Add project documentation"

În final, introduce un bug prin schimbarea calculului din price.php:

<?php

declare(strict_types=1);

function finalPrice(int $price, int $discount): int
{
    return $price + $discount;
}

Commit-ul versiunii rupte:

git add price.php
git commit -m "Refactor price calculation"

Proiectul are acum trei commit-uri, cu o regresie deliberată în ultimul.

3. Găsiți regresia manual

Începeți prin a confirma că arborelui de lucru este curat:

git status --short

Comanda nu ar trebui să producă niciun ieșire. Dacă ai muncă necommit-ată, commit-o corespunzător sau stash-o înainte de a începe.

Acum lansezi Git bisect:

git bisect start
git bisect bad HEAD
git bisect good HEAD~2
Illustration of the article's main concept

Aici, HEAD este revizia ruptă, iar HEAD~2 pointează la primul, commit-ul funcțional. Git check-out revizia intermediară.

Testează calculul:

php -r 'require "price.php"; echo finalPrice(100, 20), PHP_EOL;'

Dacă ieșirea este 80, marchează revizia ca bună:

git bisect good

Dacă este 120, marchează-o ca rea:

git bisect bad

Git continuă selectând commit-uri până când identifică prima revizie reă. În această demonstrație cu trei commit-uri, este nevoie doar de testarea unei revizii intermediare.

Când ai terminat, restabilești ramura ta originală:

git bisect reset

În timeul bisect, Git check-out în mod normal revizii istorice într-un stat HEAD detasat. git bisect reset te întoarece la reviza pe care o foloseai înainte de investigație.

4. Automatizează investigația cu git bisect run

Testarea manuală este utilă când un bug necesită o inspecție visuală. Dar dacă comportamentul poate fi verificat printr-o comandă, automarea este mai eficientă.

Git suportă git bisect run <command>. Comunică rezultatul folosind un cod de ieșire:

Exit code Meaning
0 Revizie bună
1–124 or 126–127 Revizie rea
125 Nu se poate testa această revizie
Other values Întrerup investigația

Aceste reguli provin din manualul oficial Git bisect.

Creați un script de test în afara depozitului, cum ar fi ../check-price.php:

<?php

declare(strict_types=1);

require __DIR__ . '/git-bisect-demo/price.php';

exit(finalPrice(100, 20) === 80 ? 0 : 1);

Scriptul presupune că folderul proiectului este numit git-bisect-demo și este lângă check-price.php. Rul aceste comandă din interiorul folderului proiectului:

git bisect start HEAD HEAD~2
git bisect run php ../check-price.php
git bisect reset

Git rulează testul pe revizii istorice selectate până când primul commit re este identificat. Deoarece scriptul de test este în afara depozitului, check-out unei vechi revizii nu îl înlătură.

Pentru proiecte reale, folosește o comandă de test stabilă sau un script de test extern care funcționează cu reviziile istorice în investigație.

5. Aplică tehnică la un proiect web real

Același flux de lucru funcționează pentru un plugin WordPress, extensie Joomla, aplicație JavaScript sau bibliotecă PHP.

Presupuneți că o funcție de checkout este ruptă în ultima versiune, dar a funcționat în lansarea v1.4.0. Mai întâi verify că lansarea este cu siguranță bună, apoi începe:

git bisect start HEAD v1.4.0

Dacă proiectul are un test PHPUnit care funcționează prin reviziile selectate, îl poți rula manual:

vendor/bin/phpunit tests/CheckoutTest.php

După fiecare test, raportează git bisect good sau git bisect bad.

Când testul este fiabil automatizat:

git bisect run vendor/bin/phpunit tests/CheckoutTest.php
git bisect reset

Commit-urile istorice pot require versiuni PHP diferite, dependențe, scheme de baze de date sau instrumente de build. Un test care eșuează din cauza unui mediu incompatibil nu indică neapărat regresia. Asigură-ți că mediul de test poate reproduce versiunile istorice relevante.

Technical workflow illustration

6. Ce se întâmplă dacă un vechi commit nu poate fi testat?

Uneori o revizie istorică eșue să se builduiască dintr-un motiv neînlegat. Nu o marchezi automat ca rea.

Folosește:

git bisect skip

Git încearcă un alt candidat. Pentru testele automate, codul de ieșire 125 spune Git să sare revizia.

Sărirea a prea multe commit-uri reduce precizia. Dacă un commit de testat este adiacent regresiei, Git poate raporta mai mulți posibili vinovați în loc de un singur commit exact.

O bună practică pe termen lung este să menții medii de dezvoltare reproducibile, să blochezi versiunile dependențelor și să păstrezi testele de regresie critice independente de infrastructura nespecifică.

7. Inspectează commit-ul care a introdus bug-ul

O dată ce Git identifică primul commit re, examinează-l:

git show <commit-hash>

Pentru a vedea ce fișiere s-au schimbat:

git show --stat <commit-hash>

Pentru a inspecta un fișier specific:

git show <commit-hash> -- price.php

Primul commit re nu este neapărat singura cauză a bug-ului. Un commit arată o problemă ascunsă anterior, interacționează cu o altă schimbare sau depinde de un serviciu extern care s-a schimbat de atunci.

Folosește commit-ul identificat pentru a investiga cauza rădăcină, nu ca dovadă automată că fiecare linie din acel commit este greșită.

8. Probleme comune și soluții

Bug-ul apare inconstant

Dacă un test uneori trece și uneori eșuează pe aceeași revizie, rezultatele bisect devin nesigure. Rulează testul de mai multe ori, înlăturate dependențele de timing unde este posibil și controlați intrările externe. Testarea repetată îmbunătățește încrederea, dar crește tiempo de investigație.

Testul eșuează pe fiecare revizie istorică

Confirmă-ți că commit-ul cunoscut ca bun cu siguranță este bun. Check-out acea revizie separat și rulează testul înainte de a începe o sesiune bisect nouă. Dacă eșuează și acolo, testul sau mediul tău poate fi greșit.

Git refuză să comute revizii

Schimbările necommit pot preveni check-out. Verifică git status și păstrează-ți schimbările înainte de a restarta. Evită comandă distructive cum ar fi git reset --hard, cu excepția cazului în care înțelegi exact ce acestea înlătură.

Istoria conține mulți commit-uri de merge

Pentru depozite complexe, Git suportă:

git bisect start --first-parent HEAD v1.4.0

Aceasta urmează istoria primului părinte și poate ajuta la investigarea regresiilor introduse prin merge. Schimbă care commit-uri sunt considerate, deci nu este o înlocuire universală pentru un bisect normal.

Bug-ul depinde de datele de producție

Nu rula niciodată codul aplicației istoric contra unei baze de date de producție live. Folosește un mediu de test izolat cu fixture curățate și o schemă reproducibilă. Reviziile mai pot conține migrații sau presupuneri incompatibile cu producția.

9. O listă de verificare practică pentru depanare

  • Confirmă-ți că bug-ul este reproducibil.
  • Identifică o revizie cunoscută ca funcțională și una cunoscută ca eșuează.
  • Păstrează munca necommit.
  • Defină un test fiabil cu un clar rezultat de reușită/eșec.
  • Păstrează serviciile externe și datele de test consistente.
  • Folosește git bisect skip pentru revizii cu adevărat de testat.
  • Inspectează commit-ul identificat și verifică cauza rădăcină.
  • Termină cu git bisect reset.

Concluzia

Git bisect transformă o sarcină de depanare nesigură în o investigație structurată. În loc să devine care schimbare recentă a rupt aplicația, identifică o revizie funcțională, o revizie ruptă și lasă Git să restrângă istoria.

Tehnica devine special puternică când este combinată cu test automate. O regresie ascunsă printre sute de commit-uri poate fi adesea localizată cu doar câteva verificări.

Pentru dezvoltatorii care mențin proiecte PHP de lungă durată, plugin WordPress, extensii Joomla sau aplicații JavaScript, git bisect este una dintre cele mai utile comande Git dincolo de branching și merging de zi cu zi.