# DockerとSonarQubeで構築するコード品質の自動チェック環境

## 1. はじめに

### 1-1. 背景
ソフトウェア開発において、コード品質の管理は非常に重要です。コード品質を保つことは、メンテナンス性の向上やバグの減少、開発効率の向上に繋がります。そこで、コード品質を自動的にチェックする環境を構築することが求められます。

### 1-2. 本記事の目的
この記事では、Dockerを用いてSonarQubeによるコード品質の自動チェック環境を構築する方法について詳しく説明します。これにより、定期的な品質チェックを自動化し、開発サイクルの中で継続的にコードの健全性を維持することができます。

## 2. SonarQubeの概要

### 2-1. SonarQubeとは？
SonarQubeはオープンソースのコード品質管理ツールです。ソースコード内のバグ、セキュリティリスク、コードの悪臭（コードスメル）を特定し、視覚的なリポートを提供します。様々なプログラミング言語をサポートしており、多言語開発にも対応しています。

### 2-2. 主な機能
- **バグ検出**: プロジェクト内で潜在的なバグを検出。
- **セキュリティの脆弱性**: セキュリティの懸念があるコードを特定。
- **コードスメル**: 効率的でないコード構造を特定し、改善を提案。
- **多言語サポート**: Java, C#, PHP, JavaScript, Pythonなど、20以上のプログラミング言語に対応。

## 3. Dockerの概要

### 3-1. Dockerとは？
Dockerは、ソフトウェアをコンテナと呼ばれる単一の実行可能パッケージとして提供するプラットフォームです。これにより、環境に依存せず、容易にデプロイや移植が可能になります。

### 3-2. 主な利点
- **環境の一貫性**: 開発から本番環境まで、同じ環境で動作。
- **ポータビリティ**: 任意のシステム上で動作可能。
- **可管理性**: コンテナ化されたソフトウェアの管理がしやすい。

## 4. 環境構築手順

### 4-1. 前提条件
- DockerとDocker Composeがインストールされていること。
- Gitなどのバージョン管理ツールが使用可能であること。

### 4-2. 手順

1. **Docker Composeファイルの準備**
    ```yaml
    version: '3'
    services:
      sonarqube:
        image: sonarqube:community
        ports:
          - "9000:9000"
        environment:
          - sonar.jdbc.username=sonar
          - sonar.jdbc.password=sonar
          - sonar.jdbc.url=jdbc:postgresql://db:5432/sonar
      db:
        image: postgres
        environment:
          POSTGRES_USER: sonar
          POSTGRES_PASSWORD: sonar
          POSTGRES_DB: sonar
    ```

2. **SonarQubeとPostgreSQLの起動**
    ```bash
    docker-compose up -d
    ```

3. **SonarQubeのセットアップ**
   - `http://localhost:9000` にアクセス。
   - デフォルトのログイン情報を入力：
     - ユーザー名： `admin`
     - パスワード： `admin`
   - セットアップウィザードに従い、必要な設定を行います。

4. **プロジェクトの分析設定**
   - SonarQubeにプロジェクトを追加し、トークンを取得。
   - 任意のプログラミング言語に対応するScannerをインストールし、設定。

### 4-3. プロジェクトの分析

プロジェクトのコードが持つ品質情報をSonarQubeで分析するために、以下の手順を実行します。

1. **Sonar Scanner CLIのインストール**
   - SonarQube公式サイトからクライアントをダウンロード。
   - 必要に応じてPATHを設定し、CLIコマンドとして利用できるようにする。

2. **プロジェクトルートで分析実行**
   ```bash
   sonar-scanner \
     -Dsonar.projectKey=プロジェクトキー \
     -Dsonar.sources=ディレクトリ名 \
     -Dsonar.host.url=http://localhost:9000 \
     -Dsonar.login=取得したトークン
   ```

## 5. まとめ
DockerとSonarQubeを使用することにより、コード品質のチェックを自動化し、健全なソフトウェア開発環境を構築することができます。これにより、開発フローが強化され、バグの早期発見やコードの最適化が可能となります。継続的なチェックにより、長期的に質の高いソフトウェアの提供が期待できます。 [cv:issue_marketplace_engineer]

# DockerとSonarQubeで構築するコード品質の自動チェック環境

