完整内容在此, 干话王_Grafana GitLab 与 SonarQube 整合
GitHub Repository连结
GitLab 与 SonarQube 整合
请参阅GitLab CI 可以自动检测程式码品质！SonarQube 程式码品质检测怎么做？
SonarQube Project Properties
因为我们其实都是使用 SonarScanner 在扫描然后才把结果上传至 SonarQube server, 所以需要一只档案名为sonar-project.properties 来给scanner 解读该专案的配置.
专案基本设定
sonar.projectKey=xxx # 专案在SonarQuber中的唯一识别码
sonar.projectName=yyyy # 专案名称
sonar.qualitygate.wait=true # 等待品质闸道检查完成
sonar.scm.provider=git # 使用 git 作为version control
原始码分析范围设定
sonar.sources=. # 分析的根目录（当前目录）
sonar.inclusions=**/*.go # 只分析 .go 档案
# 排除以下档案：
sonar.exclusions=**/*_test.go,\\
**/vendor/**,\\
**/mock_*.go,\\
**/*.pb.go,\\
**/contract/*.go,\\
**/*.pb.ts,\\
**/docs/**
测试相关设定
sonar.tests=. # 测试档案的根目录
sonar.test.inclusions=**/*_test.go # 包含所有 test.go 档案
sonar.test.exclusions=**/vendor/**, # 排除 vendor 目录中的测试
sonar.go.coverage.reportPaths=coverage.out # 程式码覆盖率报告的路径
sonar.go.tests.reportPaths=test.out # 测试结果报告的路径
sonar.coverage.exclusions= # 不计入覆盖率统计的档案：
**/*_mock.go,\\
**/mock/**/*,\\
cmd/**/*,\\
main.go,\\
**/test/**/*,\\
**/tests/**/*,\\
infrastructure/**/*,\\
internal/config/**/*,\\
internal/driver/**/*
但其实 SonarQube Scanner 本身不会直接执行go test指令, 毕竟他里面也没安装 Go SDK, 所以需要依赖预先产生的测试报告档案.因此接着就看 CI pipeline 中怎将报告传递给 SonarQube Scanner.
GitLab CI Pipeline
在 GitLab CI 中，我们需要设定适当的 pipeline 来执行测试并产生报告给 SonarQube Scanner 使用。以下是一个基本的 .gitlab-ci.yml 配置范例：
stages:
- test
- sonarqube
unit-test:
stage: test
script:
# 执行测试并产生测试报告
- go test -json ./... > test.out
# 产生覆盖率报告
- go test -coverprofile=coverage.out ./...
artifacts:
paths:
- test.out
- coverage.out
expire_in: 1 day # 设定报告档案的保存期限
sonarqube-check:
stage: sonarqube
image:
name: sonarsource/sonar-scanner-cli
entrypoint: [""]
dependencies:
- unit-test # 确保能取得测试阶段产生的报告
script:
- sonar-scanner
only:
- merge_requests
- main
- develop
完整内容在此, 干话王_Grafana GitLab 与 SonarQube 整合