lequal/sonarqube

CNES SonarQube 镜像 [服务器]

用于SonarQube的Docker镜像，由CNES预配置插件和设置，专用于持续集成。

该镜像是基于https://github.com/cnescatlab/docker-cat%E8%A1%8D%E7%94%9F%E7%9A%84%E9%A2%84%E9%85%8D%E7%BD%AESonarQube%E6%9C%8D%E5%8A%A1%E5%99%A8%E9%95%9C%E5%83%8F%EF%BC%8C%E5%8C%85%E5%90%AB%E7%9B%B8%E5%90%8C%E7%9A%84%E6%8F%92%E4%BB%B6%E5%92%8C%E4%BB%A3%E7%A0%81%E5%88%86%E6%9E%90%E8%A7%84%E5%88%99%EF%BC%8C%E5%9F%BA%E4%BA%8ESonarQube%E7%9A%84LTS%E7%89%88%E6%9C%AC%E6%9E%84%E5%BB%BA%E3%80%82

SonarQube本身是GitHub上的开源项目：https://github.com/SonarSource/sonarqube%E3%80%82

版本和变更日志请参见：https://github.com/cnescatlab/sonarqube/releases%E3%80%82

核心功能

该镜像基于官方SonarQube LTS镜像（即https://hub.docker.com/_/sonarqube%EF%BC%89%E6%9E%84%E5%BB%BA%EF%BC%8C%E5%B9%B6%E6%8F%90%E4%BE%9B%E4%BB%A5%E4%B8%8B%E9%A2%9D%E5%A4%96%E5%8A%9F%E8%83%BD%EF%BC%9A

• 运行容器时强制修改默认admin密码
• 容器健康检查
• 更多插件（详见插件列表）
• CNES配置
  • CNES质量配置文件
  • CNES质量门禁（设为默认）

此镜像旨在与预配置的sonar-scanner镜像配合使用，后者嵌入了所有必要工具：https://github.com/cnescatlab/sonar-scanner%E3%80%82%E4%BD%86%E5%B9%B6%E9%9D%9E%E5%BF%85%E9%A1%BB%E4%BD%BF%E7%94%A8%E8%AF%A5%E6%89%AB%E6%8F%8F%E5%99%A8%E3%80%82

开发者指南

如何构建镜像

这是一个标准Docker镜像，可通过以下命令构建：

sh
# 从项目根目录执行
$ docker build -t lequal/sonarqube .

运行此镜像的容器方法参见用户指南。

运行测试及创建自定义测试请参见https://github.com/cnescatlab/sonar-scanner/tree/develop/tests%E3%80%82

用户指南

该镜像已发布至Docker Hub：https://hub.docker.com/r/lequal/sonarqube/%E3%80%82

自创建以来，此镜像即设计用于生产环境，因此绝不容许保留默认admin密码（即"admin"）。必须通过设置环境变量SONARQUBE_ADMIN_PASSWORD指定admin账户的新密码。

:warning: :rotating_light: 若SONARQUBE_ADMIN_PASSWORD为空或等于"admin"，容器将启动失败。

本地运行镜像

sh
# 推荐选项
$ docker run --name lequalsonarqube \
             --rm \
             -p 9000:9000 \
             -e SONARQUBE_ADMIN_PASSWORD="自定义的admin密码" \
             lequal/sonarqube:latest

# 停止（并移除）容器
Ctrl-C
# 或
$ docker container stop lequalsonarqube

使用外部数据库

默认情况下，SonarQube使用嵌入式数据库，仅适用于测试环境；生产环境必须使用外部数据库以确保数据持久化。docker-compose.yml文件展示了配置外部PostgreSQL数据库的示例，可通过以下命令运行：

sh
$ docker-compose up -d

# 运行容器时设置变量
$ LEQUAL_SONARQUBE_VERSION=1.0.0 POSTGRES_PASSWD=secret-passwd SONARQUBE_ADMIN_PASSWORD="密码" docker-compose up -d

使用外部数据库时，SonarQube的数据存储在容器外部，因此容器可随意停止、重启、移除和重建。

SonarQube 包含的插件

要更新此列表，请运行以下脚本：

sh
while IFS='|' read -r plugin version url
do
    if [ "$url" = "null" ]; then url="n/a"; fi
    printf "| %.60s| %.25s| %.75s|\n" "$plugin                                                            " "$version                         " "$url                                                                           "
done < <(curl -u MY_TOKEN: -s http://localhost:9000/api/plugins/installed | jq -r '.plugins[] | "\(.name)|\(.version)|\(.homepageUrl)"')

# 其中 `MY_TOKEN` 是你的SonarQube个人令牌

社区分支插件的额外信息

建议在http://localhost:9000/admin/settings中设置属性sonar.core.serverBaseURL，以确保PR评论和邮件中的链接正常工作。

如何贡献

如遇镜像问题，请提交issue，说明复现步骤并粘贴日志。

如需提交PR，请说明PR的原因；若修复了某个issue，请注明issue编号或在PR中说明复现步骤。

详细信息参见https://github.com/cnescatlab/.github/blob/master/CONTRIBUTING.md%E3%80%82

Bug报告和功能请求：https://github.com/cnescatlab/sonar-scanner/issues

要贡献项目，请阅读https://github.com/cnescatlab/.github/wiki/CATLab's-Workflows%E3%80%82

许可证

基于GNU通用公共许可证3.0版授权

本项目是自由软件；您可以根据自由软件基金会发布的GNU通用公共许可证第3版（或任何更高版本）的条款重新分发和/或修改它。