PluginUsage - Redmine TestLink Link Plugin Wiki - Redmine TestLink Link Plugin

Move to : http://www.r-labs.org/projects/rp-testlinklink/wiki/PluginUsageEn

移動しました : http://www.r-labs.org/projects/rp-testlinklink/wiki/PluginUsage

FrontPage >>

Outline

1. 使用法
   1. testlink(testcase, testreport) マクロ
      1. report, planreport の引数
      2. result の引数
   2. testfile マクロ
   3. 使用例

使用法

testlink(testcase, testreport) マクロ

Wiki 編集画面で次のように記述します。

    {{testlink(リンク対象, ID [, ...])}}
    {{testcase(ID)}}
    {{testreport(ID, PlanID [, 出力項目, ...])}}

リンク対象には対象を特定する識別名を記述します。 testcase, testreport マクロはそれぞれ case, report の識別名を省略したものです。

また、 ID 以降の引数は識別名によって変わります。(通常何も指定しません)

使用できるリンク対象は以下のものです。

識別名	リンク対象	備考
case	テストケース
suite	テストスウィート
project	テストプロジェクト	(TestLink 1.8 以上)
plan	テスト計画
milestone	マイルストーン
build	ビルド情報
cfield	カスタムフィールド
keyword	キーワード情報
user	ユーザ情報

テスト結果用(TestLink 1.8 以上)

識別名	リンク対象	備考
report	テストレポート	ID が 2 つ必要。引数にレポートの出力項目を指定可能。
planreport	テスト計画レポート	ID が 2 つ必要。引数にレポートの出力項目を指定可能。
metrics	メトリクス
result	テスト結果の表示	引数にステータスを指定可能
graph	結果のグラフ表示

(注) TestLink 側は自動ログインできる状態でないと上手く表示できません。

記述する ID の調査方法は FindTestLinkId をご覧ください。

report, planreport の引数

report, planreport の場合、引数として ID を二つ(ID, PlanID)指定する必要があります。
また、その後に出力項目を指定することが出来ます。

指定可能な出力項目は以下のものです。

出力項目	説明	report	planreport
toc	目次	○	○
header	テストスイートの説明	○	○
summary	テストケースの要約	○	○
body	本文	○	○
author	テストケース作者	○	○
keyword	テストケースに関連するキーワード	○	○
cfields	テストケースに関連するカスタムフィールド	○	○
passfail	成功/失敗と備考	○
metrics	メトリクス	○
testplan	テスト計画の説明		○

出力項目を省略した場合には設定画面で設定した項目を出力します。

result の引数

result の場合、 ID の後に出力対象のステータスを指定することが出来ます。

省略時にはすべて表示します。

ステータス	説明
f	失敗したテストケース
b	ブロックされたテストケース
n	未実行のテストケース

testfile マクロ

testfile マクロは MS Word 形式などでの出力ファイルへのリンクです。 (TestLink 1.8 以上)

Wiki 編集画面で次のように記述します。

{{testfile(フォーマット名, リンク対象, ID ...)}}

このマクロは引数の先頭にフォーマット名を指定することを除き、 testlink マクロと同一です。

フォーマットにより、指定可能な識別名が変わります。

フォーマット	フォーマット名	指定可能な識別名
OpenOffice Writer	odt	report, planreport
OpenOffice Calc	ods	metrics, result
MS Excel	xls	metrics, result
MS Word	doc	report, planreport

使用例

  {{testcase(sample-1)}}
  {{testlink(case, sample-1)}}
  {{testlink(suite, 2)}}
  {{testlink(project, 1)}}
  {{testlink(plan, 5)}}
  {{testlink(milestone, 1)}}
  {{testlink(build, 1)}}
  {{testlink(cfield, 1)}}
  {{testlink(user, 1)}}

テスト結果用

  {{testreport(2,6)}}
  {{testlink(report, 2, 6)}}
  {{testreport(2,6, header, summary, toc, body, cfields, passfail, metrics, author, keyword)}}
  {{testlink(planreport, 2, 6)}} 
  {{testlink(planreport, 2, 6, header, summary, toc, body, cfields, author, testplan, keyword)}}
  {{testlink(metrics, 6)}} 
  {{testlink(result, 6)}}
  {{testlink(result, 6, f)}}
  {{testlink(graph, 6)}}

ファイルダウンロード用

  {{testfile(doc, report, 2,6)}}
  {{testfile(odt, planreport, 2, 6, header, summary, toc, body)}} 
  {{testfile(xls, metrics, 6)}} 
  {{testfile(ods, result, 6)}}
  {{testfile(ods, result, 6, n)}}