Merge branch 'mr/thevenoux/langkit-query-language#471' into 'master'

GNATcheck/LKQL: replace LKQL_RULES_PATH usage by LKQL_PATH

Closes #471

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

Author: thvnx

lkql_checker/src/lkql_checker.adb

@@ -80,7 +80,7 @@ package body Lkql_Checker is
       --  Get the default LKQL rule options file name.
 
       procedure Setup_Search_Paths;
-      --  Initialize LKQL_RULES_PATH to include path to built-in rules.
+      --  Initialize LKQL_PATH to include path to built-in rules.
       --  Assuming this executable is in $PREFIX/bin, this includes the
       --  $PREFIX/share/lkql and $PREFIX/share/lkql/kp paths. That way, only
       --  the driver needs to be aware of built-in rules, and worker can be
@@ -150,8 +150,8 @@ package body Lkql_Checker is
             Lib     : constant String := Compose (Prefix, "lib");
             Lib_LAL : constant String := Compose (Lib, "libadalang");
          begin
-            Add_Path ("LKQL_RULES_PATH", Lkql);
-            Add_Path ("LKQL_RULES_PATH", Kp);
+            Add_Path ("LKQL_PATH", Lkql);
+            Add_Path ("LKQL_PATH", Kp);
 
             Add_Path ("PATH", Lib);
             Add_Path ("PATH", Lib_LAL);
@@ -565,7 +565,7 @@ package body Lkql_Checker is
          end;
       end if;
 
-      --  Setup LKQL_RULES_PATH to point on built-in rules
+      --  Setup LKQL_PATH to point on built-in rules
 
       Setup_Search_Paths;
 

lkql_checker/src/rules_factory.adb

@@ -98,9 +98,9 @@ package body Rules_Factory is
          return True;
       end Add_Rules_Path;
    begin
-      if Ada.Environment_Variables.Exists ("LKQL_RULES_PATH") then
+      if Ada.Environment_Variables.Exists ("LKQL_PATH") then
          GNATCOLL.Utils.Split
