Merge branch 'topic/gnatcheck/forbid_compiler_rules' into 'master'

Unallow compiler based rules in source restricted rule sets

Closes #469

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

Author: HugoGGuerrier

lkql_checker/doc/gnatcheck_rm/using_gnatcheck.rst

@@ -530,6 +530,16 @@ only on SPARK code. Those symbols must also refer to an object value formatted l
     Ada_2022_In_Ghost_Code
   }
 
+Please note that compiler based rules (:ref:`Warnings`, :ref:`Restrictions` and
+:ref:`Style_Checks`) cannot be restricted to Ada or SPARK code. Consequently,
+the following configuration will raise an error:
+
+::
+
+  val spark_rules = @{
+    Warnings: "a"
+  }
+
 .. note::
 
   Note that an LKQL rules config file may contain arbitrary computation logic; the only

lkql_checker/src/gnatcheck-rules-rule_table.adb

@@ -1213,6 +1213,16 @@ package body Gnatcheck.Rules.Rule_Table is
    begin
       --  If the rule is a compiler check then get the argument and process it
       if Is_Compiler_Rule (R_Id) then
+         --  Ensure the source mode is "BOTH"
+         if Source_Mode_String /= "GENERAL" then
+            Error_In_Rule_File
+              ("cannot run compiler base rule """
+               & Rule_Name
+               & """ only on "
+               & Source_Mode_String
+               & " code");
+         end if;
+
          Instance := new Compiler_Instance (Instance_Name /= "");
          Instance.Rule := R_Id;
          Instance.Defined_At := To_Unbounded_String (Output_Rule_File);

testsuite/tests/gnatcheck_errors/invalid_lkql_rules_config/compiler_rule_in_restricted_source.lkql

@@ -0,0 +1,7 @@
+val rules = @{
+    Goto_Statements
+}
+
+val ada_rules = @{
+    Warnings: "a"
+}

testsuite/tests/gnatcheck_errors/invalid_lkql_rules_config/test.out

@@ -85,3 +85,9 @@ gnatcheck: error: Multiple instances with the same name: an_instance (instance_n
 gnatcheck: error: no rule to check specified
 try "gnatcheck --help" for more information.
 >>>program returned status code 2
+
+Compiler base rule in restricted rule set
+=========================================
+
+gnatcheck: error: cannot run compiler base rule "warnings" only on ADA code (compiler_rule_in_restricted_source.lkql)
+>>>program returned status code 5

testsuite/tests/gnatcheck_errors/invalid_lkql_rules_config/test.yaml

@@ -26,3 +26,5 @@ tests:
   lkql_rule_file: extra_param.lkql
 - label: Multiple instance with the same name
   lkql_rule_file: instance_names.lkql
+- label: Compiler base rule in restricted rule set
+  lkql_rule_file: compiler_rule_in_restricted_source.lkql