Blog

ちょっとしたバグに引っかかったので、メモ書きです。

TFS2015では、Subversionのリポジトリからソースコードを取得してビルドが実行できます。

これを使って、他チームが使ってるSubversionのリポジトリからソースコードを取ってきて、SonarQubeで分析してみるテストをしようと思ったところ・・・

ソースコードが取得できない (；ﾟДﾟ)

Visual C++ 2010 再配布可能パッケージが必要なんですね・・・。
ここからダウンロードしてきます。
32bit： https://www.microsoft.com/ja-jp/download/details.aspx?id=5555
64bit： https://www.microsoft.com/ja-jp/download/details.aspx?id=14632

インストール→再起動して、もう一回実行すると・・・

・・・なぜっ！　(；ﾟДﾟ)(；ﾟДﾟ)(；ﾟДﾟ)

いくら考えてもわからないので、Microsoft Connectにバグ報告。
何回かやり取りしたところ、この回避策やってみてくれと。
reg add HKLM\Software\Microsoft\VisualStudio\10.0\VC\VCRedist\x32 /v Installed /t reg_dword /d 1
（これって、単にパッケージのインストール判定するときのレジストリキーを単純に間違えてる（32bit版は「x86」）だけじゃ…）

・・・

通ったぁ～～
ちなみに、ビルドエージェントが32bitOSのときに発生します。（64bitOSでは正常に動作します）

次のバージョンで修正してほしいところですが、GitHubのビルドエージェントのリポジトリ（https://github.com/Microsoft/vsts-agent）にある最新版は64bitしか提供されていないのと、「Team Foundation Server "15" RC1」が出てる状態なので、このままかもしれません。

その１の続きです。
※2016/07/03時点の情報です。最新の情報は自身で確認をお願いします。

SonarQubeのビルドタスクを設定して実行すると、こんなエラーがでることがあります。
（正常に動作する方もいらっしゃるので、何かしらの環境依存かもしれませんが、今のところ不明です）


「バッチ ファイル： １から予期しない終了コードを受け取りました」とかいう意味不明な日本語訳は置いときまして、次の行がエラーの原因のようです。
「summary.md」はSonarQubeの解析結果が格納されるファイルですが、ビルドエージェントを直接確認しても格納フォルダすら作成されていません。
数日間悩みましたが、結論は、とあるスクリプトのたった１文字がおかしいことで発生する日本語版固有（２バイト文字圏なら日本語以外でも発生するかも？）の問題です。

ビルドエージェントの内部動作で、ビルドが開始されるとビルドエージェントに対して実行するビルド定義で使用するタスクのモジュール／スクリプトがダウンロードされます。
「MSBuild用のSonarQube – 分析開始」で使用されるモジュール／スクリプトは「[エージェントのベースフォルダ]\tasks\SonarQubeReBuild\[バージョン番号(ex. 1.0.44)]」に展開されるのですが、その中にある「SonarQubePreBuild.ps1」の最終行が問題です。
このファイルを日本語環境で開くと、



(；ﾟДﾟ)(；ﾟДﾟ)(；ﾟДﾟ)
「泡rguments」って何ですか？

最初は自分か作成した環境が悪いと思ってTFSサーバを作り直したり、ネットを検索したりしましたが、文字化けということで英語環境を作成してみるとちゃんと動作します。
ちなみに、英語環境で開くとこう見えます。

試しに、日本語環境のファイルをメモ帳で（見た目上）英語環境と同じ状態に変更してみるとちゃんと動作します。
？なので、変更前後のファイルをバイナリ比較すると、１バイトだけ違ってました。


上が変更前、下が変更後ですが、「-」の文字コードが違います。このせいで、スクリプトに引数がちゃんと渡せなくなってました。
※ちなみに、シフトJISで0x96は定義されていません。どうやって英語の人が入力したんでしょうか・・・。

回避策ですが、
1.ビルドエージェントが固定化されている場合は、さきほどの「SonarQubePreBuild.ps1」を修正すれば動作します。
　但し、バージョンアップしたり、違うビルドエージェントや違うフォルダで実行したり、「tasks\SonarQubeReBuild」フォルダを削除した場合は、サーバが持っている間違ったスクリプトが展開されるので、またエラーになります。
2.「MSBuild用のSonarQube – 分析開始」の次に、改めてSonarQubeのタスクランナーを実行する。
　スクリプトで最終的に実行したいのはMSBuild用のSonarQubeタスクランナー「MSBuild.SonarQube.Runner.exe」なので、バッチファイルを１つ用意し、それを実行することで回避します。
＜サンプル＞
○バッチファイルの中身


○バッチスクリプト実行タスクの設定


バッチファイルの引数に、プロジェクトキー／プロジェクト名／プロジェクトバージョンを指定するようにしてます。
「MSBuild.SonarQube.Runner.exe」の絶対パスと接続URLは、「MSBuild用のSonarQube – 分析開始」の実行後であればビルドエージェントのOS環境変数に格納されているので、それで対応してます。
（絶対パスは「%MSBUILD_SONARQUBE_BOOTSTRAPPERPATH%」、接続URLは「%MSBUILD_SONARQUBE_HOSTURL%」）

