instrument-projects.adb: show progress for coverage instrumentation

Author: pmderodat

testsuite/SCOV/instr.py

@@ -38,8 +38,8 @@ def default_dump_channel():
         return 'base64-stdout'
 
 
-def xcov_instrument(gprsw, covlevel, extra_args=[], dump_trigger="auto",
-                    dump_channel="auto", gpr_obj_dir=None,
+def xcov_instrument(gprsw, covlevel, quiet=True, extra_args=[],
+                    dump_trigger="auto", dump_channel="auto", gpr_obj_dir=None,
                     runtime_project=None, out=None, err=None,
                     tolerate_messages=None, register_failure=True,
                     auto_config_args=True, auto_target_args=True,
@@ -50,6 +50,7 @@ def xcov_instrument(gprsw, covlevel, extra_args=[], dump_trigger="auto",
     :param GPRswitches gprsw: Project file command line switches to honor.
     :param None|str covlevel: Coverage level for the instrumentation
         (--level argument). Not passed if None.
+    :param bool quiet: Whether to pass the "--quiet" flag.
     :param list[str] extra_args: Extra arguments to append to the command line.
     :param None|str dump_trigger: If None, do not pass the --dump-trigger
         argument. If "auto", pass the result of default_dump_trigger().
@@ -97,6 +98,8 @@ def xcov_instrument(gprsw, covlevel, extra_args=[], dump_trigger="auto",
         mains = [main.strip(' "') for main in mains]
 
     args = ['instrument'] + covlevel_args
+    if quiet:
+        args.append("--quiet")
 
     if dump_trigger:
         if dump_trigger == "auto":

testsuite/SCOV/minicheck.py

@@ -26,16 +26,16 @@
 
 COV_RE = re.compile(r'^ *(\d+) (.):.*$')
 
-def build_and_run(gprsw, covlevel, mains, extra_coverage_args, scos=None,
-                  gpr_obj_dir=None, gpr_exe_dir=None, ignored_source_files=[],
-                  separate_coverage=None, extra_args=[], extra_run_args=None,
-                  extra_instr_args=None, extra_gprbuild_args=[],
-                  extra_gprbuild_cargs=[], extra_gprbuild_largs=[],
-                  absolute_paths=False, dump_trigger="auto",
-                  dump_channel="auto", check_gprbuild_output=False,
-                  trace_mode=None, runtime_project=None,
-                  gprsw_for_coverage=None, scos_for_run=True,
-                  register_failure=True, program_env=None,
+def build_and_run(gprsw, covlevel, mains, extra_coverage_args, quiet=True,
+                  scos=None, gpr_obj_dir=None, gpr_exe_dir=None,
+                  ignored_source_files=[], separate_coverage=None,
+                  extra_args=[], extra_run_args=None, extra_instr_args=None,
+                  extra_gprbuild_args=[], extra_gprbuild_cargs=[],
+                  extra_gprbuild_largs=[], absolute_paths=False,
+                  dump_trigger="auto", dump_channel="auto",
+                  check_gprbuild_output=False, trace_mode=None,
+                  runtime_project=None, gprsw_for_coverage=None,
+                  scos_for_run=True, register_failure=True, program_env=None,
                   tolerate_instrument_messages=None, exec_args=None,
                   auto_languages=True, manual_prj_name=None):
     """
@@ -56,6 +56,7 @@ def build_and_run(gprsw, covlevel, mains, extra_coverage_args, scos=None,
         "gnatcov coverage" command-line returned. This is just for convenience:
         one can pass an empty list here and manually append extra arguments to
         the result.
+    :param bool quiet: Whether to pass "--quiet" to "gnatcov.
     :param None|list[str] scos: Optional list of SCOs files (ALI or SID) must
         be passed to gnatcov. These files must have no extension (for instance:
         'obj/foo' instead of 'obj/foo.ali'. If absent, we pass "-P" to "gnatcov
@@ -170,6 +171,8 @@ def gprbuild_wrapper(root_project):
          for pattern in ignored_source_files])
     if separate_coverage:
         cov_or_instr_args.extend(['-S', separate_coverage])
+    if quiet:
+        cov_or_instr_args.append("--quiet")
 
     # Compute arguments to specify units of interest.
     if trace_mode == 'bin':
@@ -213,14 +216,20 @@ def gprbuild_wrapper(root_project):
 
         # Instrument the project and build the result
         extra_instr_args = cov_or_instr_args + list(extra_instr_args or [])
-        xcov_instrument(gprsw, covlevel, extra_args=extra_instr_args,
-                        gpr_obj_dir=gpr_obj_dir, dump_trigger=dump_trigger,
-                        dump_channel=dump_channel,
-                        runtime_project=runtime_project,
-                        out='instrument.log',
-                        register_failure=register_failure,
-                        tolerate_messages=tolerate_instrument_messages,
-                        auto_languages=auto_languages)
+        xcov_instrument(
+            gprsw,
+            covlevel,
+            quiet=False,
+            extra_args=extra_instr_args,
+            gpr_obj_dir=gpr_obj_dir,
+            dump_trigger=dump_trigger,
+            dump_channel=dump_channel,
+            runtime_project=runtime_project,
+            out='instrument.log',
+            register_failure=register_failure,
+            tolerate_messages=tolerate_instrument_messages,
+            auto_languages=auto_languages,
+        )
         gprbuild_wrapper(gprsw.root_project)
 
         # Retrieve the dump_channel that "gnatcov instrument" actually used,

testsuite/tests/129-instr-progress/c_unit.c

@@ -0,0 +1,10 @@
+#include <stdio.h>
+
+extern void cpp_func (void);
+
+void
+c_func (void)
+{
+  puts ("c:c_func");
+  cpp_func ();
+}

testsuite/tests/129-instr-progress/cpp_unit.cpp

@@ -0,0 +1,11 @@
+#include <iostream>
+
+extern "C" {
+  extern void cpp_func (void);
+}
+
+void
+cpp_func (void)
+{
+  std::cout << "cpp:cpp_func" << std::endl;
+}

testsuite/tests/129-instr-progress/main.adb

@@ -0,0 +1,9 @@
+with Ada.Text_IO; use Ada.Text_IO;
+
+procedure Main is
+   procedure C_Func;
+   pragma Import (C, C_Func, "c_func");
+begin
+   Put_Line ("Ada:main");
+   C_Func;
+end Main;

testsuite/tests/129-instr-progress/test.opt

@@ -0,0 +1 @@
+!C++ DEAD Testcase uses a Ada/C/C++ mixed project

testsuite/tests/129-instr-progress/test.py

@@ -0,0 +1,66 @@
+"""
+Check that "gnatcov instrument" correctly reports progress about the
+instrumented units.
+"""
+
+import os
+import os.path
+
+from SCOV.minicheck import build_run_and_coverage, check_xcov_reports
+from SUITE.context import thistest
+from SUITE.cutils import Wdir, lines_of
+from SUITE.tutils import gprfor
+from SUITE.gprutils import GPRswitches
+
+
+tmp = Wdir("tmp_")
+
+# Avoid "creating output path" info messages
+os.mkdir("obj")
+
+build_run_and_coverage(
+    gprsw=GPRswitches(
+        root_project=gprfor(
+            langs=["Ada", "C", "C++"],
+            mains=["main.adb"],
+            srcdirs=[".."],
+        )
+    ),
+    covlevel="stmt",
+    mains=["main"],
+    extra_coverage_args=["-axcov", "--output-dir=xcov"],
+    quiet=False,
+    trace_mode="src",
+)
+
+# Sanity check: the insrument-build-coverage process completed with the
+# expected results.
+check_xcov_reports(
+    "*xcov",
+    {
+        "main.adb.xcov": {"+": {7, 8}},
+        "c_unit.c.xcov": {"+": {8}},
+        "cpp_unit.cpp.xcov": {"+": {10}},
+    },
+    cwd="xcov",
+)
+
+# Units are not instrumented in a particular order: we only want to check that
+# all of them are listed with the expected formatting.
+output = lines_of("instrument.log")
+thistest.fail_if_not_equal(
+    "First line of 'gnatcov instrument' output",
+    "".join(output[:1]),
+    "Coverage instrumentation",
+)
+thistest.fail_if_not_equal(
+    "'gnatcov instrument' output",
+    "\n".join([
+        "   [Ada]           main",
+        "   [C++]           cpp_unit.cpp",
+        "   [C]             c_unit.c",
+    ]),
+    "\n".join(sorted(output[1:])),
+)
+
+thistest.result()

testsuite/tests/TC11-052-internal-error/test.py

@@ -17,7 +17,7 @@ def check(args, trigger, info):
     out = f"{trigger}.log"
     env = dict(os.environ)
     env["GNATCOV_INTERNAL_ERROR_TRIGGER"] = trigger
-    p = xcov(args, out=out, env=env, register_failure=False)
+    p = xcov(args + ["-q"], out=out, env=env, register_failure=False)
     thistest.fail_if(
         p.status == 0,
         "gnatcov returned success exit code, error expected"

tools/gnatcov/instrument-projects.adb

@@ -28,6 +28,7 @@ with Ada.Strings;
 with Ada.Strings.Fixed;
 with Ada.Strings.Unbounded;   use Ada.Strings.Unbounded;
 with Ada.Strings.Unbounded.Hash;
+with Ada.Text_IO;             use Ada.Text_IO;
 with Ada.Unchecked_Deallocation;
 
 with GNAT.Exception_Actions;
@@ -266,6 +267,10 @@ is
    --  Clean the instrumentation directories and print any relevant information
    --  regarding the instrumentation context.
 
+   procedure Show_Progress (Language : Some_Language; Unit_Name : String);
+   --  If quiet mode is not enabled, show instrumentation progress by printing
+   --  the language/unit name that are being instrumented.
+
    -----------------------
    -- Load_From_Project --
    -----------------------
@@ -987,6 +992,37 @@ is
       Outputs.Print_Internal_Error (Exc);
    end Clean_And_Print;
 
+   -------------------
+   -- Show_Progress --
+   -------------------
+
+   procedure Show_Progress (Language : Some_Language; Unit_Name : String) is
+   begin
+      if Quiet then
+         return;
+      end if;
+
+      declare
+         Language_Name        : constant String :=
+           "[" & Image (Language)  & "]";
+         Filename_Indentation : constant String :=
+           (1 .. 16 - Language_Name'Length => ' ');
+      begin
+         Put ("   ");
+         Put (Language_Name);
+         Put (Filename_Indentation);
+
+         --  To keep progress logs readable, use source basenames for
+         --  file-based languages.
+
+         if Language_Kind (Language) = File_Based_Language then
+            Put_Line (Ada.Directories.Simple_Name (Unit_Name));
+         else
+            Put_Line (Unit_Name);
+         end if;
+      end;
+   end Show_Progress;
+
    Mains_To_Instrument : array (Src_Supported_Language)
      of Main_To_Instrument_Vectors.Vector;
    --  For each supported language, list of mains to instrument. Note that
@@ -1203,6 +1239,10 @@ begin
       Sources_Of_Interest_File.Close;
    end;
 
+   if not Quiet then
+      Put_Line ("Coverage instrumentation");
+   end if;
+
    --  Instrument every unit of interest asynchronously
 
    declare
@@ -1255,6 +1295,8 @@ begin
 
             Unit_Args.Append (+Unit_Name);
 
+            Show_Progress (LU_Info.Language, Unit_Name);
+
             --  According to the set parallelism level, instrument in
             --  the same process (thus reusing the libadalang context, which
             --  is a big gain of time), or spawn another instrumentation