Како смо имплементирали СонарКубе и схватили његов велики потенцијал

Желимо да пренесемо наше искуство имплементације платформе за континуирану анализу и мерење квалитета СонарКубе кода у постојеће процесе развоја ДПО система (додатак Аламеда депозитарном и клириншком рачуноводственом систему) Националног депозита за поравнање.

Национални депозитар за поравнање (група компанија Московске берзе) је једна од кључних компанија за финансијску инфраструктуру која чува и евидентира хартије од вредности руских и страних емитената у вредности већој од 50 трилиона рубаља. Све већи обим операција које спроводи систем, као и континуирано повећање функционалности, захтевају одржавање високог квалитета изворног кода система. Један од алата за постизање овог циља је статички анализатор СонарКубе. У овом чланку описујемо успешно искуство беспрекорне имплементације статичког анализатора СонарКубе у постојеће развојне процесе нашег одељења.

Укратко о одељењу

Наша надлежност обухвата следеће модуле: плаћања клијентима НСД-а, електронско управљање документима (ЕДФ), обрада порука репозиторијума трговања (регистрација ванберзанских трансакција), електронски канали интеракције између клијената и НСД-а и још много тога. Генерално, велики слој посла на техничкој страни операција. Радимо на основу пријава. Пријаве благајника обрађују аналитичари: прикупљају захтеве купаца и презентују нам своју визију како би требало да се уклопе у програм. Даље, стандардна шема: развој кода - тестирање - пробни рад - испорука кода у продуктивно коло директном купцу.

Зашто СонарКубе?

Ово је прво искуство нашег одељења у имплементацији платформе за контролу квалитета кода – раније смо то радили ручно, само преглед кода. Али све већи обим посла захтева аутоматизацију овог процеса. Поред тога, у тиму има и неискусних запослених који нису у потпуности упознати са интерним развојним прописима и склони су да више греше. Да би се контролисао квалитет кода, одлучено је да се имплементира статички анализатор. Пошто је СонарКубе већ коришћен у неким НСД системима, није требало дуго да се изабере. Раније су га колеге из других сектора користиле за анализу кода микросервиса у систему Аламеда (сопствени депозитно-клириншки рачуноводствени систем НСД), у ЦФТ (информациони систем за рачуноводство, биланс, припрему обавезног и интерног извештавања), у неким другим системи . Ради експериментисања, одлучили смо да почнемо са бесплатном верзијом СонарКубе-а. Дакле, пређимо на наш случај.

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

Имамо:

• аутоматска монтажа система у ТеамЦити-у;
• подесити процес отпремања кода преко МергеРекуест-а из гране функције у главну грану у ГитЛабу (процес развоја према ГитХуб Флов-у);
• СонарКубе је конфигурисан да анализира код за ДПО систем по распореду.

Наш циљ: имплементирати аутоматску анализу кода у ЦИ/ЦД процесима АВЕ.

Потребно је прилагодити: процес аутоматске провере кода помоћу статичког анализатора са сваким МергеРекуест-ом до главне гране.

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

Конфигурисање КуалитиГате-а у СонарКубе-у

КуалитиГате анализа је ствар коју читамо у утроби Интернета. У почетку смо користили другачији приступ, сложенији и, на неки начин, не сасвим исправан. Прво смо два пута извршили скенирање кроз СонарКубе: скенирали смо грану карактеристика и грану у којој смо хтели да спојимо грану карактеристика, а затим смо упоредили број грешака. Овај метод није био стабилан и није увек давао тачан резултат. А онда смо сазнали да уместо да двапут покренете СонарКубе, можете поставити ограничење броја направљених грешака (КуалитиГате) и анализирати само грану коју отпремате и упоредите.

За сада још увек користимо прилично примитивну проверу кода. Треба напоменути да СонарКубе није компатибилан са неким програмским језицима, укључујући Делпхи. Тренутно за наш систем анализирамо само ПЛСкл код.

ради овако:

• Анализирамо само ПЛ/СКЛ код за наш пројекат.
• КуалитиГате је конфигурисан у СонарКубе-у тако да се број грешака не повећава са урезивањем.
• Број грешака при првом покретању био је 229. Ако има више грешака током урезивања, спајање није дозвољено.
• Даље, уз исправку грешака, биће могуће поново конфигурисати КуалитиГате.
• Такође можете додати нове ставке за анализу, на пример, покривеност кода тестовима итд.

Шема рада:

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

Дугме за спајање постаје доступно.

У коментарима скрипте можете видети да је број грешака у грани функција постао више него дозвољен. Дакле, све је ЛОШЕ.

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

Самопоступање са бубама

Затим морате проверити све грешке које је систем открио, јер СонарКубе анализира према својим строгим стандардима. Оно што он сматра грешком можда заправо није у нашем коду. Зато треба да проверите и забележите да ли је ово заиста грешка, или нема потребе за уређивањем у нашим условима. Тиме смањујемо број грешака. Временом, систем ће научити да разуме ове нијансе.

До чега смо дошли

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

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

Аутор текста: атаниа

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