このセクションでは、コミット後コードレビュースキャンを構成する方法について説明します。コミット後コードレビュースキャンは、ソース管理システムをスキャンし、チェックインされたコードの中から新規作成または変更されたコードを特定し、そのコードを担当レビューアーと一致させます。

このセクションの内容

ソース管理にコミット前にコードをレビューする「コミット前コードレビュー」の構成の詳細については、「コミット前コードレビュースキャンの設定と実行」を参照してください。
コミット前、コミット後、およびタスク駆動型のワークフローの違いについては、「ワークフローの概要」を参照してください。
コミット前とコミット後の両方のプロセスに適用される全般的なコードレビューの構成オプションの詳細については「コードレビューの全般的な設定」を参照してください。

設定の概要

コミット後コードレビューを構成するには、次の操作が必要です。

サーバー上の Parasoft Test において
- コードレビュー用のテストコンフィギュレーションを構成します (以下のセクションで説明)。
- このテストコンフィギュレーションのコマンドライン実行を構成します (以下のセクションで説明)。
- 自動スキャンのスケジュールを設定します (以下のセクションで説明)。
- レビュー対象のコードがあるプロジェクトが、Parasoft Test で確実に利用できるようにします。プロジェクトはソース管理システムからチェックアウトするべきです。
デスクトップとサーバー両方のすべての Parasoft Test において
- 「コードレビューの全般的な設定」の説明にあるように、すべての Parasoft Test で適切な設定を行います。

コミット後コードレビューのためのテストコンフィギュレーション設定

コミット後プロセスのために、コードレビュー用テストコンフィギュレーションを毎晩サーバー上で実行し、ソース管理システムをスキャンします。このテストコンフィギュレーションは、チェックインされたコードの中から新規作成または変更されたコードを特定し、そのコードを担当レビューアーと一致させます。

コードレビューを実行する前に、デフォルトのコードレビュー用テストコンフィギュレーションを確認してカスタマイズする必要があります。

コードの変更を検出してレビューの準備をするテストコンフィギュレーションを作成するには、次の操作を行います。

[Parasoft]メニューの [テストコンフィギュレーション] をクリックするか、[テストの実行] ツールバーボタンのドロップダウンメニューで [テストコンフィギュレーション] をクリックしてテストコンフィギュレーションダイアログを開きます。
既存テストコンフィギュレーション (たとえば [ビルトイン] > [Code Review] > [Post-Commit] など) を複製するか、新規にテストコンフィギュレーションを作成します。
[スコープ] タブで [指定した期間に追加または変更されたファイルだけをテスト] チェックボックスをオンにします。この設定は、どのファイルがコードレビューのために準備されているかを決定します。たとえば、毎日コードレビュースキャナーを実行する予定の場合、[日前] フィールドに 1 を入力します。毎週実行する予定であれば、 7 を入力します。
- 別の方法として、ある期間中に変更されたすべてのファイルを準備するように設定することもできます。[指定した期間に追加または変更されたファイルだけをテスト]の代わりに [締め切り後に追加または変更されたファイルだけをテスト] および [かつ次の日付までに追加または修正されたファイル] を有効にして、期間を設定します。
[スコープ] タブで [ファイルフィルター] > [パス オプション] の設定を確認し、必要があれば変更します。これらのテストコンフィギュレーション設定の詳細については、「テストコンフィギュレーションの設定」を参照してください。
[共通] タブで [ソース管理システムからプロジェクトを更新] チェックボックスをオンにします。
- コードレビュースキャンが実行される前にプロジェクトはソース管理リポジトリから完全に更新されている必要があります。コードレビュースキャンの前にリソースを更新する外部システムがある場合、 [ソース管理システムからプロジェクトを更新] オプションをオンにする必要はありません。更新を行う他のシステムがない場合は、このオプションをオンにすることを強く推奨します。
固有のセッションタグをコードレビュースキャンで使用するようレポート設定を行っていない場合、[共通] タブに移動して [セッションタグのオーバーライド] を有効にし、定義済みの識別子から選択するか、独自の識別子を指定します。このタグはこのテストコンフィギュレーションによるすべてのコードレビューに割り当てられます。
- コードレビューが正しくレポートされるためには、コードレビュースキャンのセッションタグを設定し、Concerto セッションタグを使用して特定の Concerto プロジェクトと関連付けるコードレビューを指定します。
[コードレビュー] タブをクリックします。
1. [コードレビュースキャナーを有効化] チェックボックスをオンにします。
2. すべての利用可能なチームスキャナーからのコードレビューの結果をレポートに含めるには、[詳細なレポートを生成] チェックボックスをオンにします。このチェックボックスをオフにすると、レポートには、現行のテストコンフィギュレーションで指定したスキャナー識別子の結果だけが含まれます。
3. このテストコンフィギュレーションを実行した後にコードレビュータスクを自動的に公開 (アップロード) したい場合、[レビューを自動公開] チェックボックスをオンにします。夜間の実行で -publish オプションを使用する場合、この設定に関係なくタスクはパブリッシュされます。
4. [優先順位] ドロップダウンリストから優先順位を選択します。この優先順位は、このテストコンフィギュレーションを使って作成されるすべてのコードレビュータスクに割り当てられます。
[作成者]、[レビューアー]、[監督者]、および [フィルター] タブで、コードレビューをどのように割り当てるかを定義します。レビューアーと監督者は、特定の作成者またはプロジェクト領域に割り当てることができます。
- [作成者] タブで、レビュー対象のコードを作成している開発者のリストを定義します。作成者ごとに名前を指定します。名前とソース管理システムでのログイン名が異なる場合はログイン名も指定します。
  - 作成者リストには、開発者全員を指定することも、一部の開発者だけを指定することもできます。
  - コードの変更をコミットした開発者が [作成者] タブで定義されていない場合、その変更は「未定義の作成者」による変更としてマークされます。
  - ここで作成者をレビューや監督者にマップする必要はありません。これらのフィールドは、以前のバージョンの Parasoft Test との下位互換性を保つためのものです。[作成者] タブで各開発者を定義したくない場合、次の設定を行うことができます。 1)[フィルター] タブで、 [レビュー対象パスの (未定義を含む) すべての作成者を受け入れ] チェックボックスをオンにします。 2) [レビューアー] タブで、コードのどの部分をどのレビューアーが担当するかを定義します。
