Kako spremiti SonarQube izvješća u Git repozitorij

Mia Chevalier

Subota, 25. svibnja 2024. u 11:30:29

Automatiziranje upravljanja izvješćima SonarQube
Upravljanje kvalitetom koda za više mikroservisa može biti zastrašujući zadatak. Automatiziranje procesa preuzimanja, pohranjivanja i predaje SonarQube izvješća u Git repozitorij može značajno pojednostaviti ovaj tijek rada.
U ovom vodiču provest ćemo vas kroz korake za izradu bash skripte koja preuzima izvješća SonarQube za 30 mikroservisa, pohranjuje ih u određeni direktorij na Linux poslužitelju i obvezuje ih u Git repozitorij. Na kraju ćete također naučiti naredbu za prikaz ovih izvješća na vašem poslužitelju.

Naredba Opis

mkdir -p Stvara imenik ako već ne postoji.

curl -u Izvodi provjereni HTTP zahtjev za preuzimanje datoteka s poslužitelja.

os.makedirs Rekurzivno stvara direktorij ako već ne postoji (Python).

subprocess.run Izvodi naredbu s argumentima i čeka da završi (Python).

cp Kopira datoteke ili direktorije s jednog mjesta na drugo.

git pull Dohvaća i spaja promjene iz udaljenog Git repozitorija u trenutnu granu.

git add Dodaje promjene datoteke u radnom direktoriju u radnu površinu.

git commit -m Bilježi promjene u repozitorij s porukom koja opisuje promjene.

git push Prenosi sadržaj lokalnog repozitorija u udaljeni repozitorij.

requests.get Šalje GET zahtjev na određeni URL (Python).

Naredba	Opis
mkdir -p	Stvara imenik ako već ne postoji.
curl -u	Izvodi provjereni HTTP zahtjev za preuzimanje datoteka s poslužitelja.
os.makedirs	Rekurzivno stvara direktorij ako već ne postoji (Python).
subprocess.run	Izvodi naredbu s argumentima i čeka da završi (Python).
cp	Kopira datoteke ili direktorije s jednog mjesta na drugo.
git pull	Dohvaća i spaja promjene iz udaljenog Git repozitorija u trenutnu granu.
git add	Dodaje promjene datoteke u radnom direktoriju u radnu površinu.
git commit -m	Bilježi promjene u repozitorij s porukom koja opisuje promjene.
git push	Prenosi sadržaj lokalnog repozitorija u udaljeni repozitorij.
requests.get	Šalje GET zahtjev na određeni URL (Python).

Automatiziranje upravljanja izvješćima SonarQube

Priložene skripte osmišljene su za automatizaciju procesa preuzimanja SonarQube izvješća za više mikroservisa, njihovo pohranjivanje u određeni direktorij na Linux poslužitelju i predaju tih izvješća Git repozitoriju. The počinje definiranjem potrebnih varijabli kao što su URL SonarQube poslužitelja, token, popis mikroservisa, direktorij resursa i put Git repozitorija. Zatim stvara direktorij resursa ako ne postoji pomoću . Skripta prolazi kroz svaku mikrouslugu, konstruira URL izvješća i koristi kako biste preuzeli izvješće i spremili ga kao JSON datoteku u direktoriju resursa.

Nakon preuzimanja izvješća, skripta prelazi u direktorij Git repozitorija, izvodi a kako bi osigurao da ima najnovije promjene i kopira preuzeta izvješća u Git repozitorij. Zatim postavlja promjene pomoću , obvezuje ih porukom pomoću , i gura promjene u udaljeno spremište s git push. The izvodi sličan skup operacija, iskorištavajući funkcija za stvaranje imenika, za preuzimanje izvješća i subprocess.run za izvršavanje Git naredbi. Ova postavka osigurava da se izvješćima SonarQube sustavno upravlja i pohranjuje.

Preuzimanje i pohranjivanje izvješća SonarQube za mikroservise

Bash skripta za automatiziranje upravljanja izvješćima SonarQube

#!/bin/bash
# Define variables
SONARQUBE_URL="http://your-sonarqube-server"
SONARQUBE_TOKEN="your-sonarqube-token"
MICROSERVICES=("service1" "service2" "service3" ... "service30")
RESOURCE_DIR="/root/resource"
GIT_REPO="/path/to/your/git/repo"

# Create resource directory if not exists
mkdir -p $RESOURCE_DIR

# Loop through microservices and download reports
for SERVICE in "${MICROSERVICES[@]}"; do
    REPORT_URL="$SONARQUBE_URL/api/measures/component?component=$SERVICE&metricKeys=coverage"
    curl -u $SONARQUBE_TOKEN: $REPORT_URL -o $RESOURCE_DIR/$SERVICE-report.json
done

# Change to git repository
cd $GIT_REPO
git pull

