Codeer Friendlyを使ったC#WPFのユニットテストで、LabelのRaiseEventメソッドを呼び出すことってできますかね？

Question

実現したいこと

Codeer Friendlyに入門しました。従来FlaUIを使ってユニットテストしていたのですが事情があってFriendlyに乗り換えようか検討中です。素晴らしいライブラリだと思うので乗り換えたいのですが、ある壁にぶつかっており乗り換えの決心がつかない状況です。掲題の課題が実現できるとありがたいのですが、実現できるか否か、実現できるならばどうすればいいか、アドバイスいただける方いらっしゃるでしょうか？

やりたいことは、テスト対象のLabelにMouse.MouseUpEventが投げられたように見せかけることです。

発生している問題・分からないこと

LabelのRaiseEventメソッドを呼び出してみようとしているのですが「'MouseButtonEventArgs' はシリアル化可能として設定されていません。」というエラーになってしまいます。

該当のソースコード

<!-- テスト対象プログラム -->
<Window x:Class="WpfApp1.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:WpfApp1"
        mc:Ignorable="d"
        Title="MainWindow" Height="200" Width="300">
    <Grid>
        <Button x:Name="button1" Content="length">
            <Button.ContextMenu>
                <ContextMenu>
                    <Label x:Name="menu1" Content="ft" MouseUp="OnMouseUp"/>
                    <Label Content="m" MouseUp="OnMouseUp"/>
                </ContextMenu>
            </Button.ContextMenu>
        </Button>
    </Grid>
</Window>

// テスト対象プログラム
using System.Diagnostics;
using System.Windows;
using System.Windows.Input;

namespace WpfApp1
{
    /// <summary>
    /// MainWindow.xaml の相互作用ロジック
    /// </summary>
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private void OnMouseUp(object sender, MouseButtonEventArgs e)
        {
            Debug.WriteLine("OnMouseUp");
        }
    }
}

// ユニットテストのためのテスト対象プログラムのドライバ
using System.Windows;
using System.Windows.Controls.Primitives;
using Codeer.Friendly.Windows.Grasp;
using RM.Friendly.WPFStandardControls;

namespace WpfControlLibrary.Tests
{
    internal class WpfApp1Driver
    {
        public WindowControl MainWindow { get; private set; }
        public IWPFDependencyObjectCollection<DependencyObject> LogicalTree { get; }
        public WPFButtonBase Button1 { get; private set; }

        public WpfApp1Driver(WindowControl w)
        {
            MainWindow = w;
            LogicalTree = w.LogicalTree();

            var btn = LogicalTree.ByType<ButtonBase>().ByName("button1").Single();
            Button1 = new WPFButtonBase(btn);
        }
    }
}

// ユニットテスト
using Microsoft.VisualStudio.TestTools.UnitTesting;

using Codeer.Friendly.Dynamic;
using Codeer.Friendly.Windows;
using Codeer.Friendly.Windows.Grasp;
using RM.Friendly.WPFStandardControls;
using System.Diagnostics;
using System.Windows.Input;

namespace WpfControlLibrary.Tests
{
    [TestClass()]
    public class WpfApp1Tests
    {
        private WindowsAppFriend _app;
        private WindowControl _win;
        private WpfApp1Driver _drv;

        [TestInitialize]
        public void Initialize()
        {
            var path = System.IO.Path.GetFullPath(@"..\..\..\WpfApp1\bin\Debug\WpfApp1.exe");
            _app = new WindowsAppFriend(Process.Start(path));
            _win = _app.IdentifyFromTypeFullName("WpfApp1.MainWindow");
            _drv = new WpfApp1Driver(_win);
        }

        [TestCleanup]
        public void Cleanup()
        {
            _app.Dispose();

            Process process = Process.GetProcessById(_app.ProcessId);
            process.CloseMainWindow();
        }

        [TestMethod()]
        public void WpfApp1Test_01()
        {
            _drv.Button1.EmulateClick();

            var contextMenus = _win.VisualTreeWithPopup().ByType("System.Windows.Controls.ContextMenu");
            var contextMenu = contextMenus[0];
            var labels = contextMenu.LogicalTree().ByType("System.Windows.Controls.Label");
            var label = new WPFContentControl(labels[0]);
            Debug.WriteLine($"label text = {label.Content}");

            // これでは「MouseButtonEventArgs' はシリアル化可能として設定されていません。」になってしまう。どうすればLabelにMouse.MouseUpEventを通知できるのか？
            label.Dynamic().RaiseEvent(new MouseButtonEventArgs(Mouse.PrimaryDevice, 0, MouseButton.Right)
            {
                RoutedEvent = Mouse.MouseUpEvent,
                Source = this,
            });
        }
    }
}

試したこと・調べたこと

• teratailやGoogle等で検索した
• ソースコードを自分なりに変更した
• 知人に聞いた
• その他

