All files / src/rules msag_consistency.ts

81.18% Statements 82/101
83.33% Branches 15/18
100% Functions 8/8
81.18% Lines 82/101

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 1011x 1x 1x 1x 1x 1x 1x 1x 21998x 21998x 21998x 21998x 1x 11001x 11001x 11001x 11001x 32805x 32805x 32805x 32805x 32805x 32805x 32805x 11001x 11001x 1x 1x 11001x 11001x 10453x 10453x 11001x 11001x 260x 260x 11001x 11001x 264x 264x 11001x 11001x 330x 330x 330x 323x 323x 7x 7x 7x 330x 6x 6x 1x 1x 1x 1x 1x 6x 6x           6x 6x 6x 1x 1x 1x 1x 6x 5x 5x 6x 6x 6x 6x           6x 6x                   6x 6x 7x 7x 7x 11001x
import {Issue} from "../issue";
import {BasicRuleConfig} from "./_basic_rule_config";
import {IRegistry} from "../_iregistry";
import {MessageClass} from "../objects";
import {IRule, IRuleMetadata} from "./_irule";
import {IObject} from "../objects/_iobject";
import {Position} from "../position";
 
export class MSAGConsistencyConf extends BasicRuleConfig {
  /** parameters must be numbered */
  public numericParameters = true;
}
 
export class MSAGConsistency implements IRule {
  private conf = new MSAGConsistencyConf();
 
  public getMetadata(): IRuleMetadata {
    return {
      key: "msag_consistency",
      title: "MSAG consistency check",
      shortDescription: `Checks the validity of messages in message classes`,
      extendedInformation: `Message numbers must be 3 digits, message text must not be empty, no message number duplicates`,
    };
  }
 
  private getDescription(reason: string): string {
    return "Message class invalid: " + reason;
  }
 
  public getConfig() {
    return this.conf;
  }
 
  public setConfig(conf: MSAGConsistencyConf) {
    this.conf = conf;
  }
 
  public initialize(_reg: IRegistry) {
    return this;
  }
 
  public run(obj: IObject): Issue[] {
    const issues: Issue[] = [];
 
    if (!(obj instanceof MessageClass)) {
      return [];
    }
 
    const numbers = new Set<string>();
 
    for (const message of obj.getMessages()) {
// todo, get the right positions in xml file, and report the issue there
      if (!message.getNumber().match(/\d\d\d/)) {
        const text = this.getDescription("Message number must be 3 digits: message " + message.getNumber());
        const position = new Position(1, 1);
        const issue = Issue.atPosition(obj.getFiles()[0], position, text, this.getMetadata().key, this.conf.severity);
        issues.push(issue);
      }
 
      if (message.getMessage() === "") {
        const text = "Message text empty: message " + message.getNumber();
        const position = new Position(1, 1);
        const issue = Issue.atPosition(obj.getFiles()[0], position, text, this.getMetadata().key, this.conf.severity);
        issues.push(issue);
      }
 
      const num = message.getNumber();
      if (numbers.has(num)) {
        const text = "Duplicate message number " + num;
        const position = new Position(1, 1);
        const issue = Issue.atPosition(obj.getFiles()[0], position, text, this.getMetadata().key, this.conf.severity);
        issues.push(issue);
      } else {
        numbers.add(num);
      }
 
      if (this.getConfig().numericParameters === true) {
        const placeholderCount = message.getPlaceholderCount();
        if (placeholderCount > 4) {
          const text = `More than 4 placeholders in mesasge ${message.getNumber()}` ;
          const position = new Position(1, 1);
          const issue = Issue.atPosition(obj.getFiles()[0], position, text, this.getMetadata().key, this.conf.severity);
          issues.push(issue);
        }
 
        for (let i = 1; i <= placeholderCount; i++) {
          const placeholder = "&" + i;
          if (message.getMessage().includes(placeholder) === false) {
            const text = `Expected placeholder ${placeholder} in message ${message.getNumber()}` ;
            const position = new Position(1, 1);
            const issue = Issue.atPosition(obj.getFiles()[0], position, text, this.getMetadata().key, this.conf.severity);
            issues.push(issue);
            break;
          }
        }
      }
    }
 
    return issues;
  }
}