Что такое SonarQube?

 1# Установка через Docker
 2docker run -d --name sonarqube \
 3  -p 9000:9000 \
 4  -e SONAR_ES_BOOTSTRAP_CHECKS_DISABLE=true \
 5  sonarqube:latest
 6
 7# Или скачать ZIP архив
 8wget https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-9.9.0.65466.zip
 9unzip sonarqube-9.9.0.65466.zip
10cd sonarqube-9.9.0.65466/bin/linux-x86-64/
11./sonar.sh start

 1# Установка SonarQube Scanner
 2wget https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.8.0.2856-linux.zip
 3unzip sonar-scanner-cli-4.8.0.2856-linux.zip
 4export PATH=$PATH:/path/to/sonar-scanner-4.8.0.2856-linux/bin
 5
 6# Или через пакетный менеджер
 7# pip install sonar-scanner
 8pip install sonar-scanner
 9
10# poetry add --group dev sonar-scanner

 1# sonar-project.properties
 2sonar.projectKey=my-project
 3sonar.projectName=My Project
 4sonar.projectVersion=1.0
 5sonar.sources=src/
 6sonar.tests=tests/
 7sonar.language=py
 8sonar.python.coverage.reportPaths=coverage.xml
 9sonar.python.xunit.reportPath=test-results.xml
10
11# Исключения
12sonar.exclusions=**/*_test.py,**/migrations/**,**/venv/**
13sonar.test.exclusions=**/tests/**
14
15# Настройки для JavaScript/TypeScript
16sonar.javascript.lcov.reportPaths=coverage/lcov.info

 1# Простой запуск
 2sonar-scanner \
 3  -Dsonar.projectKey=my-project \
 4  -Dsonar.sources=. \
 5  -Dsonar.host.url=http://localhost:9000 \
 6  -Dsonar.login=admin \
 7  -Dsonar.password=admin
 8
 9# С токеном аутентификации
10sonar-scanner \
11  -Dsonar.projectKey=my-project \
12  -Dsonar.sources=. \
13  -Dsonar.host.url=http://localhost:9000 \
14  -Dsonar.login=your-token
15
16# Анализ с coverage
17pytest --cov=src --cov-report=xml
18sonar-scanner

 1# .gitlab-ci.yml
 2stages:
 3  - test
 4  - quality
 5
 6test:
 7  stage: test
 8  script:
 9    - pip install pytest pytest-cov
10    - pytest --cov=src --cov-report=xml --junitxml=test-results.xml
11
12sonarqube-check:
13  stage: quality
14  image: sonarsource/sonar-scanner-cli:latest
15  variables:
16    SONAR_USER_HOME: "${CI_PROJECT_DIR}/.sonar"
17    GIT_DEPTH: "0"
18  cache:
19    key: "${CI_JOB_NAME}"
20    paths:
21      - .sonar/cache
22  script:
23    - sonar-scanner
24  only:
25    - merge_requests
26    - master
27    - develop

 1# .github/workflows/sonar.yml
 2name: SonarQube Analysis
 3on:
 4  push:
 5    branches: [ main, develop ]
 6  pull_request:
 7    branches: [ main ]
 8
 9jobs:
10  sonarqube:
11    runs-on: ubuntu-latest
12    steps:
13    - uses: actions/checkout@v3
14      with:
15        fetch-depth: 0
16
17    - name: Set up Python
18      uses: actions/setup-python@v4
19      with:
20        python-version: '3.9'
21
22    - name: Install dependencies
23      run: |
24        pip install pytest pytest-cov
25        pip install -r requirements.txt
26
27    - name: Run tests with coverage
28      run: |
29        pytest --cov=src --cov-report=xml
30
31    - name: SonarQube Scan
32      uses: sonarsource/sonarqube-scan-action@master
33      env:
34        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
35        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
36        SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}

 1// Пример Quality Gate правил
 2{
 3  "conditions": [
 4    {
 5      "metric": "coverage",
 6      "operator": "LT",
 7      "value": "80.0"
 8    },
 9    {
10      "metric": "duplicated_lines_density",
11      "operator": "GT",
12      "value": "3.0"
13    },
14    {
15      "metric": "maintainability_rating",
16      "operator": "GT",
17      "value": "1"
18    },
19    {
20      "metric": "reliability_rating",
21      "operator": "GT",
22      "value": "1"
23    },
24    {
25      "metric": "security_rating",
26      "operator": "GT",
27      "value": "1"
28    }
29  ]
30}

 1# Создание профиля качества через API
 2curl -X POST \
 3  'http://localhost:9000/api/qualityprofiles/create' \
 4  -H 'Authorization: Basic YWRtaW46YWRtaW4=' \
 5  -d 'name=Custom Python Profile&language=py'
 6
 7# Активация правил
 8curl -X POST \
 9  'http://localhost:9000/api/qualityprofiles/activate_rule' \
10  -H 'Authorization: Basic YWRtaW46YWRtaW4=' \
11  -d 'key=profile_key&rule=python:S1481'

1# VS Code - установка SonarLint
2# Через Extensions Marketplace: SonarLint
3
4# IntelliJ IDEA/PyCharm
5# Settings -> Plugins -> SonarLint
6
7# Настройка подключения к SonarQube
8# SonarLint -> Connected Mode -> Add Connection

 1# Python скрипт для получения метрик
 2import requests
 3import base64
 4
 5def get_sonar_metrics(project_key, sonar_url, token):
 6    auth = base64.b64encode(f"{token}:".encode()).decode()
 7    headers = {"Authorization": f"Basic {auth}"}
 8    
 9    url = f"{sonar_url}/api/measures/component"
10    params = {
11        "component": project_key,
12        "metricKeys": "coverage,bugs,vulnerabilities,code_smells"
13    }
14    
15    response = requests.get(url, headers=headers, params=params)
16    return response.json()
17
18# Использование
19metrics = get_sonar_metrics("my-project", "http://localhost:9000", "token")
20print(metrics)