如何使用 out 参数模拟方法

本文关键字:模拟 方法 参数 out 何使用 | 更新日期: 2023-09-27 18:33:40

我正在使用一个在函数中使用参数的库,我需要使用该函数测试我的代码。

因此,试图通过我在项目其余部分使用的 Moq 在这里让模拟来拯救我。

问题

我知道下面有一堵文字墙,所以(提前(问题是:

  • 根据下面的线索:Moq 是否可以使用需要通常不会自行调用的参数的构造函数模拟项目?
  • 这是我的测试代码有问题吗?与图书馆?使用验证库?
  • 我是否在没有参数的情况下使用最小起订量?
  • 我什至从哪里开始调试它?

更新:到目前为止的潜在客户

我认为这是嘲笑 IXLRow 界面方面的一个问题。通常,XLRow 似乎仅从工作簿实例化,而不是通过new XLRow() - 这是一个因素吗?

以下测试在以下情况下通过(注意:模拟(:

   [Fact]
    public void TryGetValueCanReturnTrueForVieldWithAnInteger_WhenAccessingFromRow()
    {
        var workbook = new XLWorkbook();
        workbook.Worksheets.Add("TestWS");
        var wb = workbook.Worksheet("TestWS");
        wb.Cell("A1").Value = "12345";
        // NOTE: Here we're referring to the row as part of an instantiated  
        //       workbook instead of Mocking it by itself
        int output;
        Assert.True(wb.Row(1).Cell("A").TryGetValue(out output));
    }

《守则》

获取有效对象((的模拟的方法片段:

// ...other code that sets up other parts of the row correctly
int isAnyInt = 0; //I don't care about this value, only the true/false
// set this to false to true to mimic a row being a legitimate integer
mock.Setup(m => m.Cell("B").TryGetValue(out isAnyInt)).Returns(true);

测试快乐路径的 xUnit 测试 -- 获取有效行的模拟,然后确保它通过验证。注意:此测试通过。

    [Fact]
    public void Validate_GivenValidRow_ReturnsValid()
    {
        var mockRow = TestHelper.GetMockValidInvoiceDetailsWorksheetRow();
        var validationResult = new InvoiceDetailsWorksheetRowValidator().Validate(mockRow.Object);
        Assert.True(validationResult.IsValid);
    }

xUnit 测试(基本上,"验证器是否因不是整数的单元格而失败?注意:此测试通过。

    [Fact]
    public void Validate_GivenNonNumericClaimantID_ReturnsInvalid()
    {
        int outint = 0;
        // Get a mock of a valid row
        var mockRow = TestHelper.GetMockValidInvoiceDetailsWorksheetRow();
        // change the TryGetValue result to false
        mockRow.Setup(m => m.Cell("B").TryGetValue(out outint)).Returns(false);
        var validationResult = new InvoiceDetailsWorksheetRowValidator().Validate(mockRow.Object);
        Assert.False(validationResult.IsValid);
        Assert.Equal("ClaimantID column value is not a number.", validationResult.Errors.First().ErrorMessage);
    }

验证器(使用FluentValidation(:

public class InvoiceDetailsWorksheetRowValidator : AbstractValidator<IXLRow>
{
    public InvoiceDetailsWorksheetRowValidator()
    {
        RuleFor(x => x.Cell("B"))
            .Must(BeAnInt).WithMessage("ClaimantID column value is not a number.")
            .OverridePropertyName("ClaimantIDColumn");
    }
    private bool BeAnInt(IXLCell cellToCheck)
    {
        int result;
        var successful = cellToCheck.TryGetValue(out result);
        return successful;
    }
}

作为参考,库中的方法:

    public Boolean TryGetValue<T>(out T value)
    {
        var currValue = Value;
        if (currValue == null)
        {
            value = default(T);
            return true;
        }
        bool b;
        if (TryGetTimeSpanValue(out value, currValue, out b)) return b;
        if (TryGetRichStringValue(out value)) return true;
        if (TryGetStringValue(out value, currValue)) return true;
        var strValue = currValue.ToString();
        if (typeof(T) == typeof(bool)) return TryGetBasicValue<T, bool>(out value, strValue, bool.TryParse);
        if (typeof(T) == typeof(sbyte)) return TryGetBasicValue<T, sbyte>(out value, strValue, sbyte.TryParse);
        if (typeof(T) == typeof(byte)) return TryGetBasicValue<T, byte>(out value, strValue, byte.TryParse);
        if (typeof(T) == typeof(short)) return TryGetBasicValue<T, short>(out value, strValue, short.TryParse);
        if (typeof(T) == typeof(ushort)) return TryGetBasicValue<T, ushort>(out value, strValue, ushort.TryParse);
        if (typeof(T) == typeof(int)) return TryGetBasicValue<T, int>(out value, strValue, int.TryParse);
        if (typeof(T) == typeof(uint)) return TryGetBasicValue<T, uint>(out value, strValue, uint.TryParse);
        if (typeof(T) == typeof(long)) return TryGetBasicValue<T, long>(out value, strValue, long.TryParse);
        if (typeof(T) == typeof(ulong)) return TryGetBasicValue<T, ulong>(out value, strValue, ulong.TryParse);
        if (typeof(T) == typeof(float)) return TryGetBasicValue<T, float>(out value, strValue, float.TryParse);
        if (typeof(T) == typeof(double)) return TryGetBasicValue<T, double>(out value, strValue, double.TryParse);
        if (typeof(T) == typeof(decimal)) return TryGetBasicValue<T, decimal>(out value, strValue, decimal.TryParse);
        if (typeof(T) == typeof(XLHyperlink))
        {
            XLHyperlink tmp = GetHyperlink();
            if (tmp != null)
            {
                value = (T)Convert.ChangeType(tmp, typeof(T));
                return true;
            }
            value = default(T);
            return false;
        }
        try
        {
            value = (T)Convert.ChangeType(currValue, typeof(T));
            return true;
        }
        catch
        {
            value = default(T);
            return false;
        }
    }

问题所在

第一个测试通过。但是当我运行此测试时,它失败了:

   [Fact]
   public void Validate_GivenNonNumericInvoiceNumber_ReturnsInvalid()
    {
        int outint = 0; // I don't care about this value
        // Get a mock of a valid worksheet row
        var mockRow = TestHelper.GetMockValidInvoiceDetailsWorksheetRow();
        mockRow.Setup(m => m.Cell("E").TryGetValue(out outint)).Returns(false);
        // Validates & asserts
        var validationResult = new InvoiceDetailsWorksheetRowValidator().Validate(mockRow.Object);
        Assert.False(validationResult.IsValid);
        // Placed here to ensure it's the only error message. This is where it fails.
        Assert.Equal("InvoiceNumber column value is not a number.",validationResult.Errors.First().ErrorMessage);
    }

但它不会失败,因为尚未实现验证 - 它失败是因为另一个项目首先无效,即使我从获得有效的模拟返回它 - 通过测试的相同有效模拟。

确切地说,消息是:

Assert.Equal(( 失败

位置

:第一个差值位于位置 0

预期:发票编号列值不是数字。

实际:索赔人 ID 列值不是数字。

我期望:

  • 它的工作方式与其他测试的工作方式相同,或者
  • 让快乐的道路也失败。

但是,当快乐路径(例如有效的模拟(通过,但测试失败时,因为该方法无效(与通过与"有效"模拟的一部分相同的验证相同(......这让我完全困惑。

供参考

  • 我正在使用的库是 ClosedXML
  • 我正在使用的验证库是FluentValidation
  • 我正在使用 xUnit.NET 进行单元测试。

如何使用 out 参数模拟方法

我认为你不需要测试TryGetValue在图书馆里。

豆英特在一个单独的类中,比如XLCellHelpers,使用IXLCell的模拟来测试它

XLCellHelpers创建一个接口,比如IXLCellHelpers,将其注入到您的验证器中:InvoiceDetailsWorksheetRowValidator

模拟IXLCellHelpers来测试验证器。

喜欢这个:

using System;
                    
public class InvoiceDetailsWorksheetRowValidator : AbstractValidator<IXLRow>
{
private readonly IXlCellHelpers xlCellHelpers;
    InvoiceDetailsWorksheetRowValidator(IXlCellHelpers xlCellHelpers)
    {
        this.xlCellHelpers = xlCellHelpers;
    }
    
    public InvoiceDetailsWorksheetRowValidator()
    {
        RuleFor(x => x.Cell("B"))
            .Must(this.xlCellHelpers.BeAnInt).WithMessage("ClaimantID column value is not a number.")
            .OverridePropertyName("ClaimantIDColumn");
    }
}
public interface IXlCellHelpers
{
    bool BeAnInt(IXLCell cellToCheck);
}
public class XlCellHelpers : IXlCellHelpers
{   
    publi bool BeAnInt(IXLCell cellToCheck)
    {
        int result;
        var successful = cellToCheck.TryGetValue(out result);
        return successful;
    }
}

尽管我非常喜欢FluentValidator,但这是我在使用Fluent Validator进行测试时讨厌的问题之一。

被测系统:

  public class InvoiceDetailsWorksheetRowValidator : AbstractValidator<IXLRow>
  {
      public InvoiceDetailsWorksheetRowValidator()
      {
        RuleFor(x => x.Cell("B"))
            .Must(BeAnInt).WithMessage("ClaimantID column value is not a number.")
            .OverridePropertyName("ClaimantIDColumn");
        RuleFor(x => x.Cell("E"))
            .Must(BeAnInt).WithMessage("InvoiceNumber column value is not a number.")
            .OverridePropertyName("ClaimantIDColumn");
      }
      private bool BeAnInt(IXLCell cellToCheck)
      {
        int result;
        var successful = cellToCheck.TryGetValue(out result);
        return successful;
      }
  }

单元测试:

  [Fact]
  public void Validate_GivenNonNumericClaimantID_ReturnsInvalid()
  {
     int outint = 0;
     // Get a mock of a valid row
     //var mockRow = TestHelper.GetMockValidInvoiceDetailsWorksheetRow();
       var mockRow = new Mock<IXLRow>();
     // change the TryGetValue result to false
     mockRow.Setup(m => m.Cell("B").TryGetValue(out outint)).Returns(false);
     var validationResult = new InvoiceDetailsWorksheetRowValidator().Validate(mockRow.Object);
     Assert.True(validationResult.Errors.Any
       (x => x.ErrorMessage == "ClaimantID column value is not a number."));
     //Other option:
     //validationResult.Errors.Remove(validationResult.Errors.First(x => x.ErrorMessage == "InvoiceNumber column value is not a number."));
     //Assert.Equal("ClaimantID column value is not a number.", validationResult.Errors.First().ErrorMessage);
  }
 [Fact]
 public void Validate_GivenNonNumericInvoiceNumber_ReturnsInvalid()
 {
     int outint = 0; // I don't care about this value
     // Get a mock of a valid worksheet row
     var mockRow = new Mock<IXLRow>();
     mockRow.Setup(m => m.Cell("E").TryGetValue(out outint)).Returns(false);
     // Validates & asserts
     var validationResult = new InvoiceDetailsWorksheetRowValidator().Validate(mockRow.Object);
     Assert.True(validationResult.Errors.Any
          (x => x.ErrorMessage == "InvoiceNumber column value is not a number."));
     //Other option:
     //validationResult.Errors.Remove(validationResult.Errors.First(x => x.ErrorMessage == "ClaimantID column value is not a number."));
     //Assert.Equal("InvoiceNumber column value is not a number.", validationResult.Errors.First().ErrorMessage);
  }