🥇Статичка анализа - од увода до интеграције

Уморни од бескрајног прегледа кода или отклањања грешака, понекад размишљате о томе како да поједноставите свој живот. И након мало претраге или случајно наиђете на њу, можете видети магичну фразу: „Статичка анализа“. Хајде да видимо шта је то и како може да утиче на ваш пројекат.

У ствари, ако пишете на било ком савременом језику, онда сте, а да тога нисте ни свесни, прошли кроз статички анализатор. Чињеница је да сваки савремени компајлер пружа, иако мали, скуп упозорења о потенцијалним проблемима у коду. На пример, када компајлирате Ц++ код у Висуал Студио-у, можда ћете видети следеће:

У овом излазу видимо да је променљива вар никада није коришћен нигде у функцији. Дакле, у стварности, скоро увек сте користили једноставан статички анализатор кода. Међутим, за разлику од професионалних анализатора као што су Цоверити, Клоцворк или ПВС-Студио, упозорења компајлера могу указивати на само мали опсег проблема.

Ако не знате сигурно шта је статичка анализа и како да је примените, прочитајте овај чланакда сазнате више о овој методологији.

Зашто вам је потребна статичка анализа?

Укратко: убрзање и поједностављење.

Статичка анализа вам омогућава да пронађете много различитих проблема у коду: од нетачне употребе језичких конструкција до грешака у куцању. На пример, уместо

auto x = obj.x;
auto y = obj.y;
auto z = obj.z;

Написали сте следећи код:

auto x = obj.x;
auto y = obj.y;
auto z = obj.x;

Као што видите, у последњем реду постоји штампарска грешка. На пример, ПВС-Студио издаје следеће упозорење:

ВКСНУМКС Размислите о прегледу исправности употребе ставке 'и'.

Ако желите да гурнете руке у ову грешку, покушајте са готовим примером у Цомпилер Екплорер-у: *кликните*.

И као што разумете, није увек могуће одмах обратити пажњу на такве делове кода, и због тога можете седети да отклањате грешке добар сат, питајући се зашто све функционише тако чудно.

Међутим, ово је очигледно грешка. Шта ако је програмер написао неоптималан код јер је заборавио неке суптилности језика? Или чак дозволио у коду недефинисано понашање? Нажалост, такви случајеви су потпуно уобичајени и највећи део времена се троши на отклањање грешака у конкретном радном коду који садржи грешке у куцању, типичне грешке или недефинисано понашање.

За ове ситуације се појавила статичка анализа. Ово је помоћник програмера који ће указати на разне проблеме у коду и објаснити у документацији зашто није потребно писати на овај начин, до чега то може довести и како то поправити. Ево примера како би то могло да изгледа: *кликните*.

Више занимљивих грешака које анализатор може открити можете пронаћи у чланцима:

Сада када сте прочитали овај материјал и уверили се у предности статичке анализе, можда бисте желели да је испробате. Али одакле почети? Како интегрисати нови алат у ваш тренутни пројекат? А како му представити екипу? У наставку ћете наћи одговоре на ова питања.

Напомена. Статичка анализа не замењује нити поништава тако корисну ствар као што је преглед кода. Он допуњује овај процес, помажући да се унапред уочи и исправи грешке у куцању, нетачности и опасни дизајн. Много је продуктивније фокусирати се на прегледе кода о алгоритмима и јасноћи кода, него тражити погрешну заграду или прочитајте досадне функције поређења.

0. Упознавање са алатом

Све почиње са пробном верзијом. Заиста, тешко је одлучити се да уведете нешто у процес развоја ако никада раније нисте видели алат уживо. Стога, прва ствар коју треба да урадите је да преузмете Пробна верзија.

Шта ћете научити у овој фази:

Који су начини интеракције са анализатором;
Да ли је анализатор компатибилан са вашим развојним окружењем?
Који проблеми тренутно постоје у вашим пројектима?

Након што сте инсталирали све што вам је потребно, прва ствар коју треба да урадите је да извршите анализу целог пројекта (виндовс, линук, Мац ОС). У случају ПВС-Студио у Висуал Студио-у видећете сличну слику (на коју се може кликнути):

Чињеница је да статички анализатори обично издају огроман број упозорења за пројекте са великом базом кода. Нема потребе да их све поправљате, пошто ваш пројекат већ ради, што значи да ови проблеми нису критични. Међутим, ти можете погледати најзанимљивија упозорења и по потреби их исправити. Да бисте то урадили, морате филтрирати излаз и оставити само најпоузданије поруке. У ПВС-Студио додатку за Висуал Студио, ово се ради филтрирањем према нивоима грешака и категоријама. За најтачнији излаз, оставите само висок и општи (такође може да се кликне):

Заиста, 178 упозорења је много лакше погледати него неколико хиљада...

