模拟UdpClient进行单元测试

Question

我正在开发一个使用UdpClient的类,并尝试在此过程中使用NUnit和Moq学习/利用TDD方法.

到目前为止,我班上的一个简单部分如下:

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,而且类中的UdpClient实际上是向它发送数据.因此,据我所知,这不是真正的单元测试.

问题是,我无法理解该怎么做.我应该改变我的类并传入一个新的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();
}

.

创建了一个适配器类来包装UdpClient系统类:

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 clas以要求通过构造函数注入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

如果你只想测试你的类的功能,我会创建一个接口ICommunucator,然后创建一个类UdpCommunicator,它直接包装所需的UdpClient属性和方法,没有任何检查和条件.

在你的类中,注入包装器并使用is而不是tf UdpClient.

这样,在测试中你可以模拟ISender,并进行测试.

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

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

即,你的班级变成这样:

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....

因此,在几个Verify语句中,您可以检查通信器上的Open是否被调用,是否传递了正确的数据等.

通常 - 您不需要测试系统或第三方类,只需要您自己的类.

如果您的代码使用这样的类,请将它们注入.如果这些类没有虚拟方法(即你不能直接模拟它们),或者没有实现某些通用接口(比如SqlConnection等等,它实现了IDbConnection),那么就创建一个如上所述的普通包装器.

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