Verkkosivut ja kehitys

Git Bisect: Löydä commit, joka aiheutti virheen

Git Bisect: Find the Commit That Introduced a Bug

Ominaisuus toimi eilen, mutta epäonnistuu tänään. Opi käyttämään Git bisectia tunnistaaksesi commitin, joka aiheutti regressiota, testata versioita automaattisesti ja tutkia tulosta turvallisesti.

Git Bisect: Löydä virheen aiheuttanut commit

Verkkosivusto toimi viime viikolla. Tänään kassan laskenta on väärä, JavaScript-komponentti ei enää reagoi tai PHP-päätepiste palauttaa odottamatonta dataa.

Tiedät, että virhe ilmestyi jossain Git-historiassa, mutta arkisto sisältää kymmeniä tai satoja commiteja viimeisimmän toimivan version jälkeen. Jokaisen commitin avaaminen ja jokaisen diffin lukeminen on harvoin nopein ratkaisu.

Git sisältää juuri tähän tilanteeseen suunnitellun työkalun: git bisect. Sen sijaan, että tutkisi jokaisen commitin, se käyttää binäärihakua tunnistaakseen version, joka ensimmäisenä toi esiin ongelman. Luotettavalla testillä voit automatisoida tutkinnan.

Tässä opetusohjelmassa luot pienen PHP-projektin, tuot tarkoituksella regression, paikannat sen Git bisectillä ja opit soveltamaan samaa tekniikkaa oikeisiin projekteihin.

1. Miten Git bisect toimii

Kuvittele, että sovelluksesi toimi commitissa A mutta epäonnistuu commitissa H. Git bisect tarvitsee kaksi vertailukohtaa: hyvän commitin, jossa ominaisuus varmasti toimi, ja huonon commitin, jossa virhe varmasti on olemassa.

Se tarkastaa välissä olevan version. Testaat sen, ilmoitat, toimiiko se, ja Git pienentää jäljellä olevaa hakualuetta. Noin 128 kandidaatticommitille binäärihaku vaatii tyypillisesti noin seitsemän testiä sen sijaan, että kaikki 128 tarkastettaisiin, olettaen että toimintaa voidaan luokitella johdonmukaisesti.

Gitin virallinen dokumentaatio kuvaa prosessin ja sen rajoitukset.

2. Luo toistettava PHP-regressio

Rakennamme pienen hinnanlaskentafunktion. Kehystä, tietokantaa, Composer-pakettia tai verkkopalvelinta ei tarvita. Sinun täytyy asentaa Git ja PHP CLI, ja Gitin tulee sisältää tekijänimesi ja sähköpostiosoitteesi commiteille.

Luo hakemisto ja alusta arkisto:

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

Luo price.php:

<?php

declare(strict_types=1);

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

Odotettu toiminta on suoraviivainen: finalPrice(100, 20) palauttaa 80.

Commitoi tämä toimiva versio:

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

Luo seuraavaksi aiheeton muutos:

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

Toimita lopuksi virhe muuttamalla laskentaa price.php:

<?php

declare(strict_types=1);

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

Commitoi rikkinäinen versio:

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

Projektissa on nyt kolme committia, ja viimeisimmässä on tarkoituksella aiheutettu regressio.

3. Etsi regressio manuaalisesti

Aloita varmistamalla, että työpöytäsi on puhdas:

git status --short

Komennon tulisi olla tuottamatta mitään tulostetta. Jos sinulla on commitoimaton työtä, commitoi se asiaankuuluvasti tai tallenna se välimuistiin ennen aloittamista.

Käynnistä nyt Git bisect:

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

Tässä HEAD on rikkinäinen versio, kun taas HEAD~2 osoittaa ensimmäiseen, toimivaan committiin. Git tarkastaa välissä olevan commitin.

Testaa laskentaa:

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

Jos tuloste on 80, merkitse versio hyväksi:

git bisect good

Jos se on 120, merkitse se huonoksi:

git bisect bad

