WPF PrismでコンストラクタにIRegionManagerを指定するViewModelをxUnitでテストしたい

Question

■環境
Windows 10 Pro 21H2 64bit 日本語版 build 19044.1387
Visual Studio Professional 2019 日本語版 ver.16.11.7
Prism Template Pack 2.3.0
.NET 5.0
Prism.Core 8.1.97

■質問の概要
PrismでViewModelのユニットテストを行う際に参考になるwebサイトや書籍があったらご紹介頂きたく思います。

■課題
WPF/Prism/MVVM/DIを一度に学習しはじめて、わけわからないことになってます...
そのうちの1つについて質問したく思います。

Prismのサンプルコードにある

public HogeViewModel(IRegionManager regionManager)
{
	_regionManager = regionManager;

	MyCommand = new DelegateCommand(() =>
	{
		_regionManager.RequestNavigate("ContentRegion", nameof(FooView));
	});
}

みたいなViewModelについて、xUnitでユニットテストしようと思っています。

「Prism IRegionManager for test implementation」で検索をかけたところ、例えば以下のようなページが見つかりました。
https://github.com/PrismLibrary/Prism/issues/65
しかし本issueはクローズされており、中に出てくるMockRegionManagerで検索をかけても、実際にViewModelのコンストラクタに渡すインスタンスを生成しているコードが見つかりませんでした。

「IRegionManager Mock」で検索をかけたところ、以下のようなページが見つかりました。
https://stackoverflow.com/questions/62445269/unable-to-mock-regionmanager-activeviews-first
これを見るに、Moqというライブラリを使って必要なインターフェースを実体化すれば良さそうに思えます。しかし今度は見慣れない「IViewsCollection」というものが出てきました。こちらはdocs.microsoft.comにドキュメントページがありましたが、記述がほぼ何もない状態で、ユニットテストにとって何のために必要なのか、上記StackOverflowで示されるコードが自身のユニットテストにとって過不足ないのかどうかがよくわかりませんでした。

PrismにおけるViewModelのユニットテストについて、網羅的に扱っているwebサイトや電子書籍はないでしょうか。

Comments

[ry188472]

間違っていたらすみません。IRegionManagerをDIしたい理由は画面遷移のためでしょうか？

[ttact]

はい。Prismのサンプルコードで見た感じで、IRegionManagerはページ（ウィンドウの一部）を別のUserControlに切り替えるためのもの、と理解しております。

[TN8001]

テンプレートの「Prism Full App」で作ると、

FullApp1.Modules.ModuleName.Tests.ViewModelsアセンブリ（Testsフォルダの中）に、

_regionManagerMock = new Mock<IRegionManager>();
や
var vm = new ViewAViewModel(_regionManagerMock.Object, _messageServiceMock.Object);

のようなコードが作られますが、そういう話ですか？

[ttact]

>TN8001さん
IRegionManagerについては、まさにこれです！...公式のテンプレートでもMoqを使っているんですね。

IViewsCollectionの件や網羅的な内容の紹介については引き続き募集しますので、まだクローズしません。

Answer 1

ry188472さん、TN8001さん、コメントとご回答をありがとうございます。大変参考になりました。

私が今扱っているシステムでは、やはり画面遷移をテストしたい、かつ現下のビューを表示しているリージョンとは異なるリージョンに対する指示を確認したい、ということがわかりました。
そのためやはりIRegionManagerは欲しいということで、お二方に頂いた情報を元に、以下のようにテストを組みました。

(1)
xUnitプロジェクトを作成。Nugetパッケージとして以下を追加：

• Prism.Core
• Moq

(2)
以下のようにテストを記述。NextCommandはMainWindowViewModel.RegionNameで識別されるリージョンにView2を表示するはずのコマンドです。

public void Test1()
{
    var regionManagerMock = new Mock<IRegionManager>();
    var vm = new View1ViewModel(regionManager.Object);
    vm.NextCommand.Execute(null);
    regionManagerMock.Verify(r => r.RequestNavigate(MainWindowViewModel.RegionName, nameof(View2)), Times.Once);
}

ただしこれですと、IConfirmNavigationRequest.ConfirmNavigationRequest()にて遷移をキャンセルした際に実際にリージョンに設定されているビューが確認できません。それは今後の課題ということで、PrismやMoqの詳細を調べて解決しようと思います。

Comments

[ttact]

IViewsCollectionについてはどうしてもわからないので、一旦諦めました。。。

Answer 2

期待された回答ではないかもしれませんが、Prismを使って画面遷移する場合、VMはINavigationAwareインターフェイスを実装し、画面遷移後にOnNavigatedToメソッドでIRegionNavigationServiceの実体をnavigationContext.NavigationServiceから取得する方法をおすすめします。

https://qiita.com/kwhrkzk/items/719354e86a15ccac7296
https://webbibouroku.com/Blog/Article/prism-navigation#outline__3
https://elf-mission.net/programming/wpf/episode07/

この方法ですとINavigationAwareはコンストラクタインジェクションする必要がありませんので、テスト時に困ることはありません（ただしINavigationAwareのセットはコンストラクタ後になるため、.NET5以降でNullable=enable設定の場合は初期値をnull!にしないと警告が出る）。

また、私は画面遷移そのものはテストしません。それはPrismの責務のためです。画面遷移関係でテスト実装するのは「画面遷移のきっかけになるボタン押し等イベントのテスト（イベント発生可否等）」「画面遷移先の決定処理」「渡すデータの生成ロジック」「遷移先画面のデータ受領処理」にしています。これらがOKならPrismによる画面遷移自体は成功するためです。ただこれらはprivate/protectedメソッドになっていることがあるのでChainingAssersion等で無理やりテストしており、もっとよい方法があるのかもしれません。

Comments

[ttact]

Prismでの画面遷移全般について、非常に参考になるページをご紹介頂きありがとうございます！
このコメントを書いている段階では、まだ直接的な回答を募集しておりますのでベストアンサーにはしませんが、2番目のURLの記事にある内容が別の悩み事だった「ViewModelにViewのクラス名を記述する」という事柄に対する回避策を示して下さっているので、とても助かりました。

[ttact]

なお画面遷移のテストの件ですが、ユーザーとダイアログで対話しつつ一連の処理を流すシーケンスについてのテスト要件がシステム的にあることがわかっているので、そのシーケンスに対するテストとして必要かもしれないと思って調査しております。まだPrismのDialog Serviceのドキュメントを読んでないので、そこがわかったらまた話が変わるかもしれませんが。。。