UnderstandをGit連携して、２つのリビジョンを比較する

以前、「Understand 5.1 の新機能・改善点 – 差分グラフィカルビュー/差分レポートの追加」において、プロジェクトを比較する機能としてCompareグラフやChangedEntities Reportをご紹介しました。
これに対してお客様より、「プロジェクトの比較設定がもっと簡単になると嬉しい」という声をいただきました。

今回は、Understandのユーザーツール機能を使用して、gitリポジトリの２つのリビジョンを指定することで、各リビジョンを自動的に解析し、比較する方法をご案内します。
本手順により任意のSHA番号を2つ指定いただくだけで、簡単にリビジョン間の解析差分を確認いただくことが可能となります。

これにより、例えば以下のようなユースケースでご利用いただくことが考えられます。

ユースケース

---

事前準備

1. batファイルの配置

比較先プロジェクト

メニューバーから[プロジェクト]-[プロジェクトの設定]-[比較]の[比較プロジェクト]欄をご確認いただくと、比較先プロジェクトとしてB.udbが自動的に指定されている（相対パスにて指定済）ことをご確認いただけます。

ぜひお試しください。 以降は発展的な使い方の例となります。

発展的な使い方の例

ここでは本設定をより便利に使用するための例（多くはカスタマイズが必要）をご紹介いたします。

２つ目以降のリポジトリ

開発者によっては、複数のプロジェクトにアサインされ、複数のリポジトリを並行して同じマシン環境で取り扱うことが必要な場合があるかと思います。
そのような場合は、[準備3 gitリポジトリの準備]を再度行うことで２つ目以降のリポジトリをgit cloneし、該当リポジトリ内の2つのSHA番号について同様に取り扱うことが可能です。（undCompare実行時は.git_ParentDirで選択するリポジトリを変更してください。）

• お試し用リポジトリ及びSHA番号
  https://github.com/apache/httpd.git
  新Rev:e1673c079052
  旧Rev:679b3024e825
• [リポジトリの位置関係]
  [Compare]-[repos]-[cgit]-[.git]
  [Compare]-[repos]-[httpd]-[.git]

他ツールとの連携やAPI利用

本稿の手順によりUnderstandでの解析結果(udb)をSHA番号の指定のみで自動的に得ることが可能となっております。
CompareGitSHA.batに追記していただく、もしくは本稿を参考に新たにユーザーツールを作成いただくことで、コマンドライン経由で他ツールとの連携が可能となります。 すなわちSHA番号を指定するだけでUnderstand以外のツールとの連携をした使い方が可能となります。
（参考）連携ツールや連携処理の例

• Lattix
• UnderstandAPIを使用したスクリプト（APIライセンスが必要です。）
• コンパイルスクリプトの呼び出し及びテストスクリプトの呼び出し
• 特定のURLに対しPOSTするbatを作成し、チケット発行または発行画面をブラウザで開く処理を実行
  例：wget (Redmineの新しいチケットを発行する画面のURLパラメータ込みのURL)
• URLをwgetするbatによるJenkinsジョブの実行

C/C++のStrictモードやその他の言語

C/C++のStrictモード
以前とあるお客様と本稿の内容についてお話しをしたところ、Strictモードでの設定が可能かと、質問を頂きました。 実現するにはやや難易度が高い内容になりますが、 本ブログに記載しているCompareGitSHA.batファイルに関し、A.udb及びB.udbの分析時にanalyzeを実施する前に以下のような設定を加えていただくことで、Strictモードでの解析が可能となります。
ただし、プロジェクトやリビジョン毎のマクロやインクルードディレクトリの設定が必要になります。マクロやインクルードパス等の設定はテキストファイルに記載しインポートすることが可能です。gitの各プロジェクトにてこのテキストファイルを一緒に管理いただく形での実現になるかと考えられます。
（例）und settings -C++UseStrict on fastgrep.udb
コマンドライン処理に関する詳細は[Understand 5 ユーザーズ ガイド & リファレンス マニュアル]第13章をご参照ください。

その他の言語
また、C/C++以外のいくつかの主要言語（C#やJAVAを含む）についてもCompareグラフを表示することが可能です。
CompareGitSHA.batの内容を修正いただくことで同様にご使用いただくことが可能です。 ユーザーツールの設定の詳細は[Understand 5 ユーザーズ ガイド & リファレンス マニュアル]第12章をご参照ください。

 カスタム例：
