QA/Bibisect/ru

Введение
Bibisect означает "деление пополам" и предназначен для помощи членам команды QA LibreOffice занимающихся регрессиями. Регрессия наиболее раздражающий артефакт, который, к сожалению, приходит с разработкой программы. Однако, мы хотим иметь дело с ними как можно раньше, так как их поиск и исправление со временем становятся всё сложнее и сложнее. Git хранит свои вещи так, что одна программа Bibisect может содержать несколько полных 64-разрядных офисных пакетов Linux установленных в очень сжатом размере. И это не требует установки всех версий параллельно, так как можно перейти к любому из них быстро через, что занимает менее 1 секунды.

Ограничения
При помощи Bibisect возможно находить только те ошибки, для которых в репозитории Bibisect есть в наличии круг подтверждённых вопросов. На сегодняшний день это верно для всех регрессий в Linux. Для macOS и Windows мы медленно приближаемся к цели.

Если вы не готовы испытывать одну и туже версию LibreOffice несколько раз на одну и туже ошибку, чтобы собрать статистику и обезопасить свои выводы, этот способ не сможет гарантировать нахождение той версии в которой с которой она появилась, тем более если она не 100% воспроизводима.

Видео урок на Youtube
10-ти минутный ролик (Youtube)] от Florian Reisinger. - Урок на английском. Но вроде бы, все ключевые моменты понятны. Качество звука не очень хорошее, но достаточное, чтобы понять что говорят.

Details
A successful bibisect will leave developers with only a few commits to search through to find the 'culprit' commit that we believe introduced a regression. QA can go the additional step of fully bisecting (determining the exact commit) or can leave this to the developers. It's often easy to find the commit that caused the issue after bibisecting the bug.

With approximately 10 gigs, you'll have hundreds of builds to work with. A bibisect can take as little as 15 minutes.

Currently, bibisecting is possible on:
 * GNU/Linux (64 bit)
 * macOS
 * Windows

As can be seen from the Commits in range and Number of builds, depending upon the particular bibisect repository, this range might be on average 80 commits for old "43max" repository (reaching hundreds of source commits in some builds) to just 1 or 2 commits for newer repositories. (We also have some very 'coarse' bibisect repositories that use released versions + beta + RC builds, and these may have ranges spanning multiple hundreds of commits).

If build commit or range is found, bug is marked with keyword "bibisected", and if source commit is found, bug is additionally marked "bisected".

General Instructions
It might be a good idea for beginners to start by tracing the steps of a bibisect that was already completed successfully. For this purpose we have a bibisecting tutorial.

Note: Each operating system is different, please read the full instructions that correspond to your specific operating system (GNU/Linux, macOS, or Windows) for more complete instructions, instructional videos, and other related information.

Короткие инструкции - Только для Linux

 * 1) Скачайте репозиторий (12 Гбайт, но не беспокойтесь - это нужно только один раз).
 * 2) Распакуйте его в удобную папку.
 * 3) Откройте терминал (не волнуйтесь, всего несколько простых команд).
 * 4) Если вы используете Ubuntu нужно установить   и  :
 * 5) перейдите в директорию с программой
 * 6) Запустите программу
 * 7) Запустите офис
 * 8) Воспроизведите действия которые вызывают ошибку
 * 9) Если ошибка не воспроизводится:
 * 10) Если ошибка присутствует:
 * 11) повторите шаги 6 & 7 пока не найдёте ту версию в которой эта ошибка появилась
 * 12) Прикрепите вывод лога к отчету об ошибке
 * 1) Прикрепите вывод лога к отчету об ошибке
 * 1) Attaching the bibisect log to the bug report
 * 2) Remove keyword 'bibisectRequest' from Keywords field and add the keyword 'bibisected'
 * 3) If the commit causing the regression has been identified, also add the keyword 'bisected', add the developer as CC and add the comment 'Adding Cc: to '

Версии
Репозиторий 43all должен включать все предыдущие и поэтому они могут считаться устаревшими. Now you can copy the source hashes of the first and previous displayed commits and use them to construct a range query like so: https://git.libreoffice.org/core/log/7c4d3ea6ba4d42b4dda5148a00c8c411b5d7703d..5b195fbcf7a441aeb193f6abd08b877e580938e0 This will allow you to skim commit messages looking for related subjects. For deeper scrutiny, see the section on detective work.

Limitations
Performing a bibisect is only possible if we have a repository available for the correct OS, covering the correct range of LibreOffice commits. We have very good coverage on GNU/Linux, and are improving our coverage on Windows and macOS.