上記の詳細・結果

本家サイトを拝見したり、GoogleでCodeer Friendlyのサンプルプログラムをあさったりしたのですが、該当する例を見つけることができていません。

補足

特になし

Answer 1

作者です。ご利用ありがとうございます。

前の方が書いてくれているように対象プロセスの中にMouseButtonEventArgsを生成する必要があります。Friendlyで対象プロセスのメソッドやプロパティの引数に渡せるものは以下のものです。

• シリアライズ可能なもの
• 対象プロセスの中のオブジェクト

MouseButtonEventArgsはシリアライズできないのでテストプロセスからWPFのプロセスへ引き渡すことができません。そのため対象プロセスの中に生成してそれを渡す必要があります。

この辺はややこしいのですが、Friendlyはプロセス越しにAPIを直接呼び出すのでそのオブジェクトがどちらのプロセスに存在するのか、どのように引き渡すのかがポイントになってきます。

それからやりたいことを実現する手段が他にもあるのでそれも書いておきます。
引き続き、ご利用よろしくお願いします。

テスト自動化支援サービスも弊社でやってますのでよろしければそちらもご利用ください。

[Test]
[Apartment(ApartmentState.STA)]
public void TestMethod1()
{
    var app = new WindowsAppFriend(Process.GetProcessesByName("WpfApp1").First());
    var window = new WindowControl(app.Type<Application>().Current.MainWindow);

    //右クリックはCodeer.Friendly.Windows.KeyMouseでエミュレート
    var button1 = new WPFButtonBase(window.Dynamic().button1);
    button1.Click(MouseButtonType.Right);

    var contextMenus = window.VisualTreeWithPopup().ByType("System.Windows.Controls.ContextMenu");
    var contextMenu = contextMenus[0];
    var labels = contextMenu.LogicalTree().ByType("System.Windows.Controls.Label");
    var label = new WPFContentControl(labels[0]);

    //①これがおそらく書きたかったもの
    var primaryDevice = app.Type(typeof(Mouse)).PrimaryDevice;
    var e = app.Type<MouseButtonEventArgs>()(primaryDevice, 0, MouseButton.Right);
    e.RoutedEvent = app.Type(typeof(Mouse)).MouseUpEvent;
    e.Source = label;
    label.Dynamic().RaiseEvent(e);

    //②Codeer.Friendly.Windows.KeyMouseでエミュレートしてもOK
    label.Click();

    //③-1 直接呼ぶこともできます
    window.Dynamic().OnMouseUp(label, e);

    //③-2 特に引数つかってなかったらズルしてもいい
    window.Dynamic().OnMouseUp(null, null);
}

Comments

[jiro.kaihatsu]

ずばりの回答ありがとうございました。
やりたかったことがバッチリできました。感動です。
これでFlaUIから乗り換えられそうです。

[codeer-ishikawa]

よかったっす。引き続きご利用よろしくお願います！

Answer 2

LabelのRaiseEventメソッドを呼び出してみようとしているのですが「'MouseButtonEventArgs' はシリアル化可能として設定されていません。」というエラーになってしまいます。

この辺にさらっと書いてありますが、MouseButtonEventArgs（やパラメータ）を相手側で作ればいいようです（めんどくさｗ
Friendly/README 対象プロセス内でのインスタンス生成(Any OK)
Friendly/README static操作の呼び出し(Any OK)

やりたいことは、テスト対象のLabelにMouse.MouseUpEventが投げられたように見せかけることです。

そんなまどろっこしいことをするより、直接クリックすればいいのでは？
NuGet Gallery | Codeer.Friendly.Windows.KeyMouse
Codeer-Software/Friendly.Windows.KeyMouse: Emulate key and mouse operation.

---

<Window
  x:Class="WpfApp1.MainWindow"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  Width="300"
  Height="200">
  <Grid>
    <Button x:Name="button1" Click="Button1_Click" Content="length">
      <Button.ContextMenu>
        <ContextMenu>
          <Label x:Name="menu1" Content="ft" MouseUp="OnMouseUp" />
          <Label Content="m" MouseUp="OnMouseUp" />
        </ContextMenu>
      </Button.ContextMenu>
    </Button>
  </Grid>
</Window>

using System.Windows;
using System.Windows.Input;

namespace WpfApp1
{
    public partial class MainWindow : Window
    {
        public MainWindow() => InitializeComponent();

        private void OnMouseUp(object sender, MouseButtonEventArgs e)
            => button1.Content = e.Source.ToString();

        private void Button1_Click(object sender, RoutedEventArgs e)
            => button1.Content = "Button1_Click";
    }
}

using Codeer.Friendly.Dynamic;
using Codeer.Friendly.Windows;
using Codeer.Friendly.Windows.Grasp;
using RM.Friendly.WPFStandardControls;

