# Java SonarQubeとGitLab CIを統合する手順

## 目次

1. はじめに

   1-1. 背景

   1-2. 本記事の目的

2. 必要なツールと準備

   2-1. SonarQubeの概要

   2-2. GitLab CIの概要

   2-3. 必要なセットアップ

3. SonarQubeとGitLab CIの統合手順

   3-1. SonarQubeプロジェクトの作成

   3-2. GitLab CIの設定ファイル(.gitlab-ci.yml)の作成

   3-3. GitLab CIジョブ作成

4. JavaプロジェクトのSonarQube解析

   4-1. ソナー・スキャナーの準備

   4-2. GitLab CIでのスキャン実行

   4-3. 結果表示と分析

5. よくある問題とその解決方法

   5-1. トークンの認証エラー

   5-2. ネットワークの接続問題

6. まとめ

## 1. はじめに

### 1-1. 背景

現代のソフトウェア開発において、継続的インテグレーション(CI)と継続的デリバリー(CD)は不可欠です。コード品質を高めるために、静的解析ツールであるSonarQubeとGitLab CIを統合することは、プロジェクトの健全性を維持するために重要です。

### 1-2. 本記事の目的

本記事では、Javaプロジェクトを対象に、SonarQubeとGitLab CIをどのようにして連携させるか、その手順を具体的に説明します。読者がこの手順を実行することで、自動化されたコード品質チェックをCIパイプラインに統合することが可能になります。

## 2. 必要なツールと準備

### 2-1. SonarQubeの概要

SonarQubeは、コードベースの品質を評価するオープンソースのツールで、バグ、セキュリティ脆弱性、コードの臭いを検出します。

### 2-2. GitLab CIの概要

GitLab CI/CDは、GitLab上で提供される継続的インテグレーション／継続的デリバリー機能であり、コードのテストとデプロイを自動化します。

### 2-3. 必要なセットアップ

- SonarQubeサーバーのインストールとセットアップ

- GitLabランナーの設定

- JavaプロジェクトのリポジトリーをGitLabにホスト

- SonarQubeトークンの生成と保存

## 3. SonarQubeとGitLab CIの統合手順

### 3-1. SonarQubeプロジェクトの作成

1. SonarQubeにログインしてプロジェクトを作成します。

2. プロジェクトキーとデフォルトの設定を入力し保存します。

3. トークンを生成して、GitLab CIで使用するために保存します。

### 3-2. GitLab CIの設定ファイル(.gitlab-ci.yml)の作成

GitLab CIでSonarQubeスキャンを実行するには、GitLab CI設定ファイルにジョブを定義します。以下の例はJavaプロジェクト向けです。

```yaml

stages:

  - test

sonarqube-check:

  image: maven:3.6.3-jdk-11

  stage: test

  script:

    - mvn sonar:sonar -Dsonar.projectKey=your_project_key -Dsonar.host.url=http://your.sonarqube.server -Dsonar.login=$SONAR_TOKEN

  only:

    - master

```

### 3-3. GitLab CIジョブ作成

上記の設定により、GitLabはSonarQubeで静的解析が可能になります。ジョブをトリガーするために、リポジトリーの変更がコミットされた際にパイプラインが走るよう設定します。

## 4. JavaプロジェクトのSonarQube解析

### 4-1. ソナー・スキャナーの準備

ソナー・スキャナーを使用してJavaプロジェクトを解析するには、Mavenのプラグインが必要です。`pom.xml`に追加します。

```xml

<build>

  <plugins>

    <plugin>

      <groupId>org.sonarsource.scanner.maven</groupId>

      <artifactId>sonar-maven-plugin</artifactId>

      <version>3.9.0.2155</version>

    </plugin>

  </plugins>

</build>

```

### 4-2. GitLab CIでのスキャン実行

GitLab CIを実行すると、定義されたステージとジョブに従ってSonarQubeスキャンが自動化されます。結果はSonarQubeダッシュボードで確認できます。

### 4-3. 結果表示と分析

SonarQubeにアクセスし、ダッシュボードでスキャンの結果を確認します。サマリー、バグ、脆弱性、コードの臭いの分析が可能です。

## 5. よくある問題とその解決方法

### 5-1. トークンの認証エラー

認証トークンが無効の場合は、SonarQubeで再生成し、GitLabの環境変数に正しい値を設定し直してください。

### 5-2. ネットワークの接続問題

SonarQubeサーバーへの接続エラーは、ファイアウォールやネットワーク設定を確認し、SonarQubeがアクセス可能であることを確認してください。

## 6. まとめ

SonarQubeとGitLab CIを統合することで、Javaプロジェクトのコード品質を継続的に監視・改善することができます。設定は難しくないので、ぜひ試してみてください。これにより、より高品質なソフトウェア開発ライフサイクルの実現が期待できます。

この手順を参考にし、開発チーム全体で迅速かつ効果的なコード品質向上を目指しましょう。

Java SonarQubeとGitLab CIを統合する手順

目次

続きを読むには単価診断を受けてください（30秒）