-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAlarmStateRelayTests.cs
More file actions
475 lines (404 loc) · 21.6 KB
/
Copy pathAlarmStateRelayTests.cs
File metadata and controls
475 lines (404 loc) · 21.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging.Abstractions;
using NSubstitute;
using NSubstitute.ExceptionExtensions;
using RustPlusBot.Abstractions.Connections;
using RustPlusBot.Abstractions.Events;
using RustPlusBot.Abstractions.Time;
using RustPlusBot.Domain.Alarms;
using RustPlusBot.Features.Alarms.Posting;
using RustPlusBot.Features.Alarms.Relaying;
using RustPlusBot.Features.Connections.Listening;
using RustPlusBot.Features.Workspace.Locating;
using RustPlusBot.Localization;
using RustPlusBot.Persistence.Alarms;
using RustPlusBot.Persistence.Workspace;
namespace RustPlusBot.Features.Alarms.Tests;
/// <summary>Unit tests for <see cref="AlarmStateRelay"/>.</summary>
public sealed class AlarmStateRelayTests
{
private static readonly DateTimeOffset _fixedNow = new(2025, 6, 1, 12, 0, 0, TimeSpan.Zero);
private static Harness Create(SmartAlarm? alarm = null, ulong? channelId = 777UL)
{
var store = Substitute.For<IAlarmStore>();
var workspace = Substitute.For<IWorkspaceStore>();
workspace.GetCultureAsync(Arg.Any<ulong>(), Arg.Any<CancellationToken>()).Returns("en");
var services = new ServiceCollection();
services.AddScoped(_ => store);
services.AddScoped(_ => workspace);
var provider = services.BuildServiceProvider();
var scopeFactory = provider.GetRequiredService<IServiceScopeFactory>();
var refresher = Substitute.For<IAlarmRefresher>();
var locator = Substitute.For<IAlarmChannelLocator>();
locator.GetChannelIdAsync(Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<CancellationToken>())
.Returns(channelId);
var poster = Substitute.For<IAlarmChannelPoster>();
var teamChatSender = Substitute.For<IBotTeamChatSender>();
teamChatSender
.SendAsync(Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<string>(), Arg.Any<CancellationToken>())
.Returns(TeamChatSendResult.Sent);
var alarmLocalizer = new ResxLocalizer();
var clock = Substitute.For<IClock>();
clock.UtcNow.Returns(_fixedNow);
if (alarm is not null)
{
store.GetAsync(alarm.GuildId, alarm.ServerId, alarm.EntityId, Arg.Any<CancellationToken>())
.Returns(alarm);
}
var relay = new AlarmStateRelay(
scopeFactory,
refresher,
new AlarmRelayChannels(locator, poster, teamChatSender),
alarmLocalizer,
clock,
NullLogger<AlarmStateRelay>.Instance);
return new Harness(relay, store, refresher, poster, teamChatSender);
}
// ──────────────────────────────────────────────────────────────────────────
// Observed state (prime/sweep/refresh) — silent sync
// ──────────────────────────────────────────────────────────────────────────
/// <summary>An observed state that drifted persists (without a trigger timestamp) and refreshes — but never notifies.</summary>
[Fact]
public async Task Observed_drifted_state_persists_and_refreshes_without_notifying()
{
var serverId = Guid.NewGuid();
var alarm = new SmartAlarm
{
GuildId = 10UL,
ServerId = serverId,
EntityId = 42UL,
Name = "Perimeter",
LastIsActive = false,
PingEveryone = true,
RelayToTeamChat = true,
};
var h = Create(alarm: alarm);
await h.Relay.HandleStateObservedAsync(
new SmartDeviceStateObservedEvent(10UL, serverId, 42UL, IsActive: true), CancellationToken.None);
await h.Store.Received(1).UpdateStateAsync(
10UL, serverId, 42UL, true, null, Arg.Any<CancellationToken>());
await h.Refresher.Received(1)
.RefreshAsync(10UL, serverId, 42UL, unreachable: false, Arg.Any<CancellationToken>());
await h.Poster.DidNotReceive()
.SendEveryonePingAsync(Arg.Any<ulong>(), Arg.Any<string>(), Arg.Any<CancellationToken>());
await h.TeamChatSender.DidNotReceive()
.SendAsync(Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<string>(), Arg.Any<CancellationToken>());
}
/// <summary>An observed state equal to the persisted one is a no-op (no store write, no Discord edit).</summary>
[Fact]
public async Task Observed_unchanged_state_does_nothing()
{
var serverId = Guid.NewGuid();
var alarm = new SmartAlarm
{
GuildId = 10UL,
ServerId = serverId,
EntityId = 42UL,
Name = "Perimeter",
LastIsActive = true,
};
var h = Create(alarm: alarm);
await h.Relay.HandleStateObservedAsync(
new SmartDeviceStateObservedEvent(10UL, serverId, 42UL, IsActive: true), CancellationToken.None);
await h.Store.DidNotReceive().UpdateStateAsync(Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<ulong>(),
Arg.Any<bool>(), Arg.Any<DateTimeOffset?>(), Arg.Any<CancellationToken>());
await h.Refresher.DidNotReceive().RefreshAsync(Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<ulong>(),
Arg.Any<bool>(), Arg.Any<CancellationToken>());
}
/// <summary>An observed state for an entity that is not a managed alarm is ignored.</summary>
[Fact]
public async Task Observed_foreign_entity_is_ignored()
{
var h = Create(alarm: null);
await h.Relay.HandleStateObservedAsync(
new SmartDeviceStateObservedEvent(10UL, Guid.NewGuid(), 99UL, IsActive: true), CancellationToken.None);
await h.Store.DidNotReceive().UpdateStateAsync(Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<ulong>(),
Arg.Any<bool>(), Arg.Any<DateTimeOffset?>(), Arg.Any<CancellationToken>());
await h.Refresher.DidNotReceive().RefreshAsync(Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<ulong>(),
Arg.Any<bool>(), Arg.Any<CancellationToken>());
}
// ──────────────────────────────────────────────────────────────────────────
// Triggered → active
// ──────────────────────────────────────────────────────────────────────────
/// <summary>Active trigger on a managed alarm persists state (with timestamp) and refreshes the embed.</summary>
[Fact]
public async Task Triggered_active_managed_alarm_updates_state_and_refreshes()
{
var serverId = Guid.NewGuid();
var alarm = new SmartAlarm
{
GuildId = 10UL, ServerId = serverId, EntityId = 42UL, Name = "Perimeter",
};
var h = Create(alarm: alarm);
await h.Relay.HandleTriggeredAsync(
new SmartDeviceTriggeredEvent(10UL, serverId, 42UL, IsActive: true), CancellationToken.None);
await h.Store.Received(1).UpdateStateAsync(
10UL, serverId, 42UL, true, _fixedNow, Arg.Any<CancellationToken>());
await h.Refresher.Received(1)
.RefreshAsync(10UL, serverId, 42UL, unreachable: false, Arg.Any<CancellationToken>());
}
/// <summary>Active trigger with PingEveryone sends the @everyone message.</summary>
[Fact]
public async Task Triggered_active_ping_everyone_set_sends_ping()
{
var serverId = Guid.NewGuid();
var alarm = new SmartAlarm
{
GuildId = 10UL,
ServerId = serverId,
EntityId = 42UL,
Name = "Fire",
PingEveryone = true,
};
var h = Create(alarm: alarm, channelId: 777UL);
await h.Relay.HandleTriggeredAsync(
new SmartDeviceTriggeredEvent(10UL, serverId, 42UL, IsActive: true), CancellationToken.None);
await h.Poster.Received(1).SendEveryonePingAsync(777UL, "@everyone Fire", Arg.Any<CancellationToken>());
}
/// <summary>Active trigger without PingEveryone does NOT send the @everyone message.</summary>
[Fact]
public async Task Triggered_active_ping_everyone_unset_does_not_ping()
{
var serverId = Guid.NewGuid();
var alarm = new SmartAlarm
{
GuildId = 10UL,
ServerId = serverId,
EntityId = 42UL,
Name = "Fire",
PingEveryone = false,
};
var h = Create(alarm: alarm);
await h.Relay.HandleTriggeredAsync(
new SmartDeviceTriggeredEvent(10UL, serverId, 42UL, IsActive: true), CancellationToken.None);
await h.Poster.DidNotReceive()
.SendEveryonePingAsync(Arg.Any<ulong>(), Arg.Any<string>(), Arg.Any<CancellationToken>());
}
/// <summary>Active trigger with RelayToTeamChat sends the localized line to team chat.</summary>
[Fact]
public async Task Triggered_active_relay_to_team_chat_set_sends_team_chat_line()
{
var serverId = Guid.NewGuid();
var alarm = new SmartAlarm
{
GuildId = 10UL,
ServerId = serverId,
EntityId = 42UL,
Name = "Perimeter",
RelayToTeamChat = true,
};
var h = Create(alarm: alarm);
await h.Relay.HandleTriggeredAsync(
new SmartDeviceTriggeredEvent(10UL, serverId, 42UL, IsActive: true), CancellationToken.None);
// "alarm.triggered.teamchat" in EN = "🚨 {0} triggered"
await h.TeamChatSender.Received(1).SendAsync(
10UL, serverId, "🚨 Perimeter triggered", Arg.Any<CancellationToken>());
}
/// <summary>Active trigger without RelayToTeamChat does NOT send to team chat.</summary>
[Fact]
public async Task Triggered_active_relay_to_team_chat_unset_does_not_send_team_chat()
{
var serverId = Guid.NewGuid();
var alarm = new SmartAlarm
{
GuildId = 10UL,
ServerId = serverId,
EntityId = 42UL,
Name = "Perimeter",
RelayToTeamChat = false,
};
var h = Create(alarm: alarm);
await h.Relay.HandleTriggeredAsync(
new SmartDeviceTriggeredEvent(10UL, serverId, 42UL, IsActive: true), CancellationToken.None);
await h.TeamChatSender.DidNotReceive()
.SendAsync(Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<string>(), Arg.Any<CancellationToken>());
}
// ──────────────────────────────────────────────────────────────────────────
// Triggered → inactive
// ──────────────────────────────────────────────────────────────────────────
/// <summary>Inactive trigger persists state (null timestamp), refreshes embed, no ping/relay.</summary>
[Fact]
public async Task Triggered_inactive_updates_state_and_refreshes_no_ping_no_relay()
{
var serverId = Guid.NewGuid();
var alarm = new SmartAlarm
{
GuildId = 10UL,
ServerId = serverId,
EntityId = 42UL,
Name = "Perimeter",
PingEveryone = true,
RelayToTeamChat = true,
};
var h = Create(alarm: alarm);
await h.Relay.HandleTriggeredAsync(
new SmartDeviceTriggeredEvent(10UL, serverId, 42UL, IsActive: false), CancellationToken.None);
await h.Store.Received(1).UpdateStateAsync(
10UL, serverId, 42UL, false, null, Arg.Any<CancellationToken>());
await h.Refresher.Received(1)
.RefreshAsync(10UL, serverId, 42UL, unreachable: false, Arg.Any<CancellationToken>());
await h.Poster.DidNotReceive()
.SendEveryonePingAsync(Arg.Any<ulong>(), Arg.Any<string>(), Arg.Any<CancellationToken>());
await h.TeamChatSender.DidNotReceive()
.SendAsync(Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<string>(), Arg.Any<CancellationToken>());
}
// ──────────────────────────────────────────────────────────────────────────
// Triggered → non-alarm id
// ──────────────────────────────────────────────────────────────────────────
/// <summary>Entity id not in alarm store is ignored — no update, no refresh, no ping, no relay.</summary>
[Fact]
public async Task Triggered_non_alarm_id_is_ignored()
{
var serverId = Guid.NewGuid();
// store returns null by default (not configured for this identity)
var h = Create(alarm: null);
await h.Relay.HandleTriggeredAsync(
new SmartDeviceTriggeredEvent(10UL, serverId, 99UL, IsActive: true), CancellationToken.None);
await h.Store.DidNotReceive().UpdateStateAsync(
Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<ulong>(),
Arg.Any<bool>(), Arg.Any<DateTimeOffset?>(), Arg.Any<CancellationToken>());
await h.Refresher.DidNotReceive().RefreshAsync(
Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<ulong>(), Arg.Any<bool>(), Arg.Any<CancellationToken>());
await h.Poster.DidNotReceive()
.SendEveryonePingAsync(Arg.Any<ulong>(), Arg.Any<string>(), Arg.Any<CancellationToken>());
await h.TeamChatSender.DidNotReceive()
.SendAsync(Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<string>(), Arg.Any<CancellationToken>());
}
// ──────────────────────────────────────────────────────────────────────────
// Relay SendAsync throws → swallowed
// ──────────────────────────────────────────────────────────────────────────
/// <summary>If team-chat SendAsync throws, the exception is swallowed and the update+refresh+ping still complete.</summary>
[Fact]
public async Task Triggered_relay_send_throws_is_swallowed_and_other_actions_complete()
{
var serverId = Guid.NewGuid();
var alarm = new SmartAlarm
{
GuildId = 10UL,
ServerId = serverId,
EntityId = 42UL,
Name = "Fire",
PingEveryone = true,
RelayToTeamChat = true,
};
var h = Create(alarm: alarm, channelId: 777UL);
h.TeamChatSender
.SendAsync(Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<string>(), Arg.Any<CancellationToken>())
.ThrowsAsync(new InvalidOperationException("team chat down"));
// Must not throw
await h.Relay.HandleTriggeredAsync(
new SmartDeviceTriggeredEvent(10UL, serverId, 42UL, IsActive: true), CancellationToken.None);
await h.Store.Received(1).UpdateStateAsync(
10UL, serverId, 42UL, true, _fixedNow, Arg.Any<CancellationToken>());
await h.Refresher.Received(1)
.RefreshAsync(10UL, serverId, 42UL, unreachable: false, Arg.Any<CancellationToken>());
await h.Poster.Received(1).SendEveryonePingAsync(777UL, "@everyone Fire", Arg.Any<CancellationToken>());
}
// ──────────────────────────────────────────────────────────────────────────
// Connection status
// ──────────────────────────────────────────────────────────────────────────
/// <summary>Drop from Connected marks each alarm's embed as unreachable.</summary>
[Fact]
public async Task ConnectionStatus_not_connected_refreshes_all_alarms_unreachable()
{
var serverId = Guid.NewGuid();
var h = Create();
h.Store.ListByServerAsync(10UL, serverId, Arg.Any<CancellationToken>())
.Returns(
[
new SmartAlarm
{
GuildId = 10UL, ServerId = serverId, EntityId = 42UL, Name = "A"
},
new SmartAlarm
{
GuildId = 10UL, ServerId = serverId, EntityId = 43UL, Name = "B"
},
]);
await h.Relay.HandleConnectionStatusAsync(
new ConnectionStatusChangedEvent(10UL, serverId, IsConnected: false, WasConnected: true),
CancellationToken.None);
await h.Refresher.Received(1).RefreshAsync(
Arg.Is<SmartAlarm>(a => a!.EntityId == 42UL), unreachable: true, Arg.Any<CancellationToken>());
await h.Refresher.Received(1).RefreshAsync(
Arg.Is<SmartAlarm>(a => a!.EntityId == 43UL), unreachable: true, Arg.Any<CancellationToken>());
}
/// <summary>Connected server → no-op (supervisor's prime path handles it).</summary>
[Fact]
public async Task ConnectionStatus_connected_does_nothing()
{
var serverId = Guid.NewGuid();
var h = Create();
await h.Relay.HandleConnectionStatusAsync(
new ConnectionStatusChangedEvent(10UL, serverId, IsConnected: true, WasConnected: true),
CancellationToken.None);
await h.Refresher.DidNotReceive().RefreshAsync(
Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<ulong>(), Arg.Any<bool>(), Arg.Any<CancellationToken>());
await h.Refresher.DidNotReceive()
.RefreshAsync(Arg.Any<SmartAlarm>(), Arg.Any<bool>(), Arg.Any<CancellationToken>());
}
/// <summary>Boot/reconnect-loop statuses (never Connected in this process) must not sweep — embeds keep their last-run state until the prime republishes.</summary>
[Fact]
public async Task ConnectionStatus_boot_without_prior_connection_does_not_sweep()
{
var serverId = Guid.NewGuid();
var h = Create();
h.Store.ListByServerAsync(10UL, serverId, Arg.Any<CancellationToken>())
.Returns(
[
new SmartAlarm
{
GuildId = 10UL, ServerId = serverId, EntityId = 42UL, Name = "A"
},
]);
await h.Relay.HandleConnectionStatusAsync(
new ConnectionStatusChangedEvent(10UL, serverId, IsConnected: false, WasConnected: false),
CancellationToken.None);
await h.Refresher.DidNotReceive()
.RefreshAsync(Arg.Any<SmartAlarm>(), Arg.Any<bool>(), Arg.Any<CancellationToken>());
}
// ──────────────────────────────────────────────────────────────────────────
// Reachability changed
// ──────────────────────────────────────────────────────────────────────────
/// <summary>A reachability change for an owned alarm persists the new value and triggers a refresh.</summary>
[Fact]
public async Task ReachabilityChanged_owned_alarm_persists_and_refreshes()
{
var serverId = Guid.NewGuid();
var h = Create();
h.Store.ExistsAsync(10UL, serverId, 42UL, Arg.Any<CancellationToken>()).Returns(true);
await h.Relay.HandleReachabilityChangedAsync(
new DeviceReachabilityChangedEvent(10UL, serverId, 42UL, DeviceReachability.NoPrivilege),
CancellationToken.None);
await h.Store.Received(1)
.SetReachabilityAsync(10UL, serverId, 42UL, DeviceReachability.NoPrivilege,
Arg.Any<CancellationToken>());
await h.Refresher.Received(1)
.RefreshAsync(10UL, serverId, 42UL, unreachable: false, Arg.Any<CancellationToken>());
}
/// <summary>A reachability change for a foreign entity (not in the alarm store) is silently ignored.</summary>
[Fact]
public async Task ReachabilityChanged_foreign_entity_is_ignored()
{
var serverId = Guid.NewGuid();
var h = Create();
// ExistsAsync returns false by default for unknown entities.
h.Store.ExistsAsync(Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<ulong>(), Arg.Any<CancellationToken>())
.Returns(false);
await h.Relay.HandleReachabilityChangedAsync(
new DeviceReachabilityChangedEvent(10UL, serverId, 99UL, DeviceReachability.Removed),
CancellationToken.None);
await h.Store.DidNotReceive()
.SetReachabilityAsync(Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<ulong>(),
Arg.Any<DeviceReachability>(), Arg.Any<CancellationToken>());
await h.Refresher.DidNotReceive()
.RefreshAsync(Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<ulong>(),
Arg.Any<bool>(), Arg.Any<CancellationToken>());
}
private sealed record Harness(
AlarmStateRelay Relay,
IAlarmStore Store,
IAlarmRefresher Refresher,
IAlarmChannelPoster Poster,
IBotTeamChatSender TeamChatSender);
}