- [レビューアー] タブおよび [監督者] タブで、それぞれのレビューアー/監督者が担当する作成者あるいはプロジェクト領域を指定します。
  - レビューアーは、コードの変更の検証、コメントの追加、および承認を行います。監督者は、リビジョンが確実にレビューされて適時に修正されるよう、プロセス全体を監督します。監督者はレビューを実行する必要はありませんが、リビジョンとレビューにコメントを追加できます。この役割は任意です。
  - パスは、論理的 (ワークスペースの) パス規約で定義されます。ワイルドカードを使用できます。詳細と例については下のボックス「Filter Tips and Examples」を参照してください。
  - レビューアーと監督者は、特定の作成者やパスにマップすることなく定義できます。そのようなレビューアー/監督者には自動的にコードレビューパッケージが割り当てられませんが、彼らの名前はレポートに含まれます。
  - これらのタブは OR 論理 (AND 論理ではなく) を使用します。つまり、レビューアー (または監督者) の名前を定義し、そのレビューアーまたは監督者にレビューまたは監督させたい作成者およびレビューパスを定義します。すると、指定された作成者または指定されたパスから新しいコードが発生した場合、指定されたレビューアーまたは監督者に割り当てられます。
(オプション) [フィルター] タブで必要に応じて以下のオプションを変更します。
- 抑制されたブロックの変更を無視する: コードレビュースキャンで "codereview-begin-suppress" マーカーと "codereview-end-suppress" マーカーの間にあるすべての差分を無視する場合、このオプションをオンにします。これらのマーカーは、比較エディターで特定のコードブロックの差分を非表示にするために使用するマーカーと同じです (詳細については「差分を表示しないコード部分の指定」を参照してください)。
- 差分: コードレビュースキャンで、特定のパターンに一致する、現行のソースと以前のソースのすべての差分を無視する場合、適切な正規表現を指定します。たとえば、コードレビューが必要な差分として自動生成コメントがレポートされるのを防止できます。
- コミット前とコミット後のマッチング: コミット前およびコミット後コードレビューの複合プロセスに関するオプションです。コードをチェックインする前にレビュー用にコミットする必要があると同時にコミット後にもスキャンを行ってレビュープロセスが正しく行われるよう確認する場合に使用します。
  - コミット前とコミット後のマッチング: コミット後スキャンで、コミット前スキャンとコミット後スキャンの特定のパターンに一致するすべての差分を無視する場合、適切な正規表現を指定します。たとえば、このオプションを使用して、チェックイン時に追加された CVS の自動生成ヘッダーがコミット後レビューが必要な差分としてレポートされるのを防ぐことができます。詳細については「コミット前とコミット後の両方のコードスキャン」を参照してください。
  - コミット前検索範囲 (日): コミット前タスクとコミット後タスクの対応を決定する際に使用するタイムフレームをカスタマイズする場合、この設定を変更します。詳細については「コミット前とコミット後の両方のコードスキャン」を参照してください。