У табовима Средњи и низак Често постоје добра упозорења, али ове категорије укључују оне дијагностике које имају мању тачност (поузданост). Више информација о нивоима упозорења и опцијама за рад под Виндовс-ом можете пронаћи овде: *кликните*.

Успешно прегледати најзанимљивије грешке (и успешно их исправити) вреди потиснути преостала упозорења. Ово је неопходно како се нова упозорења не би изгубила међу старима. Поред тога, статички анализатор је помоћник програмера, а не листа грешака. 🙂

1. Автоматизациа

Након упознавања, време је да конфигуришете додатке и интегришете се у ЦИ. Ово се мора урадити пре него што програмери почну да користе статички анализатор. Чињеница је да програмер може заборавити да омогући анализу или уопште не жели да је уради. Да бисте то урадили, потребно је да урадите коначну проверу свега тако да непроверени код не може да уђе у општу развојну грану.

Шта ћете научити у овој фази:

Које опције аутоматизације пружа алат;
Да ли је анализатор компатибилан са вашим монтажним системом?

Пошто савршена документација не постоји, понекад морате да упишете подршка. Ово је нормално и радо ћемо вам помоћи. 🙂

Сада пређимо на услуге континуиране интеграције (ЦИ). У њих се без озбиљних проблема може уградити било који анализатор. Да бисте то урадили, потребно је да направите засебну фазу у цевоводу, која се обично налази након тестова изградње и јединица. Ово се ради помоћу разних конзолних услужних програма. На пример, ПВС-Студио пружа следеће услужне програме:

