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

• 開発者のユースケース
  developブランチの同一ブランチ内の前回のリビジョンと今回のリビジョンを、開発者自身がCompareグラフやソースコード差分機能を通して差分を確認する。また、比較結果となる画像をpngファイルで出力し、変更設計書などのドキュメントに張り付けてSVNでコードと一緒に管理する。
• レビュアーのユースケース
  メインブランチにコミットする直前のリビジョンと開発スタート時のリビジョンを比較して、差分をチェックする。テスト計画レビューなどでUnderstandで確認したコードベースの差分と、テスト項目の比較をする。

---

目次

• 前提条件
• 事前準備
  • 1. SVNリポジトリ
  • 2. batファイルの配置
  • 3. ユーザーツールの設定
• 実施手順：リビジョン番号を２つ指定し、リビジョンの比較を行う
• 結果の確認
• 各設定ファイルの例

前提条件

1. 動作確認済環境
   • Windows 10 64bit
   • Understand 5.1 (Build 1022)
   • 有効なUnderstandライセンス（APIライセンスは不要）
   • SVN コマンドラインツールインストール済
     （例）以下のPath設定は https://www.visualsvn.com/downloads/ から、[Apache Subversion command line tools]をDownloadし、[C:\tools]ディレクトリにインストールした場合の例
   • 環境変数[Path]に以下が追加済（SVNクライアント及びUnderstandのインストール先に合わせて変えてください。）
     • C:\Program Files\SciTools\bin\pc-win64
     • C:\tools\Apache-Subversion-1.11.1\bin
2. 解析対象
   • 言語：C/C++(Fuzzy)
   • 解析コード：tortoisesvn（オープンソース）
   • リポジトリパス：
     https://svn.code.sf.net/p/tortoisesvn/code/trunk/src/Utils
     ※サンプルでは気軽にお試しいただけるようコード量調整のため、Utilsモジュールのみを指定しております。

事前準備

1. SVNリポジトリ

今回のサンプルではオープンソースのSVNリポジトリを使用します。
このため、ご試用いただく上でお客様側でSVNリポジトリを準備いただく必要はありません。お客様側にて準備されたSVNリポジトリに接続される場合には後述の実施手順3で入力するパラメータを環境に合わせて変更してください。

2. batファイルの配置

1. ワークスペースを作成します。
   Compareディレクトリを作成し、Compareディレクトリ直下にSVNworkディレクトリを作成します。

• パスの例
  • C:\work\Compare
  • C:\work\Compare\SVNwork

2. 本ブログ最後尾に記載の各batファイルをCompareディレクトリ直下に配置します。

• batファイルの配置パスの例
  • C:\work\Compare\CompareSVNrev.bat
• 配置するbatファイル
  • CompareSVNrev.bat

なお、batファイル内でUnderstandプロジェクトの解析を行う際に言語の指定を行っております。今回はC/C++言語のFuzzyモードでの解析となります。

3. ユーザーツールの設定

1. 本ブログ最後尾に記載の scitools.iniを一時ファイルとして任意のディレクトリに保存します。
2. UnderstandのGUIを起動し、[メニューバー]-[ツール]-[オプション]-[ユーザーツール]を選択します。

3. [ユーザーツール]の[インポート]ボタンを押し、保存したiniファイルを指定します。
4. [ユーザーツールのインポート]画面において、[すべて]ボタンを押し、すべてのチェックボックスが選択された状態にして[インポート]ボタンを押します。

5. ユーザーツール内で、以下計3箇所を修正します。

• [svn\undCompare]の設定

• [コマンド(C)]：[batファイルの配置]項で配置した[CompareSVNrev.bat]ファイルのパスを指定します。
• [パラメーター(P)]
  PathKindの選択肢はご使用される際に”URL”または”DirectoryPath”のいずれかを毎回選択いただく必要があります。
  いずれかを優先的に使用されたい場合には、不要な選択肢を削除いただくか、選択肢の順番を入れ替えていただき普段使用される選択肢を先頭にしてください。
  repoPathは初期値では”defaultValue”の文字列が入力されています。
  後述の実施手順3の中で実行毎に指定頂くことが可能ですが、
  デフォルト値を設定されたい場合には、以下の例のような文字列に変更いただくことができます。
  （例）C:\work\CI\SvnRepository\repo
  （例）https://svn.code.sf.net/p/tortoisesvn/code/trunk/src/Utils
• [初期ディレクトリ]：Compareディレクトリ直下の[SVNwork]ディレクトリを指定します。
  初期ディレクトリパス
  （例）C:\work\Compare\SVNwork

