欠陥: ユーザー変数

ユーザー変数

TestRail の課題管理システムとの統合には、ユーザーが入力する変数とフィールドを定義できる独自の機能があります。変数は、統合設定に含まれるプレースホルダーとして使用できます。

なぜこれが便利なのでしょうか。TestRail ユーザーが (すべてのテスターのための汎用の ‘QA’ アカウントではなく) それぞれの課題管理システム アカウントを使ってバグ報告をプッシュできるようにしたいとします。ユーザー変数を使用すると、ユーザーが TestRail に自分の課題管理システムのログイン名とパスワードを安全に入力できるようにし、2 つのシステム間でユーザーを簡単にマップできます。

このページでは、一般的なユーザー変数機能について説明した後、変数の一般的なユース ケースである、変数を介したユーザー マッピングを設定する詳細な手順について説明します。

ユーザー変数の仕組み

新しいユーザー変数は、[管理] > [統合] で追加できます。ユーザー変数を定義すると、ユーザーは [個人設定] に変数の詳細を入力できます (TestRail のユーザー インターフェイスのログインユーザー名のリンクにある [個人設定] リンクからアクセスします)。

その後、欠陥プラグインの設定でユーザー変数をプレースホルダーとして使用できます。たとえば、“jira_user” というシステム名のユーザー変数を定義した場合、設定ボックスに %jira_user% と入力すると、TestRail によって各ユーザーの情報に置き換えられます。この機能を利用する具体的な方法については、次のセクションを参照してください。

ユーザー マッピングの設定

デフォルトでは、どのユーザーが TestRail から課題をプッシュしたかにかかわらず、単一の課題管理のユーザー アカウントを使用して TestRail からのすべての課題をプッシュします。これは、すべての課題が課題管理の 1つのユーザーの下に作成されることを意味します (通常、このために testrail や qa のような汎用的なアカウントがセット アップされます)。ユーザー変数は TestRail と課題管理ツールの間でユーザーをマッピングする簡単な方法を提供します。このセクションでは、その方法を説明します。

まず、TestRail のユーザーが自分の課題管理のログイン名とパスワードを入力できるようにするために、2 つの変数を定義する必要があります。この例では、TestRail と Jira を統合しますが、これを使用するツールの名前に置き換えることができます。ユーザー変数を設定するには、次の手順に従います。

  1. [管理] > [統合] をクリックします。
  2. フォームの下部にある [ユーザー変数の追加] リンクをクリックします。
  3. [ラベル] に「Jira User」と入力します。
  4. [説明] に「Your Jira user name」と入力します。
  5. [システム名] に「jira_user」と入力します。
  6. [タイプ][文字列] を選択します。
  7. [フォールバック] フィールドには、Jira に設定した汎用的な「testrail」ユーザーを入力することをお勧めします。これは、Jira ログイン情報を入力していないすべてのユーザーに使用されます。フォールバックを指定しない場合、TestRail は、課題を送信する前に、[個人設定] でユーザーに情報を入力するように求めるメッセージ ボックスを表示します。
  8. [OK] をクリックしてユーザー変数を保存します。

次の設定でもう 1 つユーザー変数を作成します。

  1. ラベル: Jira Password
  2. 説明: Your Jira password
  3. システム名: jira_password
  4. タイプ: パスワード
  5. フォールバック:Jiraで設定した汎用的な “testrail” ユーザーのパスワード (オプション)

パスワードには必ず [パスワード] フィールド タイプを選択します。これにより、TestRail のユーザー インターフェイスにパスワードがプレーン テキストで表示されなくなります。

[統合] フォームの [設定の保存] ボタンをクリックします。これで、ユーザーは各自の [個人設定] ページを開き、 [設定] タブを選択して自分の Jira ログイン認証情報を入力できます。

最後に、欠陥プラグインの設定でユーザー変数を使用します。それには、%jira_user% のように、システム名をパーセント文字で囲んで指定します。この例の欠陥プラグイン設定は次のようになります:

; Please configure your Jira connection below
[connection]
address=http://jira/
user=%jira_user%
password=%jira_password%

これで終わりです。ユーザーは [個人設定] で自分のログイン情報を入力できるようになり、TestRail はこの情報を使って課題をプッシュします。

ヒント: 課題管理ツールが、TestRail ユーザーのメールアドレスでログインできる場合、TestRail には特別な変数を定義せずに使うことができる 2 つのビルトイン ユーザー変数が用意されています。

  • %user_email% – TestRail ユーザーのEメールアドレス
  • %user_name% – TestRail ユーザーのフル ネーム

高度な使い方

既存の欠陥プラグインをカスタマイズしたり、独自のプラグインを作成すると、コードから定義済みのユーザー変数に直接アクセスすることもできます。ユーザー変数は $context 変数の一部であるため、次のように簡単にユーザー変数にアクセスできます。

$context['user']->settings['jira_user']

欠陥プラグインでユーザー変数を使用することで、必要に応じてユーザーごとに異なる動作や設定をすることができます。