Что такое git bisect и как искать баги в истории проекта

Иногда разработчики сталкиваются с багами, причины которых скрыты глубоко в истории проекта. Понять, когда именно была внесена ошибка, бывает сложно, особенно если проект имеет длинную историю коммитов и неочевидные зависимости. Чтобы упростить поиск ошибок и обнаружить, когда был внесен баг, в Git существует полезная команда — git bisect.

Зачем нужен git bisect?

Основная задача git bisect — это найти конкретный коммит, в котором возникла ошибка, используя метод "бинарного поиска". Команда позволяет разработчику указать верный (рабочий) и неверный (с ошибкой) коммиты, после чего автоматически запускает процесс поиска между ними. Это особенно полезно в случаях, когда в проекте сотни или даже тысячи коммитов, и проверка каждого из них вручную потребовала бы огромного количества времени.

Как работает бинарный поиск в git bisect?

Для поиска ошибки в истории Git применяет принцип бинарного поиска. Это означает, что git bisect берет диапазон коммитов между рабочей и сломанной версиями и делит его пополам, проверяя коммит в центре. Если этот коммит тоже "неправильный", поиск продолжается в половине с последними коммитами; если он "правильный" — поиск сдвигается к начальной половине. Процесс продолжается до тех пор, пока не останется один коммит, ответственный за возникновение ошибки.

Как использовать git bisect для поиска багов: пошаговая инструкция

Рассмотрим, как пользоваться git bisect на практике, чтобы обнаружить коммит, вызвавший ошибку.

Шаг 1. Запуск режима bisect

Для начала нужно открыть терминал в директории проекта и выполнить команду:

git bisect start

Теперь Git понимает, что начинается процесс бинарного поиска.

Шаг 2. Указание сломанного и рабочего коммитов

Чтобы git bisect мог понять, где искать ошибку, необходимо указать рабочий и сломанный коммиты:

git bisect bad HEAD

Эта команда указывает, что текущий коммит (HEAD) содержит ошибку. Затем нужно указать коммит, в котором ошибка точно отсутствует. Обычно это более старый коммит:

git bisect good <хеш коммита>

Теперь Git знает, между какими версиями искать ошибку.

Шаг 3. Проверка коммитов

После указания рабочего и сломанного коммитов git bisect выберет коммит в середине диапазона и автоматически переключится на него. Теперь нужно проверить, присутствует ли баг в данной версии кода. Если баг есть, выполните команду:

git bisect bad

Если баг отсутствует:

git bisect good

Git продолжит сужать диапазон коммитов и переключаться на средний коммит в оставшемся диапазоне.

Шаг 4. Повторение процесса

Продолжайте указывать bad или good для каждого коммита, на который переключает вас Git, пока не останется один коммит. Это будет коммит, ответственный за возникновение ошибки.

Шаг 5. Завершение поиска

После нахождения проблемного коммита нужно выйти из режима bisect, выполнив команду:

git bisect reset

Git вернет вас к тому коммиту, с которого начался поиск, и вы сможете приступить к исправлению ошибки.

Пример использования git bisect на практике

Допустим, у вас есть проект, и вы заметили, что в последней версии кода функция перестала работать. Вы не уверены, когда именно эта ошибка появилась, и решаете воспользоваться git bisect.

1. Запускаете бинарный поиск:git bisect start

2. Указываете, что текущий коммит содержит баг:git bisect bad HEAD

3. Указываете коммит, в котором всё точно работало:git bisect good a1b2c3d

4. Git переключает вас на коммит, находящийся в середине между рабочим и сломанным. Проверяете, работает ли нужная функция. Если не работает:git bisect bad
Если работает:git bisect good

5. Продолжаете процесс, пока Git не выявит коммит, вызвавший ошибку.
6. Завершаете процесс:git bisect reset


Полуавтоматическое использование git bisect run

Если процесс проверки можно автоматизировать с помощью скрипта, например, теста, который возвращает 0 при успешном завершении и 1 при ошибке, то можно использовать команду git bisect run. Это позволяет автоматически запускать тест для каждого коммита.

Пример использования git bisect run

Предположим, что у вас есть скрипт test.sh, который проверяет, работает ли код. Для полуавтоматического поиска выполните команды:

git bisect start

git bisect bad HEAD

git bisect good <хеш коммита>

git bisect run ./test.sh

Теперь git bisect будет автоматически выполнять скрипт на каждом выбранном коммите. Как только скрипт завершится с ошибкой (1), Git отметит коммит как "bad". Процесс продолжается до тех пор, пока не будет найден коммит с ошибкой.

Когда использовать git bisect?

git bisect полезен, если:

• В проекте много коммитов, и вручную искать ошибку сложно.
• Известны приблизительные границы, в которых произошла ошибка.
• Важно быстро определить момент, когда код перестал работать корректно.

Примеры использования:

1. Изменения на уровне производительности: Команда обнаружила, что производительность ухудшилась, но не может точно определить момент, когда это произошло.
2. Сломанная функция: Функция, которая раньше работала, вдруг перестала, и непонятно, почему.
3. Отладка тестов: Если после обновления кода несколько тестов начали проваливаться, git bisect поможет найти коммит, повлиявший на их работу.

Советы по эффективному использованию git bisect

• Минимизируйте диапазон поиска: Чем меньше диапазон между good и bad коммитами, тем быстрее будет поиск.
• Автоматизация тестов: Использование скриптов для проверки на каждом шаге может значительно ускорить процесс, особенно для крупных проектов.
• Управление ветками: git bisect можно использовать на любой ветке, но убедитесь, что вы не работаете на ветке с незавершенными изменениями.
• Ручная проверка: В некоторых случаях может потребоваться ручная проверка, особенно если тесты не полностью покрывают все аспекты ошибки.

Заключение

git bisect — это мощный инструмент для поиска ошибок в истории проекта, позволяющий сэкономить время и упростить отладку. Он применяет бинарный поиск для ускорения процесса и позволяет точно определить коммит, вызвавший проблему. Будь то сломанная функция или внезапное падение производительности, git bisect поможет найти причину и сделать ваш проект более стабильным и надежным.