Some regressions are difficult to reproduce, and may require multiple test runs for a bug to appear. As you may imagine, trying to bibisect such regressions is very difficult, and requires one to perform many test runs after each checkout of a new version of LibreOffice to give some security / statistics that the bug is indeed present or not present with the given version.

We do not currently have bibisect support for
 * LibreOffice for Android
 * BSDs (although the GNU/Linux bibisect packages may run, with minor tweaks)
 * LibreOffice Online
 * LibreOffice Vanilla for Mac (in the Mac App Store)

Ручная установка (скачивание архива tar)
Во-первых, вы должны инсталлировать Linux 64-bit. Инсталляция в виртуальной машине тоже будет работать.

Затем установите зависимости для вашего дистрибутива: > sudo apt-get install git libjpeg62 # ubuntu Затем, скачайте архив bibisect (выбрать здесь) и распакуйте его. Для 42all команда распаковки выглядит как: > tar -xf bibisect-42all.tar.xz Вы также можете проверить подлинность и целостность файлов. Для этого вам понадобится GPG-ключ с https://launchpad.net/~bjoern-michaelsen. Для примера, > gpg --keyserver keyserver.ubuntu.com --recv-keys XXXXXXXX # замените XXXXXXXX на OpenPGP ключ с веб-страницы > gpg --verify bibisect-42all.tar.xz.sig Первое скачивание будет занимать несколько гигабайт (12 гигабайт для 43all). Обновления занимают меньше места.

Finding bugs needing bibisect
The following bugs with keyword bibisectRequest are waiting for a bibisect:

In addition all unresolved regressions in LibreOffice might benefit from bibisecting.

После нескольких повторений, git сообщит вам что-то вроде этого: 9625329ea5a7e3e8475cd21c07726beec20573bd is the first bad commit commit 9625329ea5a7e3e8475cd21c07726beec20573bd Author: Bjoern Michaelsen  Date:  Thu Dec 8 12:29:59 2011 +0100

source-hash-2d19e9bb07ccff3134f855812dddfda5c07b1fe4 commit 2d19e9bb07ccff3134f855812dddfda5c07b1fe4 Author:    Jan Holesovsky  AuthorDate: Wed Nov 16 14:17:03 2011 +0100 Commit:    Jan Holesovsky  CommitDate: Wed Nov 16 14:21:33 2011 +0100 Kill one usage of chrel.sed to fix build. Приложите это (линия source-hash-2d19e9bb07ccff3134f855812dddfda5c07b1fe4 является очень важной тут) и сделайте вывод: > git bisect log Который должен выглядеть примерно так: git bisect start 'latest' 'oldest' git bisect good 2faf4bc12ab490370d2196dedbc8091f9b09d0a5 git bisect bad b6fca7e58854bc617c5fc9a75d1c1720b0d7e1a4 git bisect good 0a28a62d53e996cf66d86e9bfb63ddc6ade75b7e git bisect bad 9625329ea5a7e3e8475cd21c07726beec20573bd git bisect good 89d91bb6074026dc0894bcdc6aaf8f6124102da7 Для разработчиков это даст хорошее понимание, где начинается ошибка. Также, поставьте слово bibisected в поле статуса whiteboard, для того, чтобы ошибка больше не появлялась в списке с нуждающимися для поиска при помощи Bibisect.
 * 1) good: [2faf4bc12ab490370d2196dedbc8091f9b09d0a5] source-hash-418a35f4861e863feb39eec73f4a39a87fbcb1f3
 * 1) bad: [b6fca7e58854bc617c5fc9a75d1c1720b0d7e1a4] source-hash-ce60138d339a5eb2a174a5d27063249acf2cac42
 * 1) good: [0a28a62d53e996cf66d86e9bfb63ddc6ade75b7e] source-hash-71cbcb62028295a98ceee60cb4c4ee425bafcd2e
 * 1) bad: [9625329ea5a7e3e8475cd21c07726beec20573bd] source-hash-2d19e9bb07ccff3134f855812dddfda5c07b1fe4
 * 1) good: [89d91bb6074026dc0894bcdc6aaf8f6124102da7] source-hash-fb754a0df859e30255c25af8fa19bfaa75f257e7

