Get KPs' impacts from impact-db fetched data

thvnx · thvnx · commit 80d920ac7403 · 2025-01-16T14:11:46.000Z
Data is formatted as JSON in kp.json in the KP rules directory.
diff --git a/lkql_checker/share/lkql/kp/kp.json b/lkql_checker/share/lkql/kp/kp.json
@@ -0,0 +1,110 @@
+{
+    "impacts": {
+        "kp_19423": "22.*,23.*,24.*",
+        "kp_19341": "24.*",
+        "kp_19237": "23.*,24.1",
+        "kp_19447": "24.*",
+        "kp_19501": "7.1.*,7.2.*,7.3.*,7.4.*,17.*,18.*,19.*,20.*,21.*,22.*,23.*,24.*",
+        "kp_19142": "24.*",
+        "kp_19312": "24.*",
+        "kp_19529": "24.*",
+        "kp_19134": "23.*,24.*",
+        "kp_19279": "23.*,24.*",
+        "kp_19038": "24.1",
+        "kp_19159": "23.*,24.*",
+        "kp_19198": "19.1,19.2,19.3,19.4,19.5,19.6,19.7,19.8,20.*,21.*,22.*,23.*,24.1",
+        "kp_va03_035": "22.*",
+        "kp_u923_018": "21.*",
+        "kp_v329_046": "22.1",
+        "kp_18701": "23.*",
+        "kp_ua12_036": "21.*,22.*",
+        "kp_vb20_002": "22.*",
+        "kp_18637": "23.*",
+        "kp_u727_033": "7.4.*,17.*,18.*,19.*,20.*,21.*",
+        "kp_u812_034": "21.*",
+        "kp_w330_020": "20.*,21.*,22.*,23.1",
+        "kp_v907_005": "22.*",
+        "kp_v924_001": "22.*",
+        "kp_va06_034": "22.*",
+        "kp_ub15_001": "18.*,19.*,20.*,21.*",
+        "kp_18718": "23.*",
+        "kp_ub22_022": "19.*,20.*,21.*",
+        "kp_18614": "20.*,21.*,22.*,23.*",
+        "kp_v216_031": "21.*",
+        "kp_v120_015": "7.4.1,7.4.2,7.4.3,7.4.4,7.4.5,7.4.6,7.4.7,17.*",
+        "kp_v127_049": "21.*,22.1",
+        "kp_v302_021": "21.*,22.1",
+        "kp_u630_012": "21.*",
+        "kp_v719_024": "22.*",
+        "kp_18636": "22.*,23.*",
+        "kp_18801": "23.*",
+        "kp_u629_002": "21.*",
+        "kp_v505_020": "22.*",
+        "kp_v114_047": "18.*,19.*,20.*,21.*,22.1",
+        "kp_vb24_008": "23.1",
+        "kp_v616_018": "22.*",
+        "kp_uc22_009": "22.1",
+        "kp_u928_018": "22.*,23.1",
+        "kp_v206_001": "22.1",
+        "kp_va18_003": "21.*,22.*",
+        "kp_v214_016": "21.*,22.*,23.1",
+        "kp_v407_011": "20.*,21.*,22.1",
+        "kp_v624_025": "22.*",
+        "kp_v720_003": "22.*",
+        "kp_v708_029": "22.*",
+        "kp_u702_038": "21.*",
+        "kp_18926": "23.*,24.1",
+        "kp_v404_040": "19.1,19.2,19.3,19.4,19.5,19.6,20.1,20.2,21.1,21.2,21.3,21.4,22.1",
+        "kp_v712_039": "22.*",
+        "kp_u803_030": "21.*",
+        "kp_u701_015": "21.*,22.*",
+        "kp_q309_014": "7.1.*,7.2.*,7.3.*,7.4.*,17.*",
+        "kp_r517_023": "7.1.*,7.2.*,7.3.*,7.4.*,17.*,18.1,18.2",
+        "kp_qc02_001": "7.1.*,7.2.*,7.3.*,7.4.*,17.*,18.1,18.2",
+        "kp_r511_017": "7.1.*,7.2.*,7.3.*,7.4.*,17.*,18.*",
+        "kp_r410_028": "7.1.*,7.2.*,7.3.*",
+        "kp_r316_001": "18.*,19.1,19.2,19.3,19.4,20.1,20.2",
+        "kp_q609_033": "7.1.*,7.2.*,7.3.*,7.4.*",
+        "kp_p226_024": "7.1.*,7.2.*,7.3.*,7.4.1,7.4.2,7.4.3",
+        "kp_ob03_009": "19.*",
+        "kp_ta30_032": "20.1,20.2",
+        "kp_s724_042": "19.*,20.1",
+        "kp_s521_014": "19.*",
+        "kp_tb09_038": "20.1,20.2",
+        "kp_s114_015": "18.*,19.*",
+        "kp_s814_034": "17.*,18.*,19.*",
+        "kp_ta10_002": "21.*,22.*,23.1",
+        "kp_u310_012": "22.*",
+        "kp_s722_023": "7.1.*,7.2.*,7.3.*,7.4.*,17.*,18.1,18.2,19.1,19.2,19.3",
+        "kp_u225_018": "20.1,20.2,21.1,21.2,21.3",
+        "kp_t708_064": "20.1,20.2",
+        "kp_tc01_050": "19.1,19.2,19.3,19.4,20.1,20.2,21.1",
+        "kp_ta15_022": "18.1,18.2,18.3,19.1,19.2,19.3,19.4,19.5,19.6,20.1,20.2",
+        "kp_t602_028": "20.*",
+        "kp_u126_006": "20.1,20.2,21.1",
+        "kp_t528_043": "18.*,19.1,19.2,19.3,19.4,19.5,20.1,20.2",
+        "kp_s124_035": "7.1.*,7.2.*,7.3.*,7.4.*,17.*,18.*,19.*",
+        "kp_t420_033": "18.*,19.*,20.1",
+        "kp_tb23_035": "20.1,20.2",
+        "kp_t805_037": "20.1,20.2",
+        "kp_tb25_028": "20.*",
+        "kp_s621_051": "19.*",
+        "kp_u316_028": "20.1,20.2,21.1"
+    },
+    "gnat": [
+        "7.1",
+        "7.2",
+        "7.3",
+        "7.4",
+        "17",
+        "18",
+        "19",
+        "20",
+        "21",
+        "22",
+        "23",
+        "24",
+        "25",
+        "26"
+    ]
+}
diff --git a/lkql_checker/src/rule_commands.adb b/lkql_checker/src/rule_commands.adb
@@ -93,6 +93,7 @@ package body Rule_Commands is
    function Create_Rule_Command
      (Lkql_File_Path : String;
       Ctx            : L.Analysis_Context;
+      Impacts        : JSON_Value;
       Rc             : out Rule_Command) return Boolean
    is
       Root    : constant L.Lkql_Node :=
