5.10 Git инструменти - Дебъгване с Git

Ако проследявате дадена грешка в кода си и искате да разберете кога и как е възникнала, файловите анотации често са най-добрия начин да направите това. Те показват кой е последния къмит модифицирал всеки един ред от произволен файл. Така че, ако срещнете метод с бъгав код в него, можете да анотирате файла с командата git blame за да установите кой къмит е въвел в кода специфичния ред или редове от код.

Следващият пример използва git blame за да установи кои къмити и разработчици са отговорни за редовете код от един Makefile файл в проекта на Linux ядрото и освен това използва флага L за да ограничи изхода до редовете между 69 и 82:

Първото поле в ляво на таблицата е част от SHA-1 хеша на къмита, който последно е модифицирал съответния ред. Следващите две колони се извличат от самия къмит — името на автора му и датата на къмита. В следващите колони идват номера и съдържанието на реда от файла. Отбележете също и редовете започващи с ^1da177e4c3f4, при тях префикса ^ обозначава, че те са били създадени с първия къмит на хранилището и след това не са променяни нито веднъж. Този вид обозначение причинява малко смут, защото досега видяхме поне три различни начина, при които Git използва този символ за да модифицира SHA-1 хеш стойностите, но в този конкретен случай това е неговото значение.

Друга хубава черта на Git е, че не проследява изрично преименуванията на файловете. Git записва snapshot-ите и след това се опитва да установи какво е било безусловно преименувано постфактум. Една от интересните особености на това е, че можете да правите запитвания и за премествания на код. С параметър -C към git blame Git анализира файла, който анотирате и се опитва да установи откъде са се появили дадени отрязъци от код, ако те са копирани от друго място. Например, да кажем че преработвате файл с име GITServerHandler.m в множество файлове, един от които се казва GITPackUpload.m. Изследвайки GITPackUpload.m с параметър -C, можете да видите къде първоначално са се намирали секции код от него:

Това е наистина полезно. Нормално бихте получили като оригинален къмит този, при който сте вмъкнали съдържанието в новия файл, защото това е първия път, когато сте докоснали тези редове в този файл. Git обаче може да ви намери и оригиналния къмит, в който сте написали тези редове, дори те да са били в друг файл.

Анотирането на файлове помага, когато знаете къде започва проблема. Ако обаче не знаете какво се е счупило и има дузина или стотици къмити от последния път, когато знаете че кодът е работил, вероятно ще прибегнете до помощта на git bisect. Командата bisect се използва за бинарно търсене в историята на къмитите за да ви помогне да идентифицирате даден проблем възможно най-бързо.

Нека кажем, че сте публикували завършена версия на кода си и започвате да получавате новини за грешки, които не се наблюдават в работната версия и нямате идея защо кодът се държи така. Връщате се обратно в кода и се оказва, че всъщност можете да пресъздадете грешката, но все още не разбирате защо възниква. В такъв случай можете да bisect-нете (разполовите) кода за да потърсите причината (понятието идва от начина, по който Git третира и разцепва историята в процеса на търсене описан в примерите, които следват). Първо, изпълнявате git bisect start за да стартирате процеса и след това git bisect bad за да кажете на системата, че текущия къмит е проблематичен. След това, трябва да кажете на bisect кога е бил последния работещ статус на нещата изпълнявайки git bisect good <good_commit>:

Git е установил около 12 къмита, които са се случили между този, който сте маркирали като последно работещ (v1.0) и текущата проблемна версия и е извлякъл за вас средния от тях. На този етап, можете да си пуснете тестовете, за да видите дали проблемът все още се появява в този извлечен къмит. Ако е така, то той е възникнал някъде преди средния къмит. Ако не е, значи възниква след него. Да кажем, че проблемът го няма на текущия къмит — вие уведомявате Git за това с git bisec good и продължавате да търсите:

Сега сте на друг къмит, който е по средата между този който току що тествахте и проблематичния. Пускате тестовете отново и този път установявате, че грешката се появява и уведомявате Git с git bisect bad:

Този къмит е безпроблемен и сега Git има информацията, която му е нужна за да разбере къде се е появил проблема. Вие получавате SHA-1 хеша на първия проблемен къмит, заедно с малко данни за него и списък на модифицираните файлове така че да успеете да установите източника на грешката:

Когато приключите, трябва да изпълните git bisect reset за да пренасочите HEAD към мястото, където сте били преди да стартирате процеса:

Това е мощен инструмент, който за минути може да провери стотици къмити в процеса на търсене на грешка. В допълнение, ако имате скрипт, който завършва със статус exit 0, ако проектът работи коректно или с различен статус, ако това не е така, можете напълно да автоматизирате git bisect. Първо, вие отново указвате обхвата на bisect подавайки познатите добър и лош къмит. Можете да направите това изписвайки ги с bisect start командата, първо подавате лошия (HEAD) и след това последно познатия добър (v1.0):

Правейки това, Git автоматично ще изпълнява test-error.sh за всеки извлечен къмит докато намери първия проблематичен. Можете също да изпълнявате неща като make или make tests или каквото и да било друго средство, което използвате за автоматично тестване.