-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathRegistrationSubmissionsControllerTests.cs
More file actions
4303 lines (3490 loc) · 200 KB
/
RegistrationSubmissionsControllerTests.cs
File metadata and controls
4303 lines (3490 loc) · 200 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
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
namespace EPR.RegulatorService.Frontend.UnitTests.Web.Controllers
{
using System;
using System.Net;
using EPR.Common.Authorization.Models;
using EPR.RegulatorService.Frontend.Core.Enums;
using EPR.RegulatorService.Frontend.Core.Models;
using EPR.RegulatorService.Frontend.Core.Models.FileDownload;
using EPR.RegulatorService.Frontend.Core.Models.RegistrationSubmissions;
using EPR.RegulatorService.Frontend.Core.Sessions;
using EPR.RegulatorService.Frontend.Web.Constants;
using EPR.RegulatorService.Frontend.Web.Controllers.RegistrationSubmissions;
using EPR.RegulatorService.Frontend.Web.ViewModels.Registrations;
using EPR.RegulatorService.Frontend.Web.ViewModels.RegistrationSubmissions;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Routing;
using Microsoft.AspNetCore.Mvc.ViewFeatures;
using Microsoft.Extensions.Logging;
[TestClass]
public class RegistrationSubmissionsControllerTests : RegistrationSubmissionsTestBase
{
[TestInitialize]
public void Setup() => SetupBase();
#region RegistrationSubmissions
#region Initialisation and Basic Session state
[TestMethod]
[DataRow(0, "")]
[DataRow(1, "Environment Agency (EA)")]
[DataRow(2, "Northern Ireland Environment Agency (NIEA)")]
[DataRow(3, "Scottish Environment Protection Agency (SEPA)")]
[DataRow(4, "Natural Resources Wales (NRW)")]
public async Task RegistrationSubmissions_ReturnsView_WithCorrectViewModel(
int nationId,
string agencyName)
{
// Arrange
var expectedViewModel = new RegistrationSubmissionsViewModel
{
AgencyName = agencyName
};
string expectedBackLink = "/regulators/home";
// Ensure the Organisation has a valid NationId
_journeySession.UserData.Organisations.Add(new Organisation
{
NationId = nationId
});
_mockSessionManager.Setup(x => x.GetSessionAsync(It.IsAny<ISession>()))
.ReturnsAsync(_journeySession);
// Act
var result = await _controller.RegistrationSubmissions(1);
// Assert
result.Should().NotBeNull();
result.Should().BeOfType<ViewResult>();
var viewResult = result as ViewResult;
viewResult.Should().NotBeNull();
Assert.IsInstanceOfType(expectedViewModel, viewResult!.Model.GetType());
var resultModel = viewResult.Model as RegistrationSubmissionsViewModel;
Assert.AreEqual(expectedViewModel.AgencyName, resultModel.AgencyName);
var actualBackLink = _controller.ViewBag.CustomBackLinkToDisplay;
Assert.IsNotNull(actualBackLink);
Assert.AreEqual(expectedBackLink, actualBackLink);
}
[TestMethod]
public async Task RegistrationSubmissions_ReturnsView_WithCorrectViewModel_WithNullNationId()
{
// Arrange
var expectedViewModel = new RegistrationSubmissionsViewModel();
string expectedBackLink = "/regulators/home";
_journeySession.UserData.Organisations.Add(new Organisation());
_mockSessionManager.Setup(x => x.GetSessionAsync(It.IsAny<ISession>()))
.ReturnsAsync(_journeySession);
// Act
var result = await _controller.RegistrationSubmissions(1);
// Assert
result.Should().NotBeNull();
result.Should().BeOfType<ViewResult>();
var viewResult = result as ViewResult;
viewResult.Should().NotBeNull();
Assert.IsInstanceOfType(expectedViewModel, viewResult!.Model.GetType());
var actualBackLink = _controller.ViewBag.CustomBackLinkToDisplay;
Assert.IsNotNull(actualBackLink);
Assert.AreEqual(expectedBackLink, actualBackLink);
}
[TestMethod]
public async Task RegistrationsSubmissions_ReturnModel_WithPageNumber_FromSession_When_Supplied_Null()
{
// Arrange
_journeySession.UserData.Organisations.Add(new Organisation
{
NationId = 1
});
_journeySession.RegulatorRegistrationSubmissionSession.CurrentPageNumber = 2;
_mockSessionManager.Setup(x => x.GetSessionAsync(It.IsAny<ISession>()))
.ReturnsAsync(_journeySession);
// Act
var result = await _controller.RegistrationSubmissions(null);
// Assert
result.Should().NotBeNull();
result.Should().BeOfType<ViewResult>();
var viewResult = result as ViewResult;
viewResult.Should().NotBeNull();
var resultModel = viewResult!.Model as RegistrationSubmissionsViewModel;
resultModel.Should().NotBeNull();
resultModel!.ListViewModel.PaginationNavigationModel.CurrentPage.Should().Be(2);
}
[TestMethod]
public async Task RegistrationsSubmissions_ReturnsModel_WithPageNumber_1_When_Supplied_Null()
{
// Arrange
_journeySession.UserData.Organisations.Add(new Organisation
{
NationId = 1
});
_mockSessionManager.Setup(x => x.GetSessionAsync(It.IsAny<ISession>()))
.ReturnsAsync(_journeySession);
// Act
var result = await _controller.RegistrationSubmissions(null);
// Assert
result.Should().NotBeNull();
result.Should().BeOfType<ViewResult>();
var viewResult = result as ViewResult;
viewResult.Should().NotBeNull();
var resultModel = viewResult!.Model as RegistrationSubmissionsViewModel;
resultModel.Should().NotBeNull();
resultModel!.ListViewModel.PaginationNavigationModel.CurrentPage.Should().Be(1);
_journeySession.RegulatorRegistrationSubmissionSession.CurrentPageNumber.Should().Be(1);
}
[TestMethod]
public async Task RegistrationsSubmissions_ReturnModel_WithPageNumber_3()
{
// Arrange
_journeySession.UserData.Organisations.Add(new Organisation
{
NationId = 1
});
_mockSessionManager.Setup(x => x.GetSessionAsync(It.IsAny<ISession>()))
.ReturnsAsync(_journeySession);
// Act
var result = await _controller.RegistrationSubmissions(3);
// Assert
result.Should().NotBeNull();
result.Should().BeOfType<ViewResult>();
var viewResult = result as ViewResult;
viewResult.Should().NotBeNull();
var resultModel = viewResult!.Model as RegistrationSubmissionsViewModel;
resultModel.Should().NotBeNull();
resultModel!.ListViewModel.PaginationNavigationModel.CurrentPage.Should().Be(3);
_journeySession.RegulatorRegistrationSubmissionSession.CurrentPageNumber.Should().Be(3);
}
#endregion Initialisation and Basic Session state
#region Session Models and Filter states between gets and posts
#region Happy Path
[TestMethod]
public async Task RegistrationSubmissions_ShouldHandleNullSession()
{
// Arrange
_mockSessionManager.Setup(sm => sm.GetSessionAsync(It.IsAny<ISession>()))
.ReturnsAsync((JourneySession)null);
// Setup a mock UserData object with Organisations and NationId
var userData = new UserData
{
Organisations =
[
new Organisation
{
NationId = 1
}
]
};
// Create the JourneySession and assign UserData to it
var journeySession = new JourneySession
{
UserData = userData
};
// Inject the session with valid UserData
_mockSessionManager.Setup(sm => sm.GetSessionAsync(It.IsAny<ISession>()))
.ReturnsAsync(journeySession);
int pageNumber = 1;
// Act
var result = await _controller.RegistrationSubmissions(pageNumber);
// Assert: Verify session retrieval was attempted once
_mockSessionManager.Verify(sm => sm.GetSessionAsync(It.IsAny<ISession>()), Times.Once);
// Assert: Verify the result is a ViewResult
var viewResult = result as ViewResult;
Assert.IsNotNull(viewResult);
// Assert: Verify the model is of the expected type
var model = viewResult.Model as RegistrationSubmissionsViewModel;
Assert.IsNotNull(model);
// Since session was null initially, but we injected a session, it should use the page number logic
Assert.AreEqual(pageNumber, model.ListViewModel.PaginationNavigationModel.CurrentPage);
// Assert: Verify NationId handling
Assert.IsNotNull(journeySession.UserData.Organisations.FirstOrDefault()?.NationId);
Assert.AreEqual(1, journeySession.UserData.Organisations.FirstOrDefault()?.NationId);
}
[TestMethod]
public async Task RegistrationSubmissions_Initialises_ListViewModel_When_New()
{
// Arrange
var existingSession = new RegulatorRegistrationSubmissionSession
{
CurrentPageNumber = 1, // Existing page number
LatestFilterChoices = new RegistrationSubmissionsFilterModel()
};
_journeySession.RegulatorRegistrationSubmissionSession = existingSession;
_journeySession.UserData.Organisations.Add(new Organisation
{
NationId = 1 // Ensure a valid NationId
});
_mockSessionManager.Setup(x => x.GetSessionAsync(It.IsAny<ISession>()))
.ReturnsAsync(_journeySession);
RegistrationSubmissionsFilterModel latestFilterChoices = new()
{
OrganisationName = "braun",
OrganisationType = "small",
RelevantYears = "2025, 2026",
PageNumber = 1,
PageSize = 500,
Statuses = "Pending"
};
// Apply new filter choices without overwriting the existing session.
MergeFilterChoices(existingSession, latestFilterChoices);
// Act
var result = await _controller.RegistrationSubmissions(null);
// Assert
result.Should().BeOfType<ViewResult>();
var session = _journeySession.RegulatorRegistrationSubmissionSession;
session.Should().NotBeNull();
session.CurrentPageNumber.Should().Be(1);
session.LatestFilterChoices.OrganisationName.Should().Be("braun");
session.LatestFilterChoices.OrganisationType.Should().Be("small");
session.LatestFilterChoices.RelevantYears.Should().Be("2025, 2026");
session.LatestFilterChoices.PageNumber.Should().Be(1);
session.LatestFilterChoices.PageSize.Should().Be(500);
session.LatestFilterChoices.Statuses.Should().Be("Pending");
var model = (result as ViewResult).Model as RegistrationSubmissionsViewModel;
model.Should().NotBeNull();
model!.ListViewModel.PagedRegistrationSubmissions.Should().BeNull();
model.ListViewModel.PaginationNavigationModel.CurrentPage.Should().Be(1);
model.ListViewModel.RegistrationsFilterViewModel.PageNumber.Should().Be(1);
model.ListViewModel.RegistrationsFilterViewModel.IsStatusPendingChecked.Should().BeTrue();
model.ListViewModel.RegistrationsFilterViewModel.SelectedYears.Should().Contain("2025");
model.ListViewModel.RegistrationsFilterViewModel.SelectedYears.Should().Contain("2026");
model.ListViewModel.RegistrationsFilterViewModel.OrganisationName.Should().Be("braun");
model.ListViewModel.RegistrationsFilterViewModel.IsOrganisationSmallChecked.Should().BeTrue();
}
[TestMethod]
public async Task RegistrationSubmissions_Updates_ListViewModel_When_New_Page_Requested()
{
// Arrange
int new_page_number = 4;
// Setup the latest filter choices
RegistrationSubmissionsFilterModel latestFilterChoices = new()
{
OrganisationName = "braun",
OrganisationType = "small",
RelevantYears = "2025",
PageNumber = 2,
PageSize = 500,
Statuses = "Pending"
};
// Setup mock session with valid UserData
var userData = new UserData
{
Organisations =
[
new Organisation
{
NationId = 1
}
]
};
var journeySession = new JourneySession
{
UserData = userData,
RegulatorRegistrationSubmissionSession = new RegulatorRegistrationSubmissionSession
{
LatestFilterChoices = latestFilterChoices,
CurrentPageNumber = 2
}
};
_mockSessionManager.Setup(sm => sm.GetSessionAsync(It.IsAny<ISession>()))
.ReturnsAsync(journeySession);
// Act
var result = await _controller.RegistrationSubmissions(new_page_number);
// Debugging: Check if the session page number was updated correctly
var session = journeySession.RegulatorRegistrationSubmissionSession;
Console.WriteLine($"Current Page Number in session after request: {session.CurrentPageNumber}");
// Assert
result.Should().BeOfType<ViewResult>();
session.Should().NotBeNull();
session.CurrentPageNumber.Should().Be(new_page_number, "The session page number should be updated to the new page number.");
session.LatestFilterChoices.OrganisationName.Should().Be("braun");
session.LatestFilterChoices.OrganisationType.Should().Be("small");
session.LatestFilterChoices.RelevantYears.Should().Be("2025");
session.LatestFilterChoices.PageNumber.Should().Be(new_page_number);
session.LatestFilterChoices.PageSize.Should().Be(500);
session.LatestFilterChoices.Statuses.Should().Be("Pending");
var model = (result as ViewResult).Model as RegistrationSubmissionsViewModel;
model.Should().NotBeNull();
model.ListViewModel.PagedRegistrationSubmissions.Should().BeNull();
model.ListViewModel.PaginationNavigationModel.CurrentPage.Should().Be(new_page_number);
model.ListViewModel.RegistrationsFilterViewModel.PageNumber.Should().Be(new_page_number);
model.ListViewModel.RegistrationsFilterViewModel.IsStatusPendingChecked.Should().BeTrue();
model.ListViewModel.RegistrationsFilterViewModel.SelectedYears.Should().Contain("2025");
model.ListViewModel.RegistrationsFilterViewModel.SelectedYears.Should().NotContain("2026");
model.ListViewModel.RegistrationsFilterViewModel.OrganisationName.Should().Be("braun");
model.ListViewModel.RegistrationsFilterViewModel.IsOrganisationSmallChecked.Should().BeTrue();
}
[TestMethod]
public async Task RegistrationSubmissions_Retrieves_ListViewModel_And_Adjusts_Filter_And_Model_After_Postback()
{
// Arrange
int expectedPageNumber = 2;
RegistrationSubmissionsFilterModel emptyFilterChoices = new();
RegistrationSubmissionsFilterModel latestFilterChoices = new()
{
OrganisationName = "braun",
OrganisationType = "small",
RelevantYears = "2025, 2026",
PageNumber = expectedPageNumber,
PageSize = 500,
Statuses = "Pending"
};
_journeySession.RegulatorRegistrationSubmissionSession = new RegulatorRegistrationSubmissionSession
{
LatestFilterChoices = emptyFilterChoices,
CurrentPageNumber = 1
};
_journeySession.UserData.Organisations.Add(new Organisation
{
NationId = 1
});
_mockSessionManager.Setup(x => x.GetSessionAsync(It.IsAny<ISession>()))
.ReturnsAsync(_journeySession);
// Act: Perform initial GET request
var getResult = await _controller.RegistrationSubmissions(null);
// Assert: Initial state
getResult.Should().BeOfType<ViewResult>();
var model = (getResult as ViewResult)?.Model as RegistrationSubmissionsViewModel;
model.Should().NotBeNull();
var session = _journeySession.RegulatorRegistrationSubmissionSession;
session.Should().NotBeNull();
session.LatestFilterChoices.OrganisationName.Should().BeNullOrEmpty();
session.LatestFilterChoices.OrganisationType.Should().BeNullOrEmpty();
session.LatestFilterChoices.RelevantYears.Should().BeNullOrEmpty();
session.LatestFilterChoices.PageNumber.Should().Be(1);
session.LatestFilterChoices.Statuses.Should().BeNullOrEmpty();
session.CurrentPageNumber.Should().Be(1);
// Act: Simulate POST request with updated filters
var postResult = await _controller.RegistrationSubmissions(latestFilterChoices, FilterActions.SubmitFilters);
// Assert: POST redirects to GET action
postResult.Should().BeOfType<RedirectToActionResult>();
(postResult as RedirectToActionResult)?.ActionName.Should().Be(PagePath.RegistrationSubmissionsAction);
// Act: Perform GET request with updated filters
getResult = await _controller.RegistrationSubmissions(4);
// Assert: Final state
session.LatestFilterChoices.OrganisationName.Should().Be("braun");
session.LatestFilterChoices.OrganisationType.Should().Be("small");
session.LatestFilterChoices.RelevantYears.Should().Be("2025, 2026");
session.LatestFilterChoices.PageNumber.Should().Be(4);
session.LatestFilterChoices.PageSize.Should().Be(500);
session.LatestFilterChoices.Statuses.Should().Be("Pending");
model = (getResult as ViewResult)?.Model as RegistrationSubmissionsViewModel;
model.Should().NotBeNull();
model!.ListViewModel.PagedRegistrationSubmissions.Should().BeNull();
model.ListViewModel.PaginationNavigationModel.CurrentPage.Should().Be(4);
model.ListViewModel.RegistrationsFilterViewModel.PageNumber.Should().Be(4);
model.ListViewModel.RegistrationsFilterViewModel.IsStatusPendingChecked.Should().BeTrue();
model.ListViewModel.RegistrationsFilterViewModel.SelectedYears.Should().Contain("2025");
model.ListViewModel.RegistrationsFilterViewModel.SelectedYears.Should().Contain("2026");
model.ListViewModel.RegistrationsFilterViewModel.OrganisationName.Should().Be("braun");
model.ListViewModel.RegistrationsFilterViewModel.IsOrganisationSmallChecked.Should().BeTrue();
}
[TestMethod]
public async Task RegistrationSubmissions_Clears_Filters_On_ClearFilters_Action()
{
// Arrange
SetupSessionWithFilters("braun", "small", "2025, 2026", 2, 200, "Pending");
// Act: Perform initial GET request
var getResult = await _controller.RegistrationSubmissions(null);
// Assert: Verify initial state
AssertInitialFilters(getResult, "braun", "small", "2025, 2026", 2, 200, "Pending");
// Act: Perform POST request to clear filters
var postResult = await _controller.RegistrationSubmissions(null, FilterActions.ClearFilters);
// Assert: Verify POST redirects to GET action
AssertRedirectToGet(postResult);
// Assert: Verify cleared state
AssertClearedFilters();
}
private void SetupSessionWithFilters(
string organisationName,
string organisationType,
string relevantYears,
int pageNumber,
int pageSize,
string statuses)
{
RegistrationSubmissionsFilterModel latestFilterChoices = new()
{
OrganisationName = organisationName,
OrganisationType = organisationType,
RelevantYears = relevantYears,
PageNumber = pageNumber,
PageSize = pageSize,
Statuses = statuses
};
_journeySession.RegulatorRegistrationSubmissionSession = new RegulatorRegistrationSubmissionSession
{
LatestFilterChoices = latestFilterChoices,
CurrentPageNumber = pageNumber
};
_journeySession.UserData.Organisations.Add(new Organisation
{
NationId = 1
});
_mockSessionManager.Setup(x => x.GetSessionAsync(It.IsAny<ISession>()))
.ReturnsAsync(_journeySession);
}
private void AssertInitialFilters(
object getResult,
string organisationName,
string organisationType,
string relevantYears,
int pageNumber,
int pageSize,
string statuses)
{
getResult.Should().BeOfType<ViewResult>();
var model = (getResult as ViewResult)?.Model as RegistrationSubmissionsViewModel;
model.Should().NotBeNull();
var session = _journeySession.RegulatorRegistrationSubmissionSession;
session.Should().NotBeNull();
model!.ListViewModel.PaginationNavigationModel.CurrentPage.Should().Be(pageNumber);
model.ListViewModel.RegistrationsFilterViewModel.PageNumber.Should().Be(pageNumber);
model.ListViewModel.RegistrationsFilterViewModel.IsStatusPendingChecked.Should().BeTrue();
model.ListViewModel.RegistrationsFilterViewModel.SelectedYears.Should().Contain("2025");
model.ListViewModel.RegistrationsFilterViewModel.SelectedYears.Should().Contain("2026");
model.ListViewModel.RegistrationsFilterViewModel.OrganisationName.Should().Be(organisationName);
model.ListViewModel.RegistrationsFilterViewModel.IsOrganisationSmallChecked.Should().BeTrue();
session.LatestFilterChoices.OrganisationName.Should().Be(organisationName);
session.LatestFilterChoices.OrganisationType.Should().Be(organisationType);
session.LatestFilterChoices.RelevantYears.Should().Be(relevantYears);
session.LatestFilterChoices.PageNumber.Should().Be(pageNumber);
session.LatestFilterChoices.PageSize.Should().Be(pageSize);
session.LatestFilterChoices.Statuses.Should().Be(statuses);
}
private static void AssertRedirectToGet(object postResult)
{
postResult.Should().BeOfType<RedirectToActionResult>();
(postResult as RedirectToActionResult)?.ActionName.Should().Be(PagePath.RegistrationSubmissionsAction);
}
private void AssertClearedFilters()
{
var session = _journeySession.RegulatorRegistrationSubmissionSession;
session.LatestFilterChoices.OrganisationName.Should().BeNullOrEmpty();
session.LatestFilterChoices.OrganisationType.Should().BeNullOrEmpty();
session.LatestFilterChoices.RelevantYears.Should().BeNullOrEmpty();
session.LatestFilterChoices.PageNumber.Should().Be(1);
session.LatestFilterChoices.Statuses.Should().BeNullOrEmpty();
}
#endregion Happy Path
#region Sad Path
[TestMethod]
public async Task RegistrationSubmissions_Return_PageNot_Found_When_FilterAction_IsEmpty()
{
var viewModel = new RegistrationSubmissionsFilterViewModel();
var result = await _controller.RegistrationSubmissions(viewModel, null);
Assert.IsNotNull(result);
result.Should().BeOfType<RedirectToActionResult>();
(result as RedirectToActionResult).ActionName.Should().Be(PagePath.PageNotFound);
}
[TestMethod]
public async Task RegistrationSubmissions_Return_PageNot_Found_When_FilterAction_IsInvalid()
{
var viewModel = new RegistrationSubmissionsFilterViewModel();
var result = await _controller.RegistrationSubmissions(viewModel, "anything");
Assert.IsNotNull(result);
result.Should().BeOfType<RedirectToActionResult>();
(result as RedirectToActionResult).ActionName.Should().Be(PagePath.PageNotFound);
}
[TestMethod]
public async Task RegistrationSubmissions_Return_PageNot_Found_When_FilterAction_IsSubmitFilter_And_No_Filters_Supplied()
{
var result = await _controller.RegistrationSubmissions(null, FilterActions.SubmitFilters);
Assert.IsNotNull(result);
result.Should().BeOfType<RedirectToActionResult>();
(result as RedirectToActionResult).ActionName.Should().Be(PagePath.PageNotFound);
}
[TestMethod]
public async Task RegistrationSubmissions_Return_PageNot_Found_When_No_Filter_Or_Query_Supplied()
{
var result = await _controller.RegistrationSubmissions(null, null);
Assert.IsNotNull(result);
result.Should().BeOfType<RedirectToActionResult>();
(result as RedirectToActionResult).ActionName.Should().Be(PagePath.PageNotFound);
}
[TestMethod]
public async Task PostingTo_RegistrationSubmissions_Return_ErrorPage_When_Exception_Received()
{
_mockSessionManager.Setup(x => x.GetSessionAsync(It.IsAny<ISession>())).Throws(new Exception("Test"));
var result = await _controller.RegistrationSubmissions(null, null);
Assert.IsNotNull(result);
result.Should().BeOfType<RedirectToActionResult>();
(result as RedirectToActionResult).ActionName.Should().Be(PagePath.Error);
}
[TestMethod]
public async Task PostTo_RegistrationSubmissions_Logs_Error_When_Exception_Received()
{
_mockSessionManager.Setup(x => x.GetSessionAsync(It.IsAny<ISession>())).Throws(new Exception("Test"));
var result = await _controller.RegistrationSubmissions(null, null);
Assert.IsNotNull(result);
result.Should().BeOfType<RedirectToActionResult>();
(result as RedirectToActionResult).ActionName.Should().Be(PagePath.Error);
_loggerMock.Verify(
x => x.Log(
It.Is<LogLevel>(logLevel => logLevel == LogLevel.Error),
It.Is<EventId>((eid) => eid == 1001),
It.IsAny<It.IsAnyType>(),
It.Is<Exception>((v, t) => v.ToString().Contains("Test")),
It.IsAny<Func<It.IsAnyType, Exception, string>>()),
Times.Once);
}
#endregion Sad Path
#endregion Session Models and Filter states between gets and posts
#endregion RegistrationSubmissions
#region GrantRegistrationSubmission
[TestMethod]
public async Task GrantRegistrationSubmission_ReturnsPageNotFound_When_SubmissionId_DoesNot_Match_With_That_InSession()
{
// Act
var submissionId = Guid.NewGuid();
string locationUrl = $"/regulators/{PagePath.RegistrationSubmissionDetails}/{submissionId}";
var mockUrlHelper = CreateUrlHelper(submissionId, locationUrl);
var detailsModel = GenerateTestSubmissionDetailsViewModel(submissionId);
_journeySession.RegulatorRegistrationSubmissionSession = new RegulatorRegistrationSubmissionSession
{
SelectedRegistrations = new Dictionary<Guid, RegistrationSubmissionOrganisationDetails> {
{ submissionId, detailsModel }
}
};
_controller.Url = mockUrlHelper.Object;
var result = await _controller.GrantRegistrationSubmission(Guid.NewGuid());
// Assert
var viewResult = result as RedirectToActionResult;
Assert.IsNotNull(viewResult, "Result should be of type ViewResult.");
Assert.AreEqual(PagePath.PageNotFound, viewResult.ActionName); // Ensure the user is redirected to the correct URL
}
[TestMethod]
public async Task GrantRegistrationSubmission_ReturnsView_WithCorrectModel()
{
// Arrange
var submissionId = Guid.NewGuid();
string locationUrl = $"/regulators/{PagePath.RegistrationSubmissionDetails}/{submissionId}";
var mockUrlHelper = CreateUrlHelper(submissionId, locationUrl);
var detailsModel = GenerateTestSubmissionDetailsViewModel(submissionId);
_journeySession.RegulatorRegistrationSubmissionSession = new RegulatorRegistrationSubmissionSession
{
SelectedRegistrations = new Dictionary<Guid, RegistrationSubmissionOrganisationDetails> {
{ submissionId, detailsModel }
}
};
// Act
_controller.Url = mockUrlHelper.Object;
var result = await _controller.GrantRegistrationSubmission(submissionId) as ViewResult;
// Assert
Assert.IsNotNull(result, "Result should be a ViewResult when ModelState is invalid.");
Assert.AreEqual(nameof(_controller.GrantRegistrationSubmission), result.ViewName, "The view name should match the action name.");
// Verify that a back link is set with the expected format, including a GUID
string backLink = _controller.ViewData["BackLinkToDisplay"] as string;
Assert.IsNotNull(backLink, "BackLinkToDisplay should be set in ViewData.");
StringAssert.StartsWith(backLink, $"/regulators/{PagePath.RegistrationSubmissionDetails}/", "Back link should start with the expected URL.");
// Check that the back link contains a valid GUID at the end
string[] segments = backLink.Split('/');
Assert.IsTrue(Guid.TryParse(segments[^1], out _), "Back link should contain a valid GUID.");
}
[TestMethod]
public async Task GrantRegistrationSubmission_Get_Should_ReturnTo_CorrectViewWithModel()
{
// Arrange
var submissionId = Guid.NewGuid();
var detailsModel = GenerateTestSubmissionDetailsViewModel(submissionId);
_journeySession.RegulatorRegistrationSubmissionSession = new RegulatorRegistrationSubmissionSession
{
SelectedRegistrations = new Dictionary<Guid, RegistrationSubmissionOrganisationDetails> {
{ submissionId, detailsModel }
}
};
string locationUrl = $"/regulators/{PagePath.RegistrationSubmissionDetails}/{submissionId}";
var mockUrlHelper = CreateUrlHelper(submissionId, locationUrl);
_controller.Url = mockUrlHelper.Object;
// Act
var result = await _controller.GrantRegistrationSubmission(submissionId) as ViewResult;
// Assert
Assert.IsNotNull(result);
Assert.AreEqual(nameof(_controller.GrantRegistrationSubmission), result.ViewName, "The view name should match the action name.");
result.Model.Should().BeOfType<GrantRegistrationSubmissionViewModel>();
}
[TestMethod]
public async Task GrantRegistrationSubmission_Post_ReturnsPageNotFound_When_SubmissionId_Is_Invalid()
{
// Act
var submissionId = Guid.NewGuid();
string locationUrl = $"/regulators/{PagePath.RegistrationSubmissionDetails}/{submissionId}";
var mockUrlHelper = CreateUrlHelper(submissionId, locationUrl);
var detailsModel = GenerateTestSubmissionDetailsViewModel(submissionId);
_journeySession.RegulatorRegistrationSubmissionSession = new RegulatorRegistrationSubmissionSession
{
SelectedRegistrations = new Dictionary<Guid, RegistrationSubmissionOrganisationDetails> {
{ submissionId, detailsModel }
}
};
_controller.Url = mockUrlHelper.Object;
// Act
var result = await _controller.GrantRegistrationSubmission(new GrantRegistrationSubmissionViewModel { SubmissionId = Guid.NewGuid() });
// Assert
var viewResult = result as RedirectToActionResult;
Assert.IsNotNull(viewResult, "Result should be of type ViewResult.");
Assert.AreEqual(PagePath.PageNotFound, viewResult.ActionName); // Ensure the user is redirected to the correct URL
}
[TestMethod]
public async Task GrantRegistrationSubmission_Post_Should_Display_ErrorMessage_When_Nothing_Is_Selected()
{
// Arrange
var submissionId = Guid.NewGuid();
var detailsModel = GenerateTestSubmissionDetailsViewModel(submissionId);
_journeySession.RegulatorRegistrationSubmissionSession = new RegulatorRegistrationSubmissionSession
{
SelectedRegistrations = new Dictionary<Guid, RegistrationSubmissionOrganisationDetails> {
{ submissionId, detailsModel }
}
};
_controller.ModelState.AddModelError("IsGrantRegistrationConfirmed", "Select yes if you want to grant this registration");
// Act
var result = await _controller.GrantRegistrationSubmission(new GrantRegistrationSubmissionViewModel { SubmissionId = submissionId }) as ViewResult;
// Assert
Assert.IsNotNull(result);
Assert.AreEqual(nameof(_controller.GrantRegistrationSubmission), result.ViewName, "The view name should match the action name.");
var model = result.Model.As<GrantRegistrationSubmissionViewModel>();
model.Should().NotBeNull();
model.IsGrantRegistrationConfirmed.Should().BeNull();
// Verify that ModelState has errors
Assert.IsTrue(_controller.ModelState.ErrorCount > 0, "ModelState should contain errors.");
Assert.AreEqual("Select yes if you want to grant this registration", _controller.ModelState["IsGrantRegistrationConfirmed"].Errors[0].ErrorMessage, "The error message should match the expected message.");
}
[TestMethod]
public async Task GrantRegistrationSubmission_Post_Should_RedirectTo_SubmissionDetails_When_NotConfirmed()
{
// Arrange
var submissionId = Guid.NewGuid();
var detailsModel = GenerateTestSubmissionDetailsViewModel(submissionId);
_journeySession.RegulatorRegistrationSubmissionSession.SelectedRegistrations =
new Dictionary<Guid, RegistrationSubmissionOrganisationDetails> { { submissionId, detailsModel } };
// Act
var result = await _controller.GrantRegistrationSubmission(new GrantRegistrationSubmissionViewModel
{ SubmissionId = submissionId, IsGrantRegistrationConfirmed = false }) as RedirectToRouteResult;
// Assert
Assert.IsNotNull(result);
result.RouteName.Should().Be("SubmissionDetails");
result.RouteValues.First().Value.Should().Be(submissionId);
}
[TestMethod]
public async Task GrantRegistrationSubmission_Post_Should_RedirectTo_ServiceNotAvailable_When_Facade_Returns_Fail()
{
// Arrange
var submissionId = Guid.NewGuid();
var detailsModel = GenerateTestSubmissionDetailsViewModel(submissionId);
_journeySession.RegulatorRegistrationSubmissionSession = new RegulatorRegistrationSubmissionSession
{
SelectedRegistrations = new Dictionary<Guid, RegistrationSubmissionOrganisationDetails> {
{ submissionId, detailsModel }
}
};
_facadeServiceMock.Setup(r => r.SubmitRegulatorRegistrationDecisionAsync(It.IsAny<RegulatorDecisionRequest>())).ReturnsAsync(EndpointResponseStatus.Fail);
// Act
var result = await _controller.GrantRegistrationSubmission(new GrantRegistrationSubmissionViewModel
{ SubmissionId = submissionId, IsGrantRegistrationConfirmed = true }) as RedirectToRouteResult;
// Assert
Assert.IsNotNull(result);
result.RouteName.Should().Be("ServiceNotAvailable");
result.RouteValues.First().Value.Should().Be($"{PagePath.RegistrationSubmissionDetails}/{submissionId}");
_facadeServiceMock.Verify(r => r.SubmitRegulatorRegistrationDecisionAsync(It.IsAny<RegulatorDecisionRequest>()), Times.AtMostOnce);
}
[TestMethod]
public async Task GrantRegistrationSubmission_Post_Should_RedirectTo_ServiceNotAvailable_When_Facade_Throws()
{
// Arrange
var submissionId = Guid.NewGuid();
var existingModel = GenerateTestSubmissionDetailsViewModel(submissionId);
SetupJourneySession(null, existingModel);
var model = new GrantRegistrationSubmissionViewModel
{
SubmissionId = submissionId,
IsGrantRegistrationConfirmed = true
};
var exception = new Exception("Test exception");
// Set up the mock to throw an exception when SubmitRegulatorRegistrationDecisionAsync is called
_facadeServiceMock
.Setup(service => service.SubmitRegulatorRegistrationDecisionAsync(It.IsAny<RegulatorDecisionRequest>()))
.ThrowsAsync(exception);
// Act
var result = await _controller.GrantRegistrationSubmission(model) as RedirectToRouteResult;
// Assert
Assert.IsNotNull(result);
Assert.AreEqual("ServiceNotAvailable", result.RouteName);
// Verify the back link in the route values is set correctly
Assert.AreEqual($"{PagePath.RegistrationSubmissionDetails}/{submissionId}", result.RouteValues["backLink"]);
// Verify that the facade service was called the expected number of times
_facadeServiceMock.Verify(mock =>
mock.SubmitRegulatorRegistrationDecisionAsync(It.IsAny<RegulatorDecisionRequest>()), Times.Once);
// Verify that _logControllerError was called with correct parameters
_loggerMock.Verify(logger =>
logger.Log(
LogLevel.Error,
It.IsAny<EventId>(),
It.Is<It.IsAnyType>((v, t) => v.ToString().Contains("Exception received while granting submission")),
exception,
It.IsAny<Func<It.IsAnyType, Exception, string>>()),
Times.Once);
}
[TestMethod]
[DataRow(1, "Eng")]
[DataRow(2, "NI")]
[DataRow(3, "Sco")]
[DataRow(4, "Wal")]
[DataRow(5, "Eng")]
public async Task GrantRegistrationSubmission_Post_RedirectTo_SubmissionDetails_OnSuccess(int nationId, string nationCode)
{
// Arrange
var submissionId = Guid.NewGuid();
var detailsModel = GenerateTestSubmissionDetailsViewModel(submissionId, nationId, nationCode);
_journeySession.RegulatorRegistrationSubmissionSession = new RegulatorRegistrationSubmissionSession
{
SelectedRegistrations = new Dictionary<Guid, RegistrationSubmissionOrganisationDetails> {
{ submissionId, detailsModel }
}
}
;
_facadeServiceMock.Setup(r => r.SubmitRegulatorRegistrationDecisionAsync(It.IsAny<RegulatorDecisionRequest>())).ReturnsAsync(EndpointResponseStatus.Success);
// Act
var result = await _controller.GrantRegistrationSubmission(new GrantRegistrationSubmissionViewModel
{ SubmissionId = submissionId, IsGrantRegistrationConfirmed = true }) as RedirectToRouteResult;
// Assert
Assert.IsNotNull(result);
result.RouteName.Should().Be("SubmissionDetails");
result.RouteValues.First().Value.Should().Be(submissionId);
_facadeServiceMock.Verify(r => r.SubmitRegulatorRegistrationDecisionAsync(It.IsAny<RegulatorDecisionRequest>()), Times.AtMostOnce);
}
[TestMethod]
[DataRow(1, "Eng")]
[DataRow(2, "NI")]
[DataRow(3, "Sco")]
[DataRow(4, "Wal")]
public async Task On_GrantRegistrationSubmission_Update_Session_SelectedRegistrations_To_Remove_SubmissionDetails(int nationId, string nationCode)
{
// Arrange
var submissionId = Guid.NewGuid();
var detailsModel = GenerateTestSubmissionDetailsViewModel(submissionId, nationId, nationCode);
_journeySession.RegulatorRegistrationSubmissionSession = new RegulatorRegistrationSubmissionSession
{
SelectedRegistrations = new Dictionary<Guid, RegistrationSubmissionOrganisationDetails> {
{ submissionId, detailsModel }
}
}
;
_facadeServiceMock.Setup(r => r.SubmitRegulatorRegistrationDecisionAsync(It.IsAny<RegulatorDecisionRequest>())).ReturnsAsync(EndpointResponseStatus.Success);
// Act
var result = await _controller.GrantRegistrationSubmission(new GrantRegistrationSubmissionViewModel
{ SubmissionId = submissionId, IsGrantRegistrationConfirmed = true }) as RedirectToRouteResult;
// Assert
bool isSessionHoldsSubmissionId =
_journeySession.RegulatorRegistrationSubmissionSession.SelectedRegistrations.TryGetValue(submissionId, out var selectedRegistration);
Assert.IsNotNull(result);
Assert.IsNull(selectedRegistration);
Assert.IsFalse(isSessionHoldsSubmissionId);
result.RouteName.Should().Be("SubmissionDetails");
result.RouteValues.First().Value.Should().Be(submissionId);
_facadeServiceMock.Verify(r => r.SubmitRegulatorRegistrationDecisionAsync(It.IsAny<RegulatorDecisionRequest>()), Times.AtMostOnce);
}
[TestMethod]
[DataRow(1, "Eng")]
[DataRow(2, "NI")]
[DataRow(3, "Sco")]
[DataRow(4, "Wal")]
public async Task On_GrantRegistrationSubmission_Update_Session_OrganisationDetailsChangeHistory_To_Remove_SubmissionDetails(int nationId, string nationCode)
{
// Arrange
var submissionId = Guid.NewGuid();
var detailsModel = GenerateTestSubmissionDetailsViewModel(submissionId, nationId, nationCode);
var updateSubmissionDetailsModel = GenerateTestSubmissionDetailsViewModel(submissionId, nationId, nationCode);
_journeySession.RegulatorRegistrationSubmissionSession = new RegulatorRegistrationSubmissionSession
{
SelectedRegistrations = new Dictionary<Guid, RegistrationSubmissionOrganisationDetails> {
{ submissionId, detailsModel }
},
OrganisationDetailsChangeHistory = new Dictionary<Guid, RegistrationSubmissionOrganisationDetails> {
{ submissionId, updateSubmissionDetailsModel }
},
};
_facadeServiceMock.Setup(r => r.SubmitRegulatorRegistrationDecisionAsync(It.IsAny<RegulatorDecisionRequest>())).ReturnsAsync(EndpointResponseStatus.Success);
// Act
var result = await _controller.GrantRegistrationSubmission(new GrantRegistrationSubmissionViewModel
{ SubmissionId = submissionId, IsGrantRegistrationConfirmed = true }) as RedirectToRouteResult;
// Assert
_journeySession.RegulatorRegistrationSubmissionSession.SelectedRegistrations.TryGetValue(submissionId, out var submissionOrganisationDetails);
_journeySession.RegulatorRegistrationSubmissionSession.OrganisationDetailsChangeHistory.TryGetValue(submissionId, out var organisationDetailsChangeHistory_Submission);
Assert.IsNotNull(result);
Assert.IsNull(organisationDetailsChangeHistory_Submission);
Assert.IsNull(submissionOrganisationDetails);
result.RouteName.Should().Be("SubmissionDetails");
result.RouteValues.First().Value.Should().Be(submissionId);
_facadeServiceMock.Verify(r => r.SubmitRegulatorRegistrationDecisionAsync(It.IsAny<RegulatorDecisionRequest>()), Times.AtMostOnce);
}
[TestMethod]
[DataRow(1, "Eng")]
[DataRow(2, "NI")]
[DataRow(3, "Sco")]
[DataRow(4, "Wal")]
public async Task On_GrantRegistrationSubmission_Fails_Update_Session_To_Remove_SubmissionDetails(int nationId, string nationCode)
{
// Arrange
var submissionId = Guid.NewGuid();
var detailsModel = GenerateTestSubmissionDetailsViewModel(submissionId, nationId, nationCode);
var updateSubmissionDetailsModel = GenerateTestSubmissionDetailsViewModel(submissionId, nationId, nationCode);
_journeySession.RegulatorRegistrationSubmissionSession = new RegulatorRegistrationSubmissionSession
{
SelectedRegistrations = new Dictionary<Guid, RegistrationSubmissionOrganisationDetails> {
{ submissionId, detailsModel }
},
OrganisationDetailsChangeHistory = new Dictionary<Guid, RegistrationSubmissionOrganisationDetails> {
{ submissionId, updateSubmissionDetailsModel }
},
};
_facadeServiceMock.Setup(r => r.SubmitRegulatorRegistrationDecisionAsync(It.IsAny<RegulatorDecisionRequest>())).ReturnsAsync(EndpointResponseStatus.Fail);
// Act
var result = await _controller.GrantRegistrationSubmission(new GrantRegistrationSubmissionViewModel
{ SubmissionId = submissionId, IsGrantRegistrationConfirmed = true }) as RedirectToRouteResult;
// Assert
bool isSessionHoldsSubmissionId =
_journeySession.RegulatorRegistrationSubmissionSession.SelectedRegistrations.TryGetValue(submissionId, out var selectedRegistration);
_journeySession.RegulatorRegistrationSubmissionSession.OrganisationDetailsChangeHistory.TryGetValue(submissionId, out var organisationDetailsChangeHistory_Submission);
Assert.IsNotNull(result);
Assert.IsNull(selectedRegistration);
Assert.IsNull(organisationDetailsChangeHistory_Submission);
Assert.IsFalse(isSessionHoldsSubmissionId);
result.RouteName.Should().Be("ServiceNotAvailable");
result.RouteValues.First().Value.Should().Be("registration-submission-details/" + submissionId);
_facadeServiceMock.Verify(r => r.SubmitRegulatorRegistrationDecisionAsync(It.IsAny<RegulatorDecisionRequest>()), Times.AtMostOnce);
}