All files / src/rules uncaught_exception.ts

96.08% Statements 221/230
87.2% Branches 75/86
100% Functions 13/13
96.08% Lines 221/230

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 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 2301x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 9374x 9374x 9374x 9374x 9374x 9374x 9374x 9374x 9374x 9374x 27927x 27927x 27927x 27927x 27927x 27927x 27927x 27927x 9374x 9374x 8903x 8903x 9374x 9374x 230x 230x 230x 230x 9374x 9374x 216x 216x 9374x 9374x 318x 19x 318x 1x 1x 298x 298x 318x 12x 12x 286x 286x 318x 25x 25x 261x 261x 261x 318x 548x 548x 261x 261x 261x 9374x 9374x 1439x 1439x 1439x 218x 218x 1221x 1439x 481x 5x 5x 5x 5x 16x 16x 5x 5x 481x 476x 875x 875x 476x 1439x 740x 49x 740x 49x 691x 12x 12x 12x 1x 1x 642x 12x 630x 10x 10x 10x 10x 10x 10x 10x 10x 618x   608x 608x 608x 740x 1439x 1439x 9374x 9374x 9374x 9374x 12x 5x 5x 5x 12x 9374x 9374x 608x 608x 608x 608x 608x 423x 423x 423x 423x 7x 7x 2x 2x 7x 423x 608x 9374x 9374x 5x     5x 3x 3x     3x 3x 3x 3x 5x 9374x 9374x 49x 49x 49x 49x 49x 49x 49x 49x 49x 49x 49x 49x 49x 49x     49x 49x 49x 9374x 9374x 17x 17x 17x 1x 1x 16x 16x 17x     16x 16x 16x 17x 17x 9374x 9374x 230x 230x 230x 363x 246x 246x 363x 363x 46x 46x 71x 363x 363x 230x 9374x 9374x
import {Issue} from "../issue";
import {ABAPRule} from "./_abap_rule";
import {BasicRuleConfig} from "./_basic_rule_config";
import * as Statements from "../abap/2_statements/statements";
import * as Expressions from "../abap/2_statements/expressions";
import * as Structures from "../abap/3_structures/structures";
import {IRuleMetadata, RuleTag} from "./_irule";
import {ABAPFile} from "../abap/abap_file";
import {StatementNode, StructureNode} from "../abap/nodes";
import {IRegistry} from "../_iregistry";
import {Class, Program} from "../objects";
import {DDIC} from "../ddic";
import {SyntaxLogic} from "../abap/5_syntax/syntax";
import {ABAPObject} from "../objects/_abap_object";
import {ISyntaxResult} from "../abap/5_syntax/_spaghetti_scope";
import {ReferenceType} from "../abap/5_syntax/_reference";
import {MethodDefinition} from "../abap/types";
 
export class UncaughtExceptionConf extends BasicRuleConfig {
}
 
export class UncaughtException extends ABAPRule {
 
  private conf = new UncaughtExceptionConf();
 
  private globalExceptions: {[index: string]: string | undefined};
  private issues: Issue[] = [];
  private sinked: string[] | undefined;
  private syntax: ISyntaxResult;
 
  public getMetadata(): IRuleMetadata {
    return {
      key: "uncaught_exception",
      title: "Uncaught Exception",
      shortDescription: `Checks for uncaught static exception`,
      extendedInformation: `Does not report any issues if the code contains syntax errors`,
      tags: [RuleTag.Syntax],
    };
  }
 
  public getConfig() {
    return this.conf;
  }
 
  public initialize(reg: IRegistry) {
    super.initialize(reg);
    this.findGlobalExceptions();
    return this;
  }
 
  public setConfig(conf: UncaughtExceptionConf) {
    this.conf = conf;
  }
 
  public runParsed(file: ABAPFile, obj: ABAPObject) {
    if (obj.getType() === "INTF") { // nothing can be raised in interfaces
      return [];
    } if (obj instanceof Program && obj.isInclude() === true) {
      return [];
    }
 
    const stru = file.getStructure();
    if (stru === undefined) {
      return [];
    }
 
    this.syntax = new SyntaxLogic(this.reg, obj).run();
    if (this.syntax.issues.length > 0) {
      return [];
    }
 
    this.issues = [];
    this.sinked = undefined;
    for (const c of stru.getChildren()) {
      this.traverse(c, file);
    }
 
    return this.issues;
  }
 
