-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathKnowledgeBaseConfigurationIntegrationTests.cs
More file actions
356 lines (296 loc) · 15.1 KB
/
Copy pathKnowledgeBaseConfigurationIntegrationTests.cs
File metadata and controls
356 lines (296 loc) · 15.1 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
using System.Net;
using System.Net.Http.Json;
using System.Text.Json;
using Identity.Api.Authentication;
using KnowledgeBase.Api;
using KnowledgeBase.Application.Settings; // BP-031 dispatch-coverage marker
using Microsoft.AspNetCore.TestHost;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;
using NodaTime;
using IClock = BuildingBlocks.Domain.Time.IClock;
using BuildingBlocks.Testing.Http;
using static BuildingBlocks.Testing.Http.IntegrationTestHttpHelpers;
namespace Integration.Tests.Modules.KnowledgeBase;
public sealed class KnowledgeBaseConfigurationIntegrationTests
{
[Xunit.Fact]
public async Task KnowledgeBaseSettingsExposeDefaultsAndPersistAuditedUpdates()
{
await using var application = await PostgresBackedApiApplication.StartAsync();
var client = application.App.GetTestClient();
client.BaseAddress = new Uri("https://localhost");
var publicBefore = await client.GetAsync("/api/v1/knowledge-base/settings");
Xunit.Assert.Equal(HttpStatusCode.OK, publicBefore.StatusCode);
using (var publicBeforeJson = await ReadJsonAsync(publicBefore))
{
Xunit.Assert.Equal("Knowledge Base", publicBeforeJson.RootElement.GetProperty("publicExperienceTitle").GetString());
Xunit.Assert.True(publicBeforeJson.RootElement.GetProperty("searchEnabled").GetBoolean());
}
var adminSession = await SignInAsync(client, "admin", "LocalOnly!123");
var managementBefore = await SendAsync(
client,
HttpMethod.Get,
"/api/v1/knowledge-base/manage/settings",
adminSession.Cookies);
managementBefore.EnsureSuccessStatusCode();
var updatedTitle = "Operator-curated knowledge hub";
using var managementBeforeJson = await ReadJsonAsync(managementBefore);
var updateResponse = await SendJsonAsync(
client,
HttpMethod.Put,
"/api/v1/knowledge-base/manage/settings",
new UpdateKnowledgeBaseSettingsRequest(
ExpectedVersion: managementBeforeJson.RootElement.GetProperty("version").GetInt32(),
PublicExperienceTitle: updatedTitle,
PublicExperienceBlurb: "Live module settings now flow through a persisted, audited KnowledgeBase reference slice.",
SearchPlaceholder: "Search governed guidance",
SearchEnabled: false,
ManagementPreviewLimit: 5),
adminSession.Cookies,
adminSession.HeaderName,
adminSession.RequestToken);
updateResponse.EnsureSuccessStatusCode();
using (var updateJson = await ReadJsonAsync(updateResponse))
{
Xunit.Assert.Equal(updatedTitle, updateJson.RootElement.GetProperty("publicExperienceTitle").GetString());
Xunit.Assert.Equal(2, updateJson.RootElement.GetProperty("version").GetInt32());
Xunit.Assert.False(updateJson.RootElement.GetProperty("searchEnabled").GetBoolean());
Xunit.Assert.Equal(5, updateJson.RootElement.GetProperty("managementPreviewLimit").GetInt32());
}
var publicAfter = await client.GetAsync("/api/v1/knowledge-base/settings");
publicAfter.EnsureSuccessStatusCode();
using (var publicAfterJson = await ReadJsonAsync(publicAfter))
{
Xunit.Assert.Equal(updatedTitle, publicAfterJson.RootElement.GetProperty("publicExperienceTitle").GetString());
Xunit.Assert.False(publicAfterJson.RootElement.GetProperty("searchEnabled").GetBoolean());
}
var auditResponse = await SendAsync(client, HttpMethod.Get, "/api/v1/platform/audit-events?limit=20", adminSession.Cookies);
auditResponse.EnsureSuccessStatusCode();
using var auditJson = await ReadJsonAsync(auditResponse);
var events = auditJson.RootElement.GetProperty("events").EnumerateArray().ToArray();
Xunit.Assert.Contains(events, entry =>
string.Equals(entry.GetProperty("action").GetString(), "knowledge-base.settings.update", StringComparison.Ordinal)
&& string.Equals(entry.GetProperty("targetId").GetString(), "default", StringComparison.Ordinal));
}
[Xunit.Fact]
public async Task KnowledgeBaseSettingsUpdatesRequireRecentAuthentication()
{
var clock = new AdjustableClock(SystemClock.Instance.GetCurrentInstant());
await using var application = await PostgresBackedApiApplication.StartAsync(
configureBuilder: builder => builder.Services.AddSingleton<IClock>(clock));
var client = application.App.GetTestClient();
client.BaseAddress = new Uri("https://localhost");
var adminSession = await SignInAsync(client, "admin", "LocalOnly!123");
clock.Advance(Duration.FromMinutes(6));
var response = await SendJsonAsync(
client,
HttpMethod.Put,
"/api/v1/knowledge-base/manage/settings",
new UpdateKnowledgeBaseSettingsRequest(
ExpectedVersion: 1,
PublicExperienceTitle: "Late update",
PublicExperienceBlurb: "This write should require recent auth.",
SearchPlaceholder: "Search governed guidance",
SearchEnabled: true,
ManagementPreviewLimit: 4),
adminSession.Cookies,
adminSession.HeaderName,
adminSession.RequestToken);
Xunit.Assert.Equal(HttpStatusCode.Unauthorized, response.StatusCode);
using var json = await ReadJsonAsync(response);
Xunit.Assert.Equal("auth.recent_auth_required", json.RootElement.GetProperty("code").GetString());
}
[Xunit.Fact]
public async Task KnowledgeBaseSettingsRejectStaleVersionWithConflictError()
{
await using var application = await PostgresBackedApiApplication.StartAsync();
var client = application.App.GetTestClient();
client.BaseAddress = new Uri("https://localhost");
var adminSession = await SignInAsync(client, "admin", "LocalOnly!123");
var managementBefore = await SendAsync(
client,
HttpMethod.Get,
"/api/v1/knowledge-base/manage/settings",
adminSession.Cookies);
managementBefore.EnsureSuccessStatusCode();
using var managementBeforeJson = await ReadJsonAsync(managementBefore);
var initialVersion = managementBeforeJson.RootElement.GetProperty("version").GetInt32();
Xunit.Assert.Equal(1, initialVersion);
var firstUpdate = await SendJsonAsync(
client,
HttpMethod.Put,
"/api/v1/knowledge-base/manage/settings",
new UpdateKnowledgeBaseSettingsRequest(
ExpectedVersion: 1,
PublicExperienceTitle: "First update",
PublicExperienceBlurb: "First update blurb.",
SearchPlaceholder: "Search governed guidance",
SearchEnabled: true,
ManagementPreviewLimit: 5),
adminSession.Cookies,
adminSession.HeaderName,
adminSession.RequestToken);
firstUpdate.EnsureSuccessStatusCode();
using (var firstUpdateJson = await ReadJsonAsync(firstUpdate))
{
Xunit.Assert.Equal(2, firstUpdateJson.RootElement.GetProperty("version").GetInt32());
}
var staleUpdate = await SendJsonAsync(
client,
HttpMethod.Put,
"/api/v1/knowledge-base/manage/settings",
new UpdateKnowledgeBaseSettingsRequest(
ExpectedVersion: 1,
PublicExperienceTitle: "Stale update",
PublicExperienceBlurb: "Stale update blurb.",
SearchPlaceholder: "Search governed guidance",
SearchEnabled: true,
ManagementPreviewLimit: 5),
adminSession.Cookies,
adminSession.HeaderName,
adminSession.RequestToken);
Xunit.Assert.Equal(HttpStatusCode.Conflict, staleUpdate.StatusCode);
using var staleJson = await ReadJsonAsync(staleUpdate);
Xunit.Assert.Equal("knowledge-base.settings_version_conflict", staleJson.RootElement.GetProperty("code").GetString());
}
[Xunit.Fact]
public async Task KnowledgeBaseSettingsAuditTrailRecordsActorAndCorrelationId()
{
await using var application = await PostgresBackedApiApplication.StartAsync();
var client = application.App.GetTestClient();
client.BaseAddress = new Uri("https://localhost");
var adminSession = await SignInAsync(client, "admin", "LocalOnly!123");
var updateResponse = await SendJsonAsync(
client,
HttpMethod.Put,
"/api/v1/knowledge-base/manage/settings",
new UpdateKnowledgeBaseSettingsRequest(
ExpectedVersion: 1,
PublicExperienceTitle: "Audit trail test",
PublicExperienceBlurb: "Verifying audit metadata.",
SearchPlaceholder: "Search governed guidance",
SearchEnabled: true,
ManagementPreviewLimit: 4),
adminSession.Cookies,
adminSession.HeaderName,
adminSession.RequestToken);
updateResponse.EnsureSuccessStatusCode();
var auditResponse = await SendAsync(client, HttpMethod.Get, "/api/v1/platform/audit-events?limit=20", adminSession.Cookies);
auditResponse.EnsureSuccessStatusCode();
using var auditJson = await ReadJsonAsync(auditResponse);
var events = auditJson.RootElement.GetProperty("events").EnumerateArray().ToArray();
var settingsEvent = events.FirstOrDefault(entry =>
string.Equals(entry.GetProperty("action").GetString(), "knowledge-base.settings.update", StringComparison.Ordinal));
Xunit.Assert.NotEqual(default, settingsEvent);
Xunit.Assert.Equal("identity:seeded-admin", settingsEvent.GetProperty("actorId").GetString());
Xunit.Assert.False(string.IsNullOrWhiteSpace(settingsEvent.GetProperty("correlationId").GetString()));
var occurredUtcString = settingsEvent.GetProperty("occurredUtc").GetString();
Xunit.Assert.NotNull(occurredUtcString);
Xunit.Assert.True(DateTimeOffset.TryParse(occurredUtcString, out _));
}
[Xunit.Fact]
public async Task KnowledgeBaseSettingsRejectInvalidManagementPreviewLimitAtRuntime()
{
await using var application = await PostgresBackedApiApplication.StartAsync();
var client = application.App.GetTestClient();
client.BaseAddress = new Uri("https://localhost");
var adminSession = await SignInAsync(client, "admin", "LocalOnly!123");
var zeroLimitResponse = await SendJsonAsync(
client,
HttpMethod.Put,
"/api/v1/knowledge-base/manage/settings",
new UpdateKnowledgeBaseSettingsRequest(
ExpectedVersion: 1,
PublicExperienceTitle: "Valid title",
PublicExperienceBlurb: "Valid blurb.",
SearchPlaceholder: "Search governed guidance",
SearchEnabled: true,
ManagementPreviewLimit: 0),
adminSession.Cookies,
adminSession.HeaderName,
adminSession.RequestToken);
Xunit.Assert.Equal(HttpStatusCode.BadRequest, zeroLimitResponse.StatusCode);
using (var zeroLimitJson = await ReadJsonAsync(zeroLimitResponse))
{
Xunit.Assert.Equal("knowledge-base.settings_preview_limit_invalid", zeroLimitJson.RootElement.GetProperty("code").GetString());
}
var negativeLimitResponse = await SendJsonAsync(
client,
HttpMethod.Put,
"/api/v1/knowledge-base/manage/settings",
new UpdateKnowledgeBaseSettingsRequest(
ExpectedVersion: 1,
PublicExperienceTitle: "Valid title",
PublicExperienceBlurb: "Valid blurb.",
SearchPlaceholder: "Search governed guidance",
SearchEnabled: true,
ManagementPreviewLimit: -1),
adminSession.Cookies,
adminSession.HeaderName,
adminSession.RequestToken);
Xunit.Assert.Equal(HttpStatusCode.BadRequest, negativeLimitResponse.StatusCode);
using (var negativeLimitJson = await ReadJsonAsync(negativeLimitResponse))
{
Xunit.Assert.Equal("knowledge-base.settings_preview_limit_invalid", negativeLimitJson.RootElement.GetProperty("code").GetString());
}
}
[Xunit.Fact]
public async Task KnowledgeBaseSettingsRejectEmptyPublicExperienceTitle()
{
await using var application = await PostgresBackedApiApplication.StartAsync();
var client = application.App.GetTestClient();
client.BaseAddress = new Uri("https://localhost");
var adminSession = await SignInAsync(client, "admin", "LocalOnly!123");
var emptyTitleResponse = await SendJsonAsync(
client,
HttpMethod.Put,
"/api/v1/knowledge-base/manage/settings",
new UpdateKnowledgeBaseSettingsRequest(
ExpectedVersion: 1,
PublicExperienceTitle: "",
PublicExperienceBlurb: "Valid blurb.",
SearchPlaceholder: "Search governed guidance",
SearchEnabled: true,
ManagementPreviewLimit: 4),
adminSession.Cookies,
adminSession.HeaderName,
adminSession.RequestToken);
Xunit.Assert.Equal(HttpStatusCode.BadRequest, emptyTitleResponse.StatusCode);
using (var emptyTitleJson = await ReadJsonAsync(emptyTitleResponse))
{
Xunit.Assert.Equal("knowledge-base.settings_title_required", emptyTitleJson.RootElement.GetProperty("code").GetString());
}
var whitespaceTitleResponse = await SendJsonAsync(
client,
HttpMethod.Put,
"/api/v1/knowledge-base/manage/settings",
new UpdateKnowledgeBaseSettingsRequest(
ExpectedVersion: 1,
PublicExperienceTitle: " ",
PublicExperienceBlurb: "Valid blurb.",
SearchPlaceholder: "Search governed guidance",
SearchEnabled: true,
ManagementPreviewLimit: 4),
adminSession.Cookies,
adminSession.HeaderName,
adminSession.RequestToken);
Xunit.Assert.Equal(HttpStatusCode.BadRequest, whitespaceTitleResponse.StatusCode);
using (var whitespaceTitleJson = await ReadJsonAsync(whitespaceTitleResponse))
{
Xunit.Assert.Equal("knowledge-base.settings_title_required", whitespaceTitleJson.RootElement.GetProperty("code").GetString());
}
}
[Xunit.Fact]
public async Task KnowledgeBaseInfrastructureOptionsFailFastWhenSettingsDefaultsAreInvalid()
{
await Xunit.Assert.ThrowsAnyAsync<OptionsValidationException>(async () =>
{
await using var application = await PostgresBackedApiApplication.StartAsync(
configurationOverrides: new Dictionary<string, string?>
{
["Modules:KnowledgeBase:Settings:ManagementPreviewLimit"] = "0"
});
});
}
}