Merge branch 'topic/482' into 'master'

lkql check: add a warning when different LKQL files declare checkers with identical name

Closes #482

See merge request eng/libadalang/langkit-query-language!502

Author: thvnx

lkql_jit/language/src/main/java/com/adacore/lkql_jit/LKQLContext.java

@@ -366,6 +366,7 @@ public String[] getRuleDirectories() {
             if (additionalRulesDirs != null) {
                 rulesDirsList.addAll(Arrays.asList(StringUtils.splitPaths(additionalRulesDirs)));
             }
+            rulesDirsList.sort(null);
             this.ruleDirectories = rulesDirsList.toArray(new String[0]);
         }
         return this.ruleDirectories;

lkql_jit/language/src/main/java/com/adacore/lkql_jit/checker/BaseChecker.java

@@ -118,6 +118,11 @@ public void setAlias(String alias) {
     /** Create a deep copy of the current checker and return it. */
     public abstract BaseChecker copy();
 
+    /** Get the checker path name. */
+    public String getPath() {
+        return function.rootNode.getBody().getSourceSection().getSource().getPath();
+    }
+
     // ----- Inner classes -----
 
     /** This enum represents the valid remediation levels */

lkql_jit/language/src/main/java/com/adacore/lkql_jit/nodes/TopLevelList.java

@@ -141,6 +141,7 @@ public void addRuleImports() {
                 if (ruleDirectoryFiles != null) {
                     ruleImports.addAll(
                         Arrays.stream(ruleDirectoryFiles)
+                            .sorted()
                             .filter(File::canRead)
                             .map(f ->
                                 new Import(

lkql_jit/language/src/main/java/com/adacore/lkql_jit/runtime/GlobalScope.java

@@ -86,7 +86,19 @@ public Map<String, BaseChecker> getCheckers() {
      */
     @CompilerDirectives.TruffleBoundary
     public void addChecker(String name, BaseChecker checker) {
-        this.checkers.put(name, checker);
+        BaseChecker previousValue = this.checkers.put(name, checker);
+
+        if (previousValue != null) {
+            System.err.println(
+                "Warning: a checker named \"" +
+                name +
+                "\" from: " +
+                previousValue.getPath() +
+                ", has been replaced by the one from: " +
+                checker.getPath() +
+                ". Note: checkers should have unique names."
+            );
+        }
     }
 
     /**

testsuite/drivers/checker_driver.py

@@ -2,6 +2,7 @@
 
 from drivers.base_driver import BaseDriver, TaggedLines
 
+from e3.testsuite.driver.diff import OutputRefiner, Substitute
 
 class CheckerDriver(BaseDriver):
     """
@@ -111,3 +112,9 @@ def parse_flagged_lines(self, output: str) -> dict[str, TaggedLines]:
 
         # Return the result
         return res
+
+    @property
+    def output_refiners(self) -> list[OutputRefiner]:
+        result = super().output_refiners
+        result.append(Substitute(self.test_env['test_dir'], "<test-dir>"))
+        return result

testsuite/tests/checks/same_check_name/rule1.lkql

@@ -0,0 +1,3 @@
+@check(message="Rule1")
+fun my_rule(node) =
+    node is DefiningName

testsuite/tests/checks/same_check_name/rule2.lkql

@@ -0,0 +1,3 @@
+@check(message="Rule2")
+fun my_rule(node) =
+    node is NullStmt

testsuite/tests/checks/same_check_name/rule3.lkql

@@ -0,0 +1,3 @@
+@check(message="Rule3")
+fun my_rule(node) =
+    node is DefiningName

testsuite/tests/checks/same_check_name/test.adb

@@ -0,0 +1,4 @@
+procedure P is  --  FLAG
+begin
+   null;
+end P;

testsuite/tests/checks/same_check_name/test.out

@@ -0,0 +1,6 @@
+Warning: a checker named "my_rule" from: <test-dir>/rule1.lkql, has been replaced by the one from: <test-dir>/rule2.lkql. Note: checkers should have unique names.
+Warning: a checker named "my_rule" from: <test-dir>/rule2.lkql, has been replaced by the one from: <test-dir>/rule3.lkql. Note: checkers should have unique names.
+test.adb:1:11: rule violation: Rule3
+1 | procedure P is  --  FLAG
+  |           ^
+