xUnit 基礎觀念

簡單說明 xUnit 的一些基礎觀念與用法，還加上對應到 MSTest 的功能。如果是從 MSTest 轉過來，可能會需要一些時間來適應。

測試類別

生命週期：

• 初始化：每個測試開始前
• 清除：每個測試結束後

和一般的測試框架不同，xUnit 採用建構式和實作 IDispose 來達成初始化和清除

對應 MSTest：[XxxInitialize], [XxxCleanup]

public class ProductServiceTests : IDisposable
{
    private readonly IMapper _mapper;
    private readonly IProductRepository _productRepository;
    private readonly ProductService _sut;

    public ProductServiceTests()
    {
        this._mapper = TestHook.MapperConfigurationProvider.CreateMapper();
        this._productRepository = Substitute.For<IProductRepository>();
        this._sut = new ProductService(this._productRepository, this._mapper);
    }

    public void Dispose()
    {
        // 想要清除的東西
        // 不需要可以不用繼承 IDisposable
    }

    // 測試方法...
}

測試方法

[Fact]

對應 MSTest：[TestMethod]

[Fact]
public void GetById_輸入id_資料庫有資料_應回傳ProductDto資料()
{
    // arrange
    var id = 1;

    var fixture = new Fixture();
    var product = fixture.Build<ProductEntity>()
        .With(q => q.Id, id)
        .With(q => q.Status, 1)
        .Create();

    this._productRepository.GetById(Arg.Any<int>()).Returns(product);

    // act
    var actual = this._sut.GetById(id);

    // assert
    Assert.Equal(id, actual.Id);
    Assert.NotNull(actual);
}

[Theory], [InlineData]

資料的使用範圍：此方法內

可理解為內部資料

對應 MSTest：[TestMethod], [DataRow]

[Theory(DisplayName = "GetRange_InlineData_不合規格的值")]
[InlineData("from", -1, 10)]
[InlineData("from", 0, 10)]
[InlineData("size", 1, -1)]
[InlineData("size", 1, 0)]
public void GetRange_InlineData_輸入引數的內容為不合規格的值_應拋出ArgumentOutOfRangeException(string nameOfErrorArgument, int from, int size)
{
    // InlineData 同 DataRow，但是無法每一筆資料指定自己的 DisplayName，只能在Theory統一指定 DisplayName

    // act
    var exception = Assert.Throws<ArgumentOutOfRangeException>(() => this._sut.GetRange(from, size));

    // assert
    Assert.Contains(nameOfErrorArgument, exception.Message);
}

[Theory], [MemberData]

可玩性極高，可以在同一類別內建立多個靜態方法，或是在另一個類別裡建立，彈性比 ClassData 還高。注意必須要回傳 IEnumerable<object[]>

資料的使用範圍：同一類別內、不限 (可跨類別、專案等)

可理解為成員資料，來自於類別內的成員

對應 MSTest：[TestMethod], [DynamicData]

• 同一類別內 (範圍：同一類別)

  [Theory(DisplayName = "GetRange_同類別MemberData_不合規格的值")]
  [MemberData(nameof(PageDataMemberData))]
  public void GetRange_MemberData_同類別輸入引數的內容為不合規格的值_應拋出ArgumentOutOfRangeException(string nameOfErrorArgument, int from, int size)
  {
      // 資料來源為獨立出一個必須是 public 且 static 的方法，必須要回傳 IEnumerable<object[]>
      // 資料的使用範圍：此類別內
      // attribute 內使用 nameof(string memberDataName)
  
      // act
      var exception = Assert.Throws<ArgumentOutOfRangeException>(() => this._sut.GetRange(from, size));
  
      // assert
      Assert.Contains(nameOfErrorArgument, exception.Message);
  }
  
  public static IEnumerable<object[]> PageDataMemberData =>
      new List<object[]>
      {
          new object[] { "from", -1, 10 },
          new object[] { "from", 0, 10 },
          new object[] { "size", 1, -1 },
          new object[] { "size", 1, 0 }
      };

• 不同類別內 (範圍：不限)

  public class ProductServiceTests : IDisposable
  {
      // 省略...
  
      [Theory(DisplayName = "GetRange_不同類別MemberData_不合規格的值")]
      [MemberData(nameof(PageTestMemberData.GetPageErrorData), MemberType = typeof(PageTestMemberData))]
      public void GetRange_不同類別MemberData_輸入引數的內容為不合規格的值_應拋出ArgumentOutOfRangeException(string nameOfErrorArgument,
          int from, int size)
      {
          // 資料來源為獨立出一個必須是 public 且 static 的方法，必須要回傳 IEnumerable<object[]>
          // 資料的使用範圍：不限 (可跨類別、專案等)
          // attribute 內使用 nameof(string memberDataName), MemberType = typeof(資料來源類別的名稱)
  
          // act
          var exception = Assert.Throws<ArgumentOutOfRangeException>(() => this._sut.GetRange(from, size));
  
          // assert
          Assert.Contains(nameOfErrorArgument, exception.Message);
      }
  }
  
  public class PageTestMemberData
  {
      public static IEnumerable<object[]> GetPageCorrectData()
      {
          yield return new object[] { "from", 1, 10 };
          yield return new object[] { "from", 2, 10 };
          yield return new object[] { "size", 1, 1 };
          yield return new object[] { "size", 1, 2 };
      }
      
      public static IEnumerable<object[]> GetPageErrorData()
      {
          yield return new object[] { "from", -5, 10 };
          yield return new object[] { "from", 0, 10 };
          yield return new object[] { "size", 1, -5 };
          yield return new object[] { "size", 1, 0 };
      }
  }

[Theory], [ClassData]

資料的使用範圍：不限 (可跨類別、專案等)

可理解為由一個專門提供資料的類別取得資料

對應 MSTest：[TestMethod], [CustomDataSource]

public class ProductServiceTests : IDisposable
{
    // 省略...

    [Theory(DisplayName = "GetRange_ClassData_不合規格的值")]
    [ClassData(typeof(PageTestClassData))]
    public void GetRange_ClassData_輸入引數的內容為不合規格的值_應拋出ArgumentOutOfRangeException(string nameOfErrorArgument, int from, int size)
    {
        // 資料來源為獨立的類別，但是這個類別必須繼承 IEnumerable
        // attribute 內使用 typeof

        // act
        var exception = Assert.Throws<ArgumentOutOfRangeException>(() => this._sut.GetRange(from, size));

        // assert
        Assert.Contains(nameOfErrorArgument, exception.Message);
    }
}

public class PageTestClassData : IEnumerable<object[]>
{
    // 用於 ClassData 的類別，必須要繼承 IEnumerable

    public IEnumerator<object[]> GetEnumerator()
    {
        yield return new object[] { "from", -1, 10 };
        yield return new object[] { "from", 0, 10 };
        yield return new object[] { "size", 1, -1 };
        yield return new object[] { "size", 1, 0 };
    }

    IEnumerator IEnumerable.GetEnumerator()
    {
        return this.GetEnumerator();
    }
}

注意事項

• 想要判斷陣列是否為空集合的時候，可能會想要使用 Assert.Equal(0, actual.Count());，但是官方不建議，IDE 也會提示。建議使用 Empty (Assert.Empty(actual);)。

參考

• Getting started with xUnit.net v3 (command line) > xUnit.net
• Shared Context between Tests > xUnit.net
• Creating parameterised tests in xUnit with [InlineData], [ClassData], and [MemberData]