JIRA 統合のカスタマイズ

JIRA 統合のカスタマイズ

TestRail の JIRA に対応した高性能な欠陥プラグインにより、チームは新しいバグレポートを JIRA にプッシュしたり、JIRA の課題を検索したり、要件と参照を統合することができます。このドキュメントは、[欠陥のプッシュ] ダイアログにフィールドを追加したり、課題リンクやサブタスクを追加して統合をカスタマイズする方法を説明します。

表示されるフィールド

JIRA REST プラグインを使用すると、[欠陥のプッシュ] ダイアログおよびリンクにマウス カーソルを置いたときに表示されるフィールドを設定および変更できます。デフォルトでは、プラグインはデフォルトの欠陥設定の一部としてすでにフィールドのリストを含んでいます ([管理] > [統合][欠陥プラグイン] 設定ボックス)。

[push.fields]
summary=on
project=on
issuetype=on
...

[hover.fields]
summary=on
project=on
issuetype=on
...

上記の設定を調整して、個々のフィールドを有効/無効にしたり、フィールドの順序を変更したりできます。

フィールド オプション

上記のようにフィールドを有効または無効にすることに加えて、フィールドごとに追加のオプションを変更することも可能です。それには、 [field.settings.component] のようなセクションを定義して、 [component] フィールドの追加オプションを指定します。以下のオプションがサポートされています。

[field.settings.component]
label=Component
size=compact
remember=false
required=false
type=dropdown

ただし、すべてのオプションを指定する必要はありません。たとえば、フィールドの required オプションを変更したいだけであれば、他のオプションをスキップすることができます。オプションの説明については、以下を参照してください。

オプション 説明
label [欠陥のプッシュ] ダイアログでのフィールドの表示名を指定します。
size フィールドをコンパクト フィールド (compact) として表示するか、ダイアログの全幅を使用する (full) かを指定します。
remember 次回 [欠陥のプッシュ] ダイアログを開いたときに、以前にこのフィールドで選択した値を記憶して復元するかどうかを指定します。
required このフィールドが必須かオプションか、またユーザーが [欠陥のプッシュ] ダイアログでこのフィールドに値を入力する必要があるかどうかを指定します。
type このフィールドのタイプを指定します。サポートされているフィールド タイプのリストについては、下記のカスタム フィールドを参照してください。

カスタム フィールド

上記のアプローチを使用して、JIRA で定義されたカスタム フィールドを TestRail の [欠陥のプッシュ] ダイアログに追加することもできます。それには、 [push.fields] or [hover.fields] セクションに次のような行を追加してフィールドを追加します。

[push.fields]
summary=on
...
customfield_11002=on

フィールドの名前に注意してください。JIRA カスタムフィールドは必ず customfield_<id> を使用して指定する必要があります。ID は JIRA で定義されたカスタム フィールドの ID です。JIRA の管理エリアでカスタム フィールドを編集することで、JIRA のカスタム フィールドの ID を確認できます。ID は、編集ページの Web アドレス/URL の一部です。上記のようにフィールドを有効にすることに加えて、次のように対応するフィールド定義を追加する必要があります。

[field.settings.customfield_11002]
label=Customer
size=compact
type=dropdown
required=true

以下のフィールド タイプがサポートされています (JIRA と TestRail のフィールド間で可能なマッピングにも注意してください)。

フィールド タイプ JIRA のタイプ 説明
string Text Field, Labels 最大 250 文字の小さなフリーテキスト フィールド
text Text Field, Free Text Field 実用上サイズ制限のない大きなフリーテキスト フィールド
dropdown Radio Buttons, Cascading Select, Select List ユーザーが複数のオプションのうちの 1 つを選択できるドロップダウン リスト
multiselect Multi Select, Multi Checkboxes ユーザーが複数の定義済みオプションを選択できる

サブタスク

JIRA REST 欠陥プラグインはサブタスクもサポートしています。次のように、新しく追加された parent フィールドを使用してサブタスクのサポートを有効にできます。

[push.fields]
..
parent=on

これにより、[プッシュ] ダイアログに新しく [Parent] フィールドが表示され、新規課題の親課題 ID を入力できるようになります。参照フィールドを使用してテストケースと JIRA に保存されているユーザー ストーリーまたは要件をリンクしている場合は、次のオプションを有効にすると、[Parent] フィールドに [参照] フィールドの値を自動的に事前入力することができます。

[push.field.parent]
autofill=on

課題リンク

TestRail 4.0 から、JIRA REST 欠陥プラグインは課題リンクもサポートしています。これを使用して、JIRA の他の既存の課題にリンクする新しい課題を作成することができます。課題リンクを有効にするは、次のように指定します。

[push.fields]
..
linktype=on
links=on

これにより、[プッシュ] ダイアログに 2 つの新しいフィールド ([Link Type] と [Issue Links]) が追加されます。Link Type は、作成するリンクのタイプを指定します (例: “related” または “duplicate of” など)。Issue Links フィールドでは、新しい課題にリンクする (指定したリンク タイプを使用して) JIRA 課題 ID のリストをカンマ区切りで入力できます。

参照 フィールドを使用してテストケースと JIRA に保存されているユーザー ストーリーまたは要件をリンクしている場合は、次のオプションを有効にすると、[Issue Links] フィールドに [参照] フィールドの値を自動的に事前入力することができます。

[push.field.links]
autofill=on

注意:リンク付きの新しい JIRA 課題を作成しようとしたときにエラー (404など) が発生した場合は、[Issue Links] フィールドに追加した課題 ID が JIRA に存在することを確認してください。

添付ファイル

Jira 欠陥プラグインは、Jira への添付ファイルのサブミットもサポートしています。このフィールドをオンまたはオフにできますが、カスタマイズはできません。1 つまたは複数の添付ファイルを Jira にサブミットするには、プッシュ ダイアログの添付ファイルまたは説明エリアにファイルをドラッグするか、エリアをクリックしてファイル システムから添付ファイルを選択します。

参照プラグイン

参照プラグインを利用すると、テスト ケース、テスト ラン、マイルストーンなどの TestRail エンティティの参照フィールドに入力された ID から追加の情報を取得できます。参照プラグインは、欠陥プラグインの設定と同じように、統合設定の [参照] タブで設定します。

プラグインは参照 ID のホバリングもサポートしていますが、参照フィールドではプッシュ ダイアログはサポートされません。上で説明しているように、リンクのホバリングで表示されるフィールドをカスタマイズしたり、カスタム フィールドを追加することもできます。

すでに Jira 用の欠陥プラグインが設定されている場合、欠陥プラグインの [connection] および [hover.fields] セクションを参照プラグインの設定にコピーできます。あるいは、参照プラグインと欠陥プラグインで異なるフィールドを表示することもできます。

その他のカスタマイズ

TestRail はカスタム欠陥プラグインもサポートしています。TestRail Server を使用している場合、欠陥プラグインをさらにカスタマイズし (または独自のプラグインをビルドし)、他のフィールド タイプやデータをサポートできます。詳しくはこちらを参照してください。