SonarScanner

A projekt konfigurálása

Hozzon létre egy konfigurációs fájlt a projekt gyökérkönyvtárában, amelyet sonar-project.properties néven nevez el.

# must be unique in a given SonarQube instance
sonar.projectKey=my:project

# --- optional properties ---

# defaults to project key
#sonar.projectName=My project
# defaults to 'not provided'
#sonar.projectVersion=1.0

# Path is relative to the sonar-project.properties file. Defaults to .
#sonar.sources=.

# Encoding of the source code. Default is default system encoding
#sonar.sourceEncoding=UTF-8

SonarScanner futtatása tömörített fájlból

Kövesse az alábbi lépéseket a SonarScanner tömörített fájlból való futtatásához:

1. Csomagolja ki a letöltött fájlt egy tetszőleges könyvtárba. A továbbiakban az útmutató ebben a formában fog a <TELEPÍTÉSI_KÖNYVTÁR>-ra hivatkozni.
2. Frissítse a globális beállításokat úgy, hogy azok az Ön SonarQube szerverére mutassanak a következő fájl szerkesztésével: $telepítési_könyvtár/conf/sonar-scanner.properties:
   #----- Default SonarQube server
#sonar.host.url= http://localhost:9000
3. Adja hozzá a <TELEPÍTÉSI_KÖNYVTÁR>/bin könyvtárat az elérési útvonalhoz (PATH).
4. Ellenőrizze a telepítést egy új shell nyitásával és futtassa a következő parancsot: sonar-scanner -h (sonar-scanner.bat -h on Windows).
   usage: sonar-scanner [options]
     Options:
     -D,--define <arg> Define property
     -h,--help Display help information
     -v,--version Display version information
     -X,--debug Produce execution debug output

   Ha több hibakeresési információra van szüksége, akkor hozzáadhatja az alábbiak egyikét a parancssorához: -X, --verbose, or -Dsonar.verbose=true.

5. Indítsa el az elemzést a következő parancs kiadásával a projekt alapkönyvtárából, és adja meg az azonosítási tokenjét!
   sonar-scanner -Dsonar.login=azÖnAzonosításiTokenje

SonarScanner futtatása Docker képből

SonarScanner Docker kép használatával való szkenneléshez, kövesse a következő lépéseket!

docker run \
--rm \
-e SONAR_HOST_URL="http://${SONARQUBE_URL}" \
-e SONAR_SCANNER_OPTS="-Dsonar.projectKey=${AZ_ÖN_PROJEKT_KULCSA}" \
-e SONAR_LOGIN="azÖnAzonosításiTokenje" \
-v "${AZ_ÖN_REPOSITORY-JA}:/usr/src" \
sonarsource/sonar-scanner-cli

Sablon projektek

Az induláshoz segítségül egyszerű projektminták állnak rendelkezésre a legtöbb nyelvhez a GitHub-on. Ezeket böngészheti vagy letöltheti a sonarqube-scanner/src könyvtárból.

Alternatívák a sonar-project.properties fájlhoz

Ha nem lehet létrehozni a sonar-project.properties fájlt a projekt gyökérkönyvtárában, több alternatíva is rendelkezésre áll:

• A tulajdonságok közvetlenül megadhatók a parancssorban is. Példa:
  sonar-scanner -Dsonar.projectKey=myproject -Dsonar.sources=src1
• A projektbeállításokat a project.settings tulajdonsággal is meg lehet adni, amelyben meg lehet adni a projekt konfigurációs fájl elérési útvonalát (ez az opció nem kompatibilis a sonar.projectBaseDir tulajdonsággal). Példa:
  sonar-scanner -Dproject.settings=../myproject.properties
• A projekt elemzésére használt gyökérmappa beállítható a sonar.projectBaseDir tulajdonsággal a SonarScanner 2.4-től kezdve. Ennek a mappának tartalmaznia kell egy sonar-project.properties fájlt, ha a sonar.projectKey nincs megadva a parancssorban.

Alternatív elemzési könyvtár

Ha az elemzendő fájlok nem azzal a könyvtárral kezdődnek, ahonnan az elemzés történik, akkor használja a sonar.projectBaseDir tulajdonságot az elemzés áthelyezéséhez egy másik könyvtárba.

sonar.projectBaseDir=/home/ftpdrop/cobol/project1
sonar.sources=src
sonar.cobol.copy.directories=/copy