Теги в репозиториях bibisect
Репозиторий 42all тэги типа,  , которые маркируют последние сборки на ветке master до того как релиз был ответвлён. Если вы имеете ошибку, которую вы уже о которой знаете что она воспроизводится между 4.0 и 4.1, вы мжете сделать следующим образом: > git bisect start last41onmaster last40onmaster для того, чтобы искать в этом диапазоне. Обратите внимание, что ответвление крупного релиза происходит гораздо раньше, чем первая финальная версия (обычно между альфа и бета). Так что ошибка в первом крупном релизе может быть воспроизведена после ответвления. Она по-прежнему должны быть доступна для поиска в bibisect на ветке master по пути к следующей версии, так как почти все фиксации на ветке релиза идут в первую очередь на ветку master. Поэтому обращайтесь с осторожностью.

особенности репозитория ежедневных сборок dbgutil
Каждая версия имеет файл, и первая строка файла содержит source-hash который говорит о сборке. Это будет полезно, если вы включите исходные хэши последней хорошей версии и первый плохой в вашем докладе о результатах тестирования bibisect.

Не доступно для поиска
Некоторые ошибки не доступны для поиска при помощи Bibisect. Это включает: Еслиa ошибка с bibisectrequest в поле статуса whiteboard оказывается не пригодной для поиска при помощи Bibisect, оставьте комментарий на ошибки объясняя, почему мы не можем использовать Bibisect, и заменить bibisectrequest на NotBibisectable в поле статуса whiteboard.
 * Ошибки, которые не воспроизводятся на GNU/Linux
 * Ошибки, которые предшествуют покрытию в сборке Bibisect (Мы работаем над расширением покрытия)
 * Ошибки, которые зависят от параметров создания не включен в сборки TDF (например, ошибки в -kde)

Выберите ошибку нуждающуюся в поиске при помощи Bibisect
Следующие ошибки в поле whiteboard с записью bibisectrequest ожидают обработки:

 https://bugs.documentfoundation.org/buglist.cgi?list_id=145560&product=LibreOffice&query_format=advanced&status_whiteboard=bibisectrequest&status_whiteboard_type=allwordssubstr&title=Bug%20List&ctype=atom&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED  Открыть этот лист в Bugzilla

Кроме того, для всех нерешенных регрессий в LibreOffice можно попытаться использовать bibisecting.

Поиск ошибок уже прошедших проверку на Bibisect
Ссылки на запросы в Bugzilla смотрите тут.

С учетом указанной выше информации добавленой к ошибке разработчик знает, что регрессия появилась между фиксациями fb754a0df859e30255c25af8fa19bfaa75f257e7 (good) and 2d19e9bb07ccff3134f855812dddfda5c07b1fe4 (bad) в мастере. > git log fb754a0df859e30255c25af8fa19bfaa75f257e7..2d19e9bb07ccff3134f855812dddfda5c07b1fe4 В репозитории исходного кода будет показано 128 фиксаций в том числе та, которая спровоцировала ошибку. Это сильно облегчает поиск для разработчиков, и ускоряет исправление ошибки. Подробнее можно посмотреть:
 * Bisect в книге сообщества git
 * Обсуждение в списке разработчиков

Finding a fix
Sometimes a bug is a collateral damage of another (possibly minor) bug, in a non obvious way. In such cases that other bug might be fixed on master, but was not backported to the release branch. To identify a problem-fixing commit you can use: As you test, say  or   as appropriate.

If the fix is small and important enough, it likely can be easily backported to the release branch.

Checking out a specific commit based on source hash
Sometimes you already know a specific source commit has/does not have the bug you are hunting.

Copy the source hash from the LibreOffice git history and use it to grep in the bibisect repo log like so:

git log --all --grep='29a9f433c268414747d8ec7343fc2b5987971738'

Copy the commit hash of the bibisect repo and do a checkout for it to verify your assumption:

git checkout 38758b70f5278d4d8292a2e857e80a9a1130f38e

You can use the repo commit hash when determining the bad-good range to bisect:

git bisect start 38758b70f5278d4d8292a2e857e80a9a1130f38e oldest

Doing detective work inside a commit range
In case your bibisect result is a range of commits and you have trouble locating the offending commit, you might make your life easier by searching with a keyword.

An example for a case, where we know the problem is in Calc's Navigator view: Adjust the -B and -A grep parameters to control how many lines before and after the hit you want to display. When piping to less, -R preserves the colouring of search results.

Bisect skip hell
Sometimes we get stuck in a miserable situation, where we have to use git bisect skip over and over again due to various reasons. There are ways of getting out of these infuriating messes and here we will show one of them.

Example bug:

Bug appeared in 4.0-4.1 range.

There are lots of commits, where the autofilter is not shown at all, so have to skip those.

