テンプレートテスト

ラベル xUnit の投稿を表示しています。すべての投稿を表示

2020/07/02

[C#] xUnit で MemberData を使ったテストがテストエクスプローラーで1つのテストとして表示される

これだとデバッグが非常にやりにくいので、`InlineData` と同じように複数のテストケースとして表示する方法がないか調べてみると、以下の記事が見つかりました。  - https://stackoverflow.com/questions/30574322/memberdata-tests-show-up-as-one-test-instead-of-many  Visual Studio のテストエクスプローラーで各テストケースを別々の項目として表示するためには、テストケースの型に `IXunitSerializable` を実装する必要があるみたいです。  ## 環境  - Visual Studio 2017 - .NET Core 2.2 - xUnit 2.4.1  ## サンプル  ### 変更前  例えば、`MemberData` を使ったテストコードは以下のような感じになっていると思います。  ```cs [Theory,     MemberData(nameof(TestData))] public void TestMethod(int param1, string param2) {     // Do something test }  public static IEnumerable<object[]> TestData() {     yield return new object[] { 0, "hoge" };     yield return new object[] { 1, "fuga" }; } ```  ### 変更後  `IXunitSerializable` を実装するためにテストデータクラス `TestCaseData` を作成します。  ```cs [Theory,     MemberData(nameof(TestData))] public void TestMethod(TestCaseData testCaseData) {     var param1 = testCaseData.Param1;     var param2 = testCaseData.Param2;          // Do something test }  public class TestCaseData : IXunitSerializable {     public int Param1 { get; set; }     public string Param2 { get; set; }          public void Serialize(IXunitSerializationInfo info)     {         info.AddValue(nameof(Param1), Param1.ToString());         info.AddValue(nameof(Param2), Param2.ToString());     }      public void Deserialize(IXunitSerializationInfo info) { } }  public static IEnumerable<object[]> TestData() {     yield return new object[] {         new TestCaseData{             Param1 = 0,             Param2 = "hoge"         }     };     yield return new object[] {         new TestCaseData{             Param1 = 1,             Param2 = "fuga"         }     }; } ```  結構面倒です。  ## もう少し汎用的になるように改良してみる  上記のままだと、テストケースの度に `IXunitSerializable` を実装する必要があり面倒なので、何とかして共通化できないかと思い、とりあえず以下の２案が思い浮かびました。  ### ジェネリックを使って汎用的に実装する  `IXunitSerializable` を実装した `ValidateTestCase` を作成し、ジェネリックでテストケースクラスの型を指定してやります。  ```cs [Theory,     MemberData(nameof(TestData))] public void TestMethod(ValidateTestCase<TestCaseData> testCaseData) {     var param1 = testCaseData.Param.Param1;     var param2 = testCaseData.Param.Param2;          // Do something test }  public class ValidateTestCase<T> : IXunitSerializable {     public T Param { get; set; }      public void Serialize(IXunitSerializationInfo info)     {         // JSON を使う場合         info.AddValue(nameof(Param), JsonConvert.SerializeObject(Param));          // ハッシュ値を使う場合         // info.AddValue(nameof(Param), GetHashCode());          // GUID を使う場合         // info.AddValue(nameof(Param), Guid.NewGuid().ToString());     }      public void Deserialize(IXunitSerializationInfo info) { } }  public class TestCaseData {     public int Param1 { get; set; }     public string Param2 { get; set; } }  public static IEnumerable<object[]> TestData() {     yield return new object[] {         new ValidateTestCase<TestCaseData>{             Param = new TestCaseData(){                 Param1 = 0,                 Param2 = "hoge"             }         }     };     yield return new object[] {         new ValidateTestCase<TestCaseData>{             Param = new TestCaseData(){                 Param1 = 1,                 Param2 = "fuga"             }         }     }; } ```  `Serialize` メソッドで登録する文字列を `ToString()` から JSON でのシリアライズに変更しているのがポイントです。  クラスに対して `ToString()` するとクラス名が出力されるので、全てのテストで同じ文字列になってしまい、テストエクスプローラーでは単一のテストとして表示されてしまいました。   この文字列は一連のテストケースにおいてユニークでないとダメなようです。   なので、テストパラメーターには重複はないという前提で、JSON でシリアライズしてみました。  ただし、テストケースクラス `TestCaseData` にデリゲートを含んでいる場合は上手くいかなかったので、そういう場合はハッシュ値や GUID などを使ったほうが良いと思います。   （ハッシュ値は被ることもあるかもしれないので、GUID のほうが確実か？）  ### 抽象クラスを作成して汎用的に実装する  上記だと毎回 `ValidateTestCase` と `T` の２つのクラスをインスタンス化しないといけなくてちょっと面倒なので、同じような感じで抽象クラスで実装してみました。  自クラス `this` に対してシリアライズを行っています。  ```cs [Theory,     MemberData(nameof(TestData))] public void TestMethod(TestCaseData testCaseData) {     var param1 = testCaseData.Param1;     var param2 = testCaseData.Param2;          // Do something test }  public abstract class XunitSerializableBase : IXunitSerializable {     public void Serialize(IXunitSerializationInfo info)     {         // JSON を使う場合         info.AddValue(nameof(XunitSerializableBase), JsonConvert.SerializeObject(Param));          // ハッシュ値を使う場合         // info.AddValue(nameof(XunitSerializableBase), GetHashCode());          // GUID を使う場合         // info.AddValue(nameof(XunitSerializableBase), Guid.NewGuid().ToString());     }      public void Deserialize(IXunitSerializationInfo info) { } }  public class TestCaseData : XunitSerializableBase {     public int Param1 { get; set; }     public string Param2 { get; set; } }   public static IEnumerable<object[]> TestData() {     yield return new object[] {         new TestCaseData{             Param1 = 0,             Param2 = "hoge"         }     };     yield return new object[] {         new TestCaseData{             Param1 = 1,             Param2 = "fuga"         }     }; } ```  ちょっとだけ記述量が減りました。  ## 他の案は？  上記のリンク先にある `DjvuTheory` が便利そうだったので試しましたが、.NET Core 2.2 だと動きませんでした。   自分で修正しようともしてみましたが、何故かうまくいかず断念。   これが使えたら `Theory` を`DjvuTheory` に置換するだけでいけそうだったのに残念です。

2020/06/26

NO IMAGE

[C#] ClassData でテストデータを作成する際に、テストクラス内のリソースにアクセスしたい

C# xUnit

ここでいうリソースとは、例えばテスト用のデータベースだとか、外部ファイルなどです。    あくまで私が思いついた一例ですが、概要としては、以下です。  - テストメソッドの引数にデリゲートを用意し、テストメソッド内からリソースを渡す - テストデータ作成用のクラスで、リソースに対する処理を記述  ## 環境  - Visual Studio 2017 - .NET Core 2.2  ## サンプルコード  `resource` がデータベースなどの外部のリソースを想定しています。  ### テスト対象のクラス  以下のようなクラスをテストしたいとします。  ```cs // テストしたいクラス public class Target {     // テストしたいメソッド     public int Add(IList<int> resource)     {         // 例えば、データベースなどから値を読み込んで、何か処理をした値を返すなど         // ここでは全レコードを読み込んで総和を返すようなことを想定         return resource.Sum();     } } ```  ### テストコード  以下がテストコードです。   解説はコメントに書いてある通りです。  ```cs using System; using System.Collections; using System.Collections.Generic; using System.Linq; using Xunit; using Xunit.Abstractions;  namespace TestProject {     // テストを行うクラス     public class TestClass     {         ITestOutputHelper output;         Target target;         readonly IList<int> resource;// 例えば、データベースやファイルなどの外部リソース          public TestClass(ITestOutputHelper output)         {             // デバッグ用にテストエクスプローラーに出力できるようにしておく             this.output = output;              // リソースの初期化（実際には IClassFixture を使うなどする）             resource = new List<int> { 1, 2 };              // テストクラスのインスタンスを作成             target = new Target();         }          [Theory,             ClassData(typeof(TestData))]         public void TestMethod(             // テスト前にリソースに対して行う処理（戻り値が必要なら Func にする）             Action<IList<int>> action,             // テスト実行後の期待値             int expected             )         {             // テストに必要な前処理を行う             action(resource);              // デバッグ用にテスト前のリソースの状態を出力             output.WriteLine($"resource: {string.Join(", ", resource)}");              // テストの実行             var result = target.Add(resource);              // デバッグ用に結果を出力             output.WriteLine($"result: {result.ToString()}");              // 結果の確認             Assert.Equal(expected, result);          }     }      // テストデータを作成するクラス     class TestData : IEnumerable<object[]>    {         List<object[]> _testData = new List<object[]>();          public TestData()         {             // いくつかのパターンでテストデータを作成してみる              // テストケース１（リソースの中身を書き換え）             Action<IList<int>> action = resource =>            {                 resource[0] = 1;                 resource[1] = 2;             };             _testData.Add(new object[] {                 action,                 3             });              // テストケース２（リソースに要素を追加）             _testData.Add(new object[] {                 new Action<IList<int>>(resource => resource.Add(3)),                 6             });              // テストケース３（リソースをクリア）             action = resource => resource.Clear();             _testData.Add(new object[] {                 action,                 0             });         }          public IEnumerator<object[]> GetEnumerator() => _testData.GetEnumerator();          IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();     } } ```  ### 実行結果  **テストケース1**  ```sh resource: 1, 2 result: 3 ```  **テストケース2**  ```sh resource: 1, 2, 3 result: 6 ```  **テストケース3**  ```sh resource:  result: 0 ```

2019/11/21

NO IMAGE

ILogger に ITestOutputHelper の出力先を指定する

.NET Core C# xUnit

その際、`ILogger` に対してログ出力を行います。  その一方で、テスティングフレームワークとして xUnit を使用している場合、テストエクスプローラーにデバッグ用のログを表示するために、`ITestOutputHelper` に対してログ出力を行います。  ここで、テスト時の `ILogger` の出力先として `ITestOutputHelper` を指定できれば、プロダクトコード内のログもテストエクスプローラーに簡単に出力できて便利だなと思い、調べてみたら以下の記事にやり方が載っていたので試してみました。  - https://codeday.me/jp/qa/20190411/605325.html  ## 環境  - .NET Core 2.2  ## Logger の作成  サンプルコードをそのまま引用しますが・・・。  ```cs public class Example {     private readonly ILogger<Example> _logger;      public Example(ITestOutputHelper testOutputHelper)     {         var loggerFactory = new LoggerFactory();         loggerFactory.AddProvider(new XunitLoggerProvider(testOutputHelper));         _logger = loggerFactory.CreateLogger<Example>();     }      [Fact]     public void Test()     {         _logger.LogDebug("Foo bar baz");     } } ```  `XunitLoggerProvider` は `Microsoft.Extensions.Logging` と xUnit のテスト出力を統合するための処理です。  ```cs public class XunitLoggerProvider : ILoggerProvider {     private readonly ITestOutputHelper _testOutputHelper;      public XunitLoggerProvider(ITestOutputHelper testOutputHelper)     {         _testOutputHelper = testOutputHelper;     }      public ILogger CreateLogger(string categoryName)         => new XunitLogger(_testOutputHelper, categoryName);      public void Dispose()     { } }  public class XunitLogger : ILogger {     private readonly ITestOutputHelper _testOutputHelper;     private readonly string _categoryName;      public XunitLogger(ITestOutputHelper testOutputHelper, string categoryName)     {         _testOutputHelper = testOutputHelper;         _categoryName = categoryName;     }      public IDisposable BeginScope<TState>(TState state)         => NoopDisposable.Instance;      public bool IsEnabled(LogLevel logLevel)         => true;      public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)     {         _testOutputHelper.WriteLine($"{_categoryName} [{eventId}] {formatter(state, exception)}");         if (exception != null)             _testOutputHelper.WriteLine(exception.ToString());     }      private class NoopDisposable : IDisposable     {         public static NoopDisposable Instance = new NoopDisposable();         public void Dispose()         { }     } } ```