SonarQube OpenEdge 自定义规则使用 Proparse 验证 &IF 预处理器

Question

我正在尝试创建一个自定义插件，基于 Riverside OpenEdge plugin 及其版本的 Proparse 来创建一个有效 &IF 预处理器的规则。

此规则需要验证应用程序是否使用了已弃用的 &GLOBAL-DEFINE 值，如下所示：

/* "A" is the deprecated value of "opts" so I want to create a new ISSUE here */
&IF "{&opts}" = "A" &THEN
    MESSAGE "DEPRECATED CODE".
&ENDIF

&IF "{&opts}" > "A" &THEN
    MESSAGE "OK CODE".
&ENDIF

对于我扩展的这条规则，我尝试做这样的事情：

if (unit.getMacroGraph().macroEventList.stream().noneMatch(macro -> macro instanceof NamedMacroRef
        && ((NamedMacroRef) macro).getMacroDef().getName().equalsIgnoreCase("opts"))) {
    return;
}

TokenSource stream = unit.lex();
ProToken tok = (ProToken) stream.nextToken();

while (tok.getNodeType() != ABLNodeType.EOF_ANTLR4) {
    if (tok.getNodeType() == ABLNodeType.AMPIF) {
        // Verify node.
        System.out.println(tok);
    }

    tok = (ProToken) stream.nextToken();
}

但我不知道它是否是最好的验证方法（我根据其他来源的代码做了）并且它不起作用，因为下一个节点是一个空的“QSSTRING”。我是 Proparse 世界的新手，感谢任何帮助。

Answer 1

首先，您必须知道 Proparse 不能访问预处理器的每个细节。也就是说，unit.getMacroGraph() 方法可以让您访问预处理器的可见部分，所以这是一个很好的起点。 如果您正在寻找给定预处理器变量的用法，您可以搜索指向正确 MacroDef 对象（使用 NamedMacroRef#getMacroDef()#getName()）的 NamedMacroRef 实例和正确的值。

在老式的 for-each 循环中：

for (MacroRef ref : unit.getMacroSourceArray()) {
  if ((ref instanceof NamedMacroRef)) {
    if ("opts".equalsIgnoreCase(((NamedMacroRef) ref).getMacroDef().getName())
        && "A".equalsIgnoreCase(((NamedMacroRef) ref).getMacroDef().getValue())) {
      System.out.println("OPTS variable usage with value 'A' at file " + ref.getFileIndex() + ":" + ref.getLine());
    }
  }
}

关于这个文件：

&global-define opts a
&IF "{&opts}" = "A" &THEN
    MESSAGE "DEPRECATED CODE".
&ENDIF
&undefine opts
&global-define opts b
&IF "{&opts}" > "A" &THEN
    MESSAGE "OK CODE".
&ENDIF

这给出了：

OPTS variable usage with value 'A' at file 0:2

所以你无法访问表达式引擎，但我认为当前的 API 已经足够你想做的事情了。

然后您可以通过 OpenEdgeProparseCheck#reportIssue() 报告 SonarQube 的问题