【アリュール】

Allure とは?

最終更新:
💡 テスト結果を、詳しく調べられるHTMLレポートに

テストの実行結果をインタラクティブなHTMLレポートにまとめるオープンソースのツール。テストフレームワークとの連携で、結果・ステップ・添付ファイルなどを確認できる。

📌 このページのポイント
Allure:テスト結果をレポートに テストを実行 統合機能で記録 結果ファイル ステップ・添付等 allure generate HTMLレポート 結果・時間・失敗の詳細 履歴比較には過去データの保持が必要
レポート生成の基本的な流れ。統合機能や版によって記録・履歴の設定が異なる。
ひよこ ひよこ
Allureって何のためのツール?
ペンギン先生 ペンギン先生
テストの実行結果を集め、ブラウザで詳しく確認できるHTMLレポートを作るツールだよ。テスト結果の可視化と分析が中心の役割なんだ。
ひよこ ひよこ
ターミナルの結果とは違う?
ペンギン先生 ペンギン先生
失敗したテストを探し、実行時間や記録されたエラー、添付画像などをまとめて確認できる。チームで結果を共有するときにも使えるけれど、レポートだけで製品全体の品質を保証するわけではないよ。
ひよこ ひよこ
どうやって使うの?
ペンギン先生 ペンギン先生
対応するテストフレームワークの統合機能を使って結果ファイルを保存し、allure generateでHTMLを生成するのが基本だよ。JUnit、pytest、Mochaなどに対応がある。導入方法は使う版と統合機能で確認しよう。
ひよこ ひよこ
スクリーンショットや手順も自動で全部載る?
ペンギン先生 ペンギン先生
テスト側や統合機能が記録した情報を表示するので、必要なステップや添付を用意することが大切。@StepはJava系の例で、すべての言語で同じ書き方をするわけではないんだ。
ひよこ ひよこ
CIで前回の結果とも比べられる?
ペンギン先生 ペンギン先生
できるよ。ただし過去のデータを保持する設定が必要。Allure 2はhistoryディレクトリの引き継ぎ、Allure 3はhistoryPathなど、方式が異なる。Allure 3にはテストコマンドを呼ぶallure runもあるので、単に「テストを実行しない」と決めつけるのは正確ではないよ。
ペンギン
まとめ:ざっくりこれだけ覚えればOK!
「Allure」って出てきたら「テスト結果を見やすいレポートにするツール」と思えばだいたいOK!
📖 おまけ:英語の意味
「Allure」 = 魅力、魅惑
💬 allureは英語で魅力や魅惑を表す言葉。ここではテストレポートツールの名前で、単語の意味だけから命名理由までは断定しないよ。

参考資料

← 用語集にもどる