# Copy reports to git repository
cp $RESOURCE_DIR/*.json $GIT_REPO/resource/

# Commit and push reports to git repository
git add resource/*.json
git commit -m "Add SonarQube reports for microservices"
git push

# Command to display report in Linux server
cat $RESOURCE_DIR/service1-report.json

Automatiziranje Git operacija za SonarQube izvješća

Python skripta za upravljanje izvješćima SonarQube u Gitu

import os
import subprocess
import requests

# Define variables
sonarqube_url = "http://your-sonarqube-server"
sonarqube_token = "your-sonarqube-token"
microservices = ["service1", "service2", "service3", ..., "service30"]
resource_dir = "/root/resource"
git_repo = "/path/to/your/git/repo"

# Create resource directory if not exists
os.makedirs(resource_dir, exist_ok=True)

# Download reports
for service in microservices:
    report_url = f"{sonarqube_url}/api/measures/component?component={service}&metricKeys=coverage"
    response = requests.get(report_url, auth=(sonarqube_token, ''))
    with open(f"{resource_dir}/{service}-report.json", "w") as f:
        f.write(response.text)

# Git operations
subprocess.run(["git", "pull"], cwd=git_repo)
subprocess.run(["cp", f"{resource_dir}/*.json", f"{git_repo}/resource/"], shell=True)
subprocess.run(["git", "add", "resource/*.json"], cwd=git_repo)
subprocess.run(["git", "commit", "-m", "Add SonarQube reports for microservices"], cwd=git_repo)
subprocess.run(["git", "push"], cwd=git_repo)

# Command to display report
print(open(f"{resource_dir}/service1-report.json").read())

Poboljšanje automatizacije s Cron poslovima

Kako biste dodatno automatizirali proces preuzimanja i predaje SonarQube izvješća, možete koristiti cron poslove. Cron poslovi su planirani zadaci u operativnim sustavima sličnim Unixu koji se pokreću u određenim intervalima. Postavljanjem cron posla možete zakazati automatsko pokretanje skripti u redovitim intervalima, primjerice dnevno ili tjedno, osiguravajući da su vaša izvješća SonarQubea uvijek ažurna bez ručne intervencije. Da biste stvorili cron posao, možete koristiti naredba za uređivanje cron tablice i dodavanje unosa koji navodi skriptu i njen raspored.

Ovaj pristup osigurava da je proces potpuno automatiziran i smanjuje rizik od propuštanja ažuriranja izvješća. Osim toga, možete koristiti datoteke dnevnika za praćenje uspjeha ili neuspjeha izvršavanja cron poslova. Dodavanjem naredbi za bilježenje vašoj skripti, kao što je , možete stvoriti opsežan dnevnik svih aktivnosti. Ova postavka pruža učinkovit i pouzdan način za održavanje kontinuirane integracije i cjevovoda kontinuirane isporuke (CI/CD) za vaše mikrousluge.

Kako mogu postaviti cron posao za pokretanje moje skripte?
Možete postaviti cron posao pomoću naredbu i dodavanje retka s rasporedom i stazom skripte.
Koje su dozvole potrebne za pokretanje ovih skripti?
Osigurajte da korisnik koji izvodi skripte ima dopuštenja za čitanje/pisanje u direktorije i dopuštenja za izvršavanje datoteka skripti.
Kako mogu riješiti pogreške u izvršavanju skripte?
Uključite rukovanje pogreškama u svoju skriptu pomoću naredbe za provjeru uspješnosti naredbi i odgovarajuće bilježenje pogrešaka.
Mogu li za preuzimanje koristiti neki drugi alat osim curla?
Da, možete koristiti alate poput ili u Pythonu za preuzimanje datoteka.
Kako mogu osigurati da moje Git spremište uvijek bude ažurno?
Uključiti na početku vaše skripte kako biste dohvatili najnovije promjene iz udaljenog repozitorija prije novih obveza.
Je li moguće pokrenuti ove skripte prema rasporedu osim dnevno?
Da, možete prilagoditi raspored cron poslova da se izvršava svakih sat vremena, tjedno ili u bilo kojem drugom intervalu mijenjanjem unosa cron posla.
Koji je najbolji način za sigurno pohranjivanje mog SonarQube tokena?
Pohranite svoj SonarQube token u varijablu okruženja ili konfiguracijsku datoteku s dopuštenjima ograničenog pristupa.
Mogu li vidjeti zapisnike izvršavanja mojih cron poslova?
Da, možete vidjeti zapisnike cron poslova u sistemskoj datoteci zapisnika cron ili stvoriti vlastitu datoteku dnevnika unutar skripte.
Kako mogu provjeriti jesu li izvješća ispravno preuzeta?
Koristiti naredba za prikaz sadržaja preuzetih datoteka izvješća i osiguravanje da su ispravno formatirane.

Proces automatizacije upravljanja izvješćima SonarQube uključuje stvaranje skripti za preuzimanje, pohranu i predaju izvješća u Git repozitorij. Koristeći bash i Python, možete pojednostaviti ove zadatke i osigurati da se kvaliteta koda vaših mikroservisa dosljedno prati i dokumentira. Implementacija cron poslova dodaje dodatni sloj automatizacije, smanjujući ručnu intervenciju. Ispravno rukovanje pogreškama i bilježenje povećavaju robusnost sustava. Ovaj pristup ne samo da štedi vrijeme, već se i glatko integrira u vaš postojeći CI/CD cjevovod, pružajući pouzdano rješenje za upravljanje izvješćima SonarQube na Linux poslužitelju.