Merge branch 'eyraud/166' into 'master'

Normalize path names passed to the --files switch

Closes #166

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

Fixes eng/das/cov/gnatcoverage#166

Author: Jugst3r

doc/gnatcov/integrated_instr.rst

@@ -147,7 +147,7 @@ directory:
 
 .. code-block:: sh
 
-   cmake .. -CMAKE_CXX_COMPILER=<my_project>/build/g++
+   cmake .. -DCMAKE_CXX_COMPILER=<my_project>/build/g++
 
 The default generator for CMake is "Unix Makefiles", so we can then run the
 build process with ``make``, and our executable which will produce a source trace

testsuite/tests/integrated_instrumentation/basic_cmake/CMakeLists.txt

@@ -0,0 +1,4 @@
+project(HelloWorld)
+cmake_minimum_required(VERSION 3.0)
+
+add_executable(hello_world main.c)

testsuite/tests/integrated_instrumentation/basic_cmake/main.c

@@ -0,0 +1,8 @@
+#include <stdio.h>
+
+int
+main()
+{
+  printf("Hello world!\n");
+  return 0;
+}

testsuite/tests/integrated_instrumentation/basic_cmake/test.py

@@ -0,0 +1,51 @@
+"""
+Regression test: gnatcov used to leave paths passed to the --files switch
+un-normalized, which resulted in some units of interest being ignored at
+instrumentation time.
+"""
+
+import os
+import os.path
+
+from SUITE.control import env
+from SUITE.cutils import Wdir
+from SCOV.minicheck import check_xcov_reports
+from SUITE.tutils import cmdrun, srctracename_for, thistest, xcov
+
+Wdir("tmp_")
+
+cwd = os.getcwd()
+
+# Setup the instrumentation process
+xcov(
+    [
+        "setup-integration",
+        f"--files={os.path.join(cwd, '..', 'main.c')}",
+        "--compilers=gcc",
+    ]
+)
+
+# Shadow the compiler driver with the generated wrapper
+env.add_search_path(env_var="PATH", path=cwd)
+
+# Then, run the build process unchanged
+compiler_wrapper = os.path.join(cwd, 'gcc')
+cmdrun(["cmake", "..", f"-DCMAKE_C_COMPILER={compiler_wrapper}"], for_pgm=False)
+cmdrun(["make"], for_pgm=False)
+
+# Run the executable
+cmdrun(["hello_world"], for_pgm=False)
+
+# Check coverage expectations
+xcov(
+    [
+        "coverage",
+        "--level=stmt",
+        "--sid=main.c.sid",
+        "-axcov",
+        srctracename_for("main"),
+    ]
+)
+check_xcov_reports("*.xcov", {"main.c.xcov": {"+": {6, 7}}})
+
+thistest.result()

tools/gnatcov/gnatcov_bits_specific.adb

@@ -29,6 +29,8 @@ with GNAT.OS_Lib;
 with GNAT.Regexp;
 with GNAT.Strings; use GNAT.Strings;
 
+with GNATCOLL.VFS;
+
 with System.Multiprocessors;
 
 with Snames;
@@ -112,7 +114,7 @@ procedure GNATcov_Bits_Specific is
    Compiler_Drivers     : Inputs.Inputs_Type;
    Source_Rebase_Inputs : Inputs.Inputs_Type;
    Source_Search_Inputs : Inputs.Inputs_Type;
-   Subprograms_Inputs    : Inputs.Inputs_Type;
+   Subprograms_Inputs   : Inputs.Inputs_Type;
    Text_Start           : Pc_Type := 0;
    Output               : String_Access := null;
    Tag                  : String_Access := null;
@@ -566,7 +568,16 @@ procedure GNATcov_Bits_Specific is
       Copy_Arg_List (Opt_Ignore_Source_Files, Ignored_Source_Files);
       Copy_Arg_List (Opt_Files, Files_Of_Interest);
       Copy_Arg_List (Opt_Compiler_Wrappers, Compiler_Drivers);
-      Switches.Files_Of_Interest := To_String_Set (Files_Of_Interest);
+
+      for File of Files_Of_Interest loop
+         declare
+            use GNATCOLL.VFS;
+            F : constant Virtual_File := Create (+File.Name.all);
+         begin
+            F.Normalize_Path;
+            Switches.Files_Of_Interest.Include (+(+Full_Name (F)));
+         end;
+      end loop;
 
       --  Compute the languages for which we want coverage analysis, or enable
       --  just the default ones.

tools/gnatcov/inputs.ads

@@ -39,7 +39,17 @@ package Inputs is
    --  May raise Name_Error or Status_Error if the corresponding text file
    --  cannot be opened.
 
-   type Inputs_Type is private;
+   type Inputs_Entry is record
+      Name, Qualifier : String_Access;
+   end record;
+
+   function Equal (L, R : Inputs_Entry) return Boolean;
+
+   package Input_Lists is new Ada.Containers.Doubly_Linked_Lists
+     (Element_Type => Inputs_Entry,
+      "="          => Equal);
+
+   type Inputs_Type is new Input_Lists.List with null record;
    --  Input lists. Can be used to accumulate the arguments given on
    --  a command line.
 
@@ -68,7 +78,8 @@ package Inputs is
    --  Go through the input list and call Process on each entry (qualifiers are
    --  ignored in the first variant).
 
-   function Length (Inputs : Inputs_Type) return Ada.Containers.Count_Type;
+   function Length (Inputs : Inputs_Type) return Ada.Containers.Count_Type
+     with Inline;
    --  Return the number of elements in Inputs
 
    procedure Log_File_Open (File_Name : String);
@@ -104,20 +115,4 @@ package Inputs is
       Case_Insensitive : Boolean := False);
    --  Overload to work on Inputs.Inputs_Type values
 
-private
-
-   type Inputs_Entry is record
-      Name, Qualifier : String_Access;
-   end record;
-
-   function Equal (L, R : Inputs_Entry) return Boolean;
-
-   package Input_Lists is new Ada.Containers.Doubly_Linked_Lists
-     (Element_Type => Inputs_Entry,
-      "="          => Equal);
-
-   type Inputs_Type is new Input_Lists.List with null record;
-
-   pragma Inline (Length);
-
 end Inputs;

tools/gnatcov/instrument-clean_objdirs.adb

@@ -20,6 +20,7 @@ with Ada.Directories;       use Ada.Directories;
 
 with GNATCOLL.Projects; use GNATCOLL.Projects;
 
+with Command_Line;      use Command_Line;
 with Instrument.Common; use Instrument.Common;
 with Project;
 
@@ -62,9 +63,11 @@ begin
    --  through extended projects, as their object directories can interfere
    --  with the build of the extending project.
 
-   Project.Iterate_Projects
-     (Root_Project     => Project.Project.Root_Project,
-      Process          => Clean_Subdir'Access,
-      Recursive        => True,
-      Include_Extended => True);
+   if not Args.Bool_Args (Opt_Save_Temps) then
+      Project.Iterate_Projects
+        (Root_Project     => Project.Project.Root_Project,
+         Process          => Clean_Subdir'Access,
+         Recursive        => True,
+         Include_Extended => True);
+   end if;
 end Instrument.Clean_Objdirs;