ユーザーツールに”パラメータ”にプロンプト引数を追加して、bat側で言語別に処理を分ける。
→ユーザーツールのプロンプト引数に以下を追記（batファイル側の修正も必要です。）
 [$PromptForSelect “Language=C++Fuzzy;JAVA;C#”]

各設定ファイルの例

[CompareGitSHA.batファイルの中身]

rd /s /q ..\A
rd /s /q ..\B
mkdir ..\A
mkdir ..\B
if ""%1""=="""" goto END
if ""%2""=="""" goto END
if ""%3""=="""" goto END
cd %1
if %ERRORLEVEL%==1 goto END2
del *.udb
und create -db B.udb -languages c++
git checkout %3
und add . B.udb
und settings -AddMode Relative B.udb
und analyze -all -db B.udb
xcopy .\* ..\..\B\ /E
del *.udb
und create -db A.udb -languages c++
git checkout %2
und add . A.udb
und settings -AddMode Relative A.udb
und analyze -all -db A.udb
und settings -ComparisonProjectPath ..\B\B.udb -db A.udb
xcopy .\* ..\..\A\ /E
understand ..\..\A\A.udb
goto END
:END2
echo notExsit
:END
echo Finish

[SetGitRepo.batファイルの中⾝]

if ""%1""=="""" goto END
git clone %1
:END
echo Finish

[ShowLog.batファイルの中⾝]

if ""%1""=="""" goto END
cd %1
git log
:END
echo Finish

[scitools.iniファイルの中⾝]（コピーされる際は行の折り返し箇所に改⾏が⼊らないようご注意ください）

[commandcapture]
usertools\storedtools\git%5Clog\command=C:\\work\\Compare\\ShowLog.bat
usertools\storedtools\git%5Clog\parameters=$PromptForDir .git_ParentDir
usertools\storedtools\git%5Clog\iconfile=
usertools\storedtools\git%5Clog\commanddir=C:\\work\\Compare\\repos
usertools\storedtools\git%5Clog\input=0
usertools\storedtools\git%5Clog\output=1
usertools\storedtools\git%5Clog\uperlscript=false
usertools\storedtools\git%5Clog\addpopup=false
usertools\storedtools\git%5Clog\addmenu=true
usertools\storedtools\git%5Clog\addtoolbar=false
usertools\storedtools\git%5Clog\runsave=false
usertools\storedtools\git%5Clog\runparsechanged=false
usertools\storedtools\git%5Clog\runparseall=false
usertools\storedtools\git%5Clog\runrescan=false
usertools\storedtools\git%5Clog\runBefore=false
usertools\storedtools\git%5Clog\runafter=false
usertools\storedtools\git%5CsetRepo\command=C:\\work\\Compare\\SetGitRepo.bat
usertools\storedtools\git%5CsetRepo\parameters=$PromptForText repoURL
usertools\storedtools\git%5CsetRepo\iconfile=
usertools\storedtools\git%5CsetRepo\commanddir=C:\\work\\Compare\\repos
usertools\storedtools\git%5CsetRepo\input=0
usertools\storedtools\git%5CsetRepo\output=1
usertools\storedtools\git%5CsetRepo\uperlscript=false
usertools\storedtools\git%5CsetRepo\addpopup=false
usertools\storedtools\git%5CsetRepo\addmenu=true
usertools\storedtools\git%5CsetRepo\addtoolbar=false
usertools\storedtools\git%5CsetRepo\runsave=false
usertools\storedtools\git%5CsetRepo\runparsechanged=false
usertools\storedtools\git%5CsetRepo\runparseall=false
usertools\storedtools\git%5CsetRepo\runrescan=false
usertools\storedtools\git%5CsetRepo\runBefore=false
usertools\storedtools\git%5CsetRepo\runafter=false
usertools\storedtools\git%5CundCompare\command=C:\\work\\Compare\\CompareGitSHA.bat
usertools\storedtools\git%5CundCompare\parameters=$PromptForDir .git_ParentDir=defaultValue $PromptForText  SHA_A(usually_new) $PromptForText SHA_B(usually_old)
usertools\storedtools\git%5CundCompare\iconfile=
usertools\storedtools\git%5CundCompare\commanddir=C:\\work\\Compare\\repos
usertools\storedtools\git%5CundCompare\input=0
usertools\storedtools\git%5CundCompare\output=1
usertools\storedtools\git%5CundCompare\uperlscript=false
usertools\storedtools\git%5CundCompare\addpopup=false
usertools\storedtools\git%5CundCompare\addmenu=true
usertools\storedtools\git%5CundCompare\addtoolbar=false
usertools\storedtools\git%5CundCompare\runsave=false
usertools\storedtools\git%5CundCompare\runparsechanged=false
usertools\storedtools\git%5CundCompare\runparseall=false
usertools\storedtools\git%5CundCompare\runrescan=false
usertools\storedtools\git%5CundCompare\runBefore=false
usertools\storedtools\git%5CundCompare\runafter=false
usertools\storedtools\names=git\\log, git\\setRepo, git\\undCompare