Merge branch 'pmderodat/ignore_file_scopes' into 'master'

SC_Obligations: fix loading of scopes for ignored source files

Closes #149

See merge request eng/das/cov/gnatcoverage!325

This fixes an assertion failure: when remapping source files from the
scopes loaded from a SID/checkpoint, scopes whose identifier references
ignored source files will lose their identifier. Such scopes will
remain, but users will not be able to mark them of interest.

Note that, even though this is not a regression compared to the state of things currently in the `master` branch, this leaves things in an unsatisfying state: consolidation of scopes during SID/checkpoint loading will not necessarily restore identifiers that `--ignore-source-files` has affected previously. Future work on `--subprograms` and/or scope in reports should address this.

Fixes eng/das/cov/gnatcoverage#149

Author: pmderodat

testsuite/tests/subp_of_interest/src/pkg.adb

@@ -1,15 +1,34 @@
 with Ada.Text_IO; use Ada.Text_IO;
 
 package body Pkg is
+
+   ---------
+   -- Foo --
+   ---------
+
    procedure Foo (I : Integer) is
    begin
       Put_Line ("Hello from Foo!");
    end Foo;
 
+   ---------
+   -- Bar --
+   ---------
+
    procedure Bar is
       procedure Nested_Bar_1 is null;
+      procedure Nested_Bar_2;
+
       Dummy_Decl : Boolean;
-      procedure Nested_Bar_2 is null;
+
+      ------------------
+      -- Nested_Bar_2 --
+      ------------------
+
+      procedure Nested_Bar_2 is
+      begin
+         Put_Line ("Hello from Nested_Bar_2!");
+      end Nested_Bar_2;
    begin
       Nested_Bar_1;
       Nested_Bar_2;

testsuite/tests/subp_of_interest/src/pkg.ads

@@ -3,4 +3,6 @@ pragma Ada_2012;
 package Pkg is
    procedure Foo (I : Integer) with Pre => I > 0;
    procedure Bar;
+
+   I : Integer;
 end Pkg;

testsuite/tests/subp_of_interest/test.py

@@ -53,15 +53,16 @@ def check_xcov(label, args, expected_output=""):
 # that the coverage report contains only coverage data for the specified
 # subprograms for source traces. For binary traces, simply check that the
 # gnatcov coverage invocation yields the expected warning.
+ckpt_filename = "trace.ckpt"
 check_xcov(
     "xcov_subp",
     cov_args
     + [
         "--save-checkpoint",
-        "trace.ckpt",
+        ckpt_filename,
         f"--subprograms={pkg_spec}:4",
-        f"--subprograms={pkg_body}:10",
-        f"--subprograms={pkg_body}:12",
+        f"--subprograms={pkg_body}:19",
+        f"--subprograms={pkg_body}:20",
     ],
     expected_output=(
         ""
@@ -70,12 +71,14 @@ def check_xcov(label, args, expected_output=""):
         " with binary traces."
     ),
 )
+cov_ckpt_args = cov_args[:-1] + ["--checkpoint", ckpt_filename]
 if src_traces:
     check_xcov_reports(
         "*.xcov",
         {
             "main.adb.xcov": {},
-            "pkg.adb.xcov": {"+": {6, 10, 12}},
+            "pkg.ads.xcov": {},
+            "pkg.adb.xcov": {"+": {11, 19, 30}},
         },
         "xcov_subp",
     )
@@ -84,20 +87,37 @@ def check_xcov(label, args, expected_output=""):
     # specific subprogram. To do this, produce a new coverage report from the
     # checkpoint without using the --subprograms switch.
     thistest.log("== xcov_no_subp ==")
-    check_xcov(
-        "xcov_no_subp",
-        cov_args[:-1]
-        + ["--checkpoint", "trace.ckpt"],
-    )
+    check_xcov("xcov_no_subp", cov_ckpt_args)
     check_xcov_reports(
         "*.xcov",
         {
             "main.adb.xcov": {"-": {5, 6}},
-            "pkg.adb.xcov": {"+": {6, 10, 12}, "-": {11, 14, 15, 16}},
+            "pkg.ads.xcov": {"-": {7}},
+            "pkg.adb.xcov": {"+": {11, 19, 30}, "-": {22, 33, 34, 35}},
         },
         "xcov_no_subp",
     )
 
+    # Check that we can still select subprograms of interest declared in the
+    # package body, when the package specification is ignored through
+    # --ignored-source-files.
+    thistest.log("== xcov_ignore ==")
+    check_xcov(
+        "xcov_ignore",
+        cov_args + [
+            f"--subprograms={pkg_body}:20",
+            "--ignore-source-files=pkg.ads",
+        ],
+    )
+    check_xcov_reports(
+        "*.xcov",
+        {
+            "main.adb.xcov": {},
+            "pkg.adb.xcov": {"+": {30}},
+        },
+        "xcov_ignore",
+    )
+
     # Also check the warnings when the subprogram switch is ill-formed
 
     # Case 1: missing colon in the argument

tools/gnatcov/annotations.adb

@@ -426,7 +426,7 @@ package body Annotations is
                for SCO of LI.SCOs.all loop
                   Traverse_SCO (ST, SCO);
                end loop;
-               if not Is_Active (ST, Subps_Of_Interest) then
+               if not In_Scope_Of_Interest (ST) then
                   return;
                end if;
             end if;

tools/gnatcov/coverage-source.adb

@@ -2003,7 +2003,7 @@ package body Coverage.Source is
       is
       begin
          Traverse_SCO (ST, SCO);
-         if Is_Active (ST, Subps_Of_Interest) then
+         if In_Scope_Of_Interest (ST) then
             Update_SCI (SCO, Tag, Process);
          end if;
       end Update_SCI_Wrapper;