|
| 1 | +using CommunityToolkit.Mvvm.Messaging; |
| 2 | +using Modulus.UI.Abstractions; |
| 3 | +using Modulus.UI.Abstractions.Messages; |
| 4 | +using NSubstitute; |
| 5 | + |
| 6 | +namespace Modulus.Hosts.Tests; |
| 7 | + |
| 8 | +/// <summary> |
| 9 | +/// Tests for ShellViewModel message handling for menu items. |
| 10 | +/// These tests verify the behavior of MenuItemsRemovedMessage handling |
| 11 | +/// which is critical for cleaning up menus when modules are unloaded. |
| 12 | +/// </summary> |
| 13 | +public class ShellViewModelTests : IDisposable |
| 14 | +{ |
| 15 | + private readonly IMenuRegistry _menuRegistry; |
| 16 | + private readonly TestableShellViewModel _viewModel; |
| 17 | + |
| 18 | + public ShellViewModelTests() |
| 19 | + { |
| 20 | + _menuRegistry = Substitute.For<IMenuRegistry>(); |
| 21 | + _menuRegistry.GetItems(MenuLocation.Main).Returns(new List<MenuItem>()); |
| 22 | + _menuRegistry.GetItems(MenuLocation.Bottom).Returns(new List<MenuItem>()); |
| 23 | + |
| 24 | + _viewModel = new TestableShellViewModel(_menuRegistry); |
| 25 | + } |
| 26 | + |
| 27 | + public void Dispose() |
| 28 | + { |
| 29 | + WeakReferenceMessenger.Default.UnregisterAll(_viewModel); |
| 30 | + } |
| 31 | + |
| 32 | + [Fact] |
| 33 | + public void Receive_MenuItemsRemovedMessage_RemovesMenuItemsFromMainMenu() |
| 34 | + { |
| 35 | + // Arrange |
| 36 | + const string moduleId = "test-module"; |
| 37 | + var menuItem = new MenuItem("menu1", "Test Menu", IconKind.Home, "/test", MenuLocation.Main) |
| 38 | + { |
| 39 | + ModuleId = moduleId |
| 40 | + }; |
| 41 | + _viewModel.MainMenuItems.Add(menuItem); |
| 42 | + _viewModel.MainMenuItems.Add(new MenuItem("other", "Other", IconKind.Home, "/other", MenuLocation.Main)); |
| 43 | + |
| 44 | + // Act |
| 45 | + _viewModel.Receive(new MenuItemsRemovedMessage(moduleId)); |
| 46 | + |
| 47 | + // Assert |
| 48 | + Assert.Single(_viewModel.MainMenuItems); |
| 49 | + Assert.DoesNotContain(_viewModel.MainMenuItems, m => m.ModuleId == moduleId); |
| 50 | + } |
| 51 | + |
| 52 | + [Fact] |
| 53 | + public void Receive_MenuItemsRemovedMessage_RemovesMenuItemsFromBottomMenu() |
| 54 | + { |
| 55 | + // Arrange |
| 56 | + const string moduleId = "test-module"; |
| 57 | + var menuItem = new MenuItem("menu1", "Settings", IconKind.Settings, "/settings", MenuLocation.Bottom) |
| 58 | + { |
| 59 | + ModuleId = moduleId |
| 60 | + }; |
| 61 | + _viewModel.BottomMenuItems.Add(menuItem); |
| 62 | + _viewModel.BottomMenuItems.Add(new MenuItem("other", "Other", IconKind.Settings, "/other", MenuLocation.Bottom)); |
| 63 | + |
| 64 | + // Act |
| 65 | + _viewModel.Receive(new MenuItemsRemovedMessage(moduleId)); |
| 66 | + |
| 67 | + // Assert |
| 68 | + Assert.Single(_viewModel.BottomMenuItems); |
| 69 | + Assert.DoesNotContain(_viewModel.BottomMenuItems, m => m.ModuleId == moduleId); |
| 70 | + } |
| 71 | + |
| 72 | + [Fact] |
| 73 | + public void Receive_MenuItemsRemovedMessage_IgnoresUnrelatedModules() |
| 74 | + { |
| 75 | + // Arrange |
| 76 | + const string moduleId1 = "module-1"; |
| 77 | + const string moduleId2 = "module-2"; |
| 78 | + |
| 79 | + var menu1 = new MenuItem("menu1", "Menu 1", IconKind.Home, "/test1", MenuLocation.Main) |
| 80 | + { |
| 81 | + ModuleId = moduleId1 |
| 82 | + }; |
| 83 | + var menu2 = new MenuItem("menu2", "Menu 2", IconKind.Home, "/test2", MenuLocation.Main) |
| 84 | + { |
| 85 | + ModuleId = moduleId2 |
| 86 | + }; |
| 87 | + _viewModel.MainMenuItems.Add(menu1); |
| 88 | + _viewModel.MainMenuItems.Add(menu2); |
| 89 | + |
| 90 | + // Act - Remove only module-1's menus |
| 91 | + _viewModel.Receive(new MenuItemsRemovedMessage(moduleId1)); |
| 92 | + |
| 93 | + // Assert - module-2's menu should remain |
| 94 | + Assert.Single(_viewModel.MainMenuItems); |
| 95 | + Assert.Contains(_viewModel.MainMenuItems, m => m.ModuleId == moduleId2); |
| 96 | + Assert.DoesNotContain(_viewModel.MainMenuItems, m => m.ModuleId == moduleId1); |
| 97 | + } |
| 98 | + |
| 99 | + [Fact] |
| 100 | + public void Receive_MenuItemsRemovedMessage_RemovesMultipleItemsFromSameModule() |
| 101 | + { |
| 102 | + // Arrange |
| 103 | + const string moduleId = "multi-menu-module"; |
| 104 | + |
| 105 | + _viewModel.MainMenuItems.Add(new MenuItem("m1", "Menu 1", IconKind.Home, "/1") { ModuleId = moduleId }); |
| 106 | + _viewModel.MainMenuItems.Add(new MenuItem("m2", "Menu 2", IconKind.Home, "/2") { ModuleId = moduleId }); |
| 107 | + _viewModel.MainMenuItems.Add(new MenuItem("m3", "Menu 3", IconKind.Home, "/3") { ModuleId = moduleId }); |
| 108 | + _viewModel.MainMenuItems.Add(new MenuItem("other", "Other", IconKind.Home, "/other") { ModuleId = "other-module" }); |
| 109 | + |
| 110 | + // Act |
| 111 | + _viewModel.Receive(new MenuItemsRemovedMessage(moduleId)); |
| 112 | + |
| 113 | + // Assert |
| 114 | + Assert.Single(_viewModel.MainMenuItems); |
| 115 | + Assert.Equal("other-module", _viewModel.MainMenuItems.First().ModuleId); |
| 116 | + } |
| 117 | + |
| 118 | + [Fact] |
| 119 | + public void Receive_MenuItemsRemovedMessage_HandlesEmptyCollections() |
| 120 | + { |
| 121 | + // Arrange - collections are empty by default |
| 122 | + Assert.Empty(_viewModel.MainMenuItems); |
| 123 | + Assert.Empty(_viewModel.BottomMenuItems); |
| 124 | + |
| 125 | + // Act - should not throw |
| 126 | + var exception = Record.Exception(() => |
| 127 | + _viewModel.Receive(new MenuItemsRemovedMessage("non-existent"))); |
| 128 | + |
| 129 | + // Assert |
| 130 | + Assert.Null(exception); |
| 131 | + Assert.Empty(_viewModel.MainMenuItems); |
| 132 | + Assert.Empty(_viewModel.BottomMenuItems); |
| 133 | + } |
| 134 | + |
| 135 | + [Fact] |
| 136 | + public void Receive_MenuItemsRemovedMessage_RemovesFromBothMenusSimultaneously() |
| 137 | + { |
| 138 | + // Arrange |
| 139 | + const string moduleId = "test-module"; |
| 140 | + |
| 141 | + _viewModel.MainMenuItems.Add(new MenuItem("main1", "Main", IconKind.Home, "/main") { ModuleId = moduleId }); |
| 142 | + _viewModel.BottomMenuItems.Add(new MenuItem("bottom1", "Bottom", IconKind.Settings, "/bottom") { ModuleId = moduleId }); |
| 143 | + |
| 144 | + // Act |
| 145 | + _viewModel.Receive(new MenuItemsRemovedMessage(moduleId)); |
| 146 | + |
| 147 | + // Assert |
| 148 | + Assert.Empty(_viewModel.MainMenuItems); |
| 149 | + Assert.Empty(_viewModel.BottomMenuItems); |
| 150 | + } |
| 151 | +} |
| 152 | + |
| 153 | +/// <summary> |
| 154 | +/// Testable ShellViewModel that mimics the behavior of both Blazor and Avalonia ShellViewModels |
| 155 | +/// for message handling. This isolates the menu removal logic for unit testing. |
| 156 | +/// </summary> |
| 157 | +internal class TestableShellViewModel : IRecipient<MenuItemsRemovedMessage> |
| 158 | +{ |
| 159 | + private readonly IMenuRegistry _menuRegistry; |
| 160 | + |
| 161 | + public System.Collections.ObjectModel.ObservableCollection<MenuItem> MainMenuItems { get; } = new(); |
| 162 | + public System.Collections.ObjectModel.ObservableCollection<MenuItem> BottomMenuItems { get; } = new(); |
| 163 | + |
| 164 | + public TestableShellViewModel(IMenuRegistry menuRegistry) |
| 165 | + { |
| 166 | + _menuRegistry = menuRegistry; |
| 167 | + WeakReferenceMessenger.Default.Register(this); |
| 168 | + } |
| 169 | + |
| 170 | + /// <summary> |
| 171 | + /// Handle incremental menu removal - mirrors the implementation in ShellViewModel. |
| 172 | + /// </summary> |
| 173 | + public void Receive(MenuItemsRemovedMessage message) |
| 174 | + { |
| 175 | + var mainToRemove = MainMenuItems.Where(m => m.ModuleId == message.ModuleId).ToList(); |
| 176 | + foreach (var item in mainToRemove) |
| 177 | + { |
| 178 | + MainMenuItems.Remove(item); |
| 179 | + } |
| 180 | + |
| 181 | + var bottomToRemove = BottomMenuItems.Where(m => m.ModuleId == message.ModuleId).ToList(); |
| 182 | + foreach (var item in bottomToRemove) |
| 183 | + { |
| 184 | + BottomMenuItems.Remove(item); |
| 185 | + } |
| 186 | + } |
| 187 | +} |
| 188 | + |
0 commit comments