如何对使用 VisualTreeHelper 的内容进行单元测试？

Question

我有这个静态辅助函数：

    public static DependencyObject GetParentObject(DependencyObject child)
    {
        if (child == null) return null;
        ContentElement contentElement = child as ContentElement;

        if (contentElement != null)
        {
            var parent = ContentOperations.GetParent(contentElement);
            if (parent != null) return parent;

            var fce = contentElement as FrameworkContentElement;
            return fce != null ? fce.Parent : null;
        }

        //if it's not a ContentElement, rely on VisualTreeHelper
        return VisualTreeHelper.GetParent(child);
    }

它在真实的应用程序中工作，但我正在尝试为其编写一些单元测试。这是我的第一次尝试：

    [Test]
    public void GetParentObject_returns_immediate_parent()
    {
        var contentControl = new ContentControl();
        var textBox = new TextBox();

        contentControl.BeginInit();
        contentControl.Content = textBox;
        contentControl.EndInit();

        var result = UIHelper.GetParentObject(textBox);
        Assert.AreSame(contentControl, result);
    }

不幸的是，它失败了，因为 VisualTreeHelper 返回 null。我如何模拟一个可行的视觉树？

Answer 1

基于这里的答案 通过 Wpf-controls 打印文档并转换对于 XPS 我想出了以下扩展方法来创建可视化树。它在 NUnit 中运行良好，无需 STA 线程或其他任何东西。

/// <summary>
/// Render a UIElement such that the visual tree is generated, 
/// without actually displaying the UIElement
/// anywhere
/// </summary>
public static void CreateVisualTree(this UIElement element)
{
    var fixedDoc = new FixedDocument();
    var pageContent = new PageContent();
    var fixedPage = new FixedPage();
    fixedPage.Children.Add(element);
    pageContent.ToMaybeOf<IAddChild>().Do(c => c.AddChild(fixedPage));
    fixedDoc.Pages.Add(pageContent);

    var f = new XpsSerializerFactory();
    var w = f.CreateSerializerWriter(new MemoryStream());
    w.Write(fixedDoc);
}

请注意，

• 另一个答案使用了 Reach-dll 的 API，它看起来不像我看到的 API。我假设 .NEt Framework 版本 3.5 和 4.0 之间存在差异，
• ToMaybeOf 内容基本上意味着将 pageContent 视为 IAddChild 并执行操作该接口
• 不适用于类型为Window的元素，因为该元素本质上是作为子项添加到Visual中的，而Window会对此强烈抱怨。

Answer 2

这就是静力学存在问题的原因。

您可以抽象接口背后的功能并创建使用静态方法的默认实现。然后，您可以使用依赖项注入，这使得此单元测试变得微不足道 - 模拟对 IVisualTreeHelper 的依赖项或滚动您自己的存根实现，您可以将其配置为返回您分配的任何值。

public class Foo
{
    static IVisualTreeHelper visualTreeHelper;

    static Foo()
    {
        Foo.visualTreeHelper = new FrameworkVisualTreeHelper();
    }

    public Foo(IVisualTreeHelper visualTreeHelper)
    {
        Foo.visualTreeHelper = visualTreeHelper;
    }

    public static DependencyObject GetParentObject(DependencyObject child)
   {
       if (child == null) return null;
       ContentElement contentElement = child as ContentElement;

       if (contentElement != null)
       {
           var parent = ContentOperations.GetParent(contentElement);
           if (parent != null) return parent;

           var fce = contentElement as FrameworkContentElement;
           return fce != null ? fce.Parent : null;
       }

       //if it's not a ContentElement, rely on the IVisualTreeHelper
       return visualTreeHelper.GetParent(child);
   }
}

public interface IVisualTreeHelper
{
    DependencyObject GetParent(DependencyObject reference);
}

public class FrameworkVisualTreeHelper : IVisualTreeHelper
{
    public DependencyObject GetParent(DependencyObject reference)
    {
        return VisualTreeHelper.GetParent(reference);
    }
}

显然，如果您在其他地方使用其他方法，则可能需要将其他 VisualTreeHelper 方法添加到您的接口和默认实现中。

它仍然不完全干净，因为您正在测试的单元本身是静态的，当您尝试对依赖于 UIHelper 类的静态方法的任何类进行单元测试时，您将遇到完全相同的问题。

Answer 3

要模拟可视化树，您必须实际创建并渲染一棵可视化树。因此，您必须创建一个实际的窗口，这对于单元测试来说并不是特别理想。