  private traverse(n: StructureNode | StatementNode, file: ABAPFile) {
    const get = n.get();
    if (get instanceof Structures.ClassDefinition
        || get instanceof Structures.Interface) {
      return; // to optimize performance
    }
 
    if (n instanceof StructureNode) {
      if (get instanceof Structures.Try) {
        // note that TRY-CATCH might be arbitrarily nested
        const previous = this.sinked ? this.sinked.slice() : undefined;
        this.addFromTryStructure(n);
        for (const c of n.getChildren()) {
          this.traverse(c, file);
        }
        this.sinked = previous;
        return;
      } else {
        for (const c of n.getChildren()) {
          this.traverse(c, file);
        }
      }
    } else if (n instanceof StatementNode) {
      if (get instanceof Statements.MethodImplementation) {
        this.setSinkedFromMethod(n, file);
      } else if (get instanceof Statements.EndMethod) {
        this.sinked = undefined; // back to top level
      } else if (get instanceof Statements.Form) {
        this.sinked = [];
        const raising = n.findDirectExpression(Expressions.FormRaising);
        for (const c of raising?.findAllExpressions(Expressions.ClassName) || []) {
          this.sinked.push(c.concatTokens().toUpperCase());
        }
      } else if (get instanceof Statements.EndForm) {
        this.sinked = undefined; // back to top level
      } else if (get instanceof Statements.Raise) {
        let name: string | undefined = undefined;
 
        const concat = n.concatTokens().toUpperCase();
        if (concat.startsWith("RAISE EXCEPTION TYPE ")) {
          name = n.findFirstExpression(Expressions.ClassName)?.getFirstToken().getStr().toUpperCase();
        }
 
        this.check(name, n, file);
      } else if (get instanceof Statements.Perform) {
        // todo, PERFORM, or is this not statically checked?
      } else {
        this.checkForMethodCalls(n, file);
      }
    }
 
  }
 
////////////////////////////////
 
  private check(name: string | undefined, n: StatementNode, file: ABAPFile) {
    if (this.isSinked(name) === false) {
      const issue = Issue.atStatement(file, n, "Uncaught exception " + name, this.getMetadata().key, this.getConfig().severity);
      this.issues.push(issue);
    }
  }
 
  private checkForMethodCalls(n: StatementNode, file: ABAPFile) {
    const start = n.getFirstToken().getStart();
    const end = n.getLastToken().getEnd();
 
    const scope = this.syntax.spaghetti.lookupPosition(start, file.getFilename());
    for (const r of scope?.getData().references || []) {
      if (r.referenceType === ReferenceType.MethodReference
          && r.position.getStart().isAfter(start)
          && r.position.getEnd().isBefore(end)
          && r.resolved instanceof MethodDefinition) {
 
        for (const name of r.resolved.getRaising()) {
          this.check(name, n, file);
        }
      }
    }
  }
 
  private addFromTryStructure(s: StructureNode) {
    if (this.sinked === undefined) {
      return;
    }
    for (const structure of s.findDirectStructures(Structures.Catch)) {
      const c = structure.findDirectStatement(Statements.Catch);
      if (c === undefined) {
        continue;
      }
      for (const cn of c.findDirectExpressions(Expressions.ClassName)) {
        this.sinked.push(cn.concatTokens());
      }
    }
  }
 
  private setSinkedFromMethod(s: StatementNode, file: ABAPFile) {
    this.sinked = [];
 
    const scope = this.syntax.spaghetti.lookupPosition(s.getLastToken().getEnd(), file.getFilename());
 
    let def: MethodDefinition | undefined = undefined;
    for (const r of scope?.getData().references || []) {
      // there should be only one, so the first is okay
      if (r.referenceType === ReferenceType.MethodImplementationReference
          && r.resolved instanceof MethodDefinition) {
        def = r.resolved;
        break;
      }
    }
    if (def === undefined) {
      return; // this should not occur, so just report everything as errors
    }
 
    def.getRaising().forEach(r => this.sinked?.push(r));
  }
 
  private isSinked(name: string | undefined): boolean {
    // todo: ignore dynamic and no_check exceptions
 
    if (this.sinked === undefined || name === undefined) {
      return true;
    }
 
    const sup = this.globalExceptions[name.toUpperCase()];
    if (sup === "CX_DYNAMIC_CHECK" || sup === "CX_NO_CHECK") {
      return true;
    }
 
    // todo, check local class hierarchy
    return this.sinked.some(a => a.toUpperCase() === name.toUpperCase())
      || ( sup !== undefined && this.isSinked(sup) === true );
  }
 
  private findGlobalExceptions() {
    this.globalExceptions = {};
    const ddic = new DDIC(this.reg);
    for (const o of this.reg.getObjects()) {
      if (!(o instanceof Class)) {
        continue;
      }
      const def = o.getMainABAPFile()?.getInfo().getClassDefinitionByName(o.getName());
      if (def === undefined || ddic.isException(def, o) === false) {
        continue;
      }
 
      this.globalExceptions[o.getName().toUpperCase()] = def.superClassName?.toUpperCase();
    }
  }
 
}