このセクションでは、コード レビュー機能の概要を説明します。
コード レビューの概要
Parasoft 社のコード レビューは、レビューの準備、通知、追跡を自動化することによって、レビューをより実用的かつ生産的にすることを目的として開発されました。コード レビューは、更新されたコードを自動的に特定し、担当レビューアーにコードを割り当てます。そして、問題がクローズするまで各レビュー項目の進行状況を追跡します。これによって、チームは強力なレビュー プロセスを確立し、確実にコードをレビューして発見したすべての問題を解決するようにできます。
Parasoft 社のコード レビューは、次の一般的なコード レビュー ワークフローをサポートします。
- コミット後: カスタム ソース管理インターフェイスを介してソース リポジトリ中のコードの変更を自動的に特定します。変更されたコードとレビューアーの定義済みマッピングに基づいて、レビュー タスクが作成されます。
- コミット前: レビューに出すファイルを選択してデスクトップからコード レビューを開始するか、あるいはローカルに変更されたすべてのソース コードを自動的に特定することができます。
なお、コード レビューを使用するには、Team Server と C/C++test Custom Edition が必要です。
ワークフローの概要
2 種類の重要なワークフローがあります。「デフォルト vs. 制限付き」そして「コミット前 vs. コミット後 vs. タスク駆動型」です。
デフォルト vs. 制限付き
制限付きワークフローでは、レビューアーは各問題を承認しなければなりません。レビューアーの提案に作成者が同意しない場合、作成者はその問題についてレビューアーと話し合う必要があります。
デフォルト ワークフローはもっとオープンです。レビューアーからコメントを受け取った作成者は、コメントの内容をコードに適用するか、またはコードをそのままにしておくことができます。
コミット前 vs. コミット後
コミット前
コミット前のコード レビューは、ソース管理に追加する前にコードをレビューしたい開発チームに適しています。 新規のコードまたは変更済みのコードをレビューに出す準備ができたら、Parasoft Test からコード レビュー用テスト コンフィギュレーションを実行します。すると、必要なレビューがレビューアーに自動的に通知されます。
コミット後
コミット後のコード レビューは、ソース管理に追加する後にコードをレビューしたい開発チームに適しています。通常、コード レビュー用テスト コンフィギュレーションは、定期的に自動で実行するようスケジュールされています(たとえば24時間ごとなど)。コード レビュー用テスト コンフィギュレーションはソース管理リポジトリをスキャンし、レビューが必要なコードがあった場合、その情報を Team Server に送信して担当レビューアーに配布します。このワークフローの場合、コードの作成者は、コードをレビューしてもらうために特別なアクションを取る必要がありません。ソース管理システムにコードをコミットするだけで十分です。コード レビュー用テスト コンフィギュレーションを実行すると、必要なレビューが担当レビューアーに自動的に通知されます。
コミット前のプロセスでは、ソース管理システムにコミットする前に承認が必要なコードに対して、コード レビュー パッケージが作成されます。コミット前のプロセスにおいて、作成者はパッケージが最終的に承認されたかどうかを必ず確認するべきです。承認を確認した時点で、作成者はファイルをコミットしてコード レビュー パッケージをクローズすることができます。
コミット前プロセスでレビューのためにコードをサブミットするチームの中には、次の操作を行うためにコミット後の夜間スキャンの実行を好むチームもあります。
- 電子メールを生成し、割り当てられたコード レビュー タスクについて作成者とレビューアーに通知する。
- ソース管理にコミットされたがコミット前の処理でレビューのためにサブミットされなかったコードの変更を特定する。
ワークフローの詳細
次の図は、利用できる重要なワークフローを表しています。
ビルトイン コード レビュー テスト コンフィギュレーション
- Pre-Commit: ソース管理システムにコミットする「前」にコードをレビューしたいチームに適しています (「コミット前 vs. コミット後」を参照)。ローカルに追加または変更されたファイルをスキャンします。このテスト コンフィギュレーションを使用するには、コード レビューの設定で [ スキャナー実行中にユーザー補助を表示] チェックボックスをオンにし、適切なレビューアーを作成者が指名できるようにしなければなりません。
Post-Commit (Template): ソース管理システムにコミットする「後」にコードをレビューしたいチームに適しています (「コミット前 vs. コミット後」を参照)。前日に変更されたすべてのプロジェクト ファイルをスキャンします。このテスト コンフィギュレーションは、複製してカスタマイズしてから使用します (作成者-レビューアー マッピングを指定するなど)。詳細については「コミット後コード レビュー スキャンの設定と実行」を参照してください。
- Post-Commit (Assign All): ソース管理システムにコミットする「後」にコードをレビューしたいチームに適しています (「コミット前 vs. コミット後」を参照)。前日に変更されたすべてのプロジェクト ファイルをスキャンします。このテスト コンフィギュレーションはカスタマイズせずに使用できます。ローカル コード レビュー ユーザーのマッピングを含みます。(あらゆる作成者について) スコープで発見されたすべてのリビジョンを現行ユーザーに割り当てます。
コード レビュー タスク/ステータス レポート
「コード レビューの GUI」で説明されているとおり、コード レビュー タスクは GUI にレポートされます。コード レビューの詳細も、コマンド ラインまたは GUI での解析によって生成されたレポートのコード レビュー セクションに表示されます。これらのレポートを見ると、プロジェクトごとおよび作成者ごとのコード レビュー タスクおよび問題の概要がわかります。また、レポートには保留中の問題およびコード レビュー タスクの詳細も表示されます。
例:
