このセクションでは、コミット前コード レビュープロセスを構成して実行する方法について説明します。コミット前コード レビューでは、ソース管理にコミットする前にコードをレビューします。開発者は、コードのレビューが必要になるたびに、コード レビュー用テスト コンフィギュレーションを実行します。このテスト コンフィギュレーションは、コードの変更点を検出してレビューのために準備します。 

このセクションの内容:

概要

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

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

コード レビュー用テスト コンフィギュレーションは、変更されたコードを検出してレビューのために準備します。推奨する方法は、1 つのテスト コンフィギュレーションを設定し、Team Server を使ってチーム全体で共有する方法です。この方法はテストコンフィギュレーションの設定と更新を効率化します。 

コード レビューに特化したテスト コンフィギュレーションを作成することも、コード レビューに加えて別の処理を行うテスト コンフィギュレーションを作成することもできます。

変更されたコードを検出してレビューのために準備するテスト コンフィギュレーションを設定するには、以下の操作を行います。

  1. [Parasoft] メニューの [テスト コンフィギュレーション]をクリックするか、または ツールバーの [テストの実行] ドロップダウン リストから [テスト コンフィギュレーション] を選択します。
  2. 既存テスト コンフィギュレーション (例えば [ビルトイン] > [Code Review] > [Pre-Commit] など) を複製するか、新規にテスト コンフィギュレーションを作成します。
  3. [スコープ] タブで [ローカルで追加または変更されたファイルだけをテスト] チェックボックスをオンにします。
  4. [スコープ] タブで [ファイル フィルター] > [パス オプション] の設定を確認し、必要があれば変更します。 
  5. レポート設定で、ユニークな ID を使用してコードレビュー スキャンを実行するようまだ設定していない場合、[共通] タブに移動して [セッション タグのオーバーライド] オプションを有効にし、設定済みの ID のいずれかを選択するか、独自の ID を指定します。ID は、このテスト コンフィギュレーションから発生するすべてのコード レビューに割り当てられるタグになります。
  6. [コード レビュー] タブをクリックします。
    1. [コード レビュー スキャナーを有効化] チェックボックスをオンにします。
    2. すべての利用可能なチーム スキャナーからのコード レビューの結果をレポートに含めるには、[詳細なレポートを生成] オプションを有効にします。コミット前コード レビューでは通常このオプションを使用しません。このオプションを無効にすると、レポートには現行のテスト コンフィギュレーションで指定したスキャナー識別子の結果だけが含まれます。
    3. このテスト コンフィギュレーションを実行した後にコード レビュー タスクを自動的に公開 (アップロード) したい場合、[レビューを自動公開] オプションを有効にします。コミット前コード レビューでは、このオプションを有効にすることを推奨します。
    4. [優先順位] ドロップダウン リストから優先順位を選択します。この優先順位は、このテスト コンフィギュレーションを使って作成するすべてのコード レビュー タスクに割り当てられます。
  7. (オプション) レビューを自動的に割り当てたい場合、[作成者]、[レビューアー]、[監督者]、および [フィルター] タブで、コード レビューをどのように割り当てるかを定義します。レビューアーと監督者は、特定の作成者またはプロジェクト領域に割り当てることができます。ここでオプションを指定しない場合、各作成者は、サブミットされるレビューごとに適切なレビューアーを選択する必要があります。
  8. (オプション) [コード レビュー] > [フィルター] タブで必要に応じて以下のオプションを変更します。
  9. [適用] ボタンをクリックして新しいテスト コンフィギュレーションを保存します。
  10. 他の開発メンバーと共有するために、このテスト コンフィギュレーションを右クリックして [Team Server へアップロード] をクリックします。

レビューのためにコードを準備する - インタラクティブなデスクトップ実行

新規/変更のコードをレビューに回す準備ができたら、次の操作を実行します。

  1. プロジェクト ツリーで、レビュー対象の変更点があるプロジェクトを選択します。
  2. コード レビュー用テスト コンフィギュレーションを実行します。 このテスト コンフィギュレーションはチーム カテゴリにあるはずです。
  3. コード レビューの設定で [スキャナー実行中にユーザー補助を表示] を有効にしている場合、次のダイアログが表示されます。

    code_review_2.png

    次の操作が可能です。
  4. コード レビュー用テスト コンフィギュレーションで [コード レビュー] タブの [レビューを自動公開] オプションを無効にしている場合は、次の操作を行って手動で Team Server に結果をアップロードします。

