r-labs » TestLink Link

[[PluginUsageEn|English]]

h1.  使用法

{{>toc}}

リンク対象の種別と ID を Wiki マクロで書くことによって TestLink の対象ページへのリンクを張ります。

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

h2. testlink(testcase) マクロ

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

<pre><code class="plaintext">

    {{testlink(リンク対象, ID)}}

    {{testcase(ID)}}

</code></pre>

リンク対象には対象を特定する識別名を記述します。

*testcase* マクロはそれぞれ @case@ の識別名を省略したものです。

ID には対象の ID 番号を指定します。

記述する ID はテストケース以外のものはすこし分かりづらいので、[[FindTestLinkId|テストケース以外の ID の取得法]] を参考にしてください。

テスト結果を除いた使用できるリンク対象は以下のものです。テスト結果関連のものは次節を見てください。

|_. 識別名  |_. リンク対象       |_. 備考 |

| case      | テストケース       |   |

| suite     | テストスウィート   |   |

| project   | テストプロジェクト | TestLink 1.8 以上  |

| plan      | テスト計画         |   |

| milestone | マイルストーン     |   |

| build     | ビルド情報         |   |

| cfield    | カスタムフィールド |   |

| keyword   | キーワード情報     |   |

| user      | ユーザ情報         |   |

+例+

<pre><code class="plaintext">

  {{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)}}

</code></pre>

h2. テスト結果へのリンク

TestLink の 1.8 以降ではテスト結果へのリンクが張れます。

テスト結果へのリンクは前節 *testlink* マクロでリンク対象にテスト結果の識別名を指定します。

<pre><code class="plaintext">

    {{testlink(リンク対象, ID [, ...])}}

    {{testreport(ID, PlanID [, 出力項目, ...])}}

</code></pre>

*testreport* マクロはそれぞれ @report@ の識別名を省略したものです。

ID 以降の引数は識別名によって変わります。

テスト結果用のリンク対象は以下のものです。

|_. 識別名   |_. リンク対象       |_.  備考 |

| report     | テストレポート     | ID が 2 つ必要。引数にレポートの出力項目を指定可能。 |

| planreport | テスト計画レポート | ID が 2 つ必要。引数にレポートの出力項目を指定可能。 |

| metrics    | メトリクス         |         |

| result     | テスト結果の表示   | 引数にステータスを指定可能 |

| graph      | 結果のグラフ表示   |         |

report, planreport の場合、引数として ID を二つ(ID, PlanID)指定する必要があります。

また、その後にテスト結果の出力項目を指定することが出来ます。

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

|_. 出力項目 |_. 説明                                 |_. report |_. planreport |

| toc      | 目次  	                              | ○ | ○ |

| header   | テストスイートの説明 	              | ○ | ○ |

| summary  | テストケースの要約 	              | ○ | ○ |

| body     | 本文 	                              | ○ | ○ |

| author   | テストケース作者                         | ○ | ○ |

| keyword  | テストケースに関連するキーワード         | ○ | ○ |

| cfields  | テストケースに関連するカスタムフィールド | ○ | ○ |

| passfail | 成功/失敗と備考                          | ○ |    |

| metrics  | メトリクス                               | ○ |    |

| testplan | テスト計画の説明                         |    | ○ |

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

!setting_report.png!  !setting_planreport.png!

+例+:

<pre><code class="plaintext">

  {{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(graph, 6)}}

</code></pre>

h3. result の引数

result の場合、 ID の後にテストケースのステータスを指定することでフィルタリングした出力が出来ます。

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

|_. ステータス |_. 説明 |

| f | 失敗したテストケース |

| b | ブロックされたテストケース |

| n | 未実行のテストケース |

+例+:

<pre><code class="plaintext">

  {{testlink(result, 6)}}

  {{testlink(result, 6, f)}}

</code></pre>

h2. ファイルダウンロード用リンクマクロ(testfile)

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

(TestLink 1.8 以上)

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

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

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

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

|_. フォーマット    |_. フォーマット名 |_. 指定可能なリンク対象の識別名 |

| OpenOffice Writer | odt              | report, planreport |

| OpenOffice Calc   | ods              | metrics, result    |

| MS Word           | doc              | report, planreport |

| MS Excel          | xls              | metrics, result    |

+例+:

<pre><code class="plaintext">

  {{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)}}

</code></pre>