- レビュー対象パスの (未定義を含む) すべての作成者を受け入れ: 個々に開発者を定義したくない場合、次の設定を行います。 1) [レビュー対象パスの (未定義を含む) すべての作成者を受け入れ] チェックボックスをオンにします。 2) [レビューアー] タブで、コードのどの部分をどのレビューアーが担当するかを定義します。
[適用] ボタンをクリックして新しいテストコンフィギュレーションを保存します。
プロジェクトに対してこのテストコンフィギュレーションをテストしてから、テストコンフィギュレーションを実行します。

レビューのためにコードを準備する - スキャナーの自動実行

コミット後コードレビューの場合、Parasoft Test は通常コードレビュー用テストコンフィギュレーションはコマンドラインモードで定期的に (たとえば 24 時間ごとに) 自動実行されるように設定されます。テストはチームのコードレビュー用テストコンフィギュレーションを実行します。テストを実行するたびに、コードレビュースキャナーはソース管理リポジトリをスキャンして新規/変更のコードを探し、発見したコードをレビュー用に準備します。

コマンドラインの設定

プロジェクトをまだ設定していない場合、Parasoft Test GUI でプロジェクトを設定します。
(任意) 必要に応じてローカル設定ファイル (オプションファイル) を使って、GUI で指定された設定を上書きします。詳細は「ローカル設定の指定」を参照してください。

コマンドラインの実行

コマンドラインからコードレビュースキャナーを実行するには、次のようなコマンドを使用します。

cpptestcli -publishteamserver -config "team://xtest-codereview.properties" -resource"my_resource" -localsettings C:\tm\localsettings.properties

上記の例では次のオプションを使用しています。

-publishteamserver: Team Server にテスト結果をパブリッシュします。
-config: テストコンフィギュレーションを指定します。以下は例です。
- -config "builtin://Demo Configuration"
- -config "Demo Configuration"
- -config "user://My First Configuration"
- -config "team://Team Configuration"
- -config "team://teamconfig.properties"
-resource: テストするプロジェクト/ファイルを指定します。以下は例です。
- -resource "Acme Project"
- -resource "/MyProject/src/com/acme/MyClassTest.java"
- -resource "/MyProject/src/com/acme"
- -resource testedprojects.properties

ローカル設定ファイル (オプションファイル) を使って GUI での指定を上書きする場合、 -localsettings オプションを使用します。例:

cpptestcli -publishteamserver -config "team://xtest-codereview.properties" -resource "my_resource" -localsettings C:\tm\localsettings.properties

レビューアーへの通知

コードレビュースキャナーの実行のたびに、コードのレビューの準備ができたことが担当レビューアーに通知されます。通知があったら、レビューアーは「レビューアー：コードの変更のレビュー」にあるようにレビューを行うことができます。

レビューが終了したら、作成者は「作成者：レビューコメントの検証と対応」にあるように対応できます。

コミット前とコミット後の両方のコードスキャン

プロセス

開発チームによっては、コミット前のプロセスによってレビューのためにコードをサブミットするだけでなく、次の理由から定期的にサーバーモードで (製品のコマンドラインインターフェイスから) コミット後のスキャンを実行したい場合があります。

