Integracija projekta VueJS+TS sa SonarQube

U svom radu aktivno koristimo platformu SonarQube za održavanje kvaliteta koda na visokom nivou. Tokom integracije jednog od projekata, napisanog na VueJs+Typescript, pojavili su se problemi. Zbog toga bih želeo da detaljnije izložim kako smo ih rešavali.

Integracija projekta VueJS+TS sa SonarQube

U ovom članku će biti reči, kao što sam gore naveo, o platformi SonarQube. Malo teorije — šta je to, za one koji prvi put čuju za nju:

SonarQube (nekadašnje Sonar) — platforma sa otvorenim kodom za kontinuiranu analizu (eng. continuous inspection) i merenje kvaliteta koda.
Podržava analizu koda i pretragu grešaka prema pravilima standarda programiranja MISRA C, MISRA C++, MITRE/CWE i CERT Secure Coding Standards. Takođe može prepoznati greške iz lista OWASP Top-10 i CWE/SANS Top-25 grešaka programiranja.
Iako platforma koristi različite gotove alate, SonarQube svodi rezultate na jedinstvenu informacionu tablu (eng. dashboard), vodeći istoriju proba i tako omogućavajući uvid u opštu tendenciju promene kvaliteta softvera tokom razvoja.

Detaljnije informacije možete pronaći na službenoj veb stranici

Podržava veliki broj programskih jezika. Prema informacijama iz gornje veze — to je više od 25 jezika. Za podršku određenog jezika neophodno je instalirati odgovarajući dodatak. U community verziju je uključen dodatak za rad sa Javascript (uključujući typescript), iako je u wiki napisano suprotno. Za Javascript odgovara dodatak SonarJS, za Typescript SonarTS odgovarajuće.

Za slanje informacija o pokrivenosti koristi se zvanični klijent sonarqube-scanner, koji, koristeći podešavanja iz config-fajla, šalje te podatke na server SonarQube za dalju konsolidaciju i agregaciju.

Za Javascript ima npm-obavijač. Pa, počinjemo korak po korak implementaciju SonarQube u Vue-projekat koji koristi Typescript.

Za postavljanje servera SonarQube iskoristićemo docker-compose.

sonar.yaml:

version: '1'
    services:
        simplesample-sonar:
            image: sonarqube:lts
            ports:
                - 9001:9000
                - 9092:9092
            network_mode: bridge

Pokretanje:

docker-compose -f sonar.yml up

Nakon toga SonarQube biće dostupan na adresi – http://localhost:9001 .

Integracija projekta VueJS+TS sa SonarQube
Trenutno nema projekata i to je tačno. Ovaj problem ćemo ispraviti. Kao osnovu uzeo sam zvanični projekat primer za VueJS+TS+Jest. Kloniraćemo ga kod nas:

git clone https://github.com/vuejs/vue-test-utils-typescript-example.git

Prvo treba da instaliramo klijent SonarQube, koji se zove sonar-scanner, za npm ima obavijač:

yarn add sonarqube-scanner

I odmah dodajemo komandu u scripts za rad sa njom.

package.json:

{
 … 
   scripts: {
      ...
      "sonar": "sonar-scanner"
      ...
   },
 …
}

Zatim, da bi skener radio, potrebno je postaviti podešavanja projekta u posebnoj datoteci. Počnimo od osnovnih.

sonar-project.properties:

sonar.host.url=http://localhost:9001

sonar.projectKey=test-project-vuejs-ts
sonar.projectName=Test Aplikacija (VueJS+TS)

sonar.sources=src
# sonar.tests=
sonar.test.inclusions=src/**/*tests*/*
sonar.sourceEncoding=UTF-8

  • sonar.host.url – adresa Sonar’a;
  • sonar.projectKey – jedinstveni identifikator projekta na serveru Sonar’a;
  • sonar.projectName – njegovo ime, može se menjati u bilo kojem trenutku, jer se identifikacija projekta vrši preko projectKey;
  • sonar.sources – folder sa izvorima, obično je to src, ali može biti bilo koji. Ovaj folder se postavlja u odnosu na root folder, koji je folder iz kojeg je pokrenut skener;
  • sonar.tests – parametar koji ide u paru sa prethodnim. To je folder gde se nalaze testovi. U ovom projektu nema takvog foldera, a test se nalazi pored komponenta koji se testira u folderu ‘test‘, tako da ćemo ga za sada ignorisati i iskoristiti sledeći parametar;
  • sonar.test.inclusions – putanja za testove koristeći masku, može biti više stavki navedenih kroz zarez;
  • sonar.sourceEncoding – kodiranje za izvorne fajlove.

Za prvo pokretanje skenera sve je spremno, osim glavnog prethodnog koraka: pokretanje samog testnog okvira, kako bi formirao informacije o pokrivenosti, koje će skener kasnije koristiti.

Ali za to je potrebno konfigurisati testni okvir da formira te informacije. U ovom projektu testni okvir je Jest. A njegova podešavanja su u odgovarajućem delu datoteke package.json.

Dodajmo ova podešavanja:

"collectCoverage": true,
"collectCoverageFrom": [
      "src/**/*",
      "!src/main.ts",
      "!src/App.vue",
      "!src/**/*d.*",
      "!src/**/*__tests__*"
],