namespace WpfControlLibrary1
{
    public class WpfApp1Driver
    {
        public WindowControl MainWindow { get; }
        public WPFButtonBase Button1 => MainWindow.Dynamic().button1;
        public WPFContentControl Menu1 => MainWindow.Dynamic().menu1;

        public WpfApp1Driver(WindowControl w) => MainWindow = w;
    }

    public static class WpfApp1DriverExtensions
    {
        public static WpfApp1Driver AttachMainWindow(this WindowsAppFriend app)
            => new WpfApp1Driver(app.WaitForIdentifyFromTypeFullName("WpfApp1.MainWindow"));
    }
}

using System.Diagnostics;
using System.IO;
using System.Windows.Input;
using Codeer.Friendly.Dynamic;
using Codeer.Friendly.Windows;
using Codeer.Friendly.Windows.KeyMouse;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using WpfControlLibrary1;

namespace UnitTestProject1
{
    [TestClass]
    public class WpfApp1Tests
    {
        private WindowsAppFriend _app;
        private WpfApp1Driver _drv;

        [TestInitialize]
        public void Initialize()
        {
            var path = Path.GetFullPath(@"..\..\..\WpfApp1\bin\Debug\WpfApp1.exe");
            _app = new WindowsAppFriend(Process.Start(path));
            _drv = _app.AttachMainWindow();
        }
        [TestCleanup] public void Cleanup() => Process.GetProcessById(_app.ProcessId).CloseMainWindow();


        [TestMethod]
        public void WpfApp1Test_01()
        {
            _drv.Button1.EmulateClick();
            Assert.AreEqual("Button1_Click", (string)_drv.Button1.Dynamic().Content);

            var primaryDevice = _app.Type(typeof(Mouse)).PrimaryDevice;
            var mouseUpEvent = _app.Type(typeof(Mouse)).MouseUpEvent;
            var args = _app.Type<MouseButtonEventArgs>()(primaryDevice, 0, MouseButton.Right);
            args.RoutedEvent = mouseUpEvent;
            args.Source = _drv.Menu1;
            _drv.Menu1.Dynamic().RaiseEvent(args);

            Assert.AreEqual("System.Windows.Controls.Label: ft", (string)_drv.Button1.Dynamic().Content);
        }

        [TestMethod]
        public void WpfApp1Test_02()
        {
            _drv.Button1.EmulateClick();
            Assert.AreEqual("Button1_Click", (string)_drv.Button1.Dynamic().Content);

            _drv.Button1.Click(MouseButtonType.Right, 50, 50);
            _drv.Menu1.Click(MouseButtonType.Left, 10, 10);
            Assert.AreEqual("System.Windows.Controls.Label: ft", (string)_drv.Button1.Dynamic().Content);
        }
    }
}

Comments

[TN8001]

ContextMenuには通常MenuItemを入れますが、Labelなのは何か理由があるのでしょうか？

[jiro.kaihatsu]

テスト対象はソースを変更できないものなんです。理由は分かりませんが、MenuItemを使っていませんでした。MenuItemだとRM.Friendly.WPFStandardControls でEmulateClick()できるので楽なんですが。

[TN8001]

> テスト対象はソースを変更できないものなんです。

なるほど触れないんですね^^;

> MenuItemだとRM.Friendly.WPFStandardControls でEmulateClick()できるので楽なんですが。

わたしもそう思っていましたｗ
KeyMouseはLabelだろうがクリックできて簡単でしたよ^^

[jiro.kaihatsu]

迅速アドバイスありがとうございました。
アドバイスに基づき試していたのですが、使い方？文法が理解できていなくてもたもたしていたのですが、作者さんからずばり回答をいただきやりたかったことができるようになりました。
助かりました！
（追伸）
var primaryDevice = app.Type(typeof(Mouse)).PrimaryDevice;
ができていませんでした。

[TN8001]

> アドバイスに基づき試していたのですが、使い方？文法が理解できていなくてもたもたしていた

回答に対する疑問はすぐにコメントいただいて結構ですよ。
こっちも「回答のコメントだけ見て回答内容見てないのかな？？」とやきもきしますのでｗ

> 作者さんからずばり回答をいただきやりたかったことができるようになりました。

わたしも同じこと書いてますけどね^^;
いやjiro.kaihatsuさんやcodeer-ishikawaさんに不満を垂れているわけではないですｗ
作者直々に回答があるならこの先も心強いですね^^

> （追伸）
> var primaryDevice = app.Type(typeof(Mouse)).PrimaryDevice;
> ができていませんでした。

これは「回答との差分が分かりずらくその行を飛ばしてしまった」という意味ですか？？
単刀直入な短い回答とエビデンスのある完動コードに分けるべきでしたかorz

[jiro.kaihatsu]

恥ずかしながら、C#の文法を誤解していることに気付かず的外れな場所を調べてました。答えが分かった時は自分にガッカリしました