【第2回】SonarQubeを利用した静的解析環境の構築¶

SonarQubeの概要¶

SonarQubeは SonarSource によって提供されているオープンソースの静的解析プラットフォームで、形式的なソースコードのバグや不適切な記法のチェック、カバレッジの計測などを行い、品質を可視化することが可能です。

解析できるプログラミング言語は、Java (Android含む), C#, PHP, JavaScript, TypeScript, C/C++, Ruby, Kotlin, Go, COBOL, PL/SQL, PL/I, ABAP, VB.NET, VB6, Python, RPG, Flex, Objective-C, Swift, CSS, HTML, and XMLなど 25を超える言語をサポートし、コードのバグ、Code Smell(深い問題を発生する可能性があるコード)、セキュリティ脆弱性を検出することができます。

また、SonarQubeはプラグインにより拡張が可能になっており、IntelliJ IDEAやEclipseなどの統合開発環境と連携するSonarlintプラグイン、MavenやGradleなどのライブラリ管理ツール向けのScannerプラグインに加え、 GitHubやGitLab、JIRAやJenkinsなどの各開発ツールとの統合プラグイン、チェックルールを追加する場合のFindBugsプラグインなど様々なものが提供されています。SonarQubeを構成する代表的なコンポーネントや機能、その特徴は以下の通りです。

SonarQubeには上記の機能を無料で使用可能なCommunity Editionや、ソースコードのブランチやプルリクエスト解析などの機能を追加したDeveloper Edtion、ポートフェリオ管理機能や高度なテクニカルサポートがあるEnterprize Edtion、 複数のSonarQubeServerをクラスターとして構築し、高可用性な運用ができるDataCenter Edtionがあります。今回はCommunity Editionを使って、以降環境構築を進めていきます。

Amazon RDSを使ったSonarQubeServer用データベースの構築¶

SonarQubeServerは、サーバーの設定やプロジェクトの解析結果、組み込んだプラグイン、セキュリティ情報などを保存しておくリレーショナルデータベースが必要になります。データベースはOracle、PostgreSQL、MySQL、MS SQLServerなど 主要なデータベースエンジンをサポートしていますが、ここでは自動バックアップなど高可用性で運用が可能なAmazon RDS(PostgreSQL)を使ってデータベースを構築します。

RDS構築の要領は、筆者が執筆している別連載「AWSで作るクラウドネイティブアプリケーションの基本」の 「 Amazon RDSにアクセスするSpringアプリケーション(1) 」を参照してください。 設定内容はリンク先の手順とほぼ同一でかまいませんが、「データベースの名前」だけ、「sonar」を設定するようにしてください。

構築後は、sonarデータベースにアクセスするユーザを作成しましょう。

セキュリティグループでRDSのインバウンド接続が許可されたIPアドレスをもつEC2インスタンスなどで、PSQLクライアントなどをインストールし、 作成したRDSのエンドポイント、データベース、ユーザ名を指定してRDSに接続後、ユーザ名「sonar」、パスワード「sonar」とするユーザを作成します。

[centos@ip-XXXX-XXX-XXX-XXX ~]$ psql -U username -d sonar -h mynavi-sample-db.xxxxxxx.ap-northeast-1.rds.amazonaws.com
Password for user username:
psql (9.4.0, server 10.6)
sonar=> create role sonar with LOGIN password 'sonar';

[centos@ip-XXXX-XXX-XXX-XXX ~]$ sudo yum update -y
// omit
[centos@ip-XXX-XXX-XXX-XXX ~]$ sudo yum install -y postgresql

SonarQubeServer向けのアプリケーションロードバランサーの構築¶

続いて、SonarQubeServerへ接続するためにアプリケーションロードバランサー(ALB)を経由して接続するように構築します。 ALBと接続するターゲットグループにECSコンテナを登録することにより、ヘルスチェック機能が有効になり、サーバが何らかの理由で落ちた場合も再起動が実行され、SonarQubeServerの可用性を向上させることができます。

ALBの構築は、筆者が執筆している別連載「AWSで作るクラウドネイティブアプリケーションの基本」の 「 AWS ECS上に構築するSpringアプリケーション(2) 」を適宜参考にしてください、今回、設定内容でポイントとなる項目は以下の通りです。

SonarQubeを構築するDockerfile¶

次にSonarQubeServerをECSで構築するためのDockerfileを作成します。SonarQubeServerでデフォルトで提供されている起動スクリプトであるsonar.shは、 SonarQubeアプリケーションをスクリプト中で別プロセスでデーモンとして起動する形式になっているため、Dockerfileイメージでそのまま実行するとDockerプロセスとしてアプリケーションを起動することができません。 そこで、SonarSourceから提供されているDockerfile を参考に、 CentOSでSonarQubeServerを構築するDockerfileを作成します。

# Dockerfile for sonarqube server
# (A)
FROM            docker.io/centos:latest
# (B)
MAINTAINER      debugroom

# (C)
RUN yum install -y java-1.8.0-openjdk zip unzip wget

