關於UI Automation框架

微軟提供的UI Automation框架給開發windows平台的自動化測試帶來了很大的便利，這里就總結一下相關的代碼。

首先，直接使用UI Automation框架，完成一個NotePad的about窗口中的 “OK” button的點擊：

AutomationElement root = AutomationElement.RootElement;
AutomationElement about_notepad_windows = root.FindFirst(
    TreeScope.Descendants,
    new AndCondition(
        new PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.Window),
        new PropertyCondition(AutomationElement.NameProperty, "About Notepad")));
if (about_notepad_windows == null)
{
    Console.WriteLine("About Notepad window doesn't exist!!");
    return;
}

AutomationElement ok_button = about_notepad_windows.FindFirst(
    TreeScope.Children,
    new AndCondition(
        new PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.Button),
        new PropertyCondition(AutomationElement.NameProperty, "OK")));
Object invokePatternObject;
if (ok_button.TryGetCurrentPattern(InvokePattern.Pattern, out invokePatternObject))
{
    (invokePatternObject as InvokePattern).Invoke();
}

好吧，上面是面向過程的代碼，不利於復用，那么讓我們來將其抽象成類，

首先定義一個基類UIAControl，它包含有搜索的根節點searchRoot，搜索范圍searchScope和條件searchConditions，使用這三個對象來搜索一個AutomationElement對象並將其賦給innerElement，由於默認使用的是AndCondition來關聯所有傳入的condition對象，所以將CombineCondition方法設為虛方法，以便如果有子類想要使用其他關聯條件處理condition的時候可以覆蓋：

public abstract class UIAControl
{
    private UIAControl searchRoot;
    private TreeScope searchScope;
    private List<Condition> searchConditions;

    protected void AddSearchCondition(Condition condition)
    {
        this.searchConditions.Add(condition);
    }

    public UIAControl()
    {
        searchConditions = new List<Condition>();
        searchScope = TreeScope.Descendants;
    }

    public UIAControl(UIAControl searchRoot)
        : this()
    {
        this.searchRoot = searchRoot;
    }

    public UIAControl(IntPtr hwnd)
        : this()
    {
        searchConditions.Add(PropertyConditionFactory.GetHandleCondition(hwnd));
    }

    public AutomationElement.AutomationElementInformation? ControlInformation
    {
        get
        {
            if (Exists())
            {
                return InnerElement.Current;
            }
            return null;
        }
    }

    private AutomationElement innerElement;
    public AutomationElement InnerElement
    {
        get
        {
            if (innerElement == null)
            {
                innerElement = SearchElement();
            }
            return innerElement;
        }
    }

    protected virtual AutomationElement SearchElement()
    {
        AutomationElement ele = null;
        if (searchRoot == null)
        {
            ele = AutomationElement.RootElement;
        }
        else
        {
            ele = searchRoot.InnerElement;
        }

        if (ele == null || 0 == searchConditions.Count)
        {
            return ele;
        }
        else
        {
            Condition conditions = CombineAllConditions();
            try
            {
                return ele.FindFirst(searchScope, conditions);
            }
            catch(Exception ex)
            {
                Console.WriteLine("Getting exception when searching element: " + ex.Message);
                return null;
            }
        }
    }

    //Can override this method to return other type conditions, default will return AndCondition
    protected virtual Condition CombineAllConditions()
    {
        if (searchConditions.Count > 1)
        {
            return new AndCondition(searchConditions.ToArray());
        }
        else if (searchConditions.Count == 1)
        {
            return searchConditions.First();
        }
        else
        {
            return null;
        }

    }

    public virtual bool Exists()
    {
        //Before checking existence, set innerElement to null to trigger fresh search.
        return null != SearchElement();
    }

    public bool WaitTillExist(int timeout, int interval = 2000)
    {
        Stopwatch stopwatch = new Stopwatch();
        stopwatch.Start();
        while (stopwatch.ElapsedMilliseconds < timeout)
        {
            if (this.Exists())
            {
                return true;
            }

            Thread.Sleep(interval);
        }

        return false;
    }

    protected bool CallPattern<T>(T pattern, Action<T> action) where T : BasePattern
    {
        if (pattern != null)
        {
            try
            {
                action(pattern);
                return true;
            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.Message);
            }
        }
        return false;
    }

    protected T GetPattern<T>() where T : BasePattern
    {
        var ele = InnerElement;
        if (ele != null)
        {
            try
            {
                var patternIdentifier = (AutomationPattern)(typeof(T).GetField("Pattern").GetValue(null));
                return ele.GetCurrentPattern(patternIdentifier) as T;
            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.Message);
            }
        }
        return null;
    }

    public bool Invoke()
    {
        return CallPattern(GetPattern<InvokePattern>(), (pattern) => pattern.Invoke());
    }
}

 

之后，就可以定義其他控件類型了，下面定義了一個button的對象，只有一個click方法：

    public class UIAButton : UIAControl
    {
        public UIAButton(UIAControl root, string name)
            : base(root)
        {
            AddSearchCondition(PropertyConditionFactory.GetNameCondition(name));
            AddSearchCondition(PropertyConditionFactory.GetControlTypeCondition(ControlType.Button));
        }

        public void Click()
        {
            this.Invoke();
        }
    }

 

再定義一個window對象：

    public class UIAWindow : UIAControl
    {
        public UIAWindow(string name)
        {
            AddSearchCondition(PropertyConditionFactory.GetNameCondition(name));
            AddSearchCondition(PropertyConditionFactory.GetControlTypeCondition(ControlType.Window));
        }

        public bool Close()
        {
            return CallPattern(GetPattern<WindowPattern>(), (pattern) => pattern.Close());
        }

        public bool Maximize()
        {
            return CallPattern(GetPattern<WindowPattern>(), (pattern) => pattern.SetWindowVisualState(WindowVisualState.Maximized));
        }

        public bool Minimize()
        {
            return CallPattern(GetPattern<WindowPattern>(), (pattern) => pattern.SetWindowVisualState(WindowVisualState.Minimized));
        }

        public bool Resize(int width, int height)
        {
            return CallPattern(GetPattern<TransformPattern>(), (pattern) => pattern.Resize(width, height));
        }
    }

最后，使用上面兩個控件類型來完成Ok按鈕的點擊：

UIAWindow windows = new UIAWindow("About Notepad");
UIAButton ok_button = new UIAButton(windows, "OK");
if (windows.WaitTillExist(3000))
{
    ok_button.Click();
}

 

當然，如果是稍微上點規模的項目，就需要利用這些控件抽象出一個對應產品功能的produc類了。

如果不想從頭寫起的話，可以看看開源工具White， 一個優秀的基於UI Automation的測試框架。