「SonarQube」を使ってみる

2023-04-01
2023-04-01
SonarQube
静的解析

SonarQube

前回の記事でSonarQubeを構築したので、実際に使用してみます。

初期設定

パスワード設定

SonarQubeにアクセスすると、ログイン画面が表示されます。
初期のユーザ名／パスワードは両方「admin」です。

初期のユーザ名／パスワードでログインすると、ユーザ名「admin」のパスワード変更を求められるので、新しいパスワードを設定します。

パスワード変更が完了すると、トップページが表示されます。

実際に解析してみる

プロジェクトの作成

SonarQubeで静的解析を行うには、プロジェクトを作成する必要があります。
今回はローカル環境のソースコードを解析する手順を説明します。

ローカル環境のソースコードを解析する場合、トップページの「Manually」を選択します。

プロジェクトの設定を行います。
「Project display name」はSonarQube上の表示名、「Project key」はSonarQubeに解析結果を登録するときに使用するキーとなります。
入力が完了したら、「Set Up」をクリックします。

トークンの生成

プロジェクトの設定が完了すると、以下の画面が表示されます。
ローカル環境のソースコードを解析する場合、「Locally」を選択します。

SonarQubeに解析結果を登録するときに使用するトークンを生成します。
トークン名と、トークンの有効期限を設定し、「Generate」をクリックします。

生成されたトークンが表示されるので、保存するなりなんなりで覚えておき、「Continue」をクリックします。

ソースコード種類別の設定(.NET Framework(C#))

解析するソースコードの種類を選択します。
今回は.NET Framework(C#)のソースコードを解析してみます。

SonarQubeでは、「Scanner for .NET」というツールを使用して静的解析を行います。
「Download and unzip the Scanner for .NET」のリンクから、ダウンロードサイトに移動します。

解析したいソースコードに合わせてScannerをダウンロードする必要があります。
今回の記事では、.NET Frameworkのソースコードを解析するので、「.NET Framework 4.6+」を選択してダウンロードします。

ダウンロードしたファイルを任意の場所に解凍します。
今回は「D:\ProgramFiles\SonarQube」フォルダを作成して解凍しました。

Scannerの準備ができたら、コマンドプロンプトでScannerを実行していきます。
以下の通り、コマンドの例が記載されています。

コマンドは以下の3つで構成されています。

Scannerの起動

Scannerを起動します。
起動時にSonarQubeのURL、プロジェクトキー、トークン情報を設定します。

SonarScanner.MSBuild.exe begin /k:"<プロジェクトキー>" /d:sonar.host.url="<SonarQube URL>" /d:sonar.login="<トークン>"

静的解析対象のソースコードのリビルド

MSBuild.exeを起動し、静的解析対象のソースコードをリビルドします。
リビルドする前に、コマンドプロンプト上で静的解析対象のソースコードが格納されているフォルダに移動しておく必要があります。

MsBuild.exe /t:Rebuild

Scannerの終了

Scannerを終了します。
静的解析結果をSonarQubeに登録するため、トークン情報を設定します。

SonarScanner.MSBuild.exe end /d:sonar.login="<トークン>"

実行してみる

とりあえずバッチファイルを作成して実行します。
上記のコマンド実行前に、静的対象のソースコードフォルダに移動するコマンドを実行しています。
※ソースコードフォルダは、「.sln」ファイルがあるフォルダを指定してください。

ScannerとMSBuildの実行ファイルは、フルパスで指定して実行しています。
※MSBuildはVisual Studioのバージョンに応じて指定してください。今回の例はVisual Studio 2019 Communityです。

REM Dドライブに移動
D:

REM 静的解析対象のソースコードフォルダに移動
cd "<静的解析対象のソースコードフォルダパス>"

REM Scannerの起動
"D:\ProgramFiles\SonarQube\sonar-scanner-msbuild-5.12.0.64969-net46\SonarScanner.MSBuild.exe" begin /k:"ARuSonarQubeSample" /d:sonar.host.url="http://aru-server:51003/sonarqube" /d:sonar.login="<トークン>"

REM 静的解析対象のソースコードのリビルド
"C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\MSBuild\Current\Bin\MsBuild.exe" /t:Rebuild

REM Scannerの終了
"D:\ProgramFiles\SonarQube\sonar-scanner-msbuild-5.12.0.64969-net46\SonarScanner.MSBuild.exe" end /d:sonar.login="<トークン>"

pause

作成したバッチファイルを実行して、「EXECUTION SUCCESS」が表示されれば成功です。