## 1. はじめに

### 1-1. 背景
ソフトウェア開発において、コード品質の管理は非常に重要です。コード品質を保つことは、メンテナンス性の向上やバグの減少、開発効率の向上に繋がります。そこで、コード品質を自動的にチェックする環境を構築することが求められます。

### 1-2. 本記事の目的
この記事では、Dockerを用いてSonarQubeによるコード品質の自動チェック環境を構築する方法について詳しく説明します。これにより、定期的な品質チェックを自動化し、開発サイクルの中で継続的にコードの健全性を維持することができます。

## 2. SonarQubeの概要

### 2-1. SonarQubeとは？
SonarQubeはオープンソースのコード品質管理ツールです。ソースコード内のバグ、セキュリティリスク、コードの悪臭（コードスメル）を特定し、視覚的なリポートを提供します。様々なプログラミング言語をサポートしており、多言語開発にも対応しています。

### 2-2. 主な機能
- **バグ検出**: プロジェクト内で潜在的なバグを検出。
- **セキュリティの脆弱性**: セキュリティの懸念があるコードを特定。
- **コードスメル**: 効率的でないコード構造を特定し、改善を提案。
- **多言語サポート**: Java, C#, PHP, JavaScript, Pythonなど、20以上のプログラミング言語に対応。

## 3. Dockerの概要

### 3-1. Dockerとは？
Dockerは、ソフトウェアをコンテナと呼ばれる単一の実行可能パッケージとして提供するプラットフォームです。これにより、環境に依存せず、容易にデプロイや移植が可能になります。

### 3-2. 主な利点
- **環境の一貫性**: 開発から本番環境まで、同じ環境で動作。
- **ポータビリティ**: 任意のシステム上で動作可能。
- **可管理性**: コンテナ化されたソフトウェアの管理がしやすい。

## 4. 環境構築手順

### 4-1. 前提条件
- DockerとDocker Composeがインストールされていること。
- Gitなどのバージョン管理ツールが使用可能であること。

### 4-2. 手順

1. **Docker Composeファイルの準備**
    ```yaml
    version: '3'
    services:
      sonarqube:
        image: sonarqube:community
        ports:
          - "9000:9000"
        environment:
          - sonar.jdbc.username=sonar
          - sonar.jdbc.password=sonar
          - sonar.jdbc.url=jdbc:postgresql://db:5432/sonar
      db:
        image: postgres
        environment:
          POSTGRES_USER: sonar
          POSTGRES_PASSWORD: sonar
          POSTGRES_DB: sonar
    ```

2. **SonarQubeとPostgreSQLの起動**
    ```bash
    docker-compose up -d
    ```

3. **SonarQubeのセットアップ**
   - `http://localhost:9000` にアクセス。
   - デフォルトのログイン情報を入力：
     - ユーザー名： `admin`
     - パスワード： `admin`
   - セットアップウィザードに従い、必要な設定を行います。

4. **プロジェクトの分析設定**
   - SonarQubeにプロジェクトを追加し、トークンを取得。
   - 任意のプログラミング言語に対応するScannerをインストールし、設定。

### 4-3. プロジェクトの分析

プロジェクトのコードが持つ品質情報をSonarQubeで分析するために、以下の手順を実行します。

1. **Sonar Scanner CLIのインストール**
   - SonarQube公式サイトからクライアントをダウンロード。
   - 必要に応じてPATHを設定し、CLIコマンドとして利用できるようにする。

2. **プロジェクトルートで分析実行**
   ```bash
   sonar-scanner \
     -Dsonar.projectKey=プロジェクトキー \
     -Dsonar.sources=ディレクトリ名 \
     -Dsonar.host.url=http://localhost:9000 \
     -Dsonar.login=取得したトークン
   ```

## 5. まとめ
DockerとSonarQubeを使用することにより、コード品質のチェックを自動化し、健全なソフトウェア開発環境を構築することができます。これにより、開発フローが強化され、バグの早期発見やコードの最適化が可能となります。継続的なチェックにより、長期的に質の高いソフトウェアの提供が期待できます。 

DockerとSonarQubeで構築するコード品質の自動チェック環境

1. はじめに

1-1. 背景

1-2. 本記事の目的

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