Reject --subprograms arguments that designate no known subprogram

Author: pmderodat

testsuite/tests/subp_of_interest/test.py

@@ -35,6 +35,9 @@ def check_xcov(label, args, expected_output=""):
 
 tmp = Wdir("tmp_")
 
+pkg_spec = os.path.join("..", "src", "pkg.ads")
+pkg_body = os.path.join("..", "src", "pkg.adb")
+
 thistest.log("== Checkpoint creation ==")
 cov_args = build_and_run(
     gprsw=GPRswitches(
@@ -55,12 +58,9 @@ def check_xcov(label, args, expected_output=""):
     + [
         "--save-checkpoint",
         "trace.ckpt",
-        "--subprograms",
-        f"{os.path.join('..', 'src', 'pkg.ads')}:4",
-        "--subprograms",
-        f"{os.path.join('..', 'src', 'pkg.adb')}:10",
-        "--subprograms",
-        f"{os.path.join('..', 'src', 'pkg.adb')}:12",
+        f"--subprograms={pkg_spec}:4",
+        f"--subprograms={pkg_body}:10",
+        f"--subprograms={pkg_body}:12",
     ],
     expected_output=(
         ""
@@ -115,9 +115,7 @@ def check_xcov(label, args, expected_output=""):
     # Case 2: line number is not a number
     thistest.log("== Bad line number ==")
     xcov(
-        cov_args + [
-            "--subprograms", f"{os.path.join('..', 'src', 'pkg.ads')}:b",
-        ],
+        cov_args + ["--subprograms", f"{pkg_spec}:b"],
         out="xcov-wrong2.txt",
         register_failure=False,
     )
@@ -138,7 +136,23 @@ def check_xcov(label, args, expected_output=""):
         what="unexpected coverage output",
         regexp=(
             r".*Error when parsing --subprograms argument dumb-file-name:4:"
-            r".*dumb-file-name does not exist"
+            r" unknown source file"
+        ),
+        actual=contents_of("xcov-wrong3.txt"),
+    )
+
+    # Case 4: scope does not exist
+    thistest.log("== No such scope ==")
+    xcov(
+        cov_args + [f"--subprograms={pkg_body}:14"],
+        out="xcov-wrong3.txt",
+        register_failure=False,
+    )
+    thistest.fail_if_no_match(
+        what="unexpected coverage output",
+        regexp=(
+            f".*Error when parsing --subprograms argument {pkg_body}:14:"
+            " unknown subprogram"
         ),
         actual=contents_of("xcov-wrong3.txt"),
     )

tools/gnatcov/gnatcov_bits_specific.adb

@@ -87,6 +87,7 @@ with Traces_Files;          use Traces_Files;
 with Traces_Files_Registry; use Traces_Files_Registry;
 with Traces_Names;          use Traces_Names;
 with Traces_Source;
+with Types;                 use Types;
 with Version;
 
 procedure GNATcov_Bits_Specific is
@@ -374,20 +375,30 @@ procedure GNATcov_Bits_Specific is
            Subp_Input (Subp_Input'First .. Column_Index - 1);
          Column       : String renames
            Subp_Input (Column_Index + 1 .. Subp_Input'Last);
+
+         Identifier : Scope_Entity_Identifier;
       begin
          if Column_Index = 0 then
             raise Constraint_Error;
          end if;
-         if not Exists (Filename) then
+         Identifier.Decl_SFI :=
+           Get_Index_From_Full_Name
+             (Full_Name => Full_Name (Filename),
+              Kind      => Source_File,
+              Insert    => False);
+         if Identifier.Decl_SFI = No_Source_File then
+            Outputs.Fatal_Error
+              ("Error when parsing --subprograms argument "
+               & Subp_Input & ": unknown source file");
+         end if;
+         Identifier.Decl_Line := Natural'Value (Column);
+
+         if not Available_Subps_Of_Interest.Contains (Identifier) then
             Outputs.Fatal_Error
               ("Error when parsing --subprograms argument "
-               &  Subp_Input & ": file " & Filename & " does not exist");
+               & Subp_Input & ": unknown subprogram");
          end if;
-         Subps_Of_Interest.Include
-           (Scope_Entity_Identifier'
-              (Decl_SFI  =>
-                 Get_Index_From_Full_Name (Full_Name (Filename), Source_File),
-               Decl_Line => Natural'Value (Column)));
+         Subps_Of_Interest.Include (Identifier);
       exception
          --  Deal gracefully with parsing errors
 

tools/gnatcov/sc_obligations.adb

@@ -1236,6 +1236,11 @@ package body SC_Obligations is
             Remap_SCO_Id (Scope_Ent.From);
             Remap_SCO_Id (Scope_Ent.To);
             Remap_SFI (Relocs, Scope_Ent.Identifier.Decl_SFI);
+
+            --  Register each scope identifiers to make them available to users
+            --  on the command line.
+
+            Available_Subps_Of_Interest.Include (Scope_Ent.Identifier);
          end loop;
 
       end if;

tools/gnatcov/sc_obligations.ads

@@ -214,6 +214,11 @@ package SC_Obligations is
      (Element_Type => Scope_Entity_Identifier);
    subtype Scope_Id_Set is Scope_Id_Sets.Set;
 
+   Available_Subps_Of_Interest : SC_Obligations.Scope_Id_Set;
+   --  Set of subprograms of interest known so far. This is used to validate
+   --  that entries added to Switches.Subp_Of_Interest do exist, i.e. raise
+   --  errors when a requested subprogram of interest is unknown.
+
    package Scope_Entities_Trees is new Ada.Containers.Multiway_Trees
      (Element_Type => Scope_Entity);
    subtype Scope_Entities_Tree is Scope_Entities_Trees.Tree;

tools/gnatcov/switches.ads

@@ -134,7 +134,7 @@ package Switches is
    --  instead of hashes.
 
    Subps_Of_Interest : SC_Obligations.Scope_Id_Set;
-   --  List of subprograms of interest
+   --  List of subprograms of interest requested by users on the command line
 
    type Separated_Source_Coverage_Type is (None, Routines, Instances);
    Separated_Source_Coverage : Separated_Source_Coverage_Type := None;