このセクションでは、SOAtest を構成して、作成者を算定してチーム全体に品質タスクを割り当てる方法を説明します。
このセクションの内容:
概要
通常、1 つの開発プロジェクトには SDLC 全体を通じて数多くのチーム メンバーが参加します。アプリケーション ロジックの開発者や Web インターフェイスの開発者から、エンド ツー エンド プロセスとトランザクションをテストする QA まで、チーム メンバーの構成はさまざまです。
レビュー ワークフローの自動化、静的解析、単体テスト、実行時エラー検出、SOA ポリシーの推進、個々の SOA コンポーネントの機能テスト、そしてエンド ツー エンド テスト シナリオと多岐にわたるテクノロジーによって、SOAtest はさまざまなチーム メンバーのための品質タスクを生成します。これらの品質タスクは適切なチーム メンバーに割り当てることができ、手動による割り当てだけでなく、自動検出された作成者データに基づいて割り当てることもできます。
品質タスクの割り当ては、次の目的で行われます。
- 各チーム メンバーが自分の担当するタスクだけをコマンドライン テストから GUI にインポートできるようにする。
- 各チーム メンバーに、自分に割り当てられたタスクについてだけのレポートを送る。
- どのチーム メンバーがどのタスクを担当するかをマネージャー レポートに表示する。
タスクの割り当て
SOAtest はソース管理データに基づいてさまざまな方法でタスクを割り当てることができます。
- ソース管理システムにあるソース ファイルの静的解析を実行するか、またはソース管理システムにテスト ファイルがある機能テストを実行する場合、タスクを割り当てるためにソース管理システムのデータを使用するよう、SOAtest を設定できます。静的解析タスクは、その違反を引き起こしたコードの作成者に割り当てられます。テストの失敗は、そのテストに最後に関わったチーム メンバーに割り当てられます。
- SOAtest を使って機能テストを実行する場合、特定のテスト スイートまたは他のリソースに直接タスク オーナーを指定することができます。
SOAtest 環境のプロジェクトにソース ファイルを追加した場合、そのソース ファイルの最終更新についての情報だけでなく、そのソース ファイルの特定の行に割り当てられたチーム メンバーを参照できます。
- 適切なファイルのエディターを開きます。
- 作成者を参照したい行を右クリックし、[Parasoft] > [行の作成者を表示] をクリックします。
なお、ソース管理システムのデータを使って作成者を算出していない場合、選択した行に対する情報ではなく、ファイルの変更情報が表示されます。
作成者とタスクの割り当て
SOAtest は、サポートするソース管理システムのデータ、@author Javadoc タグ、xml マッピング ファイル (ファイルと作成者の直接マッピング)、および現行のローカル ユーザーに基づいて「作成者」を割り当てることができます。
複数のソースを使って作成者を判定する場合、作成者の優先順位は、[設定] ウィンドウの [スコープと作成者] の設定に従って上から下へ判定されます ( ソース管理システムのリスト、@author タグ、マッピング ファイル、最後に現行ユーザー)。ただし、選択したオプションが作成者を判定できない場合 (例えば @author タグが選択されたがファイルには @author タグがない場合)、SOAtest は選択された次のオプションに基づいて作成者を判定します。それでも作成者を判定できなかった 場合、ユーザーは "unknown" として設定されます。さらに、どのオプションも選択されていない場合にもユーザーは "unknown" として設定されます。
ソース管理データと @author タグの両方を作成者の算定に使用している場合、可能なかぎりソース管理データが使用され、 @author はソース管理されていないファイルとプロジェクトに対してだけ使用されます。
現行ローカル ユーザーを算定に使用している場合、ローカル ユーザーが作成者と見なされ、ローカルの時刻が最終修正時刻と見なされます。
作成者とタスクは次のように割り当てられます。
- ソース管理データに基づいて作成者が決定される場合、SOAtest はソース管理データを読み込み、ファイル/行/メソッドなどを最後に変更した、タスクに責任があるユーザーを特定します。そしてそのユーザーにタスクを割り当てます。
- @author Javadoc タグに基づいて作成者が決定される場合、 SOAtest はタスクに最も近い @author Javadoc タグを探し、返された作成者にタスクを割り当てます。
- メソッド レベルのタスクの場合、メソッド => 包含クラス =>ファイルの最初のクラスの順番で Javadoc がチェックされます。最初の null ではない作成者が返されます。
- クラス レベルのタスクの場合、クラス =>ファイルの最初のクラスの順番で Javadoc がチェックされます。最初の null ではない作成者が返されます。
- 行レベルのタスクの場合、包含しているメソッド => クラス => ファイルの最初のクラスの順番で Javadoc がチェックされます。
- ファイルおよびファイル レベルのタスクの場合、最初の null ではない作成者が返されます。
- ファイルから作成者へのマッピングは直接指定され、その指定に従って作成者が割り当てられます。
- それ以外には、ローカル ユーザーがタスクの責任があると見なされ、ローカルの変更時刻が最終変更時刻と見なされます。
- 抑制されている静的解析違反は、その抑制を実行した開発者に割り当てられます。
ソース コードの特定行に割り当てられた作成者を参照するには、次の操作を行います。
- 適切なファイルのエディターを開きます。
- 作成者を参照したい行を右クリックし、[Parasoft] > [行の作成者を表示] をクリックします。
ソース管理システムのデータを使って作成者を算定していない場合、選択された特定の行ではなくファイルについての変更情報メッセージが表示されます。
作成者の算定方法の変更
作成者の算定の設定は、次の 2 つの方法で指定できます。
- SOAtest GUI の [設定] ウィンドウの [スコープと作成者]
- 設定ファイル
GUI で作成者の算定方法を変更するには、次の操作を行います。
- [Parasoft] メニューの [設定] をクリックして [設定] ダイアログを表示します。
- 左側ペインで [Parasoft] > [スコープと作成者] カテゴリを選択します。
- チェックボックスのオン/オフを切り替えてスコープと作成者の計算方法を指定します。
- ソース管理システム (変更作成者) を使ってスコープを計算: ソース管理システムのデータを使って作成者を算定します。
- ファイル システム (XML マップ) を使ってスコープを計算: 特定のファイルにどのように作成者を割り当てるかを直接指定します (たとえば、あるファイル セットの担当者を developer1 に設定し、別のファイル セットの担当者を developer2 に設定します)。詳細については「"ファイルと作成者" のマッピングの指定」 を参照してください。
- ファイル システム (@author タグ) を使ってスコープを計算: @author Javadocタグを使って作成者を算定します。Jtest でのみ利用可能です。
- ファイル システム (現在のユーザー) を使ってスコープを計算: ローカル ユーザー名 (ログイン ユーザー名) を使って作成者を算定します。
- [OK] をクリックして設定を保存します。
設定で作成者を設定する方法については、「設定」を参照してください。
"ファイルと作成者" のマッピングの指定
作成者を自動的に算定するのではなく、どの作成者をどのファイルの担当にするかを直接指定したい場合、ファイルと作成者とのマッピングを指定できます。「チーム間での SOAtest の構成」の説明にある自動構成プロセスによって、このマッピングをいったん自動的に構成した後にチーム全体で共有できます。
特定のファイルまたはファイル セットをどのように割り当てるかを直接指定するには、以下の操作を行います。
- マッピング情報を直接入力するための設定を行います。
- [Parasoft] メニューの [設定] をクリックして [設定] ダイアログを表示します。
- 左側ペインで [スコープと作成者] カテゴリを選択します。
- [ファイル システム (XML マップ) を使ってスコープを計算] を有効にします。
- ファイルと作成者のマッピングについての情報を入力します。
- [設定] ダイアログで、[スコープと作成者] > [作成者のマッピング] を選択します。
- 作成者のマッピングのテーブルで [新規] ボタンをクリックして、マッピングを指定します。ワイルド カードを使用できます。以下はその例です。
- ?oo/src/SomeClass.c - ファイル名の先頭がスラッシュ (/) 以外の任意の文字であり、最後が "oo/src/SomeClass.c" であるすべてのファイルを割り当てます。
- **.c - 任意のディレクトリにあるすべての *.c ファイルを割り当てます。
- **/src/** - パス中に src というディレクトリがあるすべてのファイルを割り当てます。
- src/** - src ディレクトリのすべてのファイルを割り当てます。
src/**/Test* - src ディレクトリにあり、名前が "Test" で開始するすべてのファイル (例えば src/some/other/dir/TestFile.c ) を割り当てます。
- [OK] をクリックしてダイアログを閉じ、[適用] ボタンをクリックします。
- まだチーム内で設定を共有していない場合、[エクスポート] ボタンをクリックして作成者マッピング テーブルを XML ファイルとしてエクスポートします。そしてこの XML マッピング ファイルを各チーム メンバーにインポートさせます。
別の方法として、エクスポートされた XML ファイルを使用するよう、次のいずれかの方法で SOAtest を設定できます。
- GUI からの設定 - [スコープと作成者] > [作成者のマッピング] で [共有ファイル] を選択し、ファイルへのパスを指定します。
- コマンドラインからの設定 - 設定ファイルで
scope.xmlmap=true
、scope.xmlmap.file=[file]
、およびscope.mappings.location
プロパティを使ってファイルのパスを指定します。-settings
オプションを使って属性を設定する方法については、「設定」を参照してください。なお、コマンドラインでの設定は GUI でのすべての作成者設定を上書きする点に注意してください。
次のコードは、XML 作成者マッピング ファイルの例です。
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE authorship (View Source for full doctype...)> <authorship> <!-- assigns all files named: "foo/src/SomeClass.java" to "author1" --> <file author="author1" path="foo/src/SomeClass.java" /> <!-- assigns all files whose names starts with any character (except /) and ends with "oo/ src/SomeClass.cs" to "author2" --> <file author="author2" path="?oo/src/SomeClass.cs" /> <!-- assigns all *.c files in any directory to "author3" --> <file author="author3" path="**.c" /> <!-- assigns every file whose path has a folder named "src" to "author4" --> <file author="author4" path="**/src/**" /> <!-- assigns all files located in directory "src" to "author5" --> <file author="author5" path="src/**" /> <!-- assigns all files in directory "src" whose name starts with "Test" i.e. "src/some/ other/dir/TestFile.java" to "author6" --> <file author="author6" path="src/**/Test*" /> </authorship>
ソース管理システムからの XML マッピング ファイルの生成
スクリプトを使って、ソース管理システムから XML マッピング ファイルを生成できます。以下の Perl のサンプル スクリプトは、Git から作成者マッピング ファイルを生成します。別のソース管理システムを使用している場合、サンプル スクリプトを適切に変更してください。
#!perl ############################################################ # GetAuthors.pl # Sample script to generate file --> author mapping. # Note that this is usually run only once, when you first # deploy C++test . # # This script assumes that you have a list of all the files in the # project. For example, such a list can be obtained on windows # by using "dir /s/b *.c" for c files. ############################################################ sub GetAuthor ############################################################ # Gets the author (person who last modified the file) for # the input file. ############################################################ { my $fileName = shift(@_); return `git log --pretty=format:"%an" -1 $fileName`; } print "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n"; print "<mapping>\n"; ############################################################ # AllCFiles.txt has a list of all the c files in the # project. The following loop iterates through all the # files and assigns owners to each. ############################################################ open(FILELIST, "<AllCFiles.txt") || die "Could not open AllCSFiles.txt"; while (<FILELIST>) { chop; my $fileName = $_; my $author = GetAuthor($fileName); if ($author eq "") { $author = "DontKnow"; } print "<file path=\"$fileName\" "; print "author=\"$author\" />\n"; } print "</mapping>\n";
"作成者と作成者" および "作成者と E-mail" のマッピングの指定
SOAtest は、ソース管理データ、システムのローカル ユーザー設定、@author タグ、XML マッピング ファイル、インポートされた scanner.properties ファイルなどからユーザー名を検出します。デフォルトでは、SOAtest は検出したユーザー名の値をコード作成者のユーザー名と推測し、そのユーザーの電子メール アドレスを [username]@[mail_domain] と推測します。
しかし、自動検出されたユーザー名を別のユーザー名や電子メール アドレスにマップしたい場合もあります。例えば次のような場合です。例:
- ある開発者のすべてのタスクを別の開発者に再割り当てする場合。例えば、User1 が開発チームから抜けたため、User1 のすべてのタスクを User2 に引き継がせる場合などです。このマッピングを「作成者から作成者へのマッピング」と呼びます。
- 開発者のユーザー名が電子メール アドレスと一致していない場合。例えば、検出されたユーザー名が tanaka でも、電子メール アドレスは [email protected] である場合などです。このマッピングを「作成者から電子メール アドレスへのマッピング」と呼びます。
これらの作成者の設定をいったん自動的に行った後、「Parasoft Test の環境設定-概要」 で説明している自動設定プロセスを利用してチーム全体で設定を共有できます。
適切な作成者の設定をまだ自動構成プロセスから行っていない場合、あるいはインポートした設定を変更/上書きする場合、検出されたデフォルトのユーザー値を別のユーザー名あるいはアドレスにマッピングできます。次の操作を行います。
- [Parasoft] > [設定] を選択します。
- 左側ペインで [Parasoft] > [作成者] カテゴリを選択します。
- [Concerto の設定を使用] チェックボックスがオフであることを確認します。
- [作成者マッピングの場所] チェックボックスがオフになっていることを確認します。
- 「作成者から電子メール アドレスへのマッピング」を指定するには、次の操作を行います。
- [ログイン/E-mail/完全な名前] の表に移動します。
- [追加] ボタンをクリックします。
- マッピングを指定します。
- 「作成者から作成者へのマッピング」を指定するには、次の操作を行います。
- [作成者からタスクを再割り当て] >[割り当て先作成者] の表に移動します。
- [追加] ボタンをクリックします。
- マッピングを指定します。
- [適用] ボタンをクリックして変更を保存します。
大文字/小文字の区別
作成者の値で大文字と小文字を区別するかどうかを設定できます。この設定は、以下の場所の作成者の値に適用されます。
- コード レビュー
- 品質タスク
- レポート
- スコープと作成者
- Concerto タスク
- テスト コンフィギュレーション (例えば [スコープ] タブの [作成者] オプションや [コード レビュー] タブ)
この設定は、DTP の大文字/小文字の区別の設定に一致させるべきです。デフォルトでは、DTP は大文字と小文字を区別します。DTP での大文字/小文字の区別の設定については、 https://docs.parasoft.com/ の 『DTP ドキュメント』を参照してください。
大文字/小文字の区別
大文字/小文字の区別の設定は、同一ユーザー名の複数の違反を、一人のユーザーとして扱うか、複数のユーザーとして扱うかを決定します。たとえば:
- 区別する: David と DAVID は別々のユーザーとして扱われます。
- 区別しない: David と DAVID は一人のユーザー (同じユーザー) として扱われます。
大文字/小文字を「区別しない」モードが特に役立つのは、ユーザー名の大文字/小文字が重要ではない外部データベースを使用している場合です。david というユーザー名がデータベースでは DAVID として格納されていて、大文字/小文字の設定が「区別する」モードの場合、DAVID のタスクとしてインポートされたタスクは、david には影響しません。
大文字/小文字の区別の設定
Parasoft 環境内で SOAtest がユーザー名を処理する際に大文字/小文字を区別するかを設定できます。
- [設定] パネルを開き、 [Parasoft] > [作者] を選択します。
- [Parasoft Test プラットフォームでユーザー名の大文字/小文字を区別しない] を有効にします。
次の設定オプションを使って大文字と小文字の区別を設定することもできます: authors.ignore.case=true|false
設定オプションの詳細については「設定」を参照してください。
複数のソース管理システムを使用している場合の作成者の処理
チーム メンバーが同じログインで複数のソース管理システムを使用している場合、次のように Parasoft 製品を起動してソース管理システムから正確な作成者を取得できるようにします。
- Jtest スタンドアロン:
jtest -J-Duser.name=your_username ...
- SOAtest スタンドアロン:
SOAtest -J-Duser.name=your_username ...
- C++test スタンドアロン :
cpptest -J-Duser.name=your_username ...
- プラグイン:
eclipse ....-vmargs -Duser.name=your_username
ローカル ユーザーの設定
「ローカル ユーザー」データを使って作成者を判定している場合、デフォルトではマシンで定義されているローカル ユーザー設定が使用されます。
別のユーザー名を使用するには、[設定] ウィンドウで左側のリストから [Parasoft] を選択し、[デフォルト] をオフにして [ユーザー名] フィールドに適切な名前を入力します。