2016年8月19日金曜日

Sonar Scanner for MSBuild のセットアップ手順

概要

SonarQube にて、C#、VB.NET のソース解析をするための覚書。

前提条件

  • SonarQube がインストール済であること。
  • SonarQube サーバが起動中であること。

設定手順

Soner Scanner for MSBuild のダウンロード、解凍

ダウンロードURL:
上記ページの「ダウンロード」リンクから、zipファイルをダウンロードし、任意の場所に解凍する。
解凍したフォルダを<SonarMsbuildフォルダ>と呼ぶ。

設定の変更(必要であれば)

もし、インストール中のマシンと同じマシンで SonarQube サーバが動作してない場合は、以下設定を変更する必要がある。
<SonarMSbuildフォルダ>\SonarQubeAnalysis.xml
<Property Name=”sonar.host.url”> のタグ内に記載されたURLを、localhost から、対象のSonarQubeサーバに接続できるURLに変更。

動作確認

解析対象となるプロジェクトの前後に、ダウンロードした Soner Scanner for MSBuild の実行を挟む必要がある。

コマンド実行内容

以下のように、コマンドを実行する。
cd <解析対象のルートフォルダ>
<SonarMsbuildフォルダ>\MSBuild.SonarQube.Runner.exe begin /k:"sonarqube_project_key" /n:"sonarqube_project_name" /v:"sonarqube_project_version"
"C:\Program Files\MSBuild\14.0\Bin\MSBuild.exe" <ソリューションとか>  /t:Rebuild
<SonarMsbuildフォルダ>\MSBuild.SonarQube.Runner.exe end

※MSBuild の実行部分は、各プロジェクトの内容に応じて、適切な内容に書き換える
※“begin”での呼び出しで引き渡している三つの引数は、任意の内容で良いが、必須で指定する必要がある。
それぞれの意味合いは、大まか以下の通り:
  • /n : SonarQube上でプロジェクト名として表示される
  • /v : SonarQube上でプロジェクトのバージョンとして表示される。数字以外でもOK
  • /k : プロジェクト全体で一意である必要がある、プロジェクトの識別キー。SonarQube上の管理者画面で表示される。
※気軽に解析を試せるソースコードがない場合は、SonarQube の用意したサンプルで試すのが良い:https://github.com/SonarSource/sonar-examples/archive/master.zip

結果の確認

同じマシンからであれば、以下から確認。
(別マシンからであれば、”localhost”部分を、ホスト名なりIPアドレスなりに書き換え)

ソースコードの解析結果と、プロジェクト名などに、引数で指定した値が、そのまま設定されているのが確認できる、はず。

参考:

解析の実行方法:
パラメータ:

以上。

0 件のコメント:

コメントを投稿