Antag et Scenario: efter at jeg har forpligtet kode til GitHub. Jeg ønsker at følge min kode kvalitet, kender bugs, sårbarheder, kode lugter, etc. (statisk kodeanalyse) for min kode, før jeg bygger min kode automatisk med Jenkins, og jeg vil have denne aktivitet til at udføre hver gang jeg begår kode.
i dette scenario for kontinuerlig inspektion og kontinuerlig Integration af koden. Vi vil følge den bedste praksis ved hjælp af GitHub-Jenkins-Sonarkbe Integration til dette scenario.
strøm : Så snart udvikleren forpligter koden til GitHub, vil Jenkins hente / trække koden fra repository og vil udføre statisk kode analyse med hjælp af Sonar Scanner og sende analyserapport til sonar Server, så vil det automatisk bygge projektet kode.
forudsætning :
- Jenkins er setup med GitHub med nogle build trigger (i mit tilfælde sin Poll SCM) hvis dette ikke er gjort, skal du følge denne tutorial— https://medium.com/@amitvermaa93/jenkins-github-with-java-maven-project-c17cdba7062
- Sonar Scanner kører, og du har Sonar Scanner setup i systemet. Hvis ikke, følg vejledningen- https://medium.com/@amitvermaa93/sonarqube-setup-windows-e6a6c01be025
Trin 1. Åbn Sonarserver-gå til Administration > klik på sikkerhed > brugere > Klik på Tokens (billede 1)> Generer token med noget navn > Kopier token (billede 2), det vil blive brugt i Jenkins til Sonargodkendelse.
Trin 2. Opsætning af Sonarkbe med Jenkins – gå til Administrer Jenkins > Konfigurer system > Sonarkbe server sektion > Tilføj Sonarkbe > navngiv det, angiv Server-Url som http://< IP >:< port > > og autentificeringstoken kopieret fra Sonarkbe-Server > Anvend og gem
Trin 3. Installer Sonarplugin til Jenkins. Gå til Administrer Jenkins > Administrer Plugins > tilgængelig > Søg efter Sonarkscanner> installer.
Hent SonarScanner hvis du ikke har https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner
Konfigurer Sonar Scanner i Jenkins : Gå til Mange Jenkins > Global Tool Configuration > Rul til sonar Scanner > Tilføj sonar scanner > name it, uncheck hvis du allerede har sonar ellers det vil automatisk hente for dig og din sonar scanner setup vil blive gjort (i mit tilfælde har jeg allerede) > give sti til sonar runner hjem som i nedenstående billede
Trin 4. Opret et Job-nyt emne > navn og vælg en projekttype (i mit tilfælde vælger jeg Maven project, du kan også vælge freestyle)
Trin 5. Indstil Git under SCM sektion og brug * * * * * til afstemning SCM under Build Trigger sektion. Under Build Environment sektion Tilføj pre-buid trin > Vælg Udfør Sonarkbe Scanner
Trin 6. Opret en .egenskaber fil på ethvert sted og give sti på opgaven som nedenfor(Jeg har oprettet det i Jenkins arbejdsområde mappe). Denne ejendomsfil vil være projektspecifik. Den indeholder visse ekkolodsegenskaber som hvilken mappe der skal scannes, hvilken mappe der skal udelukkes i scanning, hvad er projektnøglen og mange flere, du kan se den fra https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner
inde sonar-scanner.egenskaber Skriv under kode –
sonar.projectKey=github-jenkins-sonar
sonar.kilde=./ src
for at holde det enkelt har jeg kun brugt to egenskaber(som ovenfor), sonar.projectKey ejendom vil oprette et projekt inde i din Sonar server med samme navn, hvis projektet ikke findes ellers det vil tilføje analyse til det, sonar.kilder definerer, hvilken mappe der skal scannes. Du kan angive enten relativ sti fra dit Jenkins Jobarbejdsområde eller den faktiske sti til den mappe, du vil scanne.
siden jeg har brugt ./ src (brug / til vinduer sti ) det betyder, at jeg i øjeblikket er på mit jobarbejdsområde, dvs. på C:\Users\Amit Verma\.jenkins \ arbejdsområde \ Jenkins-GitHub-Sonarke placering og herfra giver jeg stien til den mappe(src), jeg vil scanne.
Trin 7. Byg jobbet. Efter vellykket build, hvis du kan se build logs, vil det vise dig de filer og mapper, den har scannet, og efter scanning har den sendt analyserapporten til Sonarkbe Server, du har integreret.
Trin 8. Fra Job dashboard, klik på sonar ikon eller navigere til Sonar server klik på projekter (på header) vil du se et nyt projekt med samme projekt nøgle, du har givet i sonar-scanner.egenskaber fil. Nu Kan du gå ind i dit projekt og analysere rapporten