担当レビューアーに、コードのレビューの準備が整ったことが通知されます。レビューアーは 「レビューアー：コードの変更のレビュー」にあるようにレビューすることができます。

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

コード レビュー パッケージへの新しいファイルの追加

既存のコード レビュー パッケージにファイルを追加するには、次の操作を行います。

  1. プロジェクト ツリーで、ファイルを追加するパッケージを右クリックし、[Parasoft] > [ローカルな変更の追加] > [コード レビュー] をクリックします。
  2. [コード レビュー] ダイアログを完了します。

properties ファイルによるレビューアー、作成者、監督者の定義

コード レビュー ユーザーは、直接テスト コンフィギュレーションで指定したり、スキャナー補助のダイアログで追加したりするだけでなく、.properties ファイルで定義することもできます。レビュー プロセスに関わるチーム メンバーの数が多い場合、.properties ファイルを使った定義が役立ちます。

properties ファイルを使ってコード レビュー ユーザーを定義するには、次の操作を行います。

  1. 空のプロパティ ファイル config.properties を用意します。

  2. このファイルに次の初期必須データを追加します。

    com.parasoft.xtest.checkers.api.config.name=Base Code Review com.parasoft.xtest.checkers.api.config.tool=3   com.parasoft.xtest.codereview.scanner.checksum=fixed

  3. ユーザーのリストを追加します。手動で追加するか、適切な情報を自動的に抽出するカスタム スクリプトを利用して追加します。ユーザーごとにインデックスが必要です。その後に name (名前)、role (役割)、monitored.locations (監督されるパス) といったプロパティを指定します (monitored.locations を設定できるのは監督者だけです)。指定できる役割は'a' (author：作成者)、'm' (monitor：監督者)、'r' (reviewer：レビューアー) です。例:

    com.parasoft.xtest.codereview.scanner.crusers.0.name=tom com.parasoft.xtest.codereview.scanner.crusers.0.roles=r com.parasoft.xtest.codereview.scanner.crusers.1.name=bob com.parasoft.xtest.codereview.scanner.crusers.1.roles=r com.parasoft.xtest.codereview.scanner.crusers.2.monitored.locations=**/src/**, **/include/** com.parasoft.xtest.codereview.scanner.crusers.2.name=joe com.parasoft.xtest.codereview.scanner.crusers.2.roles=am com.parasoft.xtest.codereview.scanner.crusers.3.name=bill com.parasoft.xtest.codereview.scanner.crusers.3.roles=a
  4. config.properties を HTTP サーバーにパブリッシュします。ユーザー データベースに基づいてこのファイルを自動的に再生成する場合は、再生成が可能な場所を使用してください。
  5. [Pre Commit] テスト コンフィギュレーションを複製して新しいテスト コンフィギュレーションを作成します。
  6. このテスト コンフィギュレーションを右クリックし、[新しい子コンフィギュレーション] をクリックします。そして [親] フィールドで HTTP 親コンフィギュレーションへの URL アドレスを指定します。
  7. [テスト コンフィギュレーション] ダイアログをリフレッシュし、追加したコード レビュー ユーザーが表示されていることを確認します。
  8. テスト コンフィギュレーションを Team Server にパブリッシュします。

以下は properties ファイルの例です。

com.parasoft.xtest.codereview.scanner.crusers.13.roles=arm com.parasoft.xtest.codereview.scanner.crusers.13.name=dave com.parasoft.xtest.codereview.scanner.crusers.13.reviewers=mark_A, mark_B com.parasoft.xtest.codereview.scanner.crusers.13.monitors=mike com.parasoft.xtest.codereview.scanner.crusers.13.reviewed.locations=**/test/*.txt, project_A/** com.parasoft.xtest.codereview.scanner.crusers.13.monitored.locations=/**   com.parasoft.xtest.codereview.scanner.checksum=fixed

以下の点に注意してください。

コミット前プロセスへのコミット後スキャンの追加

コミット前プロセスでレビューのためにコードをサブミットするチームの中には、次の操作を行うためにコミット後の夜間スキャンの実行を好むチームもあります。

詳細については 「コミット前とコミット後の両方のコード スキャン」を参照してください。