如何对对话框交互进行单元测试

本文关键字：单元测试 交互 对话框 | 更新日期: 2023-09-27 18:00:23

我有以下类：

public class DirectoryFinder : IDirectoryFinder
{
    public string GetDirectory(string whereTo)
    {
        FolderBrowserDialog dialog = new FolderBrowserDialog {Description = whereTo};
        DialogResult result = dialog.ShowDialog();
        return result == DialogResult.OK ? dialog.SelectedPath : string.Empty;
    }
}

我该如何验证它是否返回了正确的数据？例如字符串。根据用户单击的内容，在对话框中选择空或其他内容？

我使用NUnit作为测试框架。

如何对对话框交互进行单元测试

一个选项是将不可测试的UI部分从可测试的业务逻辑中分离出来：

public string GetDirectory(string whereTo)
{
    FolderBrowserDialog dialog = new FolderBrowserDialog { Description = whereTo };
    DialogResult result = dialog.ShowDialog();
    return GetDirectory(dialog.SelectedPath, result);
}
public string GetDirectory(string selectedPath, DialogResult result)
{
    return result == DialogResult.OK ? selectedPath : string.Empty;
}

所以你只需要测试第二种方法，它变得很容易。

另一种选择是使用UI组件的模拟/伪造。然而，FolderBrowserDialog是密封的，这使得这更加困难。

你可以这样做，但这可能有些过头了。

首先，只为您想要使用的部件定义一个接口：

public interface IFolderBrowserDialogWrapper
{
    DialogResult ShowDialog();
    string SelectedPath { get; }
}

然后将真正的FolderBrowserDialog封装在您的新界面中：

public class FolderBrowserDialogWrapper : IFolderBrowserDialogWrapper
{
    private readonly FolderBrowserDialog m_dialog;
    public DialogResult ShowDialog()
    {
        return m_dialog.ShowDialog();
    }
    public string SelectedPath
    {
        get { return m_dialog.SelectedPath; }
    }
    public FolderBrowserDialogWrapper(FolderBrowserDialog dialog)
    {
        m_dialog = dialog;
    }
}

并创建一个用于测试的伪版本，该版本只返回传递给其构造函数的值：

public class FakeFolderBrowserDialogWrapper : IFolderBrowserDialogWrapper
{
    private readonly DialogResult m_result;
    private readonly string m_selectedPath;
    public DialogResult ShowDialog()
    {
        return m_result;
    }
    public string SelectedPath
    {
        get { return m_selectedPath; }
    }
    public FakeFolderBrowserDialogWrapper(string selectedPath, DialogResult result)
    {
        m_selectedPath = selectedPath;
        m_result = result;
    }
}

然后，您的方法可以使用FolderBrowserDialogWrapper进行真正的对话：

public string GetDirectory(string whereTo)
{
    var f = new FolderBrowserDialogWrapper(
        new FolderBrowserDialog { Description = whereTo });
    return GetDirectory(f);
}
public string GetDirectory(IFolderBrowserDialogWrapper dialog)
{
    DialogResult result = dialog.ShowDialog();
    return result == DialogResult.OK ? dialog.SelectedPath : string.Empty;
}

测试可以使用FakeFolderBrowserDialogWrapper绕过UI:

[Test]
public static void TestDirectoryFinderGetDirectoryWithOKExpectThePath()
{
    const string expectedPath = @"C:'temp";
    var dlg = new FakeFolderBrowserDialogWrapper(expectedPath, DialogResult.OK);
    var df = new DirectoryFinder();
    string result = df.GetDirectory(dlg);
    Assert.That(result, Is.EqualTo(expectedPath));
}
[Test]
public static void TestDirectoryFinderGetDirectoryWithCancelExpectEmptyString()
{
    const string expectedPath = @"C:'temp";
    var dlg = new FakeFolderBrowserDialogWrapper(expectedPath, DialogResult.Cancel);
    var df = new DirectoryFinder();
    string result = df.GetDirectory(dlg);
    Assert.That(result, Is.EqualTo(string.Empty));
}

但是，除非您在代码的其他地方也创建了大量的FolderBrowserDialog，否则这可能太过分了。

我要感谢Matthew Strawbrige的出色回答。我从他的答案开始，但我发现，因为我使用的是构造函数注入（Caliburn Micro），所以我定制了它以适合自己。首先是接口。（我在SelectedPath中添加了一个集合，这样我就可以设置起始目录了）。

public interface IFolderBrowserDialogWrapper
{
    string SelectedPath { get; set; }
    string Description { get; set; }
    DialogResult ShowDialog();
}

然后实现

public class FolderBrowserDialogWrapper : IFolderBrowserDialogWrapper
{
    private FolderBrowserDialog _dialog;
    public FolderBrowserDialogWrapper()
    {
        _dialog = new FolderBrowserDialog();
    }
    public DialogResult ShowDialog()
    {
        return _dialog.ShowDialog();
    }
    public string SelectedPath
    {
        get { return _dialog.SelectedPath;  }
        set { _dialog.SelectedPath = value; }
    }
    public string Description
    {
        get { return _dialog.Description; }
        set { _dialog.Description = value; }
    }
}

构造函数注入，它将在您将在注入框架中指定的正常条件下使用上面类中的普通FolderBrowseDialog；-）

public class TestBrowserDialog : Caliburn.Micro.Screen
{
    private IFolderBrowserDialogWrapper _folderBrowserDialogWrapper;
    public TestBrowserDialog(IFolderBrowserDialogWrapper folderBrowserDialogWrapper)
    {
        _folderBrowserDialogWrapper = folderBrowserDialogWrapper;
    }
    ...
    public void Browse()
    {
    ...
    }
    ...
}

命令执行了。我使用的是Caliburn Micro，它直接调用该方法。在其他框架中，它可以是委托命令或其他东西。我的Browse方法链接到视图上的一个按钮，因此单击视图上的按钮，激活Browse命令并根据需要打开BrowseFolderDialog。

    public void Browse()
    {
        _folderBrowserDialogWrapper.Description = "Your description goes here";
        DialogResult result = _folderBrowserDialogWrapper.ShowDialog();
        string path = result == DialogResult.OK ? _folderBrowserDialogWrapper.SelectedPath : string.Empty;
        // Process your result.
        SourceDirectory = path;
    }

我的测试代码的一个片段。在这里，我可以测试Browse命令的行为，而无需在单元测试期间打开BrowseFolderDialog！

    [Test]
    public void TestBrowserDialog_Browse_SetsSourceDirectory()
    {
        // Arrange - This is using NSubstitute for Mocking, NUnit for testing
        IFolderBrowserDialogWrapper _folderBrowserDialogWrapper = Substitute.For<IFolderBrowserDialogWrapper>();
        _folderBrowserDialogWrapper.ShowDialog().Returns(DialogResult.OK);
        string testFileDirectory = Path.Combine(NUnit.Framework.TestContext.CurrentContext.TestDirectory, "Directory 1");
        _folderBrowserDialogWrapper.SelectedPath.Returns(testFileDirectory);
        // Insert your own _folderBrowserDialogWrapper for testing purposes
        TestBrowserDialog sut = new TestBrowserDialog(_folderBrowserDialogWrapper);
        // Action
        sut.Browse();
        // Assert - I'm using FluentAssertions
        sut.SourceDirectory.Should().Be(testFileDirectory);
    }

我希望这能给其他人提供做什么的想法。Matthew Strawbridge的回答当然对我有帮助。

相关文章：