模拟 UdpClient 进行单元测试

Question

我正在研究使用 UdpClient 的 class，并尝试在此过程中使用 NUnit 和 Moq 学习/利用 TDD 方法。

到目前为止，我的 class 的基本部分如下：

public UdpCommsChannel(IPAddress address, int port)
{
    this._udpClient = new UdpClient();
    this._address = address;
    this._port = port;
    this._endPoint = new IPEndPoint(address, port);
}

public override void Open()
{
    if (this._disposed) throw new ObjectDisposedException(GetType().FullName);

    try
    {
        this._udpClient.Connect(this._endPoint);
    }
    catch (SocketException ex)
    {
        Debug.WriteLine(ex.Message);
    }
}

public override void Send(IPacket packet)
{
    if (this._disposed) throw new ObjectDisposedException(GetType().FullName);

    byte[] data = packet.GetBytes();
    int num = data.Length;

    try
    {
        int sent = this._udpClient.Send(data, num);
        Debug.WriteLine("sent : " + sent);
    }
    catch (SocketException ex)
    {
        Debug.WriteLine(ex.Message);
    }
}

.
.
对于 Send 方法，我目前有以下单元测试：

[Test]
public void DataIsSent()
{
    const int port = 9600;

    var mock = new Mock<IPacket>(MockBehavior.Strict);
    mock.Setup(p => p.GetBytes()).Returns(new byte[] { }).Verifiable();

    using (UdpCommsChannel udp = new UdpCommsChannel(IPAddress.Loopback, port))
    {
        udp.Open();
        udp.Send(mock.Object);
    }

    mock.Verify(p => p.GetBytes(), Times.Once());
}

.
.
我对此并不满意，因为它使用的是实际的 IP 地址，尽管只有 localhost，并且 class 内的 UdpClient 正在向它物理发送数据。 因此，据我所知，这不是一个真正的单元测试。

问题是，我不知道该怎么做。 我是否应该更改我的 class 并将新的 UdpClient 作为依赖项传入？ 以某种方式模拟 IPAddress？

有点挣扎，所以我需要在这里停下来看看我是否走在正确的轨道上，然后再继续。 任何建议表示赞赏！

（使用 NUnit 2.5.7、Moq 4.0 和 C# WinForms。）。
.

更新：

好的，我已经重构了我的代码如下：

创建了一个 IUdpClient 接口：

public interface IUdpClient
{
    void Connect(IPEndPoint endpoint);
    int Send(byte[] data, int num);
    void Close();
}

.

创建了一个适配器 class 来包装 UdpClient 系统 class：

public class UdpClientAdapter : IUdpClient
{
    private UdpClient _client;

    public UdpClientAdapter()
    {
        this._client = new UdpClient();
    }

    #region IUdpClient Members

    public void Connect(IPEndPoint endpoint)
    {
        this._client.Connect(endpoint);
    }

    public int Send(byte[] data, int num)
    {
        return this._client.Send(data, num);
    }

    public void Close()
    {
        this._client.Close();
    }

    #endregion
}

.

重构我的 UdpCommsChannel 类以要求通过构造函数注入的 IUdpClient 实例：

public UdpCommsChannel(IUdpClient client, IPEndPoint endpoint)
{
    this._udpClient = client;
    this._endPoint = endpoint;
}

.

我的单元测试现在看起来像这样：

[Test]
public void DataIsSent()
{
    var mockClient = new Mock<IUdpClient>();
    mockClient.Setup(c => c.Send(It.IsAny<byte[]>(), It.IsAny<int>())).Returns(It.IsAny<int>());

    var mockPacket = new Mock<IPacket>(MockBehavior.Strict);
    mockPacket.Setup(p => p.GetBytes()).Returns(new byte[] { }).Verifiable();

    using (UdpCommsChannel udp = new UdpCommsChannel(mockClient.Object, It.IsAny<IPEndPoint>()))
    {
        udp.Open();
        udp.Send(mockPacket.Object);
    }

    mockPacket.Verify(p => p.GetBytes(), Times.Once());
}

.

欢迎任何进一步的评论。

Answer 1

如果你只想测试你的 class 的功能，我会 go 创建一个接口 ICommunucator，然后创建一个 class UdpCommunicator 和所需的属性，无需任何检查客户端包装和方法。

在您的 class 中，注入包装器并使用 is 而不是 tf UdpClient。

这样，您可以在测试中模拟 ISender 并进行测试。

当然，你不会对包装器本身进行测试，但如果它只是一个普通的呼叫转移，你就不需要这个。

基本上，您已经朝着正确的方向开始，但是您添加了一些自定义逻辑，无法以这种方式进行测试-因此您需要拆分自定义逻辑和 comm 部分。

即，你的 class 变成这样：

public MyClass(ICommunicator comm)
{
     public void Method1(someparam)
     {
         //do some work with ICommunicator
     }
     ....
}

您的测试将如下所示：

var mockComm = Mock.GetMock<ICommunicator>();
mockComm.Setup ....
var myTestObj = new MyClass(mock.Object);
MyClass.Method1(something);

mock.Verify....

因此，在几个验证语句中，您可以检查是否调用了通信器上的 Open、是否传递了正确的数据等。

一般来说 - 你不需要测试系统或第三方类，只需要你自己的。

如果您的代码使用这样的类，请使它们可注入。 如果这些类没有虚拟方法（即您不能直接模拟它们），或者没有实现一些通用接口（如 SqlConnection 等 - 它实现了 IDbConnection），那么您将创建一个如上所述的普通包装器。

除了可测试性改进之外，这种方法将使将来修改代码变得更加容易 - 即当您需要其他一些通信方法等时。