Git jatkaa committien valitsemista, kunnes se tunnistaa ensimmäisen huonon version. Tässä kolmen commitin esimerkissä vain yksi välissä oleva versio tarvitsee testata.

Kun olet valmis, palauta alkuperäinen branchisi:

git bisect reset

Bisectin aikana Git tarkastaa yleensä historiallisia versioita erillisessä HEAD-tilassa. git bisect reset palauttaa sinut versioon, jota käytit ennen tutkimusta.

4. Automatisoi tutkinta git bisect run -komennolla

Manuaalinen testaus on hyödyllistä, kun virhe vaatii visuaalista tarkastelua. Mutta jos toimintaa voidaan tarkastaa komennolla, automatisointi on tehokkaampaa.

Git tukee git bisect run <command>. Komento välittää tuloksensa poistumiskoodilla:

Poistumiskoodi Merkitys
0 Hyvä versio
1–124 tai 126–127 Huono versio
125 Tätä versiota ei voi testata
Muut arvot Keskeytä tutkinta

Nämä säännöt tulevat Gitin virallisesta bisect-käsikirjasta.

Luo testiskripti arkiston ulkopuolelle, kuten ../check-price.php:

<?php

declare(strict_types=1);

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

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

Skripti olettaa, että projektikansio on nimetty git-bisect-demo ja sijaitsee check-price.php vieressä. Suorita nämä komennot projektikansion sisällä:

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

Git suorittaa testin valituilla historiallisilla versioilla, kunnes ensimmäinen huono commit tunnistetaan. Koska testiskripti on arkiston ulkopuolella, vanhemman version tarkastaminen ei poista sitä.

Oikeissa projekteissa käytä vakaata testikomentoa tai ulkoista testiskriptiä, joka toimii tutkittavien historiallisten versioiden kanssa.

5. Sovella tekniikkaa oikeaan verkkoprojektiin

Sama työnkulku toimii WordPress-lisäosalle, Joomla-laajennukselle, JavaScript-sovellukselle tai PHP-kirjastolle.

Oletetaan, että kassan ominaisuus on rikki uusimmassa versiossa, mutta se toimi julkaisussa v1.4.0. Varmista ensin, että julkaisu todella on hyvä, ja aloita sitten:

git bisect start HEAD v1.4.0

Jos projektissa on PHPUnit-testi, joka toimii valittujen versioiden läpi, voit ajaa sen manuaalisesti:

vendor/bin/phpunit tests/CheckoutTest.php

Jokaisen testin jälkeen ilmoita git bisect good tai git bisect bad.

Kun testi on luotettavasti automatisoitu:

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

Historialliset commitit saattavat vaatia eri PHP-versioita, riippuvuuksia, tietokantakaavioita tai rakennustyökaluja. Ympäristön yhteensopimattomuuden vuoksi epäonnistuva testi ei välttämättä osoita regressiota. Varmista, että test ympäristösi voi toistaa asiaankuuluvat historialliset versiot.

Technical workflow illustration

6. Entä jos vanhaa committia ei voi testata?

Joskus historiallinen versio epäonnistuu rakentamisessa aiheettomasta syystä. Älä merkitse sitä automaattisesti huonoksi.

Käytä:

git bisect skip

Git yrittää toista kandidaattia. Automaattisille testeille poistumiskoodi 125 kertoo Gitille, että versio ohitetaan.

Liian monen commitin ohittaminen vähentää tarkkuutta. Jos testauskelvoton commit on regression vieressä, Git saattaa ilmoittaa useita mahdollisia syyllisiä yhden tarkan commitin sijaan.

Hyvä pitkän aikavälin käytäntö on ylläpitää toistettavia kehitysympäristöjä, lukita riippuvuusversiot ja pitää kriittiset regressiotestit riippumattomina aiheettomasta infrastruktuurista.

7. Tarkasta virheen aiheuttanut commit

Kun Git tunnistaa ensimmäisen huonon commitin, tarkastele sitä:

git show <commit-hash>

Nähdäksesi, mitkä tiedostot muuttuivat:

