-
Notifications
You must be signed in to change notification settings - Fork 50
/
Copy pathUnusedVariablesTest.java
2369 lines (1892 loc) · 81.7 KB
/
UnusedVariablesTest.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
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 com.sap.adt.abapcleaner.rules.declarations;
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;
class UnusedVariablesTest extends RuleTestBase {
private UnusedVariablesRule rule;
UnusedVariablesTest() {
super(RuleID.UNUSED_VARIABLES);
rule = (UnusedVariablesRule)getRule();
}
@BeforeEach
void setUp() {
// setup default test configuration (may be modified in the individual test methods)
rule.configActionForVarsNeverUsed.setEnumValue(UnusedVariableAction.DELETE);
rule.configActionForVarsOnlyUsedInComment.setEnumValue(UnusedVariableAction.COMMENT_OUT_WITH_ASTERISK);
rule.configActionForAssignedVars.setEnumValue(UnusedVariableActionIfAssigned.ADD_TODO_COMMENT);
rule.configActionForAssignedVarsOnlyUsedInComment.setEnumValue(UnusedVariableActionIfAssigned.ADD_TODO_COMMENT);
rule.configActionForVarsAssignedInMessageInto.setEnumValue(UnusedVariableActionForMessageInto.ADD_PRAGMA_NEEDED);
rule.configActionForConstantsNeverUsed.setEnumValue(UnusedVariableAction.COMMENT_OUT_WITH_ASTERISK);
rule.configActionForConstantsOnlyUsedInComment.setEnumValue(UnusedVariableAction.COMMENT_OUT_WITH_ASTERISK);
}
@Test
void testDataDeclaration() {
buildSrc(" DATA: lv_unused_b TYPE string,");
buildSrc(" lv_used_var TYPE i,");
buildSrc(" lv_commented_out LIKE lv_used_var.");
buildSrc("");
buildSrc(" CLEAR ev_count.");
buildSrc("");
buildSrc(" lv_used_var = 0.");
buildSrc(" lv_used_var += 1.");
buildSrc(" ev_count = lv_used_var.");
buildSrc("");
buildSrc("* lv_commented_out = 0.");
buildSrc("* lv_commented_out += 1.");
buildExp(" DATA: lv_used_var TYPE i.");
buildExp("* lv_commented_out LIKE lv_used_var.");
buildExp("");
buildExp(" CLEAR ev_count.");
buildExp("");
buildExp(" lv_used_var = 0.");
buildExp(" lv_used_var += 1.");
buildExp(" ev_count = lv_used_var.");
buildExp("");
buildExp("* lv_commented_out = 0.");
buildExp("* lv_commented_out += 1.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testFieldSymbolsDeclaration() {
buildSrc(" FIELD-SYMBOLS:");
buildSrc(" <ls_unused_a> TYPE ty_s_any_struc,");
buildSrc(" <ls_commented_out> LIKE LINE OF its_table,");
buildSrc(" <ls_used> TYPE tt_table.");
buildSrc("");
buildSrc(" LOOP AT its_table ASSIGNING <ls_used>.");
buildSrc(" a += <ls_used>-component.");
buildSrc(" ENDLOOP.");
buildSrc("");
buildSrc("* LOOP AT its_table ASSIGNING <ls_commented_out>.");
buildSrc("* ENDLOOP.");
buildExp("* FIELD-SYMBOLS: <ls_commented_out> LIKE LINE OF its_table,");
buildExp(" FIELD-SYMBOLS:");
buildExp(" <ls_used> TYPE tt_table.");
buildExp("");
buildExp(" LOOP AT its_table ASSIGNING <ls_used>.");
buildExp(" a += <ls_used>-component.");
buildExp(" ENDLOOP.");
buildExp("");
buildExp("* LOOP AT its_table ASSIGNING <ls_commented_out>.");
buildExp("* ENDLOOP.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testMixedDeclarationChain() {
buildSrc(" DATA: lv_unused_b TYPE string,");
buildSrc(" lv_used_var TYPE i,");
buildSrc(" lv_commented_out LIKE lv_used_var.");
buildSrc("");
buildSrc(" lv_used_var = 0.");
buildSrc(" DO 5 TIMES.");
buildSrc(" lv_used_var += 1.");
buildSrc(" ENDDO.");
buildSrc(" ev_count = lv_used_var.");
buildSrc("");
buildSrc("* lv_commented_out = 0.");
buildSrc("* DO 5 TIMES.");
buildSrc("* lv_commented_out += 1.");
buildSrc("* ENDDO.");
buildExp(" DATA: lv_used_var TYPE i.");
buildExp("* lv_commented_out LIKE lv_used_var.");
buildExp("");
buildExp(" lv_used_var = 0.");
buildExp(" DO 5 TIMES.");
buildExp(" lv_used_var += 1.");
buildExp(" ENDDO.");
buildExp(" ev_count = lv_used_var.");
buildExp("");
buildExp("* lv_commented_out = 0.");
buildExp("* DO 5 TIMES.");
buildExp("* lv_commented_out += 1.");
buildExp("* ENDDO.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testMentioningInTextComment() {
buildSrc(" DATA lv_unused_a TYPE i.");
buildSrc("* this comment mentions the variable lv_unused_a, but that does not count:");
buildSrc("* only variables in commented-out ABAP code count, not variables in text comments!");
buildExp("* this comment mentions the variable lv_unused_a, but that does not count:");
buildExp("* only variables in commented-out ABAP code count, not variables in text comments!");
putAnyMethodAroundSrcAndExp();
deactivateRuleUseCheck(); // TODO: since the first line is simply deleted, there is currently no way to log the rule use
testRule();
}
@Test
void testUnusedWithNeededPragma() {
// expect that ##NEEDED is correctly identified for all variables and nothing is changed
buildSrc(" DATA lv_unused_but_needed TYPE string ##NEEDED.");
buildSrc(" DATA lv_unused_but_needed_2 ##NEEDED TYPE string.");
buildSrc(" DATA ##NEEDED:");
buildSrc(" lv_unused_but_needed_3 TYPE string,");
buildSrc(" lv_unused_but_needed_4 TYPE string.");
copyExpFromSrc();
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testUnusedWithNeededPseudoComment() {
// expect that "#EC NEEDED is correctly identified for all variables and nothing is changed;
// "#EC NEEDED is valid for all elements of a chain if it is before, or in any of the comments following the chain colon
buildSrc(" DATA lv_unused_but_needed TYPE string. \"#EC NEEDED");
buildSrc(" DATA lv_unused_but_needed_2 \"#EC NEEDED");
buildSrc(" TYPE string.");
buildSrc(" DATA: \"#EC NEEDED");
buildSrc(" lv_unused_but_needed_3 TYPE string,");
buildSrc(" lv_unused_but_needed_4 TYPE string.");
buildSrc(" DATA:");
buildSrc(" \" other comment");
buildSrc(" \"#EC NEEDED");
buildSrc(" lv_unused_but_needed_5 TYPE string,");
buildSrc(" lv_unused_but_needed_6 TYPE string.");
copyExpFromSrc();
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testOnlyAssignedInDeclarationChain() {
buildSrc(" DATA: lv_only_assigned TYPE i,");
buildSrc(" lv_assigned_but_used_incomment TYPE i,");
buildSrc(" lv_unused_but_needed TYPE string ##NEEDED.");
buildSrc("");
buildSrc(" CLEAR lv_only_assigned.");
buildSrc(" lv_only_assigned = lv_only_assigned + 2.");
buildSrc(" lv_assigned_but_used_incomment = 1.");
buildSrc("");
buildSrc("* rv_result = lv_assigned_but_used_incomment.");
buildExp(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildExp(" DATA: lv_only_assigned TYPE i,");
buildExp(" \" TODO: variable is assigned but only used in commented-out code (ABAP cleaner)");
buildExp(" lv_assigned_but_used_incomment TYPE i,");
buildExp(" lv_unused_but_needed TYPE string ##NEEDED.");
buildExp("");
buildExp(" CLEAR lv_only_assigned.");
buildExp(" lv_only_assigned = lv_only_assigned + 2.");
buildExp(" lv_assigned_but_used_incomment = 1.");
buildExp("");
buildExp("* rv_result = lv_assigned_but_used_incomment.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testUnusedAndOnlyAssignedInChain() {
buildSrc(" DATA: lv_unused TYPE i,");
buildSrc(" lv_only_assigned TYPE i,");
buildSrc(" lv_unused_but_needed TYPE string ##NEEDED,");
buildSrc(" lv_assigned_but_used_incomment TYPE i.");
buildSrc("");
buildSrc(" CLEAR lv_only_assigned.");
buildSrc(" lv_only_assigned = lv_only_assigned + 2.");
buildSrc(" lv_assigned_but_used_incomment = 1.");
buildSrc("");
buildSrc("* rv_result = lv_assigned_but_used_incomment.");
buildExp(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildExp(" DATA: lv_only_assigned TYPE i,");
buildExp(" lv_unused_but_needed TYPE string ##NEEDED,");
buildExp(" \" TODO: variable is assigned but only used in commented-out code (ABAP cleaner)");
buildExp(" lv_assigned_but_used_incomment TYPE i.");
buildExp("");
buildExp(" CLEAR lv_only_assigned.");
buildExp(" lv_only_assigned = lv_only_assigned + 2.");
buildExp(" lv_assigned_but_used_incomment = 1.");
buildExp("");
buildExp("* rv_result = lv_assigned_but_used_incomment.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testOnlyAssignedInImporting() {
buildSrc(" method_call( EXPORTING iv_data = 5");
buildSrc(" IMPORTING ev_result1 = DATA(lv_result1)");
buildSrc(" ev_result2 = DATA(lv_result2) ).");
buildSrc("");
buildSrc(" rv_result = lv_result1.");
buildExp(" method_call( EXPORTING iv_data = 5");
buildExp(" IMPORTING ev_result1 = DATA(lv_result1)");
buildExp(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildExp(" ev_result2 = DATA(lv_result2) ).");
buildExp("");
buildExp(" rv_result = lv_result1.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testOnlyAssignedFinalInImporting() {
buildSrc(" method_call( EXPORTING iv_data = 5");
buildSrc(" IMPORTING ev_result1 = FINAL(lv_result1)");
buildSrc(" ev_result2 = FINAL(lv_result2) ).");
buildSrc("");
buildSrc(" rv_result = lv_result1.");
buildExp(" method_call( EXPORTING iv_data = 5");
buildExp(" IMPORTING ev_result1 = FINAL(lv_result1)");
buildExp(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildExp(" ev_result2 = FINAL(lv_result2) ).");
buildExp("");
buildExp(" rv_result = lv_result1.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testOnlyAssignedInCatch() {
// for assignments in CATCH statements, the comment cannot be added as the 'previous sibling' (because that must be the 'TRY'),
// therefore expect it to be added at the end of the CATCH statement
buildSrc(" TRY.");
buildSrc(" \" do something");
buildSrc(" CATCH cx_any_error INTO DATA(lo_exp).");
buildSrc(" \" do nothing with the error object");
buildSrc(" ENDTRY.");
buildExp(" TRY.");
buildExp(" \" do something");
buildExp(" CATCH cx_any_error INTO DATA(lo_exp). \" TODO: variable is assigned but never used (ABAP cleaner)");
buildExp(" \" do nothing with the error object");
buildExp(" ENDTRY.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testOnlyAssignedToDoAlreadyInserted() {
// prepare a code in which the to-do message 'variable is assigned but never used' was already inserted by a
// previous cleanup run in two cases (but is missing in a third case)
buildSrc(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildSrc(" DATA(lv_value) = 1.");
buildSrc(" DATA(lv_other_value) = 2.");
buildSrc("");
buildSrc(" method_call( EXPORTING iv_data = 5");
buildSrc(" IMPORTING ev_result1 = DATA(lv_result1)");
buildSrc(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildSrc(" ev_result2 = DATA(lv_result2) ).");
buildSrc("");
buildSrc(" rv_result = lv_result1.");
buildExp(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildExp(" DATA(lv_value) = 1.");
buildExp(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildExp(" DATA(lv_other_value) = 2.");
buildExp("");
buildExp(" method_call( EXPORTING iv_data = 5");
buildExp(" IMPORTING ev_result1 = DATA(lv_result1)");
buildExp(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildExp(" ev_result2 = DATA(lv_result2) ).");
buildExp("");
buildExp(" rv_result = lv_result1.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testOnlyAssignedFinalToDoAlreadyInserted() {
// prepare a code in which the to-do message 'variable is assigned but never used' was already inserted by a
// previous cleanup run in two cases (but is missing in a third case)
buildSrc(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildSrc(" FINAL(lv_value) = 1.");
buildSrc(" FINAL(lv_other_value) = 2.");
buildSrc("");
buildSrc(" method_call( EXPORTING iv_data = 5");
buildSrc(" IMPORTING ev_result1 = DATA(lv_result1)");
buildSrc(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildSrc(" ev_result2 = DATA(lv_result2) ).");
buildSrc("");
buildSrc(" rv_result = lv_result1.");
buildExp(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildExp(" FINAL(lv_value) = 1.");
buildExp(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildExp(" FINAL(lv_other_value) = 2.");
buildExp("");
buildExp(" method_call( EXPORTING iv_data = 5");
buildExp(" IMPORTING ev_result1 = DATA(lv_result1)");
buildExp(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildExp(" ev_result2 = DATA(lv_result2) ).");
buildExp("");
buildExp(" rv_result = lv_result1.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testUnusedDeclChainWithAsteriskLines() {
// test a chain that already contains commented-out lines, which requires special care
buildSrc(" DATA: lo_any_instance TYPE REF TO if_any_interface,");
buildSrc("* lo_item_exp TYPE REF TO cl_item,");
buildSrc("* lo_item_act TYPE REF TO cl_item,");
buildSrc(" lo_order_exp TYPE REF TO cl_order,");
buildSrc(" lo_order_act TYPE REF TO cl_order.");
buildExp("* lo_item_exp TYPE REF TO cl_item,");
buildExp("* lo_item_act TYPE REF TO cl_item,");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testAssignedButUsedInComment() {
buildSrc(" DATA lv_assigned_but_used_incomment TYPE i.");
buildSrc("");
buildSrc(" lv_assigned_but_used_incomment = 1.");
buildSrc("");
buildSrc("* DO 5 * lv_assigned_but_used_incomment TIMES.");
buildSrc("* \" comment");
buildSrc("* ENDDO.");
buildExp(" \" TODO: variable is assigned but only used in commented-out code (ABAP cleaner)");
buildExp(" DATA lv_assigned_but_used_incomment TYPE i.");
buildExp("");
buildExp(" lv_assigned_but_used_incomment = 1.");
buildExp("");
buildExp("* DO 5 * lv_assigned_but_used_incomment TIMES.");
buildExp("* \" comment");
buildExp("* ENDDO.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testUsedOnlyInSelfAssignment() {
buildSrc(" DATA lv_only_assigned TYPE i.");
buildSrc("");
buildSrc(" \" lv_only_assigned is only used to modifying its own value");
buildSrc(" CLEAR lv_only_assigned.");
buildSrc(" lv_only_assigned = lv_only_assigned + 2.");
buildSrc(" MULTIPLY lv_only_assigned BY 2.");
buildExp(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildExp(" DATA lv_only_assigned TYPE i.");
buildExp("");
buildExp(" \" lv_only_assigned is only used to modifying its own value");
buildExp(" CLEAR lv_only_assigned.");
buildExp(" lv_only_assigned = lv_only_assigned + 2.");
buildExp(" MULTIPLY lv_only_assigned BY 2.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testUsedOnlyInSelfAssignmentWithOffset() {
buildSrc(" DATA lv_only_assigned TYPE i.");
buildSrc("");
buildSrc(" \" lv_only_assigned is only used to modify its own value");
buildSrc(" lv_only_assigned+4 = '10'.");
buildSrc(" lv_only_assigned+2(2) = '10'.");
buildSrc(" lv_only_assigned+4(2) = lv_only_assigned+2(2).");
buildExp(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildExp(" DATA lv_only_assigned TYPE i.");
buildExp("");
buildExp(" \" lv_only_assigned is only used to modify its own value");
buildExp(" lv_only_assigned+4 = '10'.");
buildExp(" lv_only_assigned+2(2) = '10'.");
buildExp(" lv_only_assigned+4(2) = lv_only_assigned+2(2).");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testUsedOnlyInSelfAssignmentWithComponent() {
buildSrc(" DATA ls_only_assigned TYPE ty_ts_struc.");
buildSrc("");
buildSrc(" \" ls_only_assigned is only used to modifying its own components");
buildSrc(" ls_only_assigned-component_a = 5.");
buildSrc(" ls_only_assigned-component_b = ls_only_assigned-component_a.");
buildExp(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildExp(" DATA ls_only_assigned TYPE ty_ts_struc.");
buildExp("");
buildExp(" \" ls_only_assigned is only used to modifying its own components");
buildExp(" ls_only_assigned-component_a = 5.");
buildExp(" ls_only_assigned-component_b = ls_only_assigned-component_a.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testAssignedWithSideEffects() {
// test a variable that is assigned but unused, where, however, the call may have side effects
buildSrc(" DATA(lo_unused_util) = get_utility( ).");
buildExp(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildExp(" DATA(lo_unused_util) = get_utility( ).");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testAssignedFinalWithSideEffects() {
// test a variable that is assigned but unused, where, however, the call may have side effects
buildSrc(" FINAL(lo_unused_util) = get_utility( ).");
buildExp(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildExp(" FINAL(lo_unused_util) = get_utility( ).");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testUnusedDeclChainWithComment() {
buildSrc(" \" comments between chain colon : and identifier:");
buildSrc(" FIELD-SYMBOLS: \" comment");
buildSrc(" <ls_item> LIKE LINE OF its_item.");
buildExp(" \" comments between chain colon : and identifier:");
putAnyMethodAroundSrcAndExp();
deactivateRuleUseCheck(); // TODO: since the first line is simply deleted, there is currently no way to log the rule use
testRule();
}
@Test
void testUnusedDeclWithFullLineComment() {
buildSrc(" \" only the full-line comment shall remain here:");
buildSrc(" FIELD-SYMBOLS: \" comment above the first identifier");
buildSrc(" <ls_item> LIKE LINE OF its_item, \" comment");
buildSrc(" \" full-line comment within the chain");
buildSrc(" <ls_order> LIKE LINE OF mt_order.");
buildExp(" \" only the full-line comment shall remain here:");
buildExp(" \" full-line comment within the chain");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testDeclarationWithLengthInfo() {
// test identifiers with length information in parentheses
buildSrc(" DATA lv_textdat1(20) TYPE c.");
buildSrc(" DATA lv_textdat2(20) TYPE c.");
buildSrc(" WRITE: iv_date1 TO lv_textdat1,");
buildSrc(" iv_date2 TO lv_textdat2.");
buildExp(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildExp(" DATA lv_textdat1(20) TYPE c.");
buildExp(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildExp(" DATA lv_textdat2(20) TYPE c.");
buildExp(" WRITE: iv_date1 TO lv_textdat1,");
buildExp(" iv_date2 TO lv_textdat2.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testUsageWithOffsetAndLength() {
// test identifiers that are used with 'identifier+offset(length)'
buildSrc(" DATA lv_date TYPE ty_date.");
buildSrc("* ev_month = lv_date+4(2).");
buildExp("* DATA lv_date TYPE ty_date.");
buildExp("* ev_month = lv_date+4(2).");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testUsageAsOffsetOrLength() {
buildSrc(" DATA lv_offset_a TYPE i.");
buildSrc(" DATA lv_offset_b TYPE i.");
buildSrc(" DATA lv_length_a TYPE i.");
buildSrc(" DATA lv_length_b TYPE i.");
buildSrc("");
buildSrc(" lv_offset_a = 1.");
buildSrc(" lv_offset_b = 2.");
buildSrc(" lv_length_a = 3.");
buildSrc(" lv_length_b = 4.");
buildSrc("");
buildSrc(" ev_result+lv_offset_a(lv_length_a) = iv_value+lv_offset_b(lv_length_b).");
copyExpFromSrc();
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testUsageInSqlStatement() {
// ensure that @identifiers in SQL statements are correctly identified
buildSrc(" DATA lv_value TYPE dtab-any_field.");
buildSrc(" DATA ls_item TYPE ty_s_item.");
buildSrc("");
buildSrc(" SELECT SINGLE any_field");
buildSrc(" FROM dtab");
buildSrc(" WHERE other_field = @ls_item-other_field");
buildSrc(" INTO @lv_value.");
buildExp(" \" TODO: variable is assigned but never used (ABAP cleaner)");
buildExp(" DATA lv_value TYPE dtab-any_field.");
buildExp(" DATA ls_item TYPE ty_s_item.");
buildExp("");
buildExp(" SELECT SINGLE any_field");
buildExp(" FROM dtab");
buildExp(" WHERE other_field = @ls_item-other_field");
buildExp(" INTO @lv_value.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testFieldAccessOnObject() {
buildSrc(" \" lo_instance must NOT be marked as 'only assigned to', because the expression ...->mth_item is using it:");
buildSrc(" DATA lo_instance TYPE REF TO cl_any_class.");
buildSrc(" lo_instance ?= mo_instance.");
buildSrc(" lo_instance->mth_item = VALUE #( ( item_id = ls_struc-item_id");
buildSrc(" item = lo_item ) ).");
copyExpFromSrc();
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testConstants() {
buildSrc(" CONSTANTS lc_unused TYPE i VALUE 1200.");
buildSrc(" CONSTANTS lc_commented_out TYPE i VALUE 2.");
buildSrc(" CONSTANTS lc_used_constant TYPE i VALUE 3.");
buildSrc("");
buildSrc(" DO lc_used_constant TIMES.");
buildSrc(" \" do something");
buildSrc(" ENDDO.");
buildSrc("");
buildSrc("* DO lc_commented_out * 5 TIMES.");
buildSrc("* \" do something");
buildSrc("* ENDDO.");
buildExp("* CONSTANTS lc_unused TYPE i VALUE 1200.");
buildExp("* CONSTANTS lc_commented_out TYPE i VALUE 2.");
buildExp(" CONSTANTS lc_used_constant TYPE i VALUE 3.");
buildExp("");
buildExp(" DO lc_used_constant TIMES.");
buildExp(" \" do something");
buildExp(" ENDDO.");
buildExp("");
buildExp("* DO lc_commented_out * 5 TIMES.");
buildExp("* \" do something");
buildExp("* ENDDO.");
putAnyMethodAroundSrcAndExp();
testRule();
}
// -------------------------------------------------------------------------
// configuration settings for unused variables
@Test
void testCommentOutUnusedVarWithAsterisk() {
rule.configActionForVarsNeverUsed.setEnumValue(UnusedVariableAction.COMMENT_OUT_WITH_ASTERISK);
buildSrc(" DATA lv_unused TYPE string.");
buildExp("* DATA lv_unused TYPE string.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testCommentOutUnusedVarWithQuotMark() {
rule.configActionForVarsNeverUsed.setEnumValue(UnusedVariableAction.COMMENT_OUT_WITH_QUOT);
buildSrc(" DATA lv_unused TYPE string.");
buildExp(" \" DATA lv_unused TYPE string.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testAddTodoCommentForUnusedVar() {
rule.configActionForVarsNeverUsed.setEnumValue(UnusedVariableAction.ADD_TODO_COMMENT);
buildSrc(" DATA lv_unused TYPE string.");
buildExp(" \" TODO: variable is never used (ABAP cleaner)");
buildExp(" DATA lv_unused TYPE string.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testIgnoreUnusedVar() {
rule.configActionForVarsNeverUsed.setEnumValue(UnusedVariableAction.IGNORE);
buildSrc(" DATA lv_unused TYPE string.");
copyExpFromSrc();
putAnyMethodAroundSrcAndExp();
testRule();
}
// -------------------------------------------------------------------------
// configuration settings for variables only used in comments
@Test
void testDeleteVarOnlyUsedInComment() {
rule.configActionForVarsOnlyUsedInComment.setEnumValue(UnusedVariableAction.DELETE);
buildSrc(" DATA lv_only_used_in_comment TYPE string.");
buildSrc("* rv_result = lv_only_used_in_comment.");
buildExp("* rv_result = lv_only_used_in_comment.");
putAnyMethodAroundSrcAndExp();
deactivateRuleUseCheck(); // TODO: the rule use is stored on the deleted Command and therefore not detected
testRule();
}
@Test
void testCommentOutVarOnlyUsedInCommentWithQuot() {
rule.configActionForVarsOnlyUsedInComment.setEnumValue(UnusedVariableAction.COMMENT_OUT_WITH_QUOT);
buildSrc(" DATA lv_only_used_in_comment TYPE string.");
buildSrc("* lv_only_used_in_comment = 10.");
buildSrc("* lv_only_used_in_comment += 1.");
buildSrc("* rv_result = lv_only_used_in_comment.");
buildExp(" \" DATA lv_only_used_in_comment TYPE string.");
buildExp("* lv_only_used_in_comment = 10.");
buildExp("* lv_only_used_in_comment += 1.");
buildExp("* rv_result = lv_only_used_in_comment.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testCommentOutVarOnlyUsedInCommentWithAsterisk() {
rule.configActionForVarsOnlyUsedInComment.setEnumValue(UnusedVariableAction.COMMENT_OUT_WITH_ASTERISK);
buildSrc(" DATA lv_only_used_in_comment TYPE string.");
buildSrc("* rv_result = lv_only_used_in_comment.");
buildExp("* DATA lv_only_used_in_comment TYPE string.");
buildExp("* rv_result = lv_only_used_in_comment.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testAddTodoCommentForVarOnlyUsedInComment() {
rule.configActionForVarsOnlyUsedInComment.setEnumValue(UnusedVariableAction.ADD_TODO_COMMENT);
buildSrc(" DATA lv_only_used_in_comment TYPE i.");
buildSrc("* rv_result = lv_only_used_in_comment.");
buildExp(" \" TODO: variable is only used in commented-out code (ABAP cleaner)");
buildExp(" DATA lv_only_used_in_comment TYPE i.");
buildExp("* rv_result = lv_only_used_in_comment.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testIgnoreVarOnlyUsedInComment() {
rule.configActionForVarsOnlyUsedInComment.setEnumValue(UnusedVariableAction.IGNORE);
buildSrc(" DATA lv_only_used_in_comment TYPE i.");
buildSrc("* rv_result = lv_only_used_in_comment.");
copyExpFromSrc();
putAnyMethodAroundSrcAndExp();
testRule();
}
// -------------------------------------------------------------------------
// configuration settings for unused constants
@Test
void testDeleteUnusedConstant() {
rule.configActionForConstantsNeverUsed.setEnumValue(UnusedVariableAction.DELETE);
buildSrc(" CONSTANTS lc_unused TYPE i VALUE 42.");
buildSrc(" \" do something");
buildExp(" \" do something");
putAnyMethodAroundSrcAndExp();
deactivateRuleUseCheck(); // TODO: the rule use is stored on the deleted Command and therefore not detected
testRule();
}
@Test
void testCommentOutUnusedConstantWithAsterisk() {
rule.configActionForConstantsNeverUsed.setEnumValue(UnusedVariableAction.COMMENT_OUT_WITH_ASTERISK);
buildSrc(" CONSTANTS lc_unused TYPE i VALUE 42.");
buildExp("* CONSTANTS lc_unused TYPE i VALUE 42.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testCommentOutUnusedConstantWithQuotMark() {
rule.configActionForConstantsNeverUsed.setEnumValue(UnusedVariableAction.COMMENT_OUT_WITH_QUOT);
buildSrc(" CONSTANTS lc_unused TYPE i VALUE 42.");
buildExp(" \" CONSTANTS lc_unused TYPE i VALUE 42.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testAddTodoCommentForUnusedConstant() {
rule.configActionForConstantsNeverUsed.setEnumValue(UnusedVariableAction.ADD_TODO_COMMENT);
buildSrc(" CONSTANTS lc_unused TYPE i VALUE 42.");
buildExp(" \" TODO: constant is never used (ABAP cleaner)");
buildExp(" CONSTANTS lc_unused TYPE i VALUE 42.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testIgnoreUnusedConstant() {
rule.configActionForConstantsNeverUsed.setEnumValue(UnusedVariableAction.IGNORE);
buildSrc(" CONSTANTS lc_unused TYPE i VALUE 42.");
copyExpFromSrc();
putAnyMethodAroundSrcAndExp();
testRule();
}
// -------------------------------------------------------------------------
// configuration settings for constants only used in comments
@Test
void testDeleteConstantOnlyUsedInComment() {
rule.configActionForConstantsOnlyUsedInComment.setEnumValue(UnusedVariableAction.DELETE);
buildSrc(" CONSTANTS lc_only_used_in_comment TYPE string VALUE 'abc'.");
buildSrc("* rv_result = lc_only_used_in_comment.");
buildExp("* rv_result = lc_only_used_in_comment.");
putAnyMethodAroundSrcAndExp();
deactivateRuleUseCheck(); // TODO: the rule use is stored on the deleted Command and therefore not detected
testRule();
}
@Test
void testCommentOutConstantOnlyUsedInCommentWithQuot() {
rule.configActionForConstantsOnlyUsedInComment.setEnumValue(UnusedVariableAction.COMMENT_OUT_WITH_QUOT);
buildSrc(" CONSTANTS lc_only_used_in_comment TYPE string VALUE 'abc'.");
buildSrc("* rv_result = lc_only_used_in_comment.");
buildExp(" \" CONSTANTS lc_only_used_in_comment TYPE string VALUE 'abc'.");
buildExp("* rv_result = lc_only_used_in_comment.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testCommentOutConstantOnlyUsedInCommentWithAsterisk() {
rule.configActionForConstantsOnlyUsedInComment.setEnumValue(UnusedVariableAction.COMMENT_OUT_WITH_ASTERISK);
buildSrc(" CONSTANTS lc_only_used_in_comment TYPE string VALUE 'abc'.");
buildSrc("* rv_result = lc_only_used_in_comment.");
buildExp("* CONSTANTS lc_only_used_in_comment TYPE string VALUE 'abc'.");
buildExp("* rv_result = lc_only_used_in_comment.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testAddTodoCommentForConstantOnlyUsedInComment() {
rule.configActionForConstantsOnlyUsedInComment.setEnumValue(UnusedVariableAction.ADD_TODO_COMMENT);
buildSrc(" CONSTANTS lc_only_used_in_comment TYPE string VALUE 'abc'.");
buildSrc("* rv_result = lc_only_used_in_comment.");
buildExp(" \" TODO: constant is only used in commented-out code (ABAP cleaner)");
buildExp(" CONSTANTS lc_only_used_in_comment TYPE string VALUE 'abc'.");
buildExp("* rv_result = lc_only_used_in_comment.");
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testIgnoreConstantOnlyUsedInComment() {
rule.configActionForConstantsOnlyUsedInComment.setEnumValue(UnusedVariableAction.IGNORE);
buildSrc(" CONSTANTS lc_only_used_in_comment TYPE string VALUE 'abc'.");
buildSrc("* rv_result = lc_only_used_in_comment.");
copyExpFromSrc();
putAnyMethodAroundSrcAndExp();
testRule();
}
// -------------------------------------------------------------------------
// other configuration settings
@Test
void testIgnoreAssigned() {
rule.configActionForAssignedVars.setEnumValue(UnusedVariableActionIfAssigned.IGNORE);
buildSrc(" DATA: lv_only_assigned TYPE i,");
buildSrc(" lv_unused_but_needed TYPE string ##NEEDED.");
buildSrc("");
buildSrc(" lv_only_assigned = 1.");
copyExpFromSrc();
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testIgnoreAssignedOnlyUsedInComment() {
rule.configActionForAssignedVarsOnlyUsedInComment.setEnumValue(UnusedVariableActionIfAssigned.IGNORE);
buildSrc(" DATA: lv_assigned_but_used_incomment TYPE i,");
buildSrc(" lv_unused_but_needed TYPE string ##NEEDED.");
buildSrc("");
buildSrc(" lv_assigned_but_used_incomment = 1.");
buildSrc("");
buildSrc("* rv_result = lv_assigned_but_used_incomment.");
copyExpFromSrc();
putAnyMethodAroundSrcAndExp();
testRule();
}
@Test
void testMessageIntoUnusedData() {
rule.configActionForVarsAssignedInMessageInto.setEnumValue(UnusedVariableActionForMessageInto.ADD_TODO_COMMENT);
buildSrc(" MESSAGE e111(any_msg_class) WITH iv_item_id INTO DATA(lv_msg).");
buildSrc(" mo_message_handler->add_symessage( iv_ctx_type = if_any_interface=>co_context_item_id");
buildSrc(" iv_ctx_value = is_item-item_id ).");
buildExp(" \" TODO: variable is assigned but never used; add pragma ##NEEDED (ABAP cleaner)");
buildExp(" MESSAGE e111(any_msg_class) WITH iv_item_id INTO DATA(lv_msg).");
buildExp(" mo_message_handler->add_symessage( iv_ctx_type = if_any_interface=>co_context_item_id");
buildExp(" iv_ctx_value = is_item-item_id ).");
putAnyMethodAroundSrcAndExp();
testRule();