Create first tests for the 'composable rule files' feature

Author: HugoGGuerrier

testsuite/drivers/gnatcheck_driver.py

@@ -128,6 +128,8 @@ class GnatcheckDriver(BaseDriver):
           True.
         - ``in_tty`` (bool): Whether to run GNATcheck in a pseudo TTY using the
           ``pty`` Python module.
+        - ``lkql_path`` (list[str]): A list of directories forwarded to the
+            `LKQL_PATH` environment variable when the test is run.
 
         - ``jobs`` (int): The number of jobs to forward to the GNATcheck command.
         - ``project`` (str): GPR build file to use (if any).
@@ -289,6 +291,8 @@ def run_one_test(test_data: dict[str, any]) -> None:
                     f"{exe}.{'xml' if output_format == 'xml' else 'out'}"
                 )
             )
+            test_env = dict(gnatcheck_env)
+
 
             pre_python = test_data.get('pre_python', None)
             post_python = test_data.get('post_python', None)
@@ -298,6 +302,13 @@ def run_one_test(test_data: dict[str, any]) -> None:
             if pre_python:
                 capture_exec_python(pre_python)
 
+            # If required, add provided directories to the LKQL_PATH variable
+            for d in test_data.get('lkql_path', []):
+                test_env['LKQL_PATH'] = os.pathsep.join([
+                    self.working_dir(d),
+                    test_env.get('LKQL_PATH', ""),
+                ])
+
             # Set the target if one has been provided
             if test_data.get('target'):
                 args.append(f"--target={test_data['target']}")
@@ -420,9 +431,9 @@ def run_one_test(test_data: dict[str, any]) -> None:
                 exec_output = ""
                 status_code = 0
                 if test_data.get("in_tty"):
-                    exec_output, status_code = self.run_in_tty(args, env=gnatcheck_env)
+                    exec_output, status_code = self.run_in_tty(args, env=test_env)
                 else:
-                    p = self.shell(args, env=gnatcheck_env, catch_error=False, analyze_output=False)
+                    p = self.shell(args, env=test_env, catch_error=False, analyze_output=False)
                     exec_output = p.out
                     status_code = p.status
 

testsuite/tests/gnatcheck/lkql_rules_config/combine_rule_files/ambiguous_import.lkql

@@ -0,0 +1,5 @@
+import null_stmt
+
+val rules = null_stmt.rules & @{
+    Goto_Statements
+}

testsuite/tests/gnatcheck/lkql_rules_config/combine_rule_files/circular_import.lkql

@@ -0,0 +1,5 @@
+import part_one
+
+val rules = part_one.rules & @{
+    Goto_Statements
+}

testsuite/tests/gnatcheck/lkql_rules_config/combine_rule_files/invalid_import.lkql

@@ -0,0 +1,3 @@
+import null_stmt
+
+val rules = null_stmt.rules @{}

testsuite/tests/gnatcheck/lkql_rules_config/combine_rule_files/main.adb

@@ -0,0 +1,13 @@
+procedure Main is
+begin
+   null;
+   goto First;  --  FLAG
+
+   <<First>>
+
+   if C then
+      goto Second;  --  FLAG
+   end if;
+
+   <<Second>>
+end Main;

testsuite/tests/gnatcheck/lkql_rules_config/combine_rule_files/other_rule_configs/null_stmt.lkql

@@ -0,0 +1,5 @@
+import part_two
+
+val rules = part_two.rules & @{
+    Redundant_Null_Statements
+}

testsuite/tests/gnatcheck/lkql_rules_config/combine_rule_files/other_rule_configs/part_one.lkql

@@ -0,0 +1,5 @@
+import part_one
+
+val rules = part_one.rules & @{
+    Blocks
+}

testsuite/tests/gnatcheck/lkql_rules_config/combine_rule_files/other_rule_configs/part_two.lkql

@@ -0,0 +1,3 @@
+val rules = @{
+    Redundant_Null_Statements
+}

testsuite/tests/gnatcheck/lkql_rules_config/combine_rule_files/rule_configs/null_stmt.lkql

@@ -0,0 +1,3 @@
+val rules = @{
+    Goto_Statements: {Only_Unconditional: true, instance_name: "unconditional_goto"}
+}

testsuite/tests/gnatcheck/lkql_rules_config/combine_rule_files/rule_configs/uncond_goto_stmt.lkql

@@ -0,0 +1,37 @@
+Without key overlapping
+=======================
+
+main.adb:3:04: rule violation: redundant null statement [redundant_null_statements]
+main.adb:4:04: rule violation: goto statement [goto_statements]
+main.adb:9:07: rule violation: goto statement [goto_statements]
+
+With key overlapping
+====================
+
+main.adb:4:04: rule violation: goto statement [goto_statements]
+main.adb:4:04: rule violation: goto statement [unconditional_goto|goto_statements]
+main.adb:9:07: rule violation: goto statement [goto_statements]
+
+Rule file with an invalid importation
+=====================================
+
+gnatcheck: error: invalid_import.lkql:1:01: Cannot import, module not found "null_stmt" (invalid_import.lkql)
+gnatcheck: error: no rule to check specified
+try "gnatcheck --help" for more information.
+>>>program returned status code 2
+
+Rule file with circular importation
+===================================
+
+gnatcheck: error: part_two.lkql:1:01: Circular dependency in LKQL modules (circular_import.lkql -> part_one.lkql -> part_two.lkql -> part_one.lkql) (circular_import.lkql)
+gnatcheck: error: no rule to check specified
+try "gnatcheck --help" for more information.
+>>>program returned status code 2
+
+Rule file with ambiguous importation
+====================================
+
+gnatcheck: error: ambiguous_import.lkql:1:01: Ambiguous importation, multiple "null_stmt" modules found (<working-dir>/other_rule_configs/null_stmt.lkql & <working-dir>/rule_configs/null_stmt.lkql) (ambiguous_import.lkql)
+gnatcheck: error: no rule to check specified
+try "gnatcheck --help" for more information.
+>>>program returned status code 2

testsuite/tests/gnatcheck/lkql_rules_config/combine_rule_files/test.out

@@ -0,0 +1,30 @@
+driver: gnatcheck
+format: brief
+input_sources:
+ - main.adb
+show_rule: True
+check_flags: False
+
+tests:
+  # Valid configurations testing
+  - label: Without key overlapping
+    lkql_rule_file: without_overlapping.lkql
+    lkql_path:
+      - rule_configs
+  - label: With key overlapping
+    lkql_rule_file: with_overlapping.lkql
+    lkql_path:
+      - rule_configs
+
+  # Error testing
+  - label: Rule file with an invalid importation
+    lkql_rule_file: invalid_import.lkql
+  - label: Rule file with circular importation
+    lkql_rule_file: circular_import.lkql
+    lkql_path:
+      - other_rule_configs
+  - label: Rule file with ambiguous importation
+    lkql_rule_file: ambiguous_import.lkql
+    lkql_path:
+      - rule_configs
+      - other_rule_configs

testsuite/tests/gnatcheck/lkql_rules_config/combine_rule_files/test.yaml

@@ -0,0 +1,5 @@
+import uncond_goto_stmt
+
+val rules = uncond_goto_stmt.rules & @{
+    Goto_Statements
+}

testsuite/tests/gnatcheck/lkql_rules_config/combine_rule_files/with_overlapping.lkql

@@ -0,0 +1,5 @@
+import null_stmt
+
+val rules = null_stmt.rules & @{
+    Goto_Statements
+}