-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathProjectControllerSpec.groovy
1027 lines (813 loc) · 39.3 KB
/
ProjectControllerSpec.groovy
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
package au.org.ala.merit
import au.org.ala.merit.command.MeriPlanReportCommand
import au.org.ala.merit.command.SaveReportDataCommand
import au.org.ala.merit.config.ProgramConfig
import au.org.ala.merit.reports.ReportLifecycleListener
import org.apache.http.HttpStatus
import spock.lang.Specification
import grails.testing.web.controllers.ControllerUnitTest
/**
* Specification for the ProjectController
*/
class ProjectControllerSpec extends Specification implements ControllerUnitTest<ProjectController>{
def userServiceStub = Mock(UserService)
def metadataServiceStub = Stub(MetadataService)
def projectService = Mock(ProjectService)
def siteServiceStub = Stub(SiteService)
def roleServiceStub = Stub(RoleService)
def activityServiceStub = Stub(ActivityService)
def commonServiceStub = Stub(CommonService)
def reportServiceStub = Stub(ReportService)
def blogService = Stub(BlogService)
def reportService = Mock(ReportService)
def activityService = Mock(ActivityService)
def siteService = Mock(SiteService)
WebService webService = Mock(WebService)
MonitorService monitorService = Mock(MonitorService)
ProjectService realProjectService
void setup() {
realProjectService = new ProjectService()
realProjectService.metadataService = metadataServiceStub
controller.userService = userServiceStub
controller.metadataService = metadataServiceStub
controller.projectService = projectService
controller.siteService = siteServiceStub
controller.roleService = roleServiceStub
controller.activityService = activityServiceStub
controller.commonService = commonServiceStub
controller.reportService = reportServiceStub
controller.blogService = blogService
controller.reportService = reportService
controller.siteService = siteService
controller.activityService = activityService
controller.grailsApplication = grailsApplication
controller.webService = webService
controller.monitorService = monitorService
projectService.getMembersForProjectId(_) >> []
projectService.getProgramConfiguration(_) >> new ProgramConfig([requiresActivityLocking: true])
projectService.getProjectServices(_) >> { project -> realProjectService.getProjectServices(project)}
metadataServiceStub.organisationList() >> [list:[]]
userServiceStub.isProjectStarredByUser(_, _) >> [isProjectStarredByUser:true]
roleServiceStub.getRoles() >> []
reportServiceStub.getReportsForProject(_) >> []
activityServiceStub.activitiesForProject(_) >> []
projectService.grailsApplication = grailsApplication
realProjectService.grailsApplication = grailsApplication
}
def "the program can exclude optional project content"() {
setup:
def projectId = '1234'
projectService.get(projectId, _, _) >> project(projectId)
when: "we view a project homepage of a project run under a program configured to exclude the MERI Plan and Risks and Threats"
controller.index(projectId)
then:
1 * projectService.getProgramConfiguration(_) >> new ProgramConfig([name:'Test', excludes:['MERI_PLAN', 'RISKS_AND_THREATS']])
and: "The MERI plan and risks and threats content is not visible"
view == '/project/index'
model.projectContent.details.visible == false
model.projectContent.plan.risksAndThreatsVisible == false
}
def "most content is disabled if the user is not logged in"() {
setup:
def projectId = '1234'
projectService.get(projectId, null, _) >> project(projectId)
projectService.programsModel() >> new ProgramConfig([programs:[[name:'Test']]])
userServiceStub.getUser() >> null
when: "retrieving the project index page"
controller.index(projectId)
then: "Only the overview and documents tabs are enabled"
view == '/project/index'
!model.projectContent.overview.disabled
!model.projectContent.documents.disabled
model.projectContent.plan.disabled == true
model.projectContent.details.disabled == true
model.projectContent.site.disabled == true
model.projectContent.dashboard.disabled == true
and: "the data set summary and admin tabs are not visible"
model.projectContent.admin.visible == false
model.projectContent.datasets.visible == false
}
def "the admin content should be enabled for project admins"() {
def projectId = '1234'
projectService.programsModel() >> [programs:[[name:'Test', optionalProjectContent:['Risks and Threats', 'MERI Plan']]]]
Map userDetails = stubProjectAdmin('1234', projectId)
when: "retrieving the project index page"
controller.index(projectId)
then:
1 * projectService.get(projectId, userDetails, _) >> project(projectId)
and: "The admin tab is visible"
view == '/project/index'
model.projectContent.admin.visible
!model.projectContent.admin.disabled
}
def "the admin content should be enabled for grant managers"() {
def projectId = '1234'
projectService.programsModel() >> [programs:[[name:'Test', optionalProjectContent:['Risks and Threats', 'MERI Plan']]]]
Map userDetails = stubGrantManager('1234', projectId)
when: "retrieving the project index page"
controller.index(projectId)
then:
1 * projectService.get(projectId, userDetails, _) >> project(projectId)
and: "The admin tab is visible"
view == '/project/index'
model.projectContent.admin.visible
!model.projectContent.admin.disabled
}
def "meri plan should be visible to read only users"() {
setup:
def projectId = '1234'
projectService.get(projectId, null, _) >> project(projectId)
projectService.programsModel() >> new ProgramConfig([programs:[[name:'Test']]])
Map userDetails = stubReadOnly('1234', projectId)
when: "retrieving the project index page"
controller.index(projectId)
then:
1 * projectService.get(projectId, userDetails, _) >> project(projectId)
and: "meri plan is visible"
model.projectContent.details.meriPlanVisibleToUser == true
}
def "the admin content should be present for project editors (to edit blog)"() {
def projectId = '1234'
projectService.programsModel() >> [programs:[[name:'Test', optionalProjectContent:['Risks and Threats', 'MERI Plan']]]]
Map userDetails = stubProjectEditor('1234', projectId)
when: "retrieving the project index page"
controller.index(projectId)
then:
1 * projectService.get(projectId, userDetails, _) >> project(projectId)
and: "The admin tab is visible"
view == '/project/index'
model.projectContent.admin.visible
}
def "the announcements menu shouldn't be shown in RLP projects"() {
def projectId = '1234'
Map project = project(projectId)
project.planStatus = ProjectService.PLAN_APPROVED // The announcements menu items shows only for approved projects
projectService.getProgramConfiguration(_) >> new ProgramConfig([projectTemplate: ProjectController.RLP_TEMPLATE])
Map userDetails = stubProjectAdmin('1234', projectId)
when: "retrieving the project index page"
controller.index(projectId)
then:
1 * projectService.get(projectId, userDetails, _) >> project
and: "The admin tab does not include the announcements menu item"
view == '/project/index'
model.projectContent.admin.showAnnouncementsTab == false
}
def "Only grant managers can request to view a template in the non-configured project view"() {
setup:
String projectId = '1234'
userServiceStub.userIsSiteAdmin() >> false
Map project = project(projectId)
Map userDetails = stubProjectAdmin('1234', projectId)
String projectTemplate = 'esp'
when:
params.template='index'
controller.index(projectId)
then:
1 * projectService.get(projectId, userDetails, _) >> project
1 * projectService.getProgramConfiguration(project) >> new ProgramConfig([projectTemplate: projectTemplate])
view == "/project/espOverview"
!model.showAlternateTemplate
}
def "if a template is requested that is different to the project default, provide navigation back to the default template view"() {
setup:
String projectId = '1234'
userServiceStub.userIsSiteAdmin() >> true
Map project = project(projectId)
Map userDetails = stubGrantManager('1234', projectId)
String projectTemplate = 'esp'
when:
params.template='index'
controller.index(projectId)
then:
1 * projectService.get(projectId, userDetails, _) >> project
1 * projectService.getProgramConfiguration(project) >> new ProgramConfig([projectTemplate: projectTemplate])
model.showAlternateTemplate == true
}
def "projects not using the default template shouldn't display navigation back to the default template"() {
setup:
String projectId = '1234'
Map project = project(projectId)
Map userDetails = stubGrantManager('1234', projectId)
String projectTemplate = 'rlp'
when:
params.template=null
controller.index(projectId)
then:
1 * projectService.get(projectId, userDetails, _) >> project
1 * projectService.getProgramConfiguration(project) >> new ProgramConfig([projectTemplate: projectTemplate])
model.showAlternateTemplate == false
}
def "when viewing a project report, the model will be customized for project reporting"() {
setup:
String projectId = 'p1'
String reportId = 'r1'
stubProjectAdmin('1234', projectId)
Map project = this.project(projectId, true)
projectService.get(projectId) >> project
Map activityReportModel = [editable:true, metaModel:[:], outputModels:[:], activity:[activityId:'a1'], report:[:]]
when:
controller.viewReport(projectId, reportId)
then:
1 * projectService.doesReportBelongToProject(projectId, reportId) >> true
1 * reportService.activityReportModel(reportId, ReportService.ReportMode.VIEW, null) >> activityReportModel
1 * reportService.reportLifeCycleListener(_) >> new ReportLifecycleListener()
1 * projectService.filterOutputModel(activityReportModel.metaModel, project, activityReportModel.activity) >> activityReportModel.metaModel
1 * projectService.getProgramConfiguration(project) >> new ProgramConfig([requiresActivityLocking: true])
view == '/activity/activityReportView'
model.context == project
model.contextViewUrl == '/project/index/'+projectId
model.reportHeaderTemplate == '/project/rlpProjectReportHeader'
}
def "when editing a project report, the model will be customized for project reporting"() {
setup:
String projectId = 'p1'
String reportId = 'r1'
stubProjectAdmin('1234', projectId)
Map project = this.project(projectId, true)
projectService.get(projectId) >> project
Map activityReportModel = [editable:true, metaModel:[:], outputModels:[:], activity:[activityId:'a1'], report:[activityId:'a1', reportId:reportId]]
when:
controller.editReport(projectId, reportId)
then:
1 * projectService.doesReportBelongToProject(projectId, reportId) >> true
1 * reportService.activityReportModel(reportId, ReportService.ReportMode.EDIT, null) >> activityReportModel
1 * reportService.reportLifeCycleListener(_) >> new ReportLifecycleListener()
1 * projectService.filterOutputModel(activityReportModel.metaModel, project, activityReportModel.activity) >> activityReportModel.metaModel
1 * projectService.getProgramConfiguration(project) >> new ProgramConfig([requiresActivityLocking: true])
view == '/activity/activityReport'
model.context == project
model.contextViewUrl == '/project/index/'+projectId
model.reportHeaderTemplate == '/project/rlpProjectReportHeader'
model.saveReportUrl == '/project/saveReport/'+projectId+'?reportId='+reportId
}
def "if a report is not editable, the program project should present the report view instead"() {
setup:
String projectId = 'p1'
String reportId = 'r1'
stubProjectAdmin('1234', projectId)
Map project = this.project(projectId, true)
projectService.get(projectId) >> project
Map activityReportModel = [editable:false, metaModel:[:], outputModels:[:], activity:[activityId:'a1'], report:[:]]
when:
reportService.activityReportModel(reportId, ReportService.ReportMode.EDIT, null) >> activityReportModel
controller.editReport(projectId, reportId)
then: "the report activity should not be locked"
1 * projectService.doesReportBelongToProject(projectId, reportId) >> true
1 * reportService.reportLifeCycleListener(_) >> new ReportLifecycleListener()
// Override the default behaviour from setup
1 * projectService.getProgramConfiguration(project) >> new ProgramConfig([requiresActivityLocking: true])
0 * reportService.lockForEditing(_)
1 * projectService.filterOutputModel(activityReportModel.metaModel, project, activityReportModel.activity) >> activityReportModel.metaModel
and: "the user should be redirected to the report view"
response.redirectUrl == '/project/viewReport/'+projectId+"?reportId="+reportId+"&attemptedEdit=true"
}
def "if the project uses pessimistic locking for reports, the report activity should be locked when the report is edited"() {
setup:
String projectId = 'p1'
String reportId = 'r1'
stubProjectAdmin('1234', projectId)
Map project = this.project(projectId, true)
projectService.get(projectId) >> project
Map activityReportModel = [editable:true, metaModel:[:], outputModels:[:], activity:[activityId:'a1'], report:project.reports[0]]
when:
reportService.activityReportModel(reportId, ReportService.ReportMode.EDIT, null) >> activityReportModel
projectService.getProgramConfiguration(project) >> new ProgramConfig([requiresActivityLocking: true])
controller.editReport(projectId, reportId)
then:
1 * projectService.doesReportBelongToProject(projectId, reportId) >> true
1 * reportService.reportLifeCycleListener(_) >> new ReportLifecycleListener()
1 * reportService.lockForEditing(project.reports[0])
1 * projectService.filterOutputModel(activityReportModel.metaModel, project, activityReportModel.activity) >> activityReportModel.metaModel
view == '/activity/activityReport'
}
def "if the project uses pessimistic locking for reports, if the user already holds the lock, the lock should not be re-obtained"() {
setup:
String projectId = 'p1'
String reportId = 'r1'
stubProjectAdmin('1234', projectId)
Map project = this.project(projectId, true)
projectService.get(projectId) >> project
Map activityReportModel = [editable:true, metaModel:[:], outputModels:[:], activity:[activityId:'a1', lock:'1234'], report:project.reports[0]]
when:
reportService.activityReportModel(reportId, ReportService.ReportMode.EDIT, null) >> activityReportModel
projectService.getProgramConfiguration(project) >> new ProgramConfig([requiresActivityLocking: true])
controller.editReport(projectId, reportId)
then:
1 * projectService.doesReportBelongToProject(projectId, reportId) >> true
1 * reportService.reportLifeCycleListener(_) >> new ReportLifecycleListener()
0 * reportService.lockForEditing(project.reports[0])
1 * projectService.filterOutputModel(activityReportModel.metaModel, project, activityReportModel.activity) >> activityReportModel.metaModel
view == '/activity/activityReport'
}
def "report data shouldn't be saved if the project id of the report doesn't match the project id checked by the annotation"() {
setup:
Map props = [
activityId:'a1',
activity:[
test1:'test'
],
reportId:'r1',
reportService:reportService,
activityService: activityService
]
reportService.get(props.reportId) >> [projectId:'p2']
SaveReportDataCommand cmd = new SaveReportDataCommand(props)
when:
params.projectId = 'p1'
controller.saveReport(cmd)
then:
response.json.error != null
response.json.status == HttpStatus.SC_UNAUTHORIZED
}
def "Users cannot request to view a report not owned by the project they have access to"() {
setup:
String projectId = 'p1'
String reportId = 'r1'
when:
controller.viewReport(projectId, reportId)
then:
1 * projectService.doesReportBelongToProject(projectId, reportId) >> false
0 * _._
and:
response.redirectUrl == '/project/index/'+projectId
}
def "Users cannot request to edit a report not owned by the project they have access to"() {
setup:
String projectId = 'p1'
String reportId = 'r1'
when:
controller.editReport(projectId, reportId)
then:
1 * projectService.doesReportBelongToProject(projectId, reportId) >> false
0 * _._
and:
response.redirectUrl == '/project/index/'+projectId
}
def "Users cannot request to print a report not owned by the project they have access to"() {
setup:
String projectId = 'p1'
String reportId = 'r1'
when:
controller.printableReport(projectId, reportId)
then:
1 * projectService.doesReportBelongToProject(projectId, reportId) >> false
0 * _._
and:
response.redirectUrl == '/project/index/'+projectId
}
def "Users cannot request a PDF of a report not owned by the project they have access to"() {
setup:
String projectId = 'p1'
String reportId = 'r1'
when:
controller.printableReport(projectId, reportId)
then:
1 * projectService.doesReportBelongToProject(projectId, reportId) >> false
0 * _._
and:
response.redirectUrl == '/project/index/'+projectId
}
def "Users cannot request to reset a report not owned by the project they have access to"() {
setup:
String projectId = 'p1'
String reportId = 'r1'
when:
controller.resetReport(projectId, reportId)
then:
1 * projectService.doesReportBelongToProject(projectId, reportId) >> false
0 * _._
and:
response.redirectUrl == '/project/index/'+projectId
}
def "Users cannot request targets and score data for an activity not owned by the project they have access to"() {
setup:
String projectId = 'p1'
String activityId = 'a1'
when:
controller.targetsAndScoresForActivity(projectId, activityId)
then:
1 * projectService.doesActivityBelongToProject(projectId, activityId) >> false
0 * _._
and:
response.redirectUrl == '/project/index/'+projectId
}
def "Users can request targets and score data for a project / activity combination"() {
setup:
String projectId = 'p1'
String activityId = 'a1'
Map targetsAndScoresData = [:]
when:
controller.targetsAndScoresForActivity(projectId, activityId)
then:
1 * projectService.doesActivityBelongToProject(projectId, activityId) >> true
1 * projectService.targetsAndScoresForActivity(activityId) >> targetsAndScoresData
and:
response.json == targetsAndScoresData
}
def "Tick targeted project outcomes"() {
def projectId = '1234'
Map project = project(projectId)
project["custom"] = [details :[outcomes:[primaryOutcome:[
assets: ["Ginini Flats Wetland Complex"],
description: "By 2023, there is restoration of, and reduction in threats to, the ecological character of Ramsar sites, through the implementation of priority actions"
]]]]
Map userDetails = stubProjectAdmin('1234', projectId)
when: "build RLP model"
controller.index(projectId)
then:
1 * projectService.get(projectId, userDetails, _) >> project
1 * projectService.getProgramConfiguration(_) >> new ProgramConfig([
projectTemplate: ProjectController.RLP_TEMPLATE,
outcomes: [
[
"priorities": ["category":"Ramsar"],
"shortDescription":"Ramsar Sites",
"category":"environment",
"outcome":"By 2023, there is restoration of, and reduction in threats to, the ecological character of Ramsar sites, through the implementation of priority actions"
],
]
])
and: "The project outcomes should be made available to the model"
model.project.outcomes[0].targeted == true
}
def "In RLP projects, only the overview and documents tab are displayed to public users"() {
setup:
String projectId = '1234'
Map project = project(projectId)
Map userDetails = stubPublicUser()
when:
controller.index(projectId)
then:
1 * projectService.get(projectId, userDetails, _) >> project
1 * projectService.getProgramConfiguration(_) >> new ProgramConfig([
projectTemplate: ProjectController.RLP_TEMPLATE])
and:
model.projectContent.serviceDelivery.visible == false
model.projectContent.site.visible == false
model.projectContent.details.visible == false
model.projectContent.admin.visible == false
model.projectContent.reporting.visible == false
model.projectContent.datasets.visible == false
model.projectContent.overview.visible == true
model.projectContent.documents.visible == true
}
def "the financial year target exclusion works with numeric and string values"() {
expect:
controller.hasFinancialYearTarget([financialYearTarget: 0]) == false
controller.hasFinancialYearTarget([financialYearTarget: "0"]) == false
controller.hasFinancialYearTarget([financialYearTarget: "1"]) == true
controller.hasFinancialYearTarget([financialYearTarget: 2]) == true
}
def "the controller delegates to the service to return the MERI plan history for a project"() {
setup:
String projectId = 'p1'
List history = [[id:1, date:'2019-07-01T00:00:00Z', userId: '1234']]
when:
controller.approvedMeriPlanHistory(projectId)
then:
1 * projectService.approvedMeriPlanHistory(projectId) >> history
response.json.approvedMeriPlanHistory == history
}
def "the controller delegates to a command object to view the MERI plan for a project"() {
setup:
String projectId = 'p1'
when:
MeriPlanReportCommand meriPlanReportCommand = new MeriPlanReportCommand()
meriPlanReportCommand.id = projectId
meriPlanReportCommand.projectService = projectService
meriPlanReportCommand.metadataService = metadataServiceStub
controller.viewMeriPlan(meriPlanReportCommand)
then:
1 * projectService.get(projectId, _) >> [projectId:projectId]
model != null
model.project.projectId == projectId
view == '/project/meriPlanReport'
}
def "the controller will return a 404 if the project cannot be found when attempting a view a MERI plan report"() {
setup:
MeriPlanReportCommand meriPlanReportCommand = Mock(MeriPlanReportCommand)
when:
controller.viewMeriPlan(meriPlanReportCommand)
then:
1 * meriPlanReportCommand.meriPlanReportModel() >> [statusCode: HttpStatus.SC_NOT_FOUND, error:"Not found"]
response.status == HttpStatus.SC_NOT_FOUND
}
def "The project controller delegates to the reportService to override the lock on a report"() {
when:
controller.overrideLockAndEdit('p1', 'r1')
then:
1 * reportService.overrideLock('r1', {it.endsWith('project/viewReport/p1?reportId=r1')})
}
def "The program configuration can customize the project template by excluding content"() {
setup:
def projectId = '1234'
projectService.get(projectId, _, _) >> project(projectId)
stubProjectAdmin('1234', projectId)
when: "retrieving the project index page for an original MERIT project"
controller.index(projectId)
then: "Only the overview and documents tabs are enabled"
1 * projectService.getProgramConfiguration(_) >> new ProgramConfig(
[name:"Test Program", excludes:[
ProgramConfig.ProjectContent.SITES.toString(),
ProgramConfig.ProjectContent.DOCUMENTS.toString(),
ProgramConfig.ProjectContent.RISKS_AND_THREATS.toString(),
ProgramConfig.ProjectContent.MERI_PLAN.toString(),
ProgramConfig.ProjectContent.DASHBOARD.toString(),
ProgramConfig.ProjectContent.DATA_SETS.toString()]])
view == '/project/index'
!model.projectContent.overview.disabled
model.projectContent.documents.visible == false
model.projectContent.plan.visible == true
model.projectContent.details.visible == false
model.projectContent.site.visible == false
model.projectContent.dashboard.visible == false
model.projectContent.datasets.visible == false
when: "retrieving the project index page for an RLP MERIT project"
controller.index(projectId)
then: "Only the overview and documents tabs are enabled"
1 * projectService.getProgramConfiguration(_) >> new ProgramConfig(
[name:"Test Program", projectTemplate:'rlp', excludes:[
ProgramConfig.ProjectContent.SITES.toString(),
ProgramConfig.ProjectContent.DOCUMENTS.toString(),
ProgramConfig.ProjectContent.RISKS_AND_THREATS.toString(),
ProgramConfig.ProjectContent.MERI_PLAN.toString(),
ProgramConfig.ProjectContent.DASHBOARD.toString(),
ProgramConfig.ProjectContent.DATA_SETS.toString(),
ProgramConfig.ProjectContent.REPORTING.toString()
]])
view == '/project/index'
!model.projectContent.overview.disabled
model.projectContent.documents.visible == false
model.projectContent.details.visible == false
model.projectContent.site.visible == false
model.projectContent.serviceDelivery.visible == false
model.projectContent.datasets.visible == false
model.projectContent.reporting.visible == false
}
def "The controller delegates to the projectService to list project priorities and returns a JSON encoded response"() {
setup:
List expected = ['p1', 'p2', 'p3']
String projectId = 'p1'
when:
controller.listProjectInvestmentPriorities(projectId)
then:
1 * projectService.listProjectInvestmentPriorities(projectId) >> expected
and:
response.json == expected
}
def "The controller delegates to the reportService to release locks when existing a report"() {
when:
controller.exitReport('p1', 'r1')
then:
1 * reportService.unlock('r1')
response.redirectUrl == '/project/index/p1'
}
def "the controller can return a list of targets and progress towards those targets for the final report"(boolean approvedDataOnly) {
setup:
Map stubResults = [services: [[
id: 1,
name: "Service 1",
scores: [new Score([
scoreId: "score-1",
label: "score 1",
isOutputTarget: true,
target: "2",
periodTargets:[],
result:[result:1]
])]
],
[
id: 2,
name: "Service 2",
scores: [new Score([
scoreId: "score-2",
label: "score 2",
isOutputTarget: true,
target: "3",
periodTargets:[],
result:[result:3]
])]
]]]
when:
params.approvedDataOnly = approvedDataOnly
params.onlyNonZeroTargets = true
controller.projectTargetsAndScores('p1')
then:
1 * projectService.getServiceDashboardData('p1', approvedDataOnly) >> stubResults
response.json.projectId == 'p1'
response.json.targets == [[
scoreId:'score-1',
service: "Service 1",
targetMeasure:"score 1",
projectTarget: 2,
result:1,
isOverDelivered: false
], [
scoreId:'score-2',
service: "Service 2",
targetMeasure:"score 2",
projectTarget: 3,
result:3,
isOverDelivered: false
]
]
where:
approvedDataOnly | _
true | _
false | _
}
def "Data can be downloaded for a project in xlsx or json format, with json the default"(String inputFormat, String expectedOutputFormat) {
setup:
String projectId = 'p1'
when:
params.id = projectId
params.view = inputFormat
Map result = controller.downloadProjectData()
then:
1 * webService.proxyGetRequest(response, {it.endsWith('project/downloadProjectData/'+projectId+'.'+expectedOutputFormat)}, true, true, _)
result == null
where:
inputFormat | expectedOutputFormat
'json' | 'json'
'xlsx' | 'xlsx'
'' | 'json'
}
def "If no project id is supplied for a project download, an error is returned"() {
when:
controller.downloadProjectData()
then:
response.status == HttpStatus.SC_BAD_REQUEST
}
def "The ajaxUpdate action requires a POST"() {
when:
controller.ajaxUpdate()
then:
response.status == HttpStatus.SC_METHOD_NOT_ALLOWED
0 * projectService._
}
def "The project controller doesn't allow project creation as this must be done via the admin import function"() {
setup:
userServiceStub.getUser() >> [userId:'u1']
when: "The ajaxUpdate action is invoked without an id"
request.method = 'POST'
request.json = [name:'test project']
controller.ajaxUpdate()
then: "an error is returned - unauthorized is used as the pattern is a missing id is treated as a create for similar actions"
response.status == HttpStatus.SC_UNAUTHORIZED
0 * projectService._
}
def "The planStatus and hubId cannot be updated via the ajaxUpdate action (there are specific workflow actions for the planStatus)"() {
setup: "The user is a project admin"
String projectId = 'p1'
when: "The ajaxUpdate action is invoked including the planStatus attribute"
request.method = 'POST'
request.json = [name:'test project', planStatus:'approved', hubId:'newHub']
controller.ajaxUpdate(projectId)
then:
1 * projectService.update(projectId, [name:'test project'], false) >> [statusCode:HttpStatus.SC_OK, resp:[message:'updated']]
response.status == HttpStatus.SC_OK
response.json == [message:'updated']
}
def "Grant / project managers can update the project dates from the Reporting tab"() {
setup:
String projectId = 'p1'
when:
request.method = 'POST'
request.json = [plannedStartDate:'2022-06-09T14:00:00Z', plannedEndDate:'2024-06-29T14:00:00Z']
controller.ajaxUpdate(projectId)
then:
1 * userServiceStub.userIsSiteAdmin() >> true
1 * projectService.update(projectId, [plannedStartDate:'2022-06-09T14:00:00Z', plannedEndDate:'2024-06-29T14:00:00Z'], false) >> [:]
}
def "Only admins can update come properties including programId and config"(boolean isGrantManager) {
setup:
String projectId = 'p1'
Map data = ProjectController.ADMIN_ONLY_FIELDS.collectEntries { [(it):it] }
when:
request.method = 'POST'
request.json = data
controller.ajaxUpdate(projectId)
then:
1 * userServiceStub.userIsSiteAdmin() >> isGrantManager
1 * userServiceStub.userIsAlaOrFcAdmin() >> false
1 * projectService.update(projectId, [:], false) >> [:]
where:
isGrantManager | _
true | _
false | _
}
def "Project managers and admin can update some properties admins cannot"(boolean isGrantManager, boolean isAdmin, int expectedSize) {
setup:
String projectId = 'p1'
Map data = ProjectController.ADMIN_ONLY_FIELDS.collectEntries { [(it):it] }
data += ProjectController.MANAGER_ONLY_FIELDS.collectEntries { [(it):it] }
when:
request.method = 'POST'
request.json = data
controller.ajaxUpdate(projectId)
then:
userServiceStub.userIsSiteAdmin() >> (isAdmin || isGrantManager)
userServiceStub.userIsAlaOrFcAdmin() >> isAdmin
1 * projectService.update(projectId, { it.size() == expectedSize }, false) >> [:]
where:
isGrantManager | isAdmin | expectedSize
true | false | ProjectController.MANAGER_ONLY_FIELDS.size()
false | true | ProjectController.MANAGER_ONLY_FIELDS.size() + ProjectController.ADMIN_ONLY_FIELDS.size()
false | false | 0
}
def "The scoresForReport method delegates to the projectService"() {
setup:
String projectId = 'p1'
List scoreIds = ['1', '2', '3']
String reportId = 'r1'
Map result = ['1':1, '2':2, '3':3]
when:
params.id = projectId
params.scoreIds = scoreIds
params.reportId = reportId
controller.scoresForReport(projectId)
then:
1 * projectService.scoresForReport(projectId, reportId, scoreIds) >> result
response.json == result
}
def "The hasTarget method allows the target to be a string for historical reasons"() {
expect:
controller.hasTarget(0) == false
controller.hasTarget("0") == false
controller.hasTarget(null) == false
controller.hasTarget("") == false
controller.hasTarget(1) == true
controller.hasTarget("1.1") == true
controller.hasTarget("abc") == true // this is accepted for legacy reasons
}
def "The requestVoucherBarcodeLabels method delegates to the MonitorService and returns null as the response is streamed from Monitor"() {
when:
def result = controller.requestVoucherBarcodeLabels('p1', 1)
then:
1 * monitorService.requestVoucherBarcodeLabels('p1', 1, response)
result == null
}
def "Get species record for an activity id" (String activityId, int statusCode, int numberOfCalls, def data) {
when:
request.method = 'GET'
controller.getSpeciesRecordsFromActivity (activityId, null, null)
then:
numberOfCalls * projectService.getSpeciesRecordsFromActivity (activityId, _, _) >> data
controller.response.status == statusCode
where:
activityId | statusCode | numberOfCalls | data
null | 400 | 0 | null
"abc" | 200 | 1 | []
}
def "The annualReport method delegates to the projectService to get the data then simplifies the result"() {
setup:
String projectId = 'p1'
List scoreIds = ['s1', 's2']
Map resp = [resp:[[group:'2023 - 2024', count:4, results:[
[scoreId:'s1', result: [ count: 2, result: ['a', 'b']]],
[scoreId:'s2', result: [ count: 2, result: [['a', 'b'], ['c']]]],
]]]]
when:
params.id = projectId
params.scoreIds = scoreIds
params.financialYearEndDate = '2024-06-30'
controller.annualReport()
then:
1 * projectService.scoresByFinancialYear(projectId, scoreIds) >> resp
response.json == [s1:['a', 'b'], s2:['a', 'b', 'c']]
}
private Map stubPublicUser() {
userServiceStub.getUser() >> null
null
}
private Map stubGrantManager(userId, projectId) {
stubUserPermissions(userId, projectId, true, false, true, true)
['userName':null, 'userId':userId, 'class':UserDetails, 'displayName':null, 'isAdmin':false, 'isCaseManager':true, 'isEditor':true, 'hasViewAccess':true]
}
private Map stubProjectAdmin(userId, projectId) {
stubUserPermissions(userId, projectId, true, true, false, true)
['userName':null, 'userId':userId, 'class':UserDetails, 'displayName':null, 'isAdmin':true, 'isCaseManager':false, 'isEditor':true, 'hasViewAccess':true]
}
private Map stubProjectEditor(userId, projectId) {