JUnit レポート マクロ
JUnit Report マクロは、Confluence サーバーでアクセス可能なディレクトリから JUnit テスト結果のサマリを表示します。 JUnit は、Java ソース コードの個々のユニットが正常に機能していることをプログラマーが確認できるようにする、ユニット テスト フレームワークです。
セキュリティ上の理由から、JUnit テストの結果ファイルは Confluence サーバーのファイル システムの特定の場所からのみインポートできます。管理者が Confluence ホーム ディレクトリでフォルダを作成し、confluence.junit.report.directory
システム プロパティを追加して、インポート先として JUnit テストの結果ファイルを指定することをおすすめします。このシステム プロパティを設定するまでは、サーバーから JUnit テストの結果ファイルをインポートすることはできません。
JUnit Report マクロは以下のスクリーンショットのように表示されます。
スクリーンショット: Confluence の JUnit レポート マクロ
注:JUnit レポート マクロからレポートを生成する場合は、Apache Ant フォーマッターを「XML」に設定します。
JUnit レポート マクロの使用
ページに JUnit レポート マクロを追加するには:
- From the editor toolbar, choose (Insert) > Other Macros
- 対象のマクロを見つけて、選択します。
Speed it up with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. In this example we're inserting the cheese macro.
既存のマクロを編集する方法: マクロのプレースホルダをクリックして、[編集] を選択します。これによりマクロの詳細を開き、マクロのパラメーターを編集できます。
パラメーター
パラメーターは、マクロ出力の内容や形式を制御するために設定できるオプションです。Confluence の保存形式または wiki マークアップで使用されるパラメータ名がマクロ ブラウザで使用されるラベルと異なる場合、以下の一覧に括弧付きで表示されます (example
)。
パラメーター | 必須 | 既定 | 説明 |
---|---|---|---|
テスト結果 XML ファイルの URL | directory または url パラメータを含める必要があります | なし | 特定のテスト結果 XML ファイルの URL。両方を使用している場合は、テスト結果 XML ファイルのディレクトリ (URL) が上書きされます。 Confluence インスタンスからの例: 匿名ユーザー アクセスのない Confluence インストールの場合、URL パラメーター形式でこのパラメーターの一部としてログイン資格情報を指定できます。
|
テスト結果ファイルのディレクトリ (URL) | directory または url パラメータを含める必要があります | なし | テスト結果ファイルを含むディレクトリの URL。XML ファイル自体ではなく、ディレクトリ名にする必要があります。両方を使用している場合は、テスト結果 XML ファイルの URL が上書きされます。 例: ネットワーク ドライブでの例: |
レポートの詳細 | いいえ | すべて | レポートの詳細すべて、固定、概要 または failuresonly を使用できます。 |
デバッグ(debug ) | いいえ | なし | 障害の内容とともに、エラー メッセージを表示します。 |
Wiki マークアップ例
以下の例は、エディタ外部 (スペースのサイドバー、ヘッダー、フッターのカスタム コンテンツなど) でマクロを追加する場合に便利です。
マクロ名: junitreport
マクロ本文: なし。
ローカル ドライブから JUnit レポートをロードする:
{junitreport:directory=file:///C:/TEMP/}
ネットワーク ドライブから JUnit レポートをロードする:
{junitreport:url=http://*host*/*path*}
Confluence サイトから JUnit レポートをロードする:
{junitreport:url=http://yourConfluenceInstance.com/download/attachments/<page id>/file.xml}
認証が必要な Confluence サイトから JUnit レポートをロードする:
お使いの Confluence サイトが匿名ユーザーによるアクセスを許可していない場合、ログイン資格情報である os_username
および os_password
URL パラメータを、マクロの url
パラメータの一部として指定します。ここでは、ユーザー名 "admin"、パスワード "secret" を指定しています。
{junitreport:url=http://yourConfluenceInstance.com/download/attachments/<page id>/file.xml?os_username=admin&os_password=secret}