Programma Les 118 van 148 · Ontwerp je eigen tools
Ontwerp je eigen tools

Een diff risico samenvatting

Waarom dit ertoe doetReviewers scannen snel. Een samenvatting van één regel bovenaan een pull request ("raakt een migration, verzwakt tests") vertelt hen waar ze moeten vertragen. Dit is elke keer hetzelfde, in tegenstelling tot een chat vragen om "review this diff".

Je team schrijft zijn beoordelingsregels op en wil een tool die deze toepast op een unified diff (de output van git diff). Elke file in de diff is een sectie die begint met een diff --git a/OLD b/NEW regel. Header regels volgen (index, ---, +++, new file mode, deleted file mode, rename from/to, similarity index, Binary files ... differ). Na de eerste @@ regel van een sectie is elke regel inhoud: + toegevoegd, - verwijderd, een spatie voor context.

Echte verschillen zijn rommeliger dan die in het tekstboek. Een pure rename heeft geen ---/+++ regels en geen inhoud. Een binair bestand heeft geen van beide. De +++ regel van een verwijderd bestand zegt /dev/null. En een verwijderde SQL comment, -- old note, verschijnt in de diff als --- old note.

Jij bent aan de beurt

Schrijf risk_summary(diff). Een pad van een bestand is NIEUW vanaf zijn diff --git regel, of OUD als de sectie een deleted file mode regel heeft. Paden hebben geen spaties. Geef een dictionary terug van categorie naar de gesorteerde lijst van paden erin (laat lege categorieën weg):

  • schema: een directory in het pad heet migrations, of de bestandsnaam eindigt op .sql.
  • secrets: een added regel bevat password, secret, api_key of token, in elk geval.
  • tests-weakened: een testbestand (naam begint met test_, of een directory heet tests) dat wordt verwijderd, of meer verwijderde dan toegevoegde regels bevatten met assert.
  • dependencies: de bestandsnaam is requirements.txt, pyproject.toml, package.json of package-lock.json.
  • config: de bestandsnaam eindigt op .yml, .yaml, .ini of .env, of is settings.py.
Valkuil om te verslaan: de tests gebruiken hernoemingen, binaire bestanden, verwijderde en nieuwe bestanden, en SQL commentaren, zoals hierboven beschreven.

Een probleem ontdekt in deze les? Meld het · Vraag naar deze les

Deze oefening opent binnenkort

Maak de les ervoor af voordat deze wordt ontgrendeld. De hele cursus is gratis, geen account nodig, en je kunt deze les nu lezen.