Jak zapisywać raporty SonarQube w repozytorium Git

Automatyzacja zarządzania raportami SonarQube

Zarządzanie jakością kodu dla wielu mikrousług może być trudnym zadaniem. Automatyzacja procesu pobierania, przechowywania i zatwierdzania raportów SonarQube w repozytorium Git może znacznie usprawnić ten przepływ pracy.

W tym przewodniku przeprowadzimy Cię przez kolejne etapy tworzenia skryptu bash, który pobiera raporty SonarQube dla 30 mikrousług, przechowuje je w wyznaczonym katalogu na serwerze Linux i przesyła do repozytorium Git. Na koniec nauczysz się także polecenia umożliwiającego wyświetlenie tych raportów na serwerze.

Komenda	Opis
mkdir -p	Tworzy katalog, jeśli jeszcze nie istnieje.
curl -u	Wykonuje uwierzytelnione żądanie HTTP w celu pobrania plików z serwera.
os.makedirs	Tworzy katalog rekurencyjnie, jeśli jeszcze nie istnieje (Python).
subprocess.run	Uruchamia polecenie z argumentami i czeka na jego zakończenie (Python).
cp	Kopiuje pliki lub katalogi z jednej lokalizacji do drugiej.
git pull	Pobiera i łączy zmiany ze zdalnego repozytorium Git do bieżącej gałęzi.
git add	Dodaje zmiany plików w katalogu roboczym do obszaru tymczasowego.
git commit -m	Rejestruje zmiany w repozytorium wraz z komunikatem opisującym zmiany.
git push	Przesyła zawartość lokalnego repozytorium do zdalnego repozytorium.
requests.get	Wysyła żądanie GET pod określony adres URL (Python).

Automatyzacja zarządzania raportami SonarQube

Dostarczone skrypty mają na celu automatyzację procesu pobierania raportów SonarQube dla wielu mikroserwisów, przechowywania ich w określonym katalogu na serwerze Linux i wysyłania tych raportów do repozytorium Git. The rozpoczyna się od zdefiniowania niezbędnych zmiennych, takich jak adres URL serwera SonarQube, token, lista mikroserwisów, katalog zasobów i ścieżka do repozytorium Git. Następnie tworzy katalog zasobów, jeśli nie istnieje, używając . Skrypt przechodzi przez każdą mikrousługę, konstruuje adres URL raportu i używa aby pobrać raport i zapisać go jako plik JSON w katalogu zasobów.

Po pobraniu raportów skrypt przechodzi do katalogu repozytorium Git, wykonuje a aby upewnić się, że zawiera najnowsze zmiany, i kopiuje pobrane raporty do repozytorium Git. Następnie etapuje zmiany za pomocą , zatwierdza je za pomocą komunikatu using i wypycha zmiany do zdalnego repozytorium za pomocą git push. The wykonuje podobny zestaw operacji, wykorzystując funkcja tworzenia katalogów, do pobierania raportów i subprocess.run do wykonywania poleceń Git. Taka konfiguracja zapewnia systematyczne zarządzanie raportami SonarQube i ich przechowywanie.

#!/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

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())

Zwiększanie automatyzacji za pomocą zadań Cron

Aby jeszcze bardziej zautomatyzować proces pobierania i zatwierdzania raportów SonarQube, możesz użyć zadań cron. Zadania Cron to zaplanowane zadania w systemach operacyjnych typu Unix, które są uruchamiane w określonych odstępach czasu. Konfigurując zadanie cron, możesz zaplanować automatyczne uruchamianie skryptów w regularnych odstępach czasu, np. codziennie lub co tydzień, dzięki czemu raporty SonarQube będą zawsze aktualne bez konieczności ręcznej interwencji. Aby utworzyć zadanie cron, możesz użyć pliku polecenie edycji tabeli cron i dodania wpisu określającego skrypt i jego harmonogram.

Takie podejście zapewnia pełną automatyzację procesu i zmniejsza ryzyko przeoczenia aktualizacji raportów. Ponadto możesz używać plików dziennika do śledzenia powodzenia lub niepowodzenia wykonywania zadań cron. Dodając do skryptu polecenia rejestrowania, takie jak możesz stworzyć kompleksowy dziennik wszystkich działań. Ta konfiguracja zapewnia wydajny i niezawodny sposób utrzymywania potoków ciągłej integracji i ciągłego dostarczania (CI/CD) dla mikrousług.

1. Jak skonfigurować zadanie cron do uruchomienia skryptu?
2. Możesz skonfigurować zadanie cron za pomocą polecenie i dodanie linii z harmonogramem i ścieżką skryptu.
3. Jakie uprawnienia są potrzebne do uruchomienia tych skryptów?
4. Upewnij się, że użytkownik uruchamiający skrypty ma uprawnienia do odczytu/zapisu w katalogach i uprawnienia do wykonywania plików skryptów.
5. Jak mogę poradzić sobie z błędami w wykonywaniu skryptu?
6. Uwzględnij obsługę błędów w swoim skrypcie, używając instrukcje służące do sprawdzania powodzenia poleceń i odpowiedniego rejestrowania błędów.
7. Czy do pobierania mogę użyć innego narzędzia niż curl?
8. Tak, możesz użyć narzędzi takich jak Lub w Pythonie do pobierania plików.
9. Jak mogę mieć pewność, że moje repozytorium Git jest zawsze aktualne?
10. Włączać na początku skryptu, aby pobrać najnowsze zmiany ze zdalnego repozytorium przed dokonaniem nowych zatwierdzeń.
11. Czy można uruchamiać te skrypty według innego harmonogramu niż codziennie?
12. Tak, możesz dostosować harmonogram zadania cron tak, aby był uruchamiany co godzinę, co tydzień lub w dowolnym innym odstępie czasu, modyfikując wpis zadania cron.
13. Jaki jest najlepszy sposób bezpiecznego przechowywania mojego tokena SonarQube?
14. Przechowuj token SonarQube w zmiennej środowiskowej lub pliku konfiguracyjnym z ograniczonymi uprawnieniami dostępu.
15. Czy mogę wyświetlić dzienniki wykonania zadań cron?
16. Tak, możesz przeglądać dzienniki zadań cron w systemowym pliku dziennika cron lub utworzyć własny plik dziennika w skrypcie.
17. Jak mogę sprawdzić, czy raporty zostały poprawnie pobrane?
18. Użyj polecenie, aby wyświetlić zawartość pobranych plików raportów i upewnić się, że są one poprawnie sformatowane.

Proces automatyzacji zarządzania raportami SonarQube obejmuje tworzenie skryptów do pobierania, przechowywania i zatwierdzania raportów w repozytorium Git. Używając bash i Python, możesz usprawnić te zadania i zapewnić spójne monitorowanie i dokumentowanie jakości kodu mikrousług. Wdrożenie zadań cron dodaje dodatkową warstwę automatyzacji, ograniczając interwencję ręczną. Właściwa obsługa błędów i rejestrowanie zwiększają niezawodność systemu. Takie podejście nie tylko oszczędza czas, ale także płynnie integruje się z istniejącym potokiem CI/CD, zapewniając niezawodne rozwiązanie do zarządzania raportami SonarQube na serwerze Linux.