git show --stat <commit-hash>

Tarkastaaksesi tietyn tiedoston:

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

Ensimmäinen huono commit ei välttämättä ole ainoa virheen syy. Commit saattaa paljastaa aiemmin piilotetun ongelman, olla vuorovaikutuksessa toisen muutoksen kanssa tai riippua ulkoisesta palvelusta, joka on sittemmin muuttunut.

Käytä tunnistettua committia tutkiaksesi juurisyytä, älä automaattisena todistuksena siitä, että jokainen kyseisen commitin rivi on väärin.

8. Yleiset ongelmat ja ratkaisut

Virhe ilmenee epätasaisesti

Jos testi joskus menee läpi ja joskus epäonnistuu samalla versiolla, bisect-tulokset muuttuvat epäluotettaviksi. Aja testi useita kertoja, poista ajoitusriippuvuudet mahdollisuuksien mukaan ja hallitse ulkoisia syötteitä. Toistettu testaus parantaa varmuutta mutta lisää tutkimusaikaa.

Testi epäonnistuu jokaisella historiallisella versiolla

Varmista, että tunnettu hyvä commit todella on hyvä. Tarkasta se versio erikseen ja aja testi ennen uuden bisect-istunnon aloittamista. Jos se epäonnistuu sielläkin, testisi tai ympäristösi voi olla virheellinen.

Git kieltäytyy vaihtamasta versioita

Commitoimattomat muutokset voivat estää tarkastamisen. Tarkista git status ja säilytä muutoksesi ennen uudelleenkäynnistämistä. Vältä tuhoavia komentoja, kuten git reset --hard, ellei tiedä täsmälleen, mitä ne hylkäävät.

Historia sisältää monia merge-comitteja

Monimutkaisille arkistoille Git tukee:

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

Tämä noudattaa ensimmäisen vanhemmän historiaa ja voi auttaa tutkimaan mergejen kautta esiin tulleita regressioita. Se muuttaa, mitä committeja pidetään tarkastelun kohteena, joten se ei ole universaali korvaaja normaalille bisectille.

Virhe riippuu tuotantodatasta

Älä koskaan aja historiallista sovelluskoodia live-tuotantotietokantaa vastaan. Käytä eristettyä test ympäristöä desinпускيوiduilla lähtöaineistoilla ja toistettavalla kaaviolla. Vanhemmat versiot saattavat sisältää migraatioita tai oletuksia, jotka eivät ole yhteensopivia tuotannon kanssa.

9. Käytännön vianetsintä tarkistuslista

  • Varmista, että virhe on toistettavissa.
  • Tunnista yksi versio, jonka tiedetään toimivan, ja yksi, jonka tiedetään epäonnistuvan.
  • Säilytä commitoimaton työ.
  • Määrittele luotettava testi, jolla on selkeä läpäisy/epäonnistumistulos.
  • Pidä ulkoiset palvelut ja testidata johdonmukaisina.
  • Käytä git bisect skip todella testauskelvottomille versioille.
  • Tarkasta tunnistettu commit ja vahvista juurisyyn.
  • Päätä git bisect reset.

Yhteenveto

Git bisect muuttaa epävarman vianetsintätehtävän jäsennellyksi tutkimukseksi. Sen sijaan, että arvaisit, mikä viimeisimmistä muutoksista rikkoi sovelluksen, tunnistat toimivan version, rikkinäisen version ja annat Gitin rajata historian.

Tekniikka muuttuu erityisen tehokkaaksi yhdistettynä automaattisiin testeihin. Satunnaisten committien joukkoon piilotettu regressio voidaan usein paikallistaa vain kourallisella tarkastuksia.

Kehittäjille, jotka ylläpitävät pitkäikäisiä PHP-projekteja, WordPress-lisäosia, Joomla-laajennuksia tai JavaScript-sovelluksia, git bisect on yksi hyödyllisimmistä Git-komennoista arkipäiväisen haarauksen ja yhdistämisen lisäksi.