Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 21005x 21005x 21005x 21005x 21005x 21005x 21005x 21005x 21005x 21005x 21005x 21005x 21005x 21005x 21005x 21005x 21005x 21005x 21005x 21005x 21005x 21005x 21005x 1x 10503x 10503x 10503x 10503x 10503x 31351x 31351x 31351x 31351x 31351x 31351x 31351x 31351x 31351x 31351x 31351x 31351x 31351x 31351x 31351x 31351x 10503x 10503x 23x 23x 10503x 10503x 12337x 12337x 10503x 10503x 251x 251x 10503x 10503x 282x 282x 282x 282x 12x 12x 270x 270x 282x 1539x 7x 7x 1539x 263x 263x 263x 263x 263x 263x 263x 263x 263x 263x 263x 263x 263x 263x 263x 263x 263x 263x 263x 263x 282x 16x 5x 5x 5x 5x 16x 263x 263x 263x 263x 5x 5x 3x 3x 3x 3x 3x 3x 3x 3x 3x 5x 263x 263x 263x 263x 263x 10x 2x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 10x 263x 263x 263x 263x 263x 263x 263x 27x 27x 8x 8x 8x 8x 8x 8x 8x 8x 8x 27x 263x 263x 263x 263x 263x 263x 14x 6x 6x 6x 6x 6x 14x 263x 263x 263x 263x 10503x 10503x | import {Issue} from "../issue";
import * as Structures from "../abap/3_structures/structures";
import {ABAPRule} from "./_abap_rule";
import {BasicRuleConfig} from "./_basic_rule_config";
import {StructureNode} from "../abap/nodes";
import {IRuleMetadata, RuleTag} from "./_irule";
import {ABAPFile} from "../abap/abap_file";
import {Unknown} from "../abap/2_statements/statements/_statement";
export class EmptyStructureConf extends BasicRuleConfig {
/** Checks for empty LOOP blocks */
public loop: boolean = true;
/** Allow empty LOOP if subrc is checked after the loop */
public loopAllowIfSubrc: boolean = true;
/** Checks for empty IF blocks */
public if: boolean = true;
/** Checks for empty WHILE blocks */
public while: boolean = true;
/** Checks for empty CASE blocks */
public case: boolean = true;
/** Checks for empty SELECT blockss */
public select: boolean = true;
/** Checks for empty DO blocks */
public do: boolean = true;
/** Checks for empty AT blocks */
public at: boolean = true;
/** Checks for empty TRY blocks */
public try: boolean = true;
/** Checks for empty WHEN blocks */
public when: boolean = true;
// todo, other category containing ELSE
}
export class EmptyStructure extends ABAPRule {
private conf = new EmptyStructureConf();
public getMetadata(): IRuleMetadata {
return {
key: "empty_structure",
title: "Find empty blocks",
shortDescription: `Checks that the code does not contain empty blocks.`,
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#no-empty-if-branches`,
tags: [RuleTag.Styleguide, RuleTag.SingleFile],
badExample: `IF foo = bar.
ENDIF.
DO 2 TIMES.
ENDDO.`,
goodExample: `LOOP AT itab WHERE qty = 0 OR date > sy-datum.
ENDLOOP.
result = xsdbool( sy-subrc = 0 ).`,
};
}
private getDescription(name: string): string {
return "Empty block, add code: " + name;
}
public getConfig() {
return this.conf;
}
public setConfig(conf: EmptyStructureConf) {
this.conf = conf;
}
public runParsed(file: ABAPFile) {
const issues: Issue[] = [];
const stru = file.getStructure();
if (stru === undefined) {
return [];
}
const statements = file.getStatements();
for (const statement of statements) {
if (statement.get() instanceof Unknown) {
return []; // contains parser errors
}
}
const candidates: StructureNode[] = [];
if (this.getConfig().while === true) {
candidates.push(...stru.findAllStructuresRecursive(Structures.While));
}
if (this.getConfig().case === true) {
candidates.push(...stru.findAllStructuresRecursive(Structures.Case));
}
if (this.getConfig().select === true) {
candidates.push(...stru.findAllStructuresRecursive(Structures.Select));
}
if (this.getConfig().do === true) {
candidates.push(...stru.findAllStructuresRecursive(Structures.Do));
}
if (this.getConfig().at === true) {
candidates.push(...stru.findAllStructuresRecursive(Structures.At));
candidates.push(...stru.findAllStructuresRecursive(Structures.AtFirst));
candidates.push(...stru.findAllStructuresRecursive(Structures.AtLast));
}
for (const l of candidates) {
if (l.getChildren().length === 2) {
const token = l.getFirstToken();
const issue = Issue.atToken(file, token, this.getDescription(l.get().constructor.name), this.getMetadata().key, this.conf.severity);
issues.push(issue);
}
}
if (this.getConfig().try === true) {
const tries = stru.findAllStructuresRecursive(Structures.Try);
for (const t of tries) {
const normal = t.findDirectStructure(Structures.Body);
if (normal === undefined) {
const token = t.getFirstToken();
const issue = Issue.atToken(
file,
token,
this.getDescription(t.get().constructor.name),
this.getMetadata().key,
this.conf.severity);
issues.push(issue);
}
}
}
if (this.getConfig().loop === true) {
const loops = stru.findAllStructuresRecursive(Structures.Loop);
for (const loop of loops) {
if (loop.getChildren().length === 2) {
const endloopStatement = loop.getLastChild();
const endloopIndex = statements.findIndex((s) => s === endloopStatement);
const afterEndloop = statements[endloopIndex + 1];
if (afterEndloop !== undefined && afterEndloop.concatTokens().toUpperCase().includes("SY-SUBRC")) {
continue;
}
const token = loop.getFirstToken();
const issue = Issue.atToken(
file, token, this.getDescription(loop.get().constructor.name), this.getMetadata().key, this.conf.severity);
issues.push(issue);
}
}
}
if (this.getConfig().if === true) {
const tries = stru.findAllStructuresRecursive(Structures.If)
.concat(stru.findAllStructuresRecursive(Structures.Else))
.concat(stru.findAllStructuresRecursive(Structures.ElseIf));
for (const t of tries) {
const normal = t.findDirectStructure(Structures.Body);
if (normal === undefined) {
const token = t.getFirstToken();
const issue = Issue.atToken(
file,
token,
this.getDescription(t.get().constructor.name),
this.getMetadata().key,
this.conf.severity);
issues.push(issue);
}
}
}
if (this.getConfig().when === true) {
const tries = stru.findAllStructuresRecursive(Structures.When);
for (const t of tries) {
if (t.getChildren().length === 1) {
const token = t.getFirstToken();
const message = this.getDescription(t.get().constructor.name);
const issue = Issue.atToken(file, token, message, this.getMetadata().key, this.conf.severity);
issues.push(issue);
}
}
}
return issues;
}
} |