# (D)
ENV SONAR_VERSION=7.7 \
    SONARQUBE_HOME=/usr/local/sonarqube \
    SONARQUBE_JDBC_USERNAME=sonar \
    SONARQUBE_JDBC_PASSWORD=sonar \
    SONARQUBE_JDBC_URL=jdbc:postgresql://mynavi-sample-sonarqube-db.xxxxxxxx.ap-northeast-1.rds.amazonaws.com/sonar

# (E)
EXPOSE 9000

# (F)
RUN groupadd -r sonarqube && useradd -r -g sonarqube sonarqube

# (G)
RUN set -x \
 && (gpg --batch --keyserver ha.pool.sks-keyservers.net --recv-keys F1182E81C792928921DBCAB4CFCA4A29D26468DE \
         || gpg --batch --keyserver ipv4.pool.sks-keyservers.net --recv-keys F1182E81C792928921DBCAB4CFCA4A29D26468DE) \
 && curl -o sonarqube.zip -fSL https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-$SONAR_VERSION.zip \
 && curl -o sonarqube.zip.asc -fSL https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-$SONAR_VERSION.zip.asc \
 && gpg --batch --verify sonarqube.zip.asc sonarqube.zip \
 && unzip sonarqube.zip \
 && mv sonarqube-$SONAR_VERSION $SONARQUBE_HOME \
 && rm sonarqube.zip* \
 && rm -rf $SONARQUBE_HOME/bin/*

# (H)
WORKDIR $SONARQUBE_HOME
# (I)
COPY run.sh $SONARQUBE_HOME/bin/
# (J)
RUN chmod 744 $SONARQUBE_HOME/bin/run.sh
# (K)
RUN chown -R sonarqube:sonarqube $SONARQUBE_HOME
# (L)
USER sonarqube
# (M)
CMD ["./bin/run.sh"]

|br|

また、SonarQubeServerを実行するrun.shスクリプトは以下の通りです。起動スクリプトはSonarSourceから提供されているものをほぼそのまま利用しますが、 javaコマンドでアプリケーションを起動するプロセスをフォアグラウンドで実行しているのがポイントです。

#!/usr/bin/env bash

set -e

if [ "${1:0:1}" != '-' ]; then
  exec "$@"
fi

declare -a sq_opts

while IFS='=' read -r envvar_key envvar_value
  do
    if [[ "$envvar_key" =~ sonar.* ]]; then
       sq_opts+=("-D${envvar_key}=${envvar_value}")
    fi
  done < <(env)

exec java -jar lib/sonar-application-$SONAR_VERSION.jar \
  -Dsonar.log.console=true \
  -Dsonar.jdbc.username="$SONARQUBE_JDBC_USERNAME" \
  -Dsonar.jdbc.password="$SONARQUBE_JDBC_PASSWORD" \
  -Dsonar.jdbc.url="$SONARQUBE_JDBC_URL" \
  -Dsonar.web.javaAdditionalOpts="$SONARQUBE_WEB_JVM_OPTS -Djava.security.egd=file:/dev/./urandom" \
 "${sq_opts[@]}" \
 "$@"

こちらも AWS ECS上に構築するSpringアプリケーション(4) と同様の手順で、Dockerfile作成後にDockerがインストールされた適当な端末で、イメージを作成します。

[centos@ip-XXX-XXX-XXX-XXX]$ docker build . -t debugroom/sonarqube-server:latest
   // omit
[centos@ip-XXX-XXX-XXX-XXX ~]$ docker images
REPOSITORY                                TAG                 IMAGE ID            CREATED             SIZE
debugroom/sonarqube-server                latest              97e608f45e20        2 minites ago       973MB

Dockerイメージが作成されたら、Docker Hubへプッシュします。

[centos@ip-XXX-XXX-XXX-XXX ~]$ docker login
// omit  - enter USERID and password
[centos@ip-XXX-XXX-XXX-XXX ~]$ docker push debugroom/sonarqube-server:latest

ECSクラスタ・タスク定義、サービスの実行¶

SonarQubeServerのDockerfileイメージをDockerHubへプッシュした後は、EC2起動型のECSクラスタおよびECSタスク定義を行い、コンテナをサービスとして実行します。 ECSクラスタの構築手順は AWS ECS上に構築するSpringアプリケーション(5) を、ECSタスク定義は AWS ECS上に構築するSpringアプリケーション(6) 、 ECSサービスの実行は AWS ECS上に構築するSpringアプリケーション(7) に記載してある要領を参考に進めてください。ただし、今回ポイントになる設定項目は以下の通りです。

ECSサービスを実行した後、ALBのDNS名を使ってブラウザからアクセスできれば起動は成功です。

次回はSonarQubeServerでプロジェクトを作成し、QualityProfileを設定、開発端末のIDEで環境構築してみます。

著者紹介¶

川畑 光平(KAWABATA Kohei) - NTTデータ 課長代理

金融機関システム業務アプリケーション開発・システム基盤担当を経て、現在はソフトウェア開発自動化関連の研究開発・推進に従事。

Red Hat Certified Engineer、Pivotal Certified Spring Professional、AWS Certified Solutions Architect Professional等の資格を持ち、アプリケーション基盤・クラウドなど様々な開発プロジェクト支援にも携わる。