iotium/sonarqube

SonarQube 代码检查容器

镜像概述

本镜像提供SonarQube代码检查工具的容器化部署，需配合外部数据库使用，支持通过容器链接或现有数据库服务器进行配置，适用于开发团队进行代码质量分析和静态代码检查。

核心功能与特性

• 提供代码质量检查与分析能力
• 支持PostgreSQL数据库作为数据存储
• 支持两种数据库配置方式：链接数据库容器或使用现有数据库服务器
• 可集成Maven构建工具进行项目代码分析

使用场景

• 开发团队对Java项目（或其他支持的编程语言）进行静态代码质量检查
• 集成到CI/CD流程中进行自动化代码质量分析
• 本地开发环境中进行代码质量验证

使用方法与配置说明

1. 数据库配置

1.1 创建PostgreSQL容器（推荐）

若没有现有PostgreSQL数据库，可通过以下命令创建专用数据库容器：

bash
docker run --name pgsql -p 5432:5432 \
-e POSTGRES_PASSWORD=secret \
-e POSTGRES_DB=sonar -d postgres:latest

1.2 使用现有数据库

在现有PostgreSQL服务器中创建名为sonar的数据库。

2. SonarQube容器运行

2.1 与数据库容器链接

bash
docker run -d \
-p 9009:9000 \
--link pgsql:pgsql \
-e SONAR_JDBC_USER=postgres \
-e SONAR_JDBC_PASSWORD=secret \
-e SONAR_JDBC_URL=jdbc:postgresql://pgsql:5432/sonar \
--name sonar -i iotium/sonarqube:latest

2.2 使用现有数据库服务器

bash
docker run -d \
-p 9009:9000 \
-e SONAR_JDBC_USER=postgres \
-e SONAR_JDBC_PASSWORD=secret \
-e SONAR_JDBC_URL=jdbc:postgresql://hostname:5432/sonar \
--name sonar -i iotium/sonarqube:latest

3. Maven配置

3.1 添加Maven Profile

在Maven配置文件（~/.m2/settings.xml或/etc/maven/settings.xml）的<profiles>标签下添加以下内容：

xml
<profile>
  <id>sonarpgsql</id>
  <activation>
    <activeByDefault>false</activeByDefault>
  </activation>
  <properties>
    <sonar.jdbc.url>
      jdbc:postgresql://localhost:5432/sonar
    </sonar.jdbc.url>
    <sonar.jdbc.driverClassName>org.postgresql.Driver</sonar.jdbc.driverClassName>
    <sonar.jdbc.username>postgres</sonar.jdbc.username>
    <sonar.jdbc.password>secret</sonar.jdbc.password>
    <!-- 可选：SonarQube服务器URL，默认值为http://localhost:9000 -->
    <sonar.host.url>
      http://localhost:9009
    </sonar.host.url>
  </properties>
</profile>

3.2 添加Sonar Maven插件

在项目的pom.xml中添加Sonar Maven插件：

xml
<plugin>
  <groupId>org.codehaus.mojo</groupId>
  <artifactId>sonar-maven-plugin</artifactId>
  <version>2.6</version>
</plugin>

更多插件信息参见Sonar Maven插件文档。

4. 执行代码检查

在项目根目录（包含pom.xml的目录）中执行以下命令进行代码检查：

bash
mvn sonar:sonar -Psonarpgsql

5. 查看检查报告

访问SonarQube Web界面查看检查报告：http://localhost:9009/