Dakle, postavljamo sam flag potrebnog izračunavanja pokrivenosti i izvor (uz izuzetke), na osnovu kojih će se formirati.

Sada pokrenimo test:

yarn test

Videćemo sledeće:

Integracija projekta VueJS+TS sa SonarQube

Razlog je što u samoj komponenti, kao takvoj, nema koda. Ispravimo to.

HelloWorld.vue:

...
methods: {
    calc(n) {
      return n + 1;
    }
  },
mounted() {
  this.msg1 = this.msg + this.calc(1);
},
...

To će biti dovoljno za izračunavanje pokrivenosti.

Nakon ponovnog pokretanja testa, uverićemo se u to:

Integracija projekta VueJS+TS sa SonarQube

Na ekranu bi trebalo da vidimo informacije o pokrivenosti, a u folderu projekta biće kreiran folder coverage sa informacijama o pokrivenosti testovima u univerzalnom formatu LCOV (LTP GCOV ekstenzija).

Gcov — slobodno distribuisan alat za istraživanje pokrivenosti koda. Gcov generiše tačan broj izvršenja za svaku instrukciju u programu i omogućava dodavanje oznaka u izvorni kod. Gcov dolazi kao standardna alatka u okviru GCC paketa.
Lcov — grafički interfejs za gcov. Prikuplja gcov datoteke za više izvornih datoteka i stvara paket HTML stranica sa kodom i informacijama o pokrivenosti. Takođe se generišu stranice za lakšu navigaciju. Lcov podržava pokrivenost linija, funkcija i grananja.

Nakon izvršavanja testova, informacije o pokrivenosti će se nalaziti u coverage/lcov.info.
Moramo reći Sonar'u odakle je uzeti. Zato dodajmo sledeće redove u njegov konfiguracijski fajl. Ali postoji jedan trenutak: projekti mogu biti višeznačni, što znači da se u fascikli src nalaze izvori za više programskih jezika, a pripadnost određenom jeziku i upotreba određenog dodatka određuje se prema njegovom ekstenziji. Informacija o pokrivenosti može se čuvati na različitim mestima za različite programske jezike, pa za svaki programerski jezik postoji svoj odeljak za podešavanje toga. Naš projekat koristi Typescript, tako da nam je potreban odeljak za podešavanje specifično za njega:

sonar-project.properties:

sonar.typescript.coveragePlugin=lcov
sonar.typescript.lcov.reportPaths=coverage/lcov.info

Sve je spremno za prvo pokretanje skenera. Želim primetiti da se projekat u Sonar'u automatski stvara prilikom prvog pokretanja skenera za ovaj projekat. U narednim slučajevima, informacije će se već akumulirati kako bi se videla dinamika promene parametara projekta tokom vremena.

Dakle, iskoristićemo komandu koju smo ranije kreirali u package.json:

yarn run sonar 

Napomena: može se takođe koristiti parametar -X za detaljnije logovanje.

Ako je pokretanje skenera bilo prvi put, prvo će se preuzeti binarna verzija samog skenera. Nakon toga, pokreće se i počinje skeniranje servera Sonar'a u potrazi za instaliranim dodacima, čime se računa podržani programski jezici. Takođe se preuzimaju drugi različiti parametri za njegov rad: quality profiles, active rules, metrics repository, server rules.

Integracija projekta VueJS+TS sa SonarQube

Integracija projekta VueJS+TS sa SonarQube

Napomena: detaljno se nećemo zadržavati na njima u okviru ovog članka, ali uvek možete konsultovati zvanične izvore.

Zatim počinje analiza fascikle src o dostupnosti izvornih datoteka za sve (ako nije posebno naznačen neki određeni) podržane jezike programiranja, s kasnijom indeksacijom.

Integracija projekta VueJS+TS sa SonarQube

Zatim slijede različite analize na koje se ne osvrćemo u ovom članku (kao što su: linting, određivanje dupliciranja koda itd.).

Na kraju rada skenera dolazi do agregacije svih prikupljenih informacija, arhiviranja i slanja na poslužitelj.

