-
Notifications
You must be signed in to change notification settings - Fork 53
/
Copy pathAbapDocParametersTest.java
903 lines (812 loc) · 42.3 KB
/
AbapDocParametersTest.java
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
package com.sap.adt.abapcleaner.rules.declarations;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import com.sap.adt.abapcleaner.rulebase.RuleID;
import com.sap.adt.abapcleaner.rulebase.RuleTestBase;
public class AbapDocParametersTest extends RuleTestBase {
private AbapDocParametersRule rule;
AbapDocParametersTest() {
super(RuleID.ABAP_DOC_PARAMETERS);
rule = (AbapDocParametersRule)getRule();
}
@BeforeEach
void setUp() {
// setup default test configuration (may be modified in the individual test methods)
rule.configAddParameters.setEnumValue(AddAbapDocType.ONLY_FOR_NON_SYNCHRONIZED);
rule.configAddExceptions.setEnumValue(AddAbapDocType.ONLY_FOR_NON_SYNCHRONIZED);
rule.configOnlyAddToExistingDetails.setValue(false);
rule.configUpdateOrder.setValue(true);
rule.configDeleteParameters.setEnumValue(DeleteObsoleteAbapDocType.IF_DESCRIPTION_EMPTY);
rule.configDeleteExceptions.setEnumValue(DeleteObsoleteAbapDocType.IF_DESCRIPTION_EMPTY);
}
@Test
void testAddAndDeleteNonSynchronized() {
buildSrc(" \"! any method");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_any_parameter | any parameter");
buildSrc(" \"! @parameter iv_obsolete_parameter | obsolete parameter");
buildSrc(" \"! @parameter iv_also_obsolete |");
buildSrc(" \"! @raising cx_any_exception | any exception");
buildSrc(" \"! @raising cx_obsolete_exception | obsolete exception");
buildSrc(" \"! @raising cx_also_obsolete |");
buildSrc(" METHODS any_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception.");
buildSrc("");
buildSrc(" METHODS:");
buildSrc(" \"! chained method");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_any_parameter | any parameter");
buildSrc(" \"! @raising cx_any_exception | any exception");
buildSrc(" chained_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception,");
buildSrc("");
buildSrc(" undocumented_method,");
buildSrc("");
buildSrc(" \"! other chained method");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_any_parameter | any parameter");
buildSrc(" \"! @parameter iv_obsolete_parameter | obsolete parameter");
buildSrc(" \"! @parameter iv_also_obsolete |");
buildSrc(" \"! @raising cx_any_exception | any exception");
buildSrc(" \"! @raising cx_obsolete_exception | obsolete exception");
buildSrc(" \"! @raising cx_also_obsolete |");
buildSrc(" other_chained_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception.");
buildExp(" \"! any method");
buildExp(" \"!");
buildExp(" \"! @parameter iv_any_parameter | any parameter");
buildExp(" \"! @parameter iv_other_parameter |");
buildExp(" \"! @raising cx_any_exception | any exception");
buildExp(" \"! @raising cx_other_exception |");
buildExp(" \"! @parameter iv_obsolete_parameter | obsolete parameter");
buildExp(" \"! @raising cx_obsolete_exception | obsolete exception");
buildExp(" METHODS any_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" iv_other_parameter TYPE i");
buildExp(" RAISING cx_any_exception");
buildExp(" cx_other_exception.");
buildExp("");
buildExp(" METHODS:");
buildExp(" \"! chained method");
buildExp(" \"!");
buildExp(" \"! @parameter iv_any_parameter | any parameter");
buildExp(" \"! @parameter iv_other_parameter |");
buildExp(" \"! @raising cx_any_exception | any exception");
buildExp(" \"! @raising cx_other_exception |");
buildExp(" chained_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" iv_other_parameter TYPE i");
buildExp(" RAISING cx_any_exception");
buildExp(" cx_other_exception,");
buildExp("");
buildExp(" undocumented_method,");
buildExp("");
buildExp(" \"! other chained method");
buildExp(" \"!");
buildExp(" \"! @parameter iv_any_parameter | any parameter");
buildExp(" \"! @parameter iv_other_parameter |");
buildExp(" \"! @raising cx_any_exception | any exception");
buildExp(" \"! @raising cx_other_exception |");
buildExp(" \"! @parameter iv_obsolete_parameter | obsolete parameter");
buildExp(" \"! @raising cx_obsolete_exception | obsolete exception");
buildExp(" other_chained_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" iv_other_parameter TYPE i");
buildExp(" RAISING cx_any_exception");
buildExp(" cx_other_exception.");
putAnyClassDefAroundSrcAndExp();
testRule();
}
@Test
void testAddAndDeleteSynchronized() {
rule.configAddParameters.setEnumValue(AddAbapDocType.ALWAYS);
rule.configAddExceptions.setEnumValue(AddAbapDocType.ALWAYS);
buildSrc(" \"! <p class=\"shorttext synchronized\">any method</p>");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_any_parameter | <p class=\"shorttext synchronized\">any parameter</p>");
buildSrc(" \"! @parameter iv_obsolete_parameter | <p class=\"shorttext synchronized\">obsolete parameter</p>");
buildSrc(" \"! @parameter iv_also_obsolete |");
buildSrc(" \"! @raising cx_any_exception | <p class=\"shorttext synchronized\">any exception</p>");
buildSrc(" \"! @raising cx_obsolete_exception | <p class=\"shorttext synchronized\">obsolete exception</p>");
buildSrc(" \"! @raising cx_also_obsolete | <p class=\"shorttext synchronized\"></p>");
buildSrc(" METHODS any_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception.");
buildSrc("");
buildSrc(" METHODS undocumented_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" EXPORTING ev_any_parameter TYPE i.");
buildSrc("");
buildSrc(" METHODS:");
buildSrc(" \"! <p class=\"shorttext synchronized\">chained method</p>");
buildSrc(" \"!");
buildSrc(" \"! @parameter ev_any_parameter | <p class=\"shorttext synchronized\">any parameter</p>");
buildSrc(" \"! @raising cx_any_exception | <p class=\"shorttext synchronized\">any exception</p>");
buildSrc(" chained_method");
buildSrc(" EXPORTING ev_any_parameter TYPE i");
buildSrc(" ev_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception,");
buildSrc("");
buildSrc(" \"! <p class=\"shorttext synchronized\">other chained method</p>");
buildSrc(" \"!");
buildSrc(" \"! @parameter ev_any_parameter | <p class=\"shorttext synchronized\">any parameter</p>");
buildSrc(" \"! @parameter ev_obsolete_parameter | <p class=\"shorttext synchronized\">obsolete parameter</p>");
buildSrc(" \"! @parameter ev_also_obsolete |");
buildSrc(" \"! @raising cx_any_exception | <p class=\"shorttext synchronized\">any exception</p>");
buildSrc(" \"! @raising cx_obsolete_exception | <p class=\"shorttext synchronized\">obsolete exception</p>");
buildSrc(" \"! @raising cx_also_obsolete | <p class=\"shorttext synchronized\"></p>");
buildSrc(" other_chained_method");
buildSrc(" EXPORTING ev_any_parameter TYPE i");
buildSrc(" ev_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception.");
buildExp(" \"! <p class=\"shorttext synchronized\">any method</p>");
buildExp(" \"!");
buildExp(" \"! @parameter iv_any_parameter | <p class=\"shorttext synchronized\">any parameter</p>");
buildExp(" \"! @parameter iv_other_parameter | <p class=\"shorttext synchronized\"></p>");
buildExp(" \"! @raising cx_any_exception | <p class=\"shorttext synchronized\">any exception</p>");
buildExp(" \"! @raising cx_other_exception | <p class=\"shorttext synchronized\"></p>");
buildExp(" \"! @parameter iv_obsolete_parameter | <p class=\"shorttext synchronized\">obsolete parameter</p>");
buildExp(" \"! @raising cx_obsolete_exception | <p class=\"shorttext synchronized\">obsolete exception</p>");
buildExp(" METHODS any_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" iv_other_parameter TYPE i");
buildExp(" RAISING cx_any_exception");
buildExp(" cx_other_exception.");
buildExp("");
buildExp(" METHODS undocumented_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" EXPORTING ev_any_parameter TYPE i.");
buildExp("");
buildExp(" METHODS:");
buildExp(" \"! <p class=\"shorttext synchronized\">chained method</p>");
buildExp(" \"!");
buildExp(" \"! @parameter ev_any_parameter | <p class=\"shorttext synchronized\">any parameter</p>");
buildExp(" \"! @parameter ev_other_parameter | <p class=\"shorttext synchronized\"></p>");
buildExp(" \"! @raising cx_any_exception | <p class=\"shorttext synchronized\">any exception</p>");
buildExp(" \"! @raising cx_other_exception | <p class=\"shorttext synchronized\"></p>");
buildExp(" chained_method");
buildExp(" EXPORTING ev_any_parameter TYPE i");
buildExp(" ev_other_parameter TYPE i");
buildExp(" RAISING cx_any_exception");
buildExp(" cx_other_exception,");
buildExp("");
buildExp(" \"! <p class=\"shorttext synchronized\">other chained method</p>");
buildExp(" \"!");
buildExp(" \"! @parameter ev_any_parameter | <p class=\"shorttext synchronized\">any parameter</p>");
buildExp(" \"! @parameter ev_other_parameter | <p class=\"shorttext synchronized\"></p>");
buildExp(" \"! @raising cx_any_exception | <p class=\"shorttext synchronized\">any exception</p>");
buildExp(" \"! @raising cx_other_exception | <p class=\"shorttext synchronized\"></p>");
buildExp(" \"! @parameter ev_obsolete_parameter | <p class=\"shorttext synchronized\">obsolete parameter</p>");
buildExp(" \"! @raising cx_obsolete_exception | <p class=\"shorttext synchronized\">obsolete exception</p>");
buildExp(" other_chained_method");
buildExp(" EXPORTING ev_any_parameter TYPE i");
buildExp(" ev_other_parameter TYPE i");
buildExp(" RAISING cx_any_exception");
buildExp(" cx_other_exception.");
putAnyClassDefAroundSrcAndExp();
testRule();
}
@Test
void testDoNotAddSynchronized() {
buildSrc(" \"! <p class=\"shorttext synchronized\">any method</p>");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_any_parameter | <p class=\"shorttext synchronized\">any parameter</p>");
buildSrc(" \"! @raising cx_any_exception | <p class=\"shorttext synchronized\">any exception</p>");
buildSrc(" METHODS any_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception.");
buildSrc("");
buildSrc(" METHODS:");
buildSrc(" \"! <p class=\"shorttext synchronized\">chained method</p>");
buildSrc(" \"!");
buildSrc(" \"! @parameter ev_any_parameter | <p class=\"shorttext synchronized\">any parameter</p>");
buildSrc(" \"! @raising cx_any_exception | <p class=\"shorttext synchronized\">any exception</p>");
buildSrc(" chained_method");
buildSrc(" EXPORTING ev_any_parameter TYPE i");
buildSrc(" ev_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception.");
copyExpFromSrc();
putAnyClassDefAroundSrcAndExp();
testRule();
}
@Test
void testAddNonSynchronizedLine() {
// expect a non-synchronized line to be added even to otherwise synchronized ABAP Doc;
// also, expect the position of the ABAP Doc right after METHODS: (with missing header) to be kept
// (such a line-end ABAP Doc creates a warning, but it works and is not a syntax error)
rule.configAddParameters.setEnumValue(AddAbapDocType.ALWAYS_AS_NON_SYNCHRONIZED);
rule.configAddExceptions.setEnumValue(AddAbapDocType.ALWAYS_AS_NON_SYNCHRONIZED);
buildSrc(" \"! <p class=\"shorttext synchronized\">any method</p>");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_any_parameter | <p class=\"shorttext synchronized\">any parameter</p>");
buildSrc(" \"! @raising cx_any_exception | <p class=\"shorttext synchronized\">any exception</p>");
buildSrc(" METHODS any_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception.");
buildSrc("");
buildSrc(" METHODS: \"! @parameter iv_other_parameter | other parameter");
buildSrc(" \"! @raising cx_any_exception | any exception");
buildSrc(" chained_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception.");
buildExp(" \"! <p class=\"shorttext synchronized\">any method</p>");
buildExp(" \"!");
buildExp(" \"! @parameter iv_any_parameter | <p class=\"shorttext synchronized\">any parameter</p>");
buildExp(" \"! @parameter iv_other_parameter |");
buildExp(" \"! @raising cx_any_exception | <p class=\"shorttext synchronized\">any exception</p>");
buildExp(" \"! @raising cx_other_exception |");
buildExp(" METHODS any_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" iv_other_parameter TYPE i");
buildExp(" RAISING cx_any_exception");
buildExp(" cx_other_exception.");
buildExp("");
buildExp(" METHODS: \"! @parameter iv_any_parameter |");
buildExp(" \"! @parameter iv_other_parameter | other parameter");
buildExp(" \"! @raising cx_any_exception | any exception");
buildExp(" \"! @raising cx_other_exception |");
buildExp(" chained_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" iv_other_parameter TYPE i");
buildExp(" RAISING cx_any_exception");
buildExp(" cx_other_exception.");
putAnyClassDefAroundSrcAndExp();
testRule();
}
@Test
void testDeleteAllObsolete() {
rule.configDeleteParameters.setEnumValue(DeleteObsoleteAbapDocType.ALWAYS);
rule.configDeleteExceptions.setEnumValue(DeleteObsoleteAbapDocType.ALWAYS);
buildSrc(" \"! <p class=\"shorttext synchronized\">any method</p>");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_any_parameter | <p class=\"shorttext synchronized\">any parameter</p>");
buildSrc(" \"! @parameter iv_obsolete_parameter | <p class=\"shorttext synchronized\">obsolete parameter</p>");
buildSrc(" \"! @parameter iv_also_obsolete |");
buildSrc(" \"! @raising cx_any_exception | <p class=\"shorttext synchronized\">any exception</p>");
buildSrc(" \"! @raising cx_obsolete_exception | <p class=\"shorttext synchronized\">obsolete exception</p>");
buildSrc(" \"! @raising cx_also_obsolete | <p class=\"shorttext synchronized\"></p>");
buildSrc(" METHODS any_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" RAISING cx_any_exception.");
buildSrc("");
buildSrc(" METHODS:");
buildSrc(" \"! other chained method");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_any_parameter | any parameter");
buildSrc(" \"! @parameter iv_obsolete_parameter | obsolete parameter");
buildSrc(" \"! @parameter iv_also_obsolete |");
buildSrc(" \"! @raising cx_any_exception | any exception");
buildSrc(" \"! @raising cx_obsolete_exception | obsolete exception");
buildSrc(" \"! @raising cx_also_obsolete |");
buildSrc(" other_chained_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" RAISING cx_any_exception.");
buildExp(" \"! <p class=\"shorttext synchronized\">any method</p>");
buildExp(" \"!");
buildExp(" \"! @parameter iv_any_parameter | <p class=\"shorttext synchronized\">any parameter</p>");
buildExp(" \"! @raising cx_any_exception | <p class=\"shorttext synchronized\">any exception</p>");
buildExp(" METHODS any_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" RAISING cx_any_exception.");
buildExp("");
buildExp(" METHODS:");
buildExp(" \"! other chained method");
buildExp(" \"!");
buildExp(" \"! @parameter iv_any_parameter | any parameter");
buildExp(" \"! @raising cx_any_exception | any exception");
buildExp(" other_chained_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" RAISING cx_any_exception.");
putAnyClassDefAroundSrcAndExp();
testRule();
}
@Test
void testDeleteAllObsoleteKeepingHeaderOnly() {
// expect the empty line below the header documentation to be removed if all parameter and exception lines were removed
rule.configAddParameters.setEnumValue(AddAbapDocType.NEVER);
rule.configAddExceptions.setEnumValue(AddAbapDocType.NEVER);
rule.configDeleteParameters.setEnumValue(DeleteObsoleteAbapDocType.ALWAYS);
rule.configDeleteExceptions.setEnumValue(DeleteObsoleteAbapDocType.ALWAYS);
buildSrc(" \"! <p class=\"shorttext synchronized\">any method</p>");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_obsolete_parameter | <p class=\"shorttext synchronized\">obsolete parameter</p>");
buildSrc(" \"! @parameter iv_also_obsolete |");
buildSrc(" \"! @raising cx_obsolete_exception | <p class=\"shorttext synchronized\">obsolete exception</p>");
buildSrc(" \"! @raising cx_also_obsolete | <p class=\"shorttext synchronized\"></p>");
buildSrc(" METHODS any_method.");
buildSrc("");
buildSrc(" METHODS:");
buildSrc(" \"! other chained method");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_obsolete_parameter | obsolete parameter");
buildSrc(" \"! @parameter iv_also_obsolete |");
buildSrc(" \"! @raising cx_obsolete_exception | obsolete exception");
buildSrc(" \"! @raising cx_also_obsolete |");
buildSrc(" other_chained_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" RAISING cx_any_exception.");
buildExp(" \"! <p class=\"shorttext synchronized\">any method</p>");
buildExp(" METHODS any_method.");
buildExp("");
buildExp(" METHODS:");
buildExp(" \"! other chained method");
buildExp(" other_chained_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" RAISING cx_any_exception.");
putAnyClassDefAroundSrcAndExp();
testRule();
}
@Test
void testNeverDeleteObsolete() {
rule.configDeleteParameters.setEnumValue(DeleteObsoleteAbapDocType.NEVER);
rule.configDeleteExceptions.setEnumValue(DeleteObsoleteAbapDocType.NEVER);
buildSrc(" \"! <p class=\"shorttext synchronized\">any method</p>");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_any_parameter | <p class=\"shorttext synchronized\">any parameter</p>");
buildSrc(" \"! @parameter iv_obsolete_parameter | <p class=\"shorttext synchronized\">obsolete parameter</p>");
buildSrc(" \"! @parameter iv_also_obsolete |");
buildSrc(" \"! @raising cx_any_exception | <p class=\"shorttext synchronized\">any exception</p>");
buildSrc(" \"! @raising cx_obsolete_exception | <p class=\"shorttext synchronized\">obsolete exception</p>");
buildSrc(" \"! @raising cx_also_obsolete | <p class=\"shorttext synchronized\"></p>");
buildSrc(" METHODS any_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" RAISING cx_any_exception.");
buildSrc("");
buildSrc(" METHODS:");
buildSrc(" \"! other chained method");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_any_parameter | any parameter");
buildSrc(" \"! @parameter iv_obsolete_parameter | obsolete parameter");
buildSrc(" \"! @parameter iv_also_obsolete |");
buildSrc(" \"! @raising cx_any_exception | any exception");
buildSrc(" \"! @raising cx_obsolete_exception | obsolete exception");
buildSrc(" \"! @raising cx_also_obsolete |");
buildSrc(" other_chained_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" RAISING cx_any_exception.");
buildExp(" \"! <p class=\"shorttext synchronized\">any method</p>");
buildExp(" \"!");
buildExp(" \"! @parameter iv_any_parameter | <p class=\"shorttext synchronized\">any parameter</p>");
buildExp(" \"! @raising cx_any_exception | <p class=\"shorttext synchronized\">any exception</p>");
buildExp(" \"! @parameter iv_obsolete_parameter | <p class=\"shorttext synchronized\">obsolete parameter</p>");
buildExp(" \"! @parameter iv_also_obsolete |");
buildExp(" \"! @raising cx_obsolete_exception | <p class=\"shorttext synchronized\">obsolete exception</p>");
buildExp(" \"! @raising cx_also_obsolete | <p class=\"shorttext synchronized\"></p>");
buildExp(" METHODS any_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" RAISING cx_any_exception.");
buildExp("");
buildExp(" METHODS:");
buildExp(" \"! other chained method");
buildExp(" \"!");
buildExp(" \"! @parameter iv_any_parameter | any parameter");
buildExp(" \"! @raising cx_any_exception | any exception");
buildExp(" \"! @parameter iv_obsolete_parameter | obsolete parameter");
buildExp(" \"! @parameter iv_also_obsolete |");
buildExp(" \"! @raising cx_obsolete_exception | obsolete exception");
buildExp(" \"! @raising cx_also_obsolete |");
buildExp(" other_chained_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" RAISING cx_any_exception.");
putAnyClassDefAroundSrcAndExp();
testRule();
}
@Test
void testDoNotAddToHeaderOnly() {
// expect no added parameter and exception lines, because no such lines exist
rule.configOnlyAddToExistingDetails.setValue(true);
buildSrc(" \"! <p class=\"shorttext synchronized\">any method</p>");
buildSrc(" METHODS any_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception.");
buildSrc("");
buildSrc(" METHODS:");
buildSrc(" \"! other chained method");
buildSrc(" \"!");
buildSrc(" other_chained_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception.");
copyExpFromSrc();
putAnyClassDefAroundSrcAndExp();
testRule();
}
@Test
void testAddToHeader() {
// expect parameter and exception lines to be added even if no other parameters and exceptions are documented yet
rule.configAddParameters.setEnumValue(AddAbapDocType.ALWAYS);
rule.configAddExceptions.setEnumValue(AddAbapDocType.ALWAYS);
rule.configOnlyAddToExistingDetails.setValue(false); // pro forma
buildSrc(" \"! <p class=\"shorttext synchronized\">any method</p>");
buildSrc(" METHODS any_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception.");
buildSrc("");
buildSrc(" METHODS:");
buildSrc(" \"! other chained method");
buildSrc(" \"!");
buildSrc(" other_chained_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception.");
buildExp(" \"! <p class=\"shorttext synchronized\">any method</p>");
buildExp(" \"!");
buildExp(" \"! @parameter iv_any_parameter | <p class=\"shorttext synchronized\"></p>");
buildExp(" \"! @parameter iv_other_parameter | <p class=\"shorttext synchronized\"></p>");
buildExp(" \"! @raising cx_any_exception | <p class=\"shorttext synchronized\"></p>");
buildExp(" \"! @raising cx_other_exception | <p class=\"shorttext synchronized\"></p>");
buildExp(" METHODS any_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" iv_other_parameter TYPE i");
buildExp(" RAISING cx_any_exception");
buildExp(" cx_other_exception.");
buildExp("");
buildExp(" METHODS:");
buildExp(" \"! other chained method");
buildExp(" \"!");
buildExp(" \"! @parameter iv_any_parameter |");
buildExp(" \"! @parameter iv_other_parameter |");
buildExp(" \"! @raising cx_any_exception |");
buildExp(" \"! @raising cx_other_exception |");
buildExp(" other_chained_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" iv_other_parameter TYPE i");
buildExp(" RAISING cx_any_exception");
buildExp(" cx_other_exception.");
putAnyClassDefAroundSrcAndExp();
testRule();
}
@Test
void testAllSettingsInactive() {
// expect no change to happen if all parameters are in 'no change' state
rule.configAddParameters.setEnumValue(AddAbapDocType.NEVER);
rule.configAddExceptions.setEnumValue(AddAbapDocType.NEVER);
rule.configUpdateOrder.setValue(false);
rule.configDeleteParameters.setEnumValue(DeleteObsoleteAbapDocType.NEVER);
rule.configDeleteExceptions.setEnumValue(DeleteObsoleteAbapDocType.NEVER);
buildSrc(" \"! any method");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_any_parameter | any parameter");
buildSrc(" \"! @parameter iv_obsolete_parameter | obsolete parameter");
buildSrc(" \"! @parameter iv_also_obsolete |");
buildSrc(" \"! @raising cx_any_exception | any exception");
buildSrc(" \"! @raising cx_obsolete_exception | obsolete exception");
buildSrc(" \"! @raising cx_also_obsolete |");
buildSrc(" METHODS any_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception.");
buildSrc("");
buildSrc(" METHODS:");
buildSrc(" \"! chained method");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_any_parameter | any parameter");
buildSrc(" \"! @raising cx_any_exception | any exception");
buildSrc(" chained_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception,");
buildSrc("");
buildSrc(" \"! other chained method");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_any_parameter | any parameter");
buildSrc(" \"! @parameter iv_obsolete_parameter | obsolete parameter");
buildSrc(" \"! @parameter iv_also_obsolete |");
buildSrc(" \"! @raising cx_any_exception | any exception");
buildSrc(" \"! @raising cx_obsolete_exception | obsolete exception");
buildSrc(" \"! @raising cx_also_obsolete |");
buildSrc(" other_chained_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception.");
putAnyClassDefAroundSrcAndExp();
copyExpFromSrc();
testRule();
}
@Test
void testNonClassBasedExceptions() {
// expect added parameters and exceptions to be non-synchronized even in otherwise synchronized ABAP Doc
rule.configAddParameters.setEnumValue(AddAbapDocType.ALWAYS_AS_NON_SYNCHRONIZED);
rule.configAddExceptions.setEnumValue(AddAbapDocType.ALWAYS_AS_NON_SYNCHRONIZED);
buildSrc(" \"! <p class=\"shorttext synchronized\">any method</p>");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_other_parameter | <p class=\"shorttext synchronized\">other parameter</p>");
buildSrc(" \"! @exception other_exception | <p class=\"shorttext synchronized\">other exception</p>");
buildSrc(" METHODS any_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" EXCEPTIONS any_exception");
buildSrc(" other_exception.");
buildSrc("");
buildSrc(" METHODS:");
buildSrc(" \"! chained method");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_other_parameter | other parameter");
buildSrc(" \"! @exception other_exception | other exception");
buildSrc(" chained_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" EXCEPTIONS any_exception");
buildSrc(" other_exception.");
buildExp(" \"! <p class=\"shorttext synchronized\">any method</p>");
buildExp(" \"!");
buildExp(" \"! @parameter iv_any_parameter |");
buildExp(" \"! @parameter iv_other_parameter | <p class=\"shorttext synchronized\">other parameter</p>");
buildExp(" \"! @exception any_exception |");
buildExp(" \"! @exception other_exception | <p class=\"shorttext synchronized\">other exception</p>");
buildExp(" METHODS any_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" iv_other_parameter TYPE i");
buildExp(" EXCEPTIONS any_exception");
buildExp(" other_exception.");
buildExp("");
buildExp(" METHODS:");
buildExp(" \"! chained method");
buildExp(" \"!");
buildExp(" \"! @parameter iv_any_parameter |");
buildExp(" \"! @parameter iv_other_parameter | other parameter");
buildExp(" \"! @exception any_exception |");
buildExp(" \"! @exception other_exception | other exception");
buildExp(" chained_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" iv_other_parameter TYPE i");
buildExp(" EXCEPTIONS any_exception");
buildExp(" other_exception.");
putAnyClassDefAroundSrcAndExp();
testRule();
}
@Test
void testUpdateOrder() {
// expect the order of parameter descriptions to be updated;
// also, expect the position of the ABAP Doc right after METHODS: to be kept
// (such a line-end ABAP Doc creates a warning, but it works and is not a syntax error)
buildSrc(" \"! any method");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_other_parameter | other parameter");
buildSrc(" \"! @parameter iv_obsolete_parameter |");
buildSrc(" \"! @parameter iv_any_parameter | any parameter");
buildSrc(" \"! @raising cx_any_exception | any exception");
buildSrc(" \"! @raising cx_third_exception | third exception");
buildSrc(" \"! @raising cx_obsolete_exception |");
buildSrc(" \"! @raising cx_other_exception | other exception");
buildSrc(" METHODS any_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception");
buildSrc(" cx_third_exception.");
buildSrc("");
buildSrc(" METHODS: \"! chained method");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_other_parameter | other parameter");
buildSrc(" \"! @parameter iv_any_parameter | any parameter");
buildSrc(" \"! @parameter iv_obsolete_parameter |");
buildSrc(" \"! @raising cx_obsolete_exception |");
buildSrc(" \"! @raising cx_other_exception | other exception");
buildSrc(" \"! @raising cx_third_exception | third exception");
buildSrc(" \"! @raising cx_any_exception | any exception");
buildSrc(" chained_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception");
buildSrc(" cx_third_exception.");
buildExp(" \"! any method");
buildExp(" \"!");
buildExp(" \"! @parameter iv_any_parameter | any parameter");
buildExp(" \"! @parameter iv_other_parameter | other parameter");
buildExp(" \"! @raising cx_any_exception | any exception");
buildExp(" \"! @raising cx_other_exception | other exception");
buildExp(" \"! @raising cx_third_exception | third exception");
buildExp(" METHODS any_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" iv_other_parameter TYPE i");
buildExp(" RAISING cx_any_exception");
buildExp(" cx_other_exception");
buildExp(" cx_third_exception.");
buildExp("");
buildExp(" METHODS: \"! chained method");
buildExp(" \"!");
buildExp(" \"! @parameter iv_any_parameter | any parameter");
buildExp(" \"! @parameter iv_other_parameter | other parameter");
buildExp(" \"! @raising cx_any_exception | any exception");
buildExp(" \"! @raising cx_other_exception | other exception");
buildExp(" \"! @raising cx_third_exception | third exception");
buildExp(" chained_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" iv_other_parameter TYPE i");
buildExp(" RAISING cx_any_exception");
buildExp(" cx_other_exception");
buildExp(" cx_third_exception.");
putAnyClassDefAroundSrcAndExp();
testRule();
}
@Test
void testDoNotUpdateOrder() {
rule.configUpdateOrder.setValue(false);
buildSrc(" \"! any method");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_other_parameter | other parameter");
buildSrc(" \"! @parameter iv_any_parameter | any parameter");
buildSrc(" \"! @raising cx_any_exception | any exception");
buildSrc(" \"! @raising cx_third_exception | third exception");
buildSrc(" \"! @raising cx_other_exception | other exception");
buildSrc(" METHODS any_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception");
buildSrc(" cx_third_exception.");
buildSrc("");
buildSrc(" METHODS:");
buildSrc(" \"! chained method");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_other_parameter | other parameter");
buildSrc(" \"! @parameter iv_any_parameter | any parameter");
buildSrc(" \"! @raising cx_other_exception | other exception");
buildSrc(" \"! @raising cx_third_exception | third exception");
buildSrc(" \"! @raising cx_any_exception | any exception");
buildSrc(" chained_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" iv_other_parameter TYPE i");
buildSrc(" RAISING cx_any_exception");
buildSrc(" cx_other_exception");
buildSrc(" cx_third_exception.");
copyExpFromSrc();
putAnyClassDefAroundSrcAndExp();
testRule();
}
@Test
void testMultiLineParametersAndExceptions() {
// ensure that multi-line parameters and exceptions are correctly processed, esp. regarding deletion
// of empty descriptions
buildSrc(" \"! <p class=\"shorttext synchronized\">any method</p>");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_any_parameter");
buildSrc(" \"! |");
buildSrc(" \"! <p class=\"shorttext synchronized\">any parameter</p>");
buildSrc(" \"! @parameter iv_obsolete_parameter |");
buildSrc(" \"! <p class=\"shorttext synchronized\">obsolete parameter</p>");
buildSrc(" \"! @parameter iv_also_obsolete |");
buildSrc(" \"! @raising cx_any_exception");
buildSrc(" \"! | <p class=\"shorttext synchronized\">any exception</p>");
buildSrc(" \"! @raising cx_obsolete_exception");
buildSrc(" \"! | <p class=\"shorttext synchronized\">obsolete exception</p>");
buildSrc(" \"! @raising cx_also_obsolete");
buildSrc(" \"! |");
buildSrc(" \"! <p class=\"shorttext synchronized\"></p>");
buildSrc(" METHODS any_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" RAISING cx_any_exception.");
buildSrc("");
buildSrc(" METHODS:");
buildSrc(" \"! other chained method");
buildSrc(" \"!");
buildSrc(" \"! @parameter iv_any_parameter");
buildSrc(" \"! |");
buildSrc(" \"! any parameter");
buildSrc(" \"! @parameter iv_obsolete_parameter |");
buildSrc(" \"! obsolete parameter");
buildSrc(" \"! @parameter iv_also_obsolete |");
buildSrc(" \"! @raising cx_any_exception");
buildSrc(" \"! | any exception");
buildSrc(" \"! @raising cx_obsolete_exception");
buildSrc(" \"! | obsolete exception");
buildSrc(" \"! @raising cx_also_obsolete");
buildSrc(" \"! |");
buildSrc(" other_chained_method");
buildSrc(" IMPORTING iv_any_parameter TYPE i");
buildSrc(" RAISING cx_any_exception.");
buildExp(" \"! <p class=\"shorttext synchronized\">any method</p>");
buildExp(" \"!");
buildExp(" \"! @parameter iv_any_parameter");
buildExp(" \"! |");
buildExp(" \"! <p class=\"shorttext synchronized\">any parameter</p>");
buildExp(" \"! @raising cx_any_exception");
buildExp(" \"! | <p class=\"shorttext synchronized\">any exception</p>");
buildExp(" \"! @parameter iv_obsolete_parameter |");
buildExp(" \"! <p class=\"shorttext synchronized\">obsolete parameter</p>");
buildExp(" \"! @raising cx_obsolete_exception");
buildExp(" \"! | <p class=\"shorttext synchronized\">obsolete exception</p>");
buildExp(" METHODS any_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" RAISING cx_any_exception.");
buildExp("");
buildExp(" METHODS:");
buildExp(" \"! other chained method");
buildExp(" \"!");
buildExp(" \"! @parameter iv_any_parameter");
buildExp(" \"! |");
buildExp(" \"! any parameter");
buildExp(" \"! @raising cx_any_exception");
buildExp(" \"! | any exception");
buildExp(" \"! @parameter iv_obsolete_parameter |");
buildExp(" \"! obsolete parameter");
buildExp(" \"! @raising cx_obsolete_exception");
buildExp(" \"! | obsolete exception");
buildExp(" other_chained_method");
buildExp(" IMPORTING iv_any_parameter TYPE i");
buildExp(" RAISING cx_any_exception.");
putAnyClassDefAroundSrcAndExp();
testRule();
}
@Test
void testTestMethodExceptionsNotAdded() {
// ensure that no ABAP Doc is added for exceptions of test methods (because it is unlikely that
// documentation should be added for those); parameters can anyway never occur with FOR TESTING methods
buildSrc(" PRIVATE SECTION.");
buildSrc(" \"! any method");
buildSrc(" METHODS any_method FOR TESTING RAISING cx_any_exception\");");
buildSrc(" cx_other_exception.\");");
copyExpFromSrc();
putAnyClassDefAroundSrcAndExp();
testRule();
}
@Test
void testTestMethodExceptionDeletedButNotAdded() {
// ensure that in FOR TESTING methods, documentation for obsolete exceptions is removed,
// even if no documentation is added for a missing exception (see previous test)
buildSrc(" PRIVATE SECTION.");
buildSrc(" \"! any method");
buildSrc(" \"!");
buildSrc(" \"! @raising cx_any_exception | any exception");
buildSrc(" \"! @raising cx_third_exception |");
buildSrc(" METHODS any_method FOR TESTING RAISING cx_any_exception\");");
buildSrc(" cx_other_exception.\");");
buildExp(" PRIVATE SECTION.");
buildExp(" \"! any method");
buildExp(" \"!");
buildExp(" \"! @raising cx_any_exception | any exception");
buildExp(" METHODS any_method FOR TESTING RAISING cx_any_exception\");");
buildExp(" cx_other_exception.\");");
putAnyClassDefAroundSrcAndExp();
testRule();
}
@Test
void testIsConfigValueEnabled() {
assertTrue(rule.isConfigValueEnabled(rule.configAddExceptions));
rule.configAddParameters.setEnumValue(AddAbapDocType.ALWAYS);
rule.configAddExceptions.setEnumValue(AddAbapDocType.ALWAYS);
assertTrue(rule.isConfigValueEnabled(rule.configAddAlwaysWarning));
rule.configAddParameters.setEnumValue(AddAbapDocType.ALWAYS_AS_NON_SYNCHRONIZED);
rule.configAddExceptions.setEnumValue(AddAbapDocType.ALWAYS);
assertTrue(rule.isConfigValueEnabled(rule.configAddAlwaysWarning));
rule.configAddParameters.setEnumValue(AddAbapDocType.ALWAYS);
rule.configAddExceptions.setEnumValue(AddAbapDocType.NEVER);
assertTrue(rule.isConfigValueEnabled(rule.configAddAlwaysWarning));
rule.configAddParameters.setEnumValue(AddAbapDocType.ONLY_FOR_NON_SYNCHRONIZED);
rule.configAddExceptions.setEnumValue(AddAbapDocType.ALWAYS_AS_NON_SYNCHRONIZED);
assertFalse(rule.isConfigValueEnabled(rule.configAddAlwaysWarning));
}
}