从另一个方法内部调用的方法的单元测试返回值

Question

我有一个类似的方法：

public List<MyClass> DoSomething(string Name, string Address, string Email, ref string ErrorMessage)
{
  //Check for empty string parameters etc now go and get some data   
  List<MyClass> Data = GetData(Name, Address, Email);

  /*************************************************************    
  //How do I unit test that the data variable might be empty???    
  *************************************************************/

  List<MyClass> FormattedData = FormatData(Data);
  return FormattedData;
}

我只是在学习 TDD/单元测试。我的问题是，如何编写测试以确保如果 GetData 返回一个空列表，我将 ErrorMessage 设置为某个值，然后返回一个空列表？

Answer 1

在开发时，您应该为这样的测试留下一个“入口点”：

public List<MyClass> DoSomething(string Name, string Address,
              string Email, ref string ErrorMessage, IDataProvider provider)
{
  //Check for empty string parameters etc now go and get some data   
  List<MyClass> Data = provider.GetData(Name, Address, Email);

  List<MyClass> FormattedData = FormatData(Data);
  return FormattedData;
}

在单元测试中你应该mockIDataProvider

这称为 依赖注入 (DI) 或 控制反转 (IOC)

常用模拟库：

• NMock
• EasyMock.NET
• TypeMock Isolator 商业/付费
• Rhino Mocks
• Moq
• NSubstitute
• JustMock 商业/付费
• FakeItEasy
• Moles

列表取自here

维基百科文章：

Dependency Injection
Inversion Of Control

---

NUnit 伪代码：

[Test]
public void When_user_forgot_password_should_save_user()
{
    // Arrange
    var errorMessage = string.Empty;
    var dataProvider = MockRepository.GenerateStub<IDataProvider>();
    dataProvider.Stub(x => x.GetData("x", "y", "z", ref errorMessage )).Return(null);

    // Act
    var result DoSomething("x","y","z", ref errorMessage, dataProvider);

    // Assert

    //...
}

Answer 2

单元测试不是您添加到现有方法中间的东西，它是关于测试与系统其余部分隔离的小代码单元，以便您确信该单元的行为应如此。

因此，您应该编写第二个类，该类的唯一职责是测试DoSomething 所在的类（我们称这个类为Daddy 和测试类DaddyTests）的行为是否符合您的预期。然后，您可以编写一个调用DoSomething 的测试方法，并确保正确设置ErrorMessage（ErrorMessage 也应该是out 参数，而不是ref，除非您还传递了一个值）。

为方便此测试，您需要确保GetData 不返回任何数据。很简单，您可以通过在假提供者中传入一组空数据来做到这一点，但在更复杂的情况下，可能必须将整个类换成假/模拟等价物：接口和依赖注入的使用使这项任务非常简单。 （通常，提供程序是在Daddy 的构造过程中设置的，而不是作为对DoSomething 的调用中的参数。）

public class Daddy {
    public List<MyClass> DoSomething(string Name, string Address,                  string Email, out string ErrorMessage, IDataProvider provider)
    {
      //Check for empty string parameters etc now go and get some data   
      List<MyClass> Data = provider.GetData(Name, Address, Email);

      if (Data.Count == 0)
      {
          ErrorMessage = "Oh noes";
          return Enumerable.Empty<MyClass>();
      }

      List<MyClass> formattedData = FormatData(Data);
      return formattedData;
    }
}

[TestClass]
public class DaddyTest {
    [TestMethod]
    public void DoSomethingHandlesEmptyDataSet() {
        // set-up
        Daddy daddy = new Daddy();

        // test
        IList<MyClass> result = daddy.DoSomething("blah",
                                                  "101 Dalmation Road",
                                                  "bob@example.com",
                                                  out error,
                                                  new FakeProvider(new Enumerable.Empty<AcmeData>())); // a class we've written to act in lieu of the real provider

        // validate
        Assert.NotNull(result); // most testing frameworks provides Assert functionality
        Assert.IsTrue(result.Count == 0);
        Assert.IsFalse(String.IsNullOrEmpty(error));
    }
}

}

Answer 3

国际海事组织，这条线

List<MyClass> Data = GetData(Name, Address, Email);

应该在课堂之外。方法签名更改为

public List<MyClass> DoSomething(List<MyClass> data, ref string ErrorMessage)

此方法变得更容易测试，因为您可以轻松更改输入以测试所有可能的边缘情况。

另一种选择是让 GetData 方法由模拟依赖项公开，然后您可以设置它以返回各种结果。所以你的班级现在看起来像：

class ThisClass
{
   [Import]
   public IDataService DataService {get; set;}

   public List<MyClass> DoSomething(string Name, string Address, string Email, ref string ErrorMessage)
   {
     //Check for empty string parameters etc now go and get some data   
     List<MyClass> Data = IDataService.GetData(Name, Address, Email); // using dependency

     List<MyClass> FormattedData = FormatData(Data);
     return FormattedData;
   }
}

Answer 4

[TestMethod]
public void MyDoSomethingTest()
{
   string errorMessage = string.Empty;
   var actual = myClass.DoSomething(..., ref errorMessage)
   Assert.AreEqual("MyErrorMessage", errorMessage);
   Assert.AreEqual(0, FormattedData.Count);
}

我假设如果没有任何要格式化的数据，格式化程序将返回一个空列表。

由于您想验证该方法的最终结果，我不会尝试找出 GetData 函数返回的内容，因为它是您想要验证它是空列表并且可能 FormatData 没有的实际返回值不会崩溃。

如果您想尽快退出该函数，您可以检查是否有任何参数为 null och 为空，在这种情况下只需执行此操作

errorMessage = "Empty parameters are not allowed";
return new List<MyClass>();