Kihagyás

SonarQube használata

1. SonarQube indítása

A backend projektben található infrastructure/docker-compose.yml fáljban vegyük ki a kommentezést az alábbi soroknál:

#  sonarqube:
#    image: sonarqube:10.4.0-community
#    container_name: sonarqube
#    restart: unless-stopped
#    ports:
#      - "9000:9000"

Majd adjuk ki az alábbi parancsot: 

docker compose up -d

Ezt követően a http://localhost:9000 oldalon lesz elérhető a SonarQube szerver.

A kezdeti admin felhasználó adatai:

  • Username: admin
  • Password: admin

2. Projekt hozzáadása és analysis token generálása

2.1 Projekt létrehozás

  1. A Projects fülön kattintsunk az Add a project gombra:

    AddProject

  2. Válasszuk a Create a local project opciót:

    CreateLocalProject

  3. Töltsük ki a Project display name és Project key mezőket, majd kattintsunk a Next gombra:

    CreateLocalProjectConfiguration

    Ezeket az értékeket kell majd megadnunk az analízis futtatásakor használt scriptekben a -Dsonar.projectKey, -Dsonar.projectName paraméterek értékeinek.

  4. Válasszuk a Use the global setting opciót majd nyomjunk a Create project gombra.

    CreateLocalProjectConfiguration2

2.2 Token generálása

  1. Az előző pontban létrehozott projektünknél az Analysis Method képernyőn válasszuk a Locally opciót:

    AnalysisMethod

  2. Az Analyze your project képernyőn a Provide a token szekcióban kattintsunk a Generate gombra:

    GenerateToken

  3. Ekkor a képernyőn megjelenik az analízishez szükséges token, amit az analízis futtatásakor használt scriptekben kell megadni, a -Dsonar.token paraméterek értékének:

    GeneratedToken

3. Quality Gate-ek definiálása

  1. A Quality Gates fülön kattintsunk az Create gombra:

    QualityGate

  2. Adjunk nevet a Quality Gate-nek majd nyomjunk a Create gombra:

    QualityGateCreate

  3. Az így létrehozott Quality Gate képernyőjén a Conditions szekcióban kattintsunk az Unlock editing gombra:

    QualityGateConditionsUnlockEditing

  4. Ezután szintén a Conditions szekcióban kattintsunk a frissen megjelent Add Condition gombra:

    QualityGateConditionsAdd

  5. Az Add Condition képernyőn definiáljuk a szükséges feltételt és nyomjunk az Add Condition gombra:

    QualityGateConditionsAddPopUp

  6. Miután minden szükséges feltételt megadtunk, a Projects szekcióban pipáljuk be a projekteket, ahol használni akarjuk a Quality Gate-et:

    QualityGateProjects

4. Analízis futtatása

Dinamikus értékek a parancsokban

A -Dsonar.projectKey, -Dsonar.projectName, -Dsonar.token, paraméterek értékének értelemszerűen a projekt létrehozásnál megadott és generált értékeket kell behelyettesíteni!.

./mvnw clean package verify sonar:sonar -Dsonar.projectKey=Semi-Backend -Dsonar.projectName='Semi Backend' -Dsonar.host.url=http://localhost:9000 -Dsonar.token=sqp_5d39362e9847d15e6acfc1bb5fe79058ac930b4e

A frontend analízishez a SonarScanner telepítése is szükséges, amihez itt található leírás.

SonarScanner telepítés macOS esetén

Amennyiben macOS-t használunk, a SonarScanner az alábbi paranccsal is telepíthető 

brew install sonar-scanner


sonar-scanner -Dsonar.projectKey=Semi-Frontend -Dsonar.sources=. -Dsonar.host.url=http://localhost:9000 -Dsonar.token=sqp_e56d9b518d47d10a14fa2a7d8f664cf43e78374d