以下の両方が実行される 2 層の通知システムを構築するため。
- 各チームメンバーにタスクをレビューするよう IDE の通知によって知らせる。これを実現するには、[新規または更新されたレビューを次の間隔で通知] オプションを使用します。
- サーバーからサマリーレポートを E-mail で送信し、保留中のレビュータスクについてレビューアーおよび監督者に通知する。E-mail は適切なレポートオプションが設定されている場合に生成されます。[詳細なレポートを生成] オプションがオンの場合、レポートにはすべてのコードレビュースキャン (コミット前およびコミット後) のタスクが含まれます。オプションがオフの場合は、現在のコミット後スキャンのタスクだけが含まれます。コマンドライン実行からのレポート生成設定の詳細については「レポートの生成」を参照してください。
ソース管理にコミットされたがコミット前の処理でレビューのためにサブミットされなかったコードの変更を特定する。

コミット前プロセスに加えてコミット後のスキャンを実行する場合、次の処理を行うことができます。

空のワークスペースに対してコミット後スキャンを実行するこの処理は、さらにスキャンを実行したり、さらにタスクをレポートしたりすることはありません。単純に、(適切なレポートオプションが設定されている場合)、サブミットされた "コミット前" レビューに関連する電子メールを生成します。
ワークスペースをセットアップしてから、-include を使ってコミット後スキャンを実行し、プロジェクト中のスキャンしたい部分だけを再スキャンするこの処理は、コミット前レビュープロセスでレビューのためにサブミットされなかった、プロジェクト中の重要なコード部分の変更を発見し、それらの変更点について新規にタスクを生成します。
完全なワークスペースをセットアップし、すべてのコードに対してコミット後スキャンを実行するこの処理は、コミット前レビュープロセスでレビューのためにサブミットされなかったコードの変更点を発見し、それらの変更点について新規にタスクを生成します。

多くのチームでは以下を要求するポリシーを持っています。

すべてのコードの変更をレビューする
コードをレビューしてからでなければチェックインしてはならない

これを達成する方法の 1 つは、ハイブリッドコードレビュープロセスを構築することです。ハイブリッドコードレビュープロセスでは、コミット前コードレビューでレビュー用にコードをサブミットしてから、コミット後モードを使用してこのプロセスが守られているかを検証します。

コミット後スキャンは、対応するコミット前タスクが「完了」としてマークされていない場合、コードレビュータスクをレポートします。[フィルター] タブの [コミット前検索範囲 (日)] オプションを変更すると、対応するコミット前タスクを決定する期間をカスタマイズできます。デフォルトでは、コミット後スキャンから 7 日前までさかのぼります。

マネージャーを監督者として設定できます。リリースまたはビルドの前にすべてのコードがレビューされたかどうかを確認するには、1) コミット後タスクがレポートされていないこと、2) 監督者 E-mail にコミット後プロセスからの保留中のレビューアイテムが表示されていないことを確認します。

コミット前とコミット後が混在するコードレビュープロセスにおいて、コードレビュースキャナーが「コミット前コードレビューでレポートされた変更点」と「ソース管理システムにコミットされた変更点」とを比較することにも注意してください。

変更の内容が一致した場合、これは、ソース管理システムにコミットする前に、コミット前コードレビューによってファイルがレビューされたことを意味します。この場合、コミット前プロセスは実施されています。
変更の内容が一致しない場合、これは、ファイルが変更されたにも関わらずコードレビューに出されなかったことを意味します。この場合、コミット前プロセスは実施されていません。

ただし、レビューを必要としない細かな変更がソース管理システムにコミットされることもあります。たとえば次のような CVS ヘッダーなどです。

/* * $RCSfile: MyFile.txt,v $ * $Revision: 1.13 $ * * Comments: * * (C) Copyright Parasoft Corporation 1996. All rights reserved. * THIS IS UNPUBLISHED PROPRIETARY SOURCE CODE OF Parasoft * The copyright notice above does not evidence any * actual or intended publication of such source code. * * Revision 1.2 2006/02/03 10:07:28 dan * class repackaged * * Revision 1.1 2005/09/18 09:26:24 mark * new file */

そのような場合は、夜間のコミット後スキャンのためのテストコンフィギュレーションで、自動生成コードを表す正規表現を指定するべきです。この設定は、[コードレビュー] タブの [フィルター] タブの [コミット前とコミット後のマッチング] オプションで指定することができます。

たとえば、上記の例の CVS ヘッダーの変更を無視するには、次のように入力します。 (^ \* .*)|(^ \*$)

また、レビューする必要がないその他の変更点を照合して無視するようテストコンフィギュレーションを設定することもできます。たとえば、開発チームはドキュメントの変更をレビューすることなく直接ソース管理システムにコミットすることができます。