ちなみに、VSTS＋日本語のローカルビルドエージェントでは正常に動作します。

ちょっと味見程度に思ってたところに時間を取られたので、とっとと本命のJava系（多分、Gradleから）での連携を確認しないと。

今までのソースの静的解析ツールと言えば、FxCop／CheckStyle／FindBugsなどの個別ツールを使って確認する感じでしたが、TFS2015 Update1で連携できるようになった「SonarQube」なるツールがいいらしいとの噂。
なんと単純な静的解析だけでなく、解析の履歴を蓄積してどれだけ改善できたかが簡単にわかるとのこと。
個別ツールだと前回との比較が面倒（前回の解析結果との比較を人がしないといけない）なところがありますが、SonarQubeだと一目でわかるので、継続的に使用するにはすごくいいツールだと思います。
以前から触ってみたいとは思っていましたが、間でいろいろあってなかなか触ることができなかったのですが、ようやく時間が取れるようになったのでUpdate3が出てきたタイミングで今更感がありますが、お試しでASP.NETのプロジェクトで実際に使ってみようとしたらまんまとハマってしましました。
なんとなくですが、日本語でのSonarQubeのビルドタスクに関する話があまり流れていないようなので、簡単な設定手順とバグ回避策についてまとめてみます。
※2016/07/03時点の情報です。最新の情報は自身で確認をお願いします。

ちなみに、英語ではMSとSonarQubeの両方に設定手順があります。
（SonarQube側の方が「MSBuild」という枠でTFS2013やコマンドラインでの実行方法も併せてまとまっているので、そちらを見ていただくほうがよさそうです）
○Build Tasks for SonarQube Analysis
https://blogs.msdn.microsoft.com/visualstudioalm/2015/08/24/build-tasks-for-sonarqube-analysis/

○Analyzing with SonarQube Scanner for MSBuild
http://docs.sonarqube.org/display/SONARQUBE53/Analyzing+with+SonarQube+Scanner+for+MSBuild

あと、ビルドエージェントにJava 7u75以上と.NET Framework 4.5.2以上が必要です。

さて、TFS2015日本語版での手順です。
事前準備として、SonarQubeへの接続情報（サービスエンドポイント）を登録します。
ブラウザでチームプロジェクトに移動した状態で、画面右上にある（歯車みたいな）サーバの管理アイコンをクリックしてコントロールパネル画面を表示します。
タブの中に「サービス」があるのでクリックし、左側に表示される「新しいサービスエンドポイント」から「汎用」を選択します。

「新しい汎用接続の追加」という子画面が表示されるので、各項目を入力します。


・接続名：ビルド定義でSonarQubeの接続先を指定するときに使う名前です。適当でかまいません。
・サーバーURL：接続先SonarQubeサーバのURLを指定します。
・ユーザ名：解析結果を登録するSonarQubeのプロジェクトにログイン可能なユーザ名を指定します。
・パスワード／トークンキー：上記ユーザに対するログインパスワード、もしくはSonarQubeサーバの「MyAccount」の「Generate Tokens」で発行したトークンを入力します。

次に、普通のビルド定義に対して、先頭に「MSBuild用のSonarQube – 分析開始」を、最後に「MSBuild用のSonarQube – 分析終了」を追加します。

一番最後にタスクが追加されますが、タスクをドラッグすると順番は変更てきます。

「MSBuild用のSonarQube – 分析開始」に対して、SonarQube側の情報を設定します。


・SonarQubeエンドポイント：事前準備のところで指定した「接続名」を指定します。（コンボボックスから選択）
・プロジェクトキー
　SonarQubeのプロジェクト作成時に「Key」に指定した内容を設定します。
　分からないときは、SonarQubeのメニューの「設定」から、「Projects」－「Management」で表示されるプロジェクト一覧の真ん中あたりに出てくるのがキーです。（イメージだと青枠のところ）


・プロジェクト名
　SonarQubeのプロジェクト名を設定します。
・プロジェクト バージョン
　とりあえず、「1.0」としておきます。
・DB接続文字列／DBユーザー名／DBユーザーパスワード
　SonarQubeが5.2以上であれば、設定不要です。5.1以下の場合は、sonar.propertiesで指定した「sonar.jdbc.url」「sonar.jdbc.username」「sonar.jdbc.password」の内容を設定します。
・詳細設定
　個別にパラメータを指定する場合、「/d:[パラメータ名]=[設定内容]」と設定します。
・設定ファイル
　各種設定をまとめた「SonarQube.Analysis.xml」を使用する場合は、ここで設定します。
　※設定時はバージョン管理に登録されている内容から選択するので、あらかじめSonarQube.Analysys.xmlはバージョン管理に登録しておく必要があります。
・品質ゲートのエラー時にビルドを失敗とする(SQ 5.3+)
　SonarQubeの品質ゲート(Quality Gate)が「Failed」となったときにTFSのビルドを失敗とする場合は、これをONにします。
　※この項目はTFS2015 Update1／2／2.1では存在しません。

ここまで設定してビルドを実行すれば、SonarQubeの静的解析が実行されて・・・のはずだったんですが．．．続きは次のブログで。