Using Allure for .NET project

Allure.md

概要

Allure は複数言語に対応したテストレポート作成ツールです。
.NETにも対応しており、単体テスト(MsTest/NUnit/xUnit.NET等)の出力から
以下のようなHTMLレポートを作成することができます。

• レポートサンプル
  • https://ci.qameta.io/job/allure2/job/master/Demo_Report/index.html

参考情報:

• 公式サイト (http://allure.qatools.ru/)
• ドキュメント (https://allure-framework.github.io/allure-docs/latest/)
• GitHubレポジトリ (https://github.com/allure-framework/allure2)

以下、.NETのプロジェクトでAllureを利用する手順について記載します。

1. Allure のインストール

AllureはJavaで作られているため、JREが事前にインストールされていることを前提とします。
Scoop(http://scoop.sh)を使用してAllureのをインストールする場合は以下のコマンドを実行してください。

scoop install allure

2. テスト実行

テストを実行して、レポート用のデータファイルを作成します。
Allureはプラグインの仕組みで複数の入力データ形式に対応しているので
使用するテストフレームワークに対応した方式を選択してください。

2.1 dotnet testコマンドを使用する場合 (trxプラグイン使用)

dotnet test コマンドを使用してテストを実行する場合は以下の手順を実行してください。

1. ソリューション or テストプロジェクトをカレントディレクトリに設定する。
2. 以下のコマンドを実行してテストを実行する。

dotnet test --logger:trx

3. TestResultsフォルダ配下にテスト結果ファイル(.trx)が出力されることを確認する。

2.2 dotnet xunit コマンドを使用する場合 (xUnit XMLプラグイン使用)

テストフレームワークとしてxUnit.NETを使用している場合は
dotnet xunit コマンドを使用することが可能です。

1. テストプロジェクトの.csprojに以下の設定を追加する。

<ItemGroup>
  <DotNetCliToolReference Include="dotnet-xunit" Version="2.3.1" />
</ItemGroup>

2. テストプロジェクトをカレントディレクトリに設定する。
3. 以下のコマンドを実行してテストを実行する。

dotnet xunit -xml TestResults\results.xml

4. TestResultsフォルダ配下にテスト結果ファイル(.xml)が出力されることを確認する。

3.レポート作成

allure generate コマンドを使用してレポートを作成します。

1. 以下のコマンドを実行する。

allure generate TestResults --clean

2. allure-report 配下にレポートが作成されることを確認する。

4.レポート表示

allure open コマンドを実行することで、ブラウザでレポートが表示されます。

その他、試してみて気になった点等

• trx plugin/xUnit XML plugin 両方試してみたが、どちらも日付が正常に表示されない(ロケールの問題?)
• Trend/Historyの情報が作成されない。
• dotnet test コマンドを使用する場合 xUnit.NETのXMLを出力指定ができない。
• dotnet xunit だとソリューションを対象としたテスト実行ができない。
  (DotNetCliToolはプロジェクト単位の設定のため)