6.  [OK]ボタンを押します。これでユーザーツールの設定は完了です。

※Understand設定ファイル（C:\Users\（ユーザー名）\AppData\Roaming\SciTools\Understand.ini）を削除されますと、本ユーザーツールの設定は削除されます。

予め[ユーザーツールのエクスポート]より設定内容をバックアップしておくことをお勧めいたします。

実施手順：リビジョン番号を２つ指定し、リビジョンの比較を行う

1. Understand(GUI)を起動した状態にします。※後にオープンエラーが発生することを防ぐため、プロジェクトは開かないでください。

2. メニューバーから[ツール]-[ユーザーツール]-[svn]-[undCompare]を押します。

3. 表示されたダイアログにおいて各値を指定し、OKボタンを押します。
   • PathKind：”URL”を選択（お客様環境に接続する場合は環境に合わせて指定）
   • repoPath：https://svn.code.sf.net/p/tortoisesvn/code/trunk/src/Utils
     （リポジトリパスを指定してください：[実施手順5（補足）]を参照）
   • rev_A：比較元（通常は新ver）
   • rev_B：比較先（通常は旧ver）
     [サンプルプロジェクトお試し用リビジョン番号]
     新Rev:24147
     旧Rev:23880

4. 以下のような実行ログが出力され、新しいUnderstandの画面が立ち上がり、その画面でA.udbが自動的に開けば成功です。

• リポジトリパスがURLの場合
  PathKindは”URL”を指定
  repoPathは該当のリポジトリURLを指定
  revA, revBは指定のリビジョンを指定
  (例)
  PathKindを”URL”、
  repoPath を https://svn.code.sf.net/p/tortoisesvn/code/trunk/src/Utils、
  リビジョンを23880と指定した場合、以下が実行されます。
  svn co -r 23880 https://svn.code.sf.net/p/tortoisesvn/code/trunk/src/Utils
  
  ※batファイル側ではプロトコルへの制限はかけておりませんので、
  svn/http/httpsなどsvnコマンドで対応しているプロトコルが使用可能です。(リポジトリ側では制限がある場合がございます。)
  ※下記に示すように利便性を考え、fileプロトコルの場合のみ、ディレクトリパス指定で利用できるように、batファイル側で調整しております。
• リポジトリパスがディレクトリパスの場合
  SVNのリポジトリ情報が含まれているrepoディレクトリをご指定ください。
  PathKindは”DirectoryPath”を指定
  repoPathは該当リポジトリのrepoディレクトリのパスを指定
  revA, revBは指定のリビジョンを指定
  (例)
  PathKind を “DirectoryPath”、repoPath を C:\work\CI\SvnRepository\repo、
  リビジョンを 9 と指定した場合、以下が実行されます。
  svn co -r 9 file:///C:/work/CI/SvnRepository/repo

• [ツール]→[比較]→[ファイル/フォルダの比較]から表示されるダイアログにおいて、AディレクトリとBディレクトリを比較し、[MiscUI\BaseWindows.cpp]を選択の上、ファイル内の差分を表示します。

• [レポート]→[プロジェクトインタラクティブレポート]→[Changed Entities]より表示されたダイアログで、全てデフォルト値でOKボタンを押すと表示されるIReportからメトリクス差分を確認します。

@echo off
setlocal enabledelayedexpansion
rd /s /q ..\A
rd /s /q ..\B
del *.udb
if ""%2""=="""" goto END
if ""%3""=="""" goto END
if ""%4""=="""" goto END
set repoPath=
if ""%1""==""URL"" (
set repoPath=%2
echo !repoPath!
) else if ""%1""==""DirectoryPath"" (
if exist %2 (
echo "Directory Path Exist"
) else (
echo "Directory Path Not Exist"
goto END
)
set repoPath="file:///%2"
echo !repoPath!
) else (
echo "Input Error"
)
mkdir B
cd B
und create -db B.udb -languages c++
svn co -r %4 !repoPath!
und add . B.udb
und settings -AddMode Relative B.udb
und analyze -all -db B.udb
cd ../
xcopy .\* ..\ /E
 move .\*.udb ..\B\
rd /s /q B
mkdir A
cd A
und create -db A.udb -languages c++
svn co -r %3 !repoPath!
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
cd ../
xcopy .\* ..\ /E
 move .\*.udb ..\A\
rd /s /q A
understand ..\A\A.udb
goto END
:END
echo Finish