-           (Ada.Environment_Variables.Value ("LKQL_RULES_PATH"),
+           (Ada.Environment_Variables.Value ("LKQL_PATH"),
             GNAT.OS_Lib.Path_Separator & "",
             Add_Rules_Path'Access);
       end if;

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

@@ -354,7 +354,7 @@ public LKQLOptions.AutoFixMode getAutoFixMode() {
     public String[] getRuleDirectories() {
         if (this.ruleDirectories == null) {
             final var rulesDirsList = new ArrayList<>(this.getOptions().rulesDirs());
-            final var additionalRulesDirs = System.getenv(Constants.LKQL_RULES_PATH);
+            final var additionalRulesDirs = System.getenv(Constants.LKQL_PATH);
             if (additionalRulesDirs != null) {
                 rulesDirsList.addAll(Arrays.asList(StringUtils.splitPaths(additionalRulesDirs)));
             }

lkql_jit/language/src/main/java/com/adacore/lkql_jit/utils/Constants.java

@@ -37,12 +37,9 @@ public class Constants {
     /** MIME type for LKQL. */
     public static final String LKQL_MIME = "application/langkit-query-language";
 
-    /** Environment variable which contains paths to look LKQL scripts in. */
+    /** Environment variable which contains paths to look LKQL scripts and rules in. */
     public static final String LKQL_PATH = "LKQL_PATH";
 
-    /** Environment variable which contains the paths to look LKQL rules in. */
-    public static final String LKQL_RULES_PATH = "LKQL_RULES_PATH";
-
     // ----- Built-in symbols -----
 
     /** Symbol which contains the "this" value in selectors. */

testsuite/drivers/checker_driver.py

@@ -1,4 +1,5 @@
 import re
+import os
 
 from drivers.base_driver import BaseDriver, TaggedLines
 
@@ -62,7 +63,11 @@ def run(self) -> None:
         else:
             # Use `catch_error=False` to avoid failing on non-zero status code,
             # as some tests actually exert erroneous behaviors.
-            self.check_run(self.lkql_checker_exe + args, catch_error=False)
+            self.check_run(
+                self.lkql_checker_exe + args,
+                catch_error=False,
+                lkql_path=os.environ["LKQL_PATH"],
+            )
 
             # If required, run the LKQL fix command
             if self.test_env.get("auto_fix"):
@@ -76,6 +81,7 @@ def run(self) -> None:
                     self.lkql_fix_exe + args + ["--auto-fix-mode", auto_fix_mode],
                     check_flags=False,
                     catch_error=False,
+                    lkql_path=os.environ["LKQL_PATH"],
                 )
 
                 # If the auto-fix mode is "NEW_FILE" or "PATCH_FILE", then

testsuite/drivers/gnatcheck_driver.py

@@ -238,15 +238,14 @@ def default_process_timeout(self):
     def run(self) -> None:
         gnatcheck_env = dict(os.environ)
 
-        # Here we don't want to pollute the LKQL_RULES_PATH and LKQL_PATH with
-        # this repository's LKQL rules: GNATcheck will find those itself by
-        # looking next to its executable. If we let this variable, we might end
-        # up with duplicate definitions of rules, for example if this repository
-        # is a copy of the original LKQL repository (which is actually what
-        # happens in production: the checkout used for testing is separate
-        # from that used for building).
-        gnatcheck_env["LKQL_RULES_PATH"] = getattr(self.env, "gnatcheck_rules_path", "")
-        gnatcheck_env["LKQL_PATH"] = ""
+        # Here we don't want to pollute LKQL_PATH with this repository's LKQL
+        # rules: GNATcheck will find those itself by looking next to its
+        # executable. If we let this variable, we might end up with duplicate
+        # definitions of rules, for example if this repository is a copy of the
+        # original LKQL repository (which is actually what happens in
+        # production: the checkout used for testing is separate from that used
+        # for building).
+        gnatcheck_env["LKQL_PATH"] = getattr(self.env, "gnatcheck_rules_path", "")
 
         # Get the test provided custom GNATcheck worker
         custom_worker = self.test_env.get("worker", None)

testsuite/drivers/interpreter_driver.py

@@ -81,7 +81,10 @@ def compute_failures(self):
 
     def run(self) -> None:
 
-        lkql_path = [self.working_dir(d) for d in self.test_env.get("lkql_path", [])]
+        lkql_path = os.pathsep.join(
+            [self.working_dir(d) for d in self.test_env.get("lkql_path", [])]
+            + [(os.environ["LKQL_PATH"])]
+        )
 
         # If lkt_refactor flag is set, then before we run the interpreter,
         # we refactor the "script.lkql" file and run the interpreter on it.
@@ -107,13 +110,11 @@ def run(self) -> None:
             # Run test on refactored script
             lkt_result = self.check_run(
                 self.build_args(refactored_file_path),
-                lkql_path=os.pathsep.join(lkql_path),
+                lkql_path=lkql_path,
                 analyze_output=False,
             )
 
             self.lkt_output = lkt_result.out
 
         # Run the interpreter
-        self.check_run(
-            self.build_args("script.lkql"), lkql_path=os.pathsep.join(lkql_path)
-        )
+        self.check_run(self.build_args("script.lkql"), lkql_path=lkql_path)

testsuite/testsuite.py

@@ -245,13 +245,10 @@ def in_repo(*args):
             )
 
             os.environ["LKQL_PATH"] = P.pathsep.join(
-                [in_repo("lkql_checker/share/lkql"), os.environ.get("LKQL_PATH", "")]
-            )
-
-            os.environ["LKQL_RULES_PATH"] = P.pathsep.join(
                 [
                     in_repo("lkql_checker/share/lkql"),
                     in_repo("lkql_checker/share/lkql/kp"),
+                    os.environ.get("LKQL_PATH", ""),
                 ]
             )