Nakon toga možemo pogledati što smo dobili u web sučelju:

Integracija projekta VueJS+TS sa SonarQube

Kako možemo vidjeti, nešto smo dobili, i čak pokazuje određenu pokrivenost, ali ona ne odgovara našem Jest-izvještaju.

Hajde da istražimo. Pogledajmo projekt detaljnije, kliknimo na vrijednost pokrivenosti i "zaronimo" u detaljni izvještaj po datotekama:

Integracija projekta VueJS+TS sa SonarQube

Ovdje osim glavne, istraživane datoteke HelloWorld.vue, prisutna je i datoteka main.ts, koja uništava cijeli dojam pokrivenosti. Ali kako to, isključili smo je iz proračuna pokrivenosti. Da, sve je to tačno, ali to je bilo na nivou Jest, no skener ju je indeksirao, stoga je ušla u njegove proračune.

Hajde da to popravimo:

sonar-project.properties:

...
sonar.exclusions=src/main.ts
...

Želim napomenuti: osim onih mapa koje su navedene u ovom parametru, takođe se dodaju sve mape navedene u parametru sonar.test.inclusions.

Nakon pokretanja skenera vidimo već korektne informacije:

Integracija projekta VueJS+TS sa SonarQube

Integracija projekta VueJS+TS sa SonarQube

Razmotrite sljedeću tačku – Quality profiles. Kao što sam ranije spomenuo, podržava Sonar' nekoliko jezika programiranja istovremeno. Ono što upravo vidimo je taj slučaj. Ali znamo da je naš projekt napisan na TS, pa zašto opterećivati skener nepotrebnim manipulacijama i provjerama. Jezik za analizu postavićemo dodavanjem još jednog parametra u konfiguracijski fajl Sonar'u:

sonar-project.properties:

...
sonar.language=ts
...

Ponovo ćemo pokrenuti skener i pogledati rezultat:

Integracija projekta VueJS+TS sa SonarQube

Pokrivenost je potpuno nestala.

Ako pogledamo u log skenera, možemo vidjeti sljedeću liniju:

Integracija projekta VueJS+TS sa SonarQube

Dakle, datoteke našeg projekta jednostavno nisu bile indeksirane.

Situacija je sljedeća: službeno je podrška VueJs dostupna u pluginu SonarJS, koji je odgovoran za Javascript.

Integracija projekta VueJS+TS sa SonarQube

Ali ove podrške nema u pluginu SonarTS za TS, o čemu postoji službena prijava u bug-trackeru. Sonar'u:

  1. https://jira.sonarsource.com/browse/MMF-1441
  2. https://github.com/SonarSource/SonarJS/issues/1281

Evo nekih odgovora jednog od predstavnika s strane developera SonarQube, koji potvrđuju ovu činjenicu.

Integracija projekta VueJS+TS sa SonarQube

Integracija projekta VueJS+TS sa SonarQube

Ali sve je radilo, prigovorit ćete. Da, tako je, hajde da pokušamo malo „hakirati“.
Ako postoji podrška za .vue-datoteke SonarAko je to slučaj, hajde da probamo reći mu da ih smatra Typescript.

Dodajmo parametar:

sonar-project.properties:

...
sonar.typescript.file.suffixes=.ts,.tsx,.vue
...

Pokrenimo skener:

Integracija projekta VueJS+TS sa SonarQube

I, voila, sve se vratilo na staro, sa jednim profilom samo za Typescript. To jest, uspjeli smo riješiti problem s podrškom VueJs+TS za SonarQube.

Pokušajmo ići dalje i malo unaprijediti informacije o pokriću.

Šta smo do sada uradili:

  • dodali smo u projekat Sonar-skener;
  • konfigurisali Jest za generisanje informacija o pokriću;
  • konfigurirali Sonar-skener;
  • riješili problem podrške .vue-datoteka + Typescript.

Osim pokrića testovima, postoji i drugi zanimljivi kriterij kvaliteta koda, kao što su dupliranje koda i broj linija (učestvuje u izračunu koeficijenata povezanih sa složenošću koda) projekta.

U trenutnoj implementaciji dodatka za rad sa TS (SonarTS) neće raditi CPD (Detektor Kopiranja i Ljepljenja) i broj linija koda .vue-datoteka.

Za stvaranje sintetičke situacije dupliranja koda, jednostavno ćemo duplirati datoteku komponenta pod drugim imenom, takođe ćemo dodati u kod main.ts funkciju-praznu i duplirati je pod drugim imenom. Da bismo provjerili dupliranje kao u .vue, kao i u .ts -datotekama.

main.ts:

...
function name(params:string): void {
  console.log(params);
}
...

