[C#] SonarQube で .NET アプリケーションのコード解析を行う

2017/12/20

[C#] SonarQube で .NET アプリケーションのコード解析を行う

2017/12/28 2017/12/19 15:18 .NET Core C# SonarQube

SonarQube を使って .NET アプリケーションを静的解析します。

概要

コードカバレッジの計測自体は OpenCover を使って行い、その出力結果を SonarQube にインポートします。
詳細は以下のページで解説されています。

SonarC#

環境

Visual Studio 2017
.NET Core 2.0
SonarQube 6.7
SonarQube Scanner for MSBuild 4.0

今回は .NET Core を使って試しましたが、Windows 環境なので .NET Framework であっても同じようにできるはずです。

SonarQube Server の準備

SonarQube Server をあらかじめ用意しておく必要があります。
Docker を使った構築については以下を参照してください。

SonarQube を docker-compose で動かしてみる

その後、プロジェクトを作成して、 API キーを発行しておいてください。

SonarQube Scanner for MSBuild のダウンロード

OpenCover の解析結果を SonarQube にインポートするには SonarQube Scanner が必要です。

https://docs.sonarqube.org/display/SCAN

ここでは SonarQube Scanner for MSBuild を使用します。

実行

以下のようなバッチファイルを作成して実行しました。

rem SonarQube Scanner fo MSBuild のインストール先
set SONARQUBE=C:\SonarQube\MSBuild.SonarQube.Runner.exe

%SONARQUBE% begin /d:sonar.host.url=http://localhost:9000 /k:"hogehoge" /n:"MyApplication" /v:"1.0" /d:sonar.cs.opencover.reportsPaths="coverage.xml"
dotnet build
call OpenCover.bat
%SONARQUBE% end

MSBuild.SonarQube.Runner.exe begin で解析を開始します。
ここでいくつかパラメータを指定する必要があります。

/d:sonar.host.url= で SonarQube Server の URL を指定
/k: でプロダクトキーを指定
/n: でプロジェクト名を指定
/v: でバージョンを指定
/d:sonar.cs.opencover.reportsPaths= で解析結果のレポートを指定（これは後述するように OpenCover の出力結果を与えます）

解析を開始したら、まずビルドを行います。
今回は .NET Core なので、dotnet build を指定します。

次にカバレッジの計測を行います。
今回は OpenCover を使って計測するので、そこを別途バッチファイルに記述しています。
このバッチファイルの中身については以下の記事を参考にしてください。

OpenCover でコードカバレッジを計測する

ビルドとカバレッジ計測が終わったら、MSBuild.SonarQube.Runner.exe end で解析を終了します。

正常に解析が完了していれば、SonarQube で結果を確認することができます。

尚、今回は OpenCover しか使っていませんが、他のいろいろツールを併用することもできます。

https://docs.sonarqube.org/pages/viewpage.action?pageId=6389770#CodeCoverageResultsImport(C#,VB.NET)-OpenCover

継続的インテグレーション

とりあえず解析自体は出来ましたが、こういうのはやはり自動化して継続的に行いたいものです。

これについてはまた別途書きます。

へっぽこプログラマーの備忘録

2017/12/20