Merge branch 'mr/pmderodat/special_filenames' into 'master'

compiler_wrappers-gcc.adb: fix handling of special filenames

Closes #175

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

Fixes https://gitlab.adacore-it.com/eng/das/cov/gnatcoverage/-/issues/175

Author: pmderodat

testsuite/tests/instr-cov/c_special_filenames/bar.c

@@ -0,0 +1,8 @@
+int
+bar (int a, int b, int c)
+{
+  if (a)
+    return b;
+  else
+    return c;
+}

testsuite/tests/instr-cov/c_special_filenames/$foo@bar$.c renamed to testsuite/tests/instr-cov/c_special_filenames/foo.c

@@ -1,8 +1,9 @@
 extern int foo (int i);
+extern int bar (int a, int b, int c);
 
 int
 main (void)
 {
-  int result = foo (0);
+  int result = foo (0) + bar (1, 0, 2);
   return result;
 }

testsuite/tests/instr-cov/c_special_filenames/main.c

@@ -3,32 +3,56 @@
 characters produces valid instrumented sources.
 """
 
+import os.path
+
+from e3.fs import cp
+
 from SCOV.minicheck import build_run_and_coverage, check_xcov_reports
+from SUITE.control import env
 from SUITE.context import thistest
 from SUITE.cutils import Wdir
 from SUITE.tutils import gprfor
 from SUITE.gprutils import GPRswitches
 
 
-tmp = Wdir('tmp_')
+tmp = Wdir("tmp_")
+
+# Copy the sources in the temporary directory. Note that we cannot test the
+# case of a filename containing a double quote or a backslash on Windows
+# because of filename restrictions on that platform.
+copy_map = {
+    "ada_main.adb": "ada_main.adb",
+    "bar.c": "src bar.c" if env.build.os.name == "windows" else 'src\\"bar.c',
+    "foo.c": "src foo$@.c",
+    "main.c": "main.c",
+}
+for src, dest in copy_map.items():
+    cp(os.path.join("..", src), dest)
+
+# Compute the expected coverage report from the actual source filenames. Note
+# that in xcov filenames, "gnatcov coverage" first turns '\' to '/' (during
+# path separator canonicalization) and then the unique filename machinery turns
+# '/' to '-'.
+coverage_data = {
+    "ada_main.adb": {"+": {7, 9}},
+    "bar.c": {"+": {4, 5}, "-": {7}},
+    "foo.c": {"+": {4}},
+    "main.c": {"+": {7, 8}},
+}
+expected_report = {
+    "{}.xcov".format(copy_map[filename].replace("\\", "-")): report
+    for filename, report in coverage_data.items()
+}
 
 build_run_and_coverage(
     gprsw=GPRswitches(
-        root_project=gprfor(srcdirs=['..'], mains=['main.c', 'ada_main.adb'])
+        root_project=gprfor(srcdirs=["."], mains=["main.c", "ada_main.adb"])
     ),
-    covlevel='stmt',
-    mains=['main', 'ada_main'],
-    extra_coverage_args=['-axcov', '--output-dir=xcov'],
-    trace_mode='src',
-)
-check_xcov_reports(
-    '*.xcov',
-    {
-        'main.c.xcov': {'+': {6}},
-        '$foo@bar$.c.xcov': {'+': {4}},
-        'ada_main.adb.xcov': {'+': {9}},
-    },
-    'xcov',
+    covlevel="stmt",
+    mains=["main", "ada_main"],
+    extra_coverage_args=["-axcov", "--output-dir=xcov"],
+    trace_mode="src",
 )
+check_xcov_reports("*.xcov", expected_report, "xcov")
 
 thistest.result()

testsuite/tests/instr-cov/c_special_filenames/test.py

@@ -0,0 +1,5 @@
+int
+bar (int c)
+{
+  return c + 1;
+}

testsuite/tests/integrated_instrumentation/special_filenames/bar.c

@@ -0,0 +1,8 @@
+int
+foo (int a, int b)
+{
+  if (a)
+    return a;
+  else
+    return b;
+}

testsuite/tests/integrated_instrumentation/special_filenames/foo.c

@@ -0,0 +1,10 @@
+extern int foo (int a, int b);
+extern int bar (int c);
+
+int
+main (void)
+{
+  foo (0, 1);
+  bar (0);
+  return 0;
+}

testsuite/tests/integrated_instrumentation/special_filenames/test.c

@@ -0,0 +1,66 @@
+"""
+Check that the integration instrumentation handles correctly filenames that
+contain spaces.
+"""
+
+import os
+import os.path
+
+from e3.fs import cp
+
+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_")
+
+# Copy the sources in the temporary directory. Note that we cannot test the
+# case of a filename containing a double quote or a backslash on Windows
+# because of filename restrictions on that platform.
+copy_map = {
+    "bar.c": 'src bar.c' if env.build.os.name == "windows" else 'src\\"bar.c',
+    "foo.c": "src foo$@.c",
+    "test.c": "test.c",
+}
+for src, dest in copy_map.items():
+    cp(os.path.join("..", src), dest)
+
+# Compute the expected coverage report from the actual source filenames. Note
+# that in xcov filenames, "gnatcov coverage" first turns '\' to '/' (during
+# path separator canonicalization) and then the unique filename machinery turns
+# '/' to '-'.
+coverage_data = {
+    "test.c": {"+": {7, 8, 9}},
+    "foo.c": {"+": {4, 7}, "-": {5}},
+    "bar.c": {"+": {4}},
+}
+expected_report = {
+    "{}.xcov".format(copy_map[filename].replace("\\", "-")): report
+    for filename, report in coverage_data.items()
+}
+
+# Setup the instrumentation process
+sources = [os.path.abspath(filename) for filename in copy_map.values()]
+files = [f"--files={filename}" for filename in sources]
+xcov(
+    ["setup-integration", "--level=stmt", "--compilers=gcc", "--output-dir=."]
+    + files
+)
+
+# Shadow the compiler driver with the generated wrapper
+env.add_search_path(env_var="PATH", path=os.getcwd())
+
+# Build the test program and run it
+cmdrun(["gcc", "-o", "test program"] + sources, for_pgm=False)
+cmdrun(["test program"], for_pgm=False)
+
+# Check coverage expectations
+sid_args = [f"--sid={filename}.sid" for filename in sources]
+xcov(
+    ["coverage", "-cstmt", "-axcov", srctracename_for("test")]
+    + sid_args
+)
+check_xcov_reports("*.xcov", expected_report)
+
+thistest.result()