Za to je potrebno privremeno zakomentarisati liniju konfiguracije:

sonar-project.properties:

...
sonar.exclusions=src/main.ts
...

Ponovo ćemo pokrenuti skener zajedno sa testiranjem:

yarn test && yarn run sonar

Naravno, pokriće će nam pasti, ali trenutno nas to ne zanima.

U kontekstu dupliranja linija koda vidimo:

Integracija projekta VueJS+TS sa SonarQube

Za provjeru ćemo iskoristiti CPD-alat – jscpd:

npx jscpd src

Integracija projekta VueJS+TS sa SonarQube

Za linije koda:

Integracija projekta VueJS+TS sa SonarQube

Možda će se to riješiti u budućim verzijama dodataka SonarJS(TS). Želim napomenuti da postepeno počinju da kombinuju ova dva dodatka u jedan SonarJS, što mislim da je ispravno.

Sada bih volio razmotriti opciju poboljšanja informacija o pokriću.

Dok trenutno vidimo pokriće testovima u procentualnom odnosu, kroz ceo projekat, i po datotekama posebno. Međutim, postoji mogućnost proširenja ovog pokazatelja informacijama o broju unit-testova po projektu, kao i u razredu datoteka.

Postoji biblioteka koja može Jest-report pretvoriti u format za Sonar'u:
generic test data — https://docs.sonarqube.org/display/SONAR/Generic+Test+Data.

Instalirat ćemo ovu biblioteku u naš projekat:

yarn add jest-sonar-reporter

I dodamo je u konfiguraciju Jest:

package.json:

…
"testResultsProcessor": "jest-sonar-reporter"
…

Sada ćemo izvršiti test:

yarn test

Nakon čega će u korijenu projekta biti kreirana datoteka test-report.xml.

Uključićemo je u konfiguraciju Sonar'u:

sonar-project.properties:

…
sonar.testExecutionReportPaths=test-report.xml
…

I ponovo pokrenuti skener:

yarn run sonar

Pogledajmo šta se promenilo u interfejsu Sonar'u:

Integracija projekta VueJS+TS sa SonarQube

I ništa nije promenjeno. Radi se o tome da Sonar ne smatra datoteke opisane u Jest izveštaju kao datoteke unit-testova. Da bismo rešili ovu situaciju, koristićemo konfiguracijski parametar Sonar sonar.tests, u kojem ćemo jasno navesti foldere sa testovima (za sada imamo samo jedan):

sonar-project.properties:

…
sonar.tests=src/components/__tests__
…

Ponovo ćemo pokrenuti skener:

yarn run sonar

Pogledajmo šta se promenilo u interfejsu:

Integracija projekta VueJS+TS sa SonarQube

Sada smo videli broj naših unit-testova i, klikom unutra, možemo pogledati raspodelu ovog broja po datotekama projekta:

Integracija projekta VueJS+TS sa SonarQube

Zaključak

Dakle, razmotrili smo alat za kontinuiranu analizu SonarQube. Uspešno smo integrisali projekat napisan u VueJs+TS. Rešavali smo neke probleme sa kompatibilnošću. Povećali smo informativnost pokazatelja o pokrivenosti testovima. U ovom članku razmotrili smo samo jedan od kriterija kvaliteta koda (možda jedan od glavnih), ali SonarQube podržava i druge kriterije kvaliteta, uključujući testiranje na sigurnost. Međutim, nisu sve te mogućnosti u potpunosti dostupne u community-izdanju. Jedna od zanimljivih i korisnih mogućnosti su integracije SonarQube sa raznim sistemima za upravljanje kodom, kao što su GitLab i BitBucket. Da ne bismo dopustili merge pull(merge) requestu glavnu granu repozitorijuma prilikom degradacije pokrivenosti. No, to je priča za potpuno drugi članak.

PS: Sve što je opisano u članku u obliku koda dostupno je u mojoj fork-u.

Samo registrovani korisnici mogu učestvovati u anketi. Prijavite se, molim vas.

Koristite li platformu SonarQube:

  • 26,3%Da5

  • 15,8%Ne3

  • 15,8%Čuo sam za ovu platformu i želim je koristiti3

  • 10,5%Čuo sam za ovu platformu i ne želim je koristiti2

  • 0,0%Koristim drugu platformu0

  • 31,6%Prvi put čujem za nju6

Glasalo je 19 korisnika. Uzdržalo se 3 korisnika.

Izvor: habr.com

Kupite pouzdan hosting za sajtove uz zaštitu od DDoS, VPS VDS servere 🔥 Kupite pouzdan hosting za sajtove uz zaštitu od DDoS, VPS VDS servere | ProHoster