ПВС-Студио_Цмд.еке (анализа решења, Ц#, Ц++ пројекти на Виндовс-у)
ЦЛМонитор.еке (надзор компилације)
пвс-студио-анализер (анализа Ц++ пројеката на Линук/мацОС)
пвс-студио-дотнет (анализа решења, Ц# пројекти на Линук/мацОС)
пвс-студио.јар (анализа Јава пројеката)
ПлогЦонвертер (конвертор фајлова извештаја)

Да бисте интегрисали анализу у ЦИ, морате да урадите три ствари:

Инсталирајте анализатор;
Рун аналисис;
Испоручите резултате.

На пример, да бисте инсталирали ПВС-Студио на Линук (Дебиан-база), потребно је да покренете следеће команде:

wget -q -O - https://files.viva64.com/etc/pubkey.txt 
    | sudo apt-key add -
sudo wget -O /etc/apt/sources.list.d/viva64.list 
  https://files.viva64.com/etc/viva64.list
  
sudo apt-get update -qq
sudo apt-get install -qq pvs-studio

На системима који користе Виндовс, не постоји начин да се инсталира анализатор из менаџера пакета, али је могуће применити анализатор из командне линије:

PVS-Studio_setup.exe /verysilent /suppressmsgboxes 
/norestart /nocloseapplications

Можете прочитати више о примени ПВС-Студио на системима који раде под Виндовсом *овде*.

Након инсталације, потребно је да директно покренете анализу. Међутим, препоручује се да то урадите тек након што су компилација и тестови прошли. То је зато што статичка анализа обично траје дупло дуже од компилације.

Пошто начин покретања зависи од платформе и карактеристика пројекта, приказаћу опцију за Ц++ (Линук) као пример:

pvs-studio-analyzer analyze -j8 
                            -o PVS-Studio.log
plog-converter -t errorfile PVS-Studio.log --cerr -w

Прва команда ће извршити анализу, а друга ковертеконвертује извештај у текстуални формат, приказује га на екрану и враћа повратни код који није 0 ако постоје упозорења. Овакав механизам се може практично користити за блокирање изградње када постоје поруке о грешци. Међутим, увек можете уклонити заставу -w и не блокирајте склоп који садржи упозорења.

Напомена. Формат текста је незгодан. Дато је једноставно као пример. Обратите пажњу на занимљивији формат извештаја - ФуллХтмл. Омогућава вам да се крећете кроз код.

Више о подешавању анализе на ЦИ можете прочитати у чланку „ПВС-Студио и континуирана интеграција" (Виндовс) или "Како подесити ПВС-Студио у Травис ЦИ“ (Линукс).

У реду, конфигурисали сте анализатор на серверу за изградњу. Сада, ако је неко поставио непроверени код, фаза верификације неће успети и моћи ћете да откријете проблем, међутим, ово није сасвим згодно, јер је ефикасније проверити пројекат не након што су гране спојене, већ пре тога, у фази захтева за повлачењем А.

Генерално, постављање анализе захтева за повлачењем се не разликује много од уобичајеног покретања анализе на ЦИ. Осим потребе да добијете листу измењених фајлова. Ово се обично може добити испитивањем разлика између грана помоћу гит-а:

git diff --name-only HEAD origin/$MERGE_BASE > .pvs-pr.list

Сада морате да проследите ову листу датотека анализатору као улаз. На пример, у ПВС-Студију ово је имплементирано помоћу заставице -S:

pvs-studio-analyzer analyze -j8 
                            -o PVS-Studio.log 
                            -S .pvs-pr.list

Можете сазнати више о анализи захтева за повлачење *овде*. Чак и ако ваш ЦИ није на листи услуга поменутих у чланку, биће вам од користи општи одељак посвећен теорији ове врсте анализе.

Подешавањем анализе захтева за повлачењем, можете блокирати урезивања која садрже упозорења, стварајући на тај начин границу коју непроверени код не може да пређе.

Ово је свакако добро, али бих волео да могу да видим сва упозорења на једном месту. Не само из статичког анализатора, већ и из јединичних тестова или из динамичког анализатора. За ово постоје разне услуге и додаци. ПВС-Студио, на пример, има додатак за интеграцију у СонарКубе.

2. Интеграција на развојним машинама

Сада је време да инсталирате и конфигуришете анализатор за свакодневну развојну употребу. До овог тренутка сте се већ упознали са већином начина рада, тако да се ово може назвати најлакшим делом.

Као најједноставнију опцију, програмери могу сами да инсталирају потребан анализатор. Међутим, ово ће одузети доста времена и одвратити их од развоја, тако да можете аутоматизовати овај процес користећи инсталатер и потребне заставице. За ПВС-Студио постоје разни заставице за аутоматизовану инсталацију. Међутим, увек постоје менаџери пакета, на пример, Цхоцолатеи (Виндовс), Хомебрев (мацОС) или десетине опција за Линук.

Затим ћете морати да инсталирате потребне додатке, на пример за висуал студио, ИДЕЈА, јахач итд

3. Свакодневна употреба

У овој фази, време је да кажемо неколико речи о начинима да убрзате анализатор током свакодневне употребе. Комплетна анализа целог пројекта одузима доста времена, али колико често мењамо код у целом пројекту одједном? Готово да не постоји рефакторисање које је толико велико да би одмах утицало на целу базу кода. Број фајлова који се мењају у исто време ретко прелази десетину, па их има смисла анализирати. За такву ситуацију постоји режим инкременталне анализе. Само немојте бити узнемирени, ово није још један алат. Ово је посебан режим који вам омогућава да анализирате само измењене датотеке и њихове зависности, а то се дешава аутоматски након изградње ако радите у ИДЕ-у са инсталираним додатком.

Ако анализатор открије проблеме у недавно промењеном коду, то ће извести независно. На пример, ПВС-Студио ће вам рећи о томе користећи упозорење:

Наравно, није довољно рећи програмерима да користе алат. Морамо им некако рећи шта је и како је. Ево, на пример, чланака о брзом почетку за ПВС-Студио, али можете пронаћи сличне туторијале за било који алат који вам је дражи:

Такви чланци пружају све информације неопходне за свакодневну употребу и не одузимају много времена. 🙂

Чак иу фази упознавања алата, потиснули смо многа упозорења током једног од првих покретања. Нажалост, статички анализатори нису савршени, па с времена на време дају лажне позитивне резултате. Обично их је лако потиснути, на пример, у ПВС-Студио додатку за Висуал Студио треба само да кликнете на једно дугме:

Међутим, можете учинити више од тога да их само потиснете. На пример, можете пријавити проблем подршци. Ако се лажно позитивно може исправити, онда у будућим ажурирањима можете приметити да сваки пут има све мање лажних позитивних резултата специфичних за вашу базу кодова.

После интеграције

Дакле, прошли смо кроз све фазе интеграције статичке анализе у процес развоја. Упркос важности постављања таквих алата на ЦИ, најважније место за њихово покретање је рачунар програмера. На крају крајева, статички анализатор није судија који каже негде далеко од вас да код није добар. Напротив, то је помоћник који вам говори да ли сте уморни и подсећа вас ако сте нешто заборавили.

Истина, без редовне употребе, мало је вероватно да ће статичка анализа значајно поједноставити развој. На крају крајева, његова главна предност за програмера није толико у тражењу сложених и контроверзних делова кода, већ у њиховом раном откривању. Слажете се да откривање проблема након што су измене послате на тестирање није само непријатно, већ и дуготрајно. Статичка анализа, када се користи редовно, посматра сваку промену директно на вашем рачунару и пријављује сумњива места док радите на коду.

А ако ви или ваше колеге још увек нисте сигурни да ли је вредно применити анализатор, онда вам предлажем да сада почнете да читате чланак "Разлози за увођење статичког анализатора кода ПВС-Студио у процес развоја„. Решава типичне бриге програмера да ће им статичка анализа одузети време и тако даље.

Ако желите да поделите овај чланак са публиком која говори енглески, користите линк за превод: Максим Звјагинцев. Статичка анализа: од почетка до интеграције.

Извор: ввв.хабр.цом

Статичка анализа – од увода до интеграције