@@ -132,8 +133,6 @@ package body Rule_Commands is
          Remediation_Arg       : constant L.Arg :=
            Check_Annotation.P_Arg_With_Name
              (To_Unbounded_Text ("remediation"));
-         Impact_Arg            : constant L.Arg :=
-           Check_Annotation.P_Arg_With_Name (To_Unbounded_Text ("impact"));
          Target_Arg            : constant L.Arg :=
            Check_Annotation.P_Arg_With_Name (To_Unbounded_Text ("target"));
          Msg                   : Unbounded_Text_Type;
@@ -218,24 +217,25 @@ package body Rule_Commands is
          Get_Text (Category_Arg, To_Unbounded_Text ("Misc"), Category);
          Get_Text (Subcategory_Arg, To_Unbounded_Text (""), Subcategory);
 
-         if not Impact_Arg.Is_Null then
-            Check_String (Impact_Arg);
-
+         if Impacts /= JSON_Null then
             declare
-               Str : constant String :=
-                 To_String (Impact_Arg.P_Expr.As_String_Literal.Text);
+               Impact_Value : constant JSON_Value :=
+                 Impacts.Get (To_UTF8 (To_Lower (Name)));
             begin
-               Impact :=
-                 new Regexp'(Compile ("{" &
-                                      Str (Str'First + 1 .. Str'Last - 1) &
-                                      "}",
-                                      Glob => True, Case_Sensitive => False));
-
+               if Impact_Value /= JSON_Null then
+                  Impact :=
+                    new Regexp'
+                      (Compile
+                         ("{" & Impact_Value.Get & "}",
+                          Glob           => True,
+                          Case_Sensitive => False));
+               end if;
             exception
                when others =>
-                  raise Rule_Error with
-                    "invalid argument for @" &
-                    To_String (Check_Annotation.F_Name.Text);
+                  raise Rule_Error
+                    with
+                      "invalid impact entry for "
+                      & To_String (Check_Annotation.F_Name.Text);
             end;
          end if;
 
diff --git a/lkql_checker/src/rule_commands.ads b/lkql_checker/src/rule_commands.ads
@@ -7,10 +7,12 @@ with Ada.Containers.Vectors;
 
 with GNAT.Regexp;
 
-with Langkit_Support.Diagnostics; use Langkit_Support.Diagnostics;
+with GNATCOLL.JSON; use GNATCOLL.JSON;
+
+with Langkit_Support.Diagnostics;          use Langkit_Support.Diagnostics;
 with Langkit_Support.Generic_API.Analysis;
 use Langkit_Support.Generic_API.Analysis;
-with Langkit_Support.Text;        use Langkit_Support.Text;
+with Langkit_Support.Text;                 use Langkit_Support.Text;
 
 with Libadalang.Analysis;
 
@@ -122,6 +124,7 @@ package Rule_Commands is
    function Create_Rule_Command
      (Lkql_File_Path : String;
       Ctx            : L.Analysis_Context;
+      Impacts        : JSON_Value;
       Rc             : out Rule_Command) return Boolean;
    --  Create a Rule_Command value with the given name and arguments and
    --  store it in ``Rc``. Return ``True`` if this succeeded, ie. the file
diff --git a/lkql_checker/src/rules_factory.adb b/lkql_checker/src/rules_factory.adb
@@ -6,7 +6,9 @@
 with Ada.Environment_Variables;
 
 with GNAT.OS_Lib;
+with GNAT.Strings;
 
+with GNATCOLL.JSON;      use GNATCOLL.JSON;
 with GNATCOLL.Opt_Parse; use GNATCOLL.Opt_Parse;
 with GNATCOLL.Strings;   use GNATCOLL.Strings;
 with GNATCOLL.Utils;
@@ -20,17 +22,23 @@ package body Rules_Factory is
      (Dirs : Path_Array) return Virtual_File_Array;
    --  Return the absolute path of the directory containing the LKQL programs
 
+   function Get_Impacts (Rules_Dirs : Virtual_File_Array) return JSON_Value;
+   --  Return all KPs' impacts. Impacts are stored in a JSON file named
+   --  'kp.json'. This file should be located in one of the directories from
+   --  "Rules_Dirs".
+
    ---------------
    -- All_Rules --
    ---------------
 
    function All_Rules
-     (Ctx  : L.Analysis_Context;
-      Dirs : Path_Array := No_Paths) return Rule_Vector
+     (Ctx : L.Analysis_Context; Dirs : Path_Array := No_Paths)
+      return Rule_Vector
    is
       Rules_Dirs : constant Virtual_File_Array := Get_Rules_Directories (Dirs);
       Rules      : Rule_Vector := Rule_Vectors.Empty_Vector;
       Seen       : String_Sets.Set := String_Sets.Empty_Set;
+      Impacts    : constant JSON_Value := Get_Impacts (Rules_Dirs);
 
    begin
       --  We search (non recursively) for all .lkql files in the Rules_Dir.
@@ -45,13 +53,14 @@ package body Rules_Factory is
             begin
                for File of Dir.all loop
                   if File.File_Extension = +".lkql"
-                     and then not Seen.Contains (+File.Full_Name)
+                    and then not Seen.Contains (+File.Full_Name)
                   then
                      declare
                         Rc : Rule_Command;
 
-                        Has_Rule : constant Boolean := Create_Rule_Command
-                          (+File.Full_Name, Ctx, Rc);
+                        Has_Rule : constant Boolean :=
+                          Create_Rule_Command
+                            (+File.Full_Name, Ctx, Impacts, Rc);
                      begin
                         if Has_Rule then
                            Rules.Append (Rc);
@@ -73,8 +82,7 @@ package body Rules_Factory is
    -- Get_Rules_Directories --
    ---------------------------
 
-   function Get_Rules_Directories
-     (Dirs : Path_Array) return Virtual_File_Array
+   function Get_Rules_Directories (Dirs : Path_Array) return Virtual_File_Array
    is
       function Add_Rules_Path (Path : String) return Boolean;
 
@@ -94,10 +102,11 @@ package body Rules_Factory is
       end if;
 
       declare
-         Custom_Checkers_Dirs : Virtual_File_Array
-           (1 .. Integer (Dirs'Length) + Integer (Lkql_Rules_Paths.Length));
+         Custom_Checkers_Dirs :
+           Virtual_File_Array
+             (1 .. Integer (Dirs'Length) + Integer (Lkql_Rules_Paths.Length));
 
-         Index                : Positive := 1;
+         Index : Positive := 1;
       begin
          for Dir of Dirs loop
             Custom_Checkers_Dirs (Index) := Create (+To_String (Dir));
@@ -113,4 +122,27 @@ package body Rules_Factory is
       end;
    end Get_Rules_Directories;
 
+   -----------------
+   -- Get_Impacts --
+   -----------------
+
+   function Get_Impacts (Rules_Dirs : Virtual_File_Array) return JSON_Value is
+   begin
+      for Rules_Dir of Rules_Dirs loop
+         declare
+            JSON_Filename : constant Virtual_File := Rules_Dir / "kp.json";
+            File_Content  : GNAT.Strings.String_Access;
+            Result        : JSON_Value;
+         begin
+            if Is_Regular_File (JSON_Filename) then
+               File_Content := Read_File (JSON_Filename);
+               Result := Read (File_Content.all).Get ("impacts");
+               GNAT.Strings.Free (File_Content);
+               return Result;
+            end if;
+         end;
+      end loop;
+      return JSON_Null;
+   end Get_Impacts;
+
 end Rules_Factory;