We can use git bisect visualize to show us the remaining suspected commits: The earliest bad results are at the top while the ones you have skipped are at the bottom. The commit below the bottom is the last known good one.

My top results included b842ac1 source-hash-7b4d76772ef76a8de852ed647ed0cad368f70189 40ef04e source-hash-dc173b7f2a550185404aacbc6da744cb6d1880fc 8e697de source-hash-eb96e4325278f31b9e6fbc1d5c6a01543204ded6

So I did git checkout b842ac1, test, continue with the next etc. Turns out the third one from the top was already a skippable commit.

I made a range query with the source hashes in the style bottomcommit..firstbadcommit.

In the displayed results I searched for "filter" and found a suspicious commit about sorting autofilter popup items.

If soffice is failing with a non-zero exit code--this probably means a crash--a solution under QA/Bibisect/Automation offers a script to ease the pain of repeatedly skipping failed probes.

Finding source commits from bibisect
If bibisect was done, but not likely to be correct or in a repository known to have large range of source commits, we can check the range by finding a previous build commit from the found one and then find the source range.

Работа в отдельном профиле пользователя
Чтобы создать отдельный каталог пользователя в  (который будет автоматически удалён при следующей перезагрузке системы): > ./opt/program/soffice -env:UserInstallation=file:///tmp/soffice-bisect

Если вы хотите, чтобы каждый запуск программы создавал новый каталог с хэш-кодом фиксации git, вы можете добавить в конец имени каталога. Для примера: > ./opt/program/soffice \ >    -env:UserInstallation=file:///tmp/soffice-bisect-$(git rev-parse HEAD)

Finding a fix
Problem / Messages: error: Your local changes to the following files would be overwritten by checkout: opt/program/pythonloader.pyc opt/program/uno.pyc opt/program/unohelper.pyc Please, commit your changes or stash them before you can switch branches. Aborting

'''Иногда ошибка неочевидным путём является побочным эффектом другой (возможно маленькой) ошибки. В таких случаях ошибка может быть исправлена на ветке master, но не внесена в основную ветку. Вы можете найти исправление таким же способом как и ошибку, кроме того, что вам нужно вводить  за   и наоборот. Если исправления небольшие и достаточно важные, это может легко быть перенесено в основную ветку.''':

The above command will repair the problem. Afterwards you can start the next test run as usual with

If that does not solve the problem, you can try the following commands:

The ultimate repair is to delete everything except one hidden .git/ folder, and do

Unable to start soffice
Problem 1: Upon trying to run soffice within bibisect you receive the error "unexpected operator terminate called after throwing an instance of 'com::sun::star::uno::DeploymentException'

Solution: Reset your libreoffice profile located in ~/.config/libreoffice. Make sure to backup the folder if you have any settings you'd like to preserve for use with your stable libreoffice release. After you're done with bibisect you can try to return your backed up profile to it's original location (ie. delete the new profile folder and replace it with the backed up one)

Problem 2: Trying to run soffice within bibisect gives frequent errors such as "Application Error" and skipping via 'git bisect skip' is tedious.

Solution: Upon an error, run one-line script to skip commit on error message and try the next one. Script will stop when soffice is successfully run and then you proceed with 'git bisect good' or 'git bisect bad'. If error is repeated, script can be run again.

How to bisect RTL bugs
In case you need to bisect a RTL ( Right-To-Left ) bug, please import this variable before calling LibreOffice:

How to bisect File Recovery bugs
In case you need to bisect File Recovery bugs ( e.g. ), comment out line OOO_DISABLE_RECOVERY=1 in file instdir/program/ooenv

You may also use user control:

How to bisect file hanging / CPU or memory exhaustion bugs
In case you need to bisect file hanging/memory exhaustion bugs, you may limit memory or CPU or time execution.

In Linux, timeout utility can be used. To avoid confusion with built-in "timeout" command, here it's renamed to "tmt".

For example, if LibreOffice 'good' commit opens a file with 1 GB of memory, you may set soffice memory limit to 1.500.000 kilobytes to avoid 'bad' commit hanging your computer.

Or, to limit CPU+SYS time (where normal time is seen with successful run):

More advanced option is to use benchexec utility. User needs to be added to the appropriate group (benchexec). Runexec can be used to execute a single command while measuring its resource consumption, similarly to the tool "time" but with more reliable time measurements and with measurement of memory usage.

In Windows, process-governor utility can be used.

Automation
See the separate article on automating bisecting.

Примечания

 * QA/Bibisect/Implementation - подробная информация о создании архивов для bibisect;
 * Bibisectzilla - информации о слиянии всех наших bibisect