Merge branch 'eyraud/test_256' into 'master'

Adapt the testsuite to work with AAMP

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

The testsuite needs some adaptation fixes to work with the AAMP target.
Notably, add the support to execute a main through the facade simulator.

For eng/das/cov/gnatcoverage#256

Author: Jugst3r

testsuite/SCOV/instr.py

@@ -6,7 +6,8 @@
 from e3.fs import mkdir
 
 from SUITE.context import thistest
-from SUITE.cutils import contents_of, ext, indent
+from SUITE.control import env
+from SUITE.cutils import contents_of, copy_to_dir, ext, indent
 from SUITE.tutils import RUNTIME_INFO, GNATCOV_INFO, locate_gpr_file, xcov
 
 
@@ -356,3 +357,23 @@ def available_ada_dump_triggers():
         return ["main-end", "ravenscar-task-termination"]
     else:
         return ["main-end"]
+
+
+def maybe_relocate_binaries(object_dir, exe_dir, mains):
+    """
+    Relocate binaries produced in the object_dir to the exe_dir for the AAMP
+    target.
+
+    :param object_dir: object directory of the main project.
+    :param exe_dir: executable directory of the main project.
+    :param mains: main filenames.
+    """
+    # The GNAAMP linker disregards the full name passed to the -o switch but
+    # only picks the simple name. Thus, the executable ends up in the object
+    # directory.
+    #
+    # Copy it to the executable directory so that the rest of the testsuite
+    # can assume executables are always there.
+    if "aamp" in env.target.platform:
+        for main in mains:
+            copy_to_dir(object_dir, exe_dir, main)

testsuite/SCOV/internals/driver.py

@@ -32,6 +32,7 @@
     add_dumper_lch_hook,
     default_dump_channel,
     default_dump_trigger,
+    maybe_relocate_binaries,
     xcov_convert_base64,
     xcov_instrument,
 )
@@ -625,12 +626,13 @@ def run(self):
         this_depth = thistest.depth + 1 if self.covctl else thistest.depth
 
         self.gpr_obj_dir = "obj"
+        self.gpr_exe_dir = self.abdir(attribute=True)
         self.gpr = gprfor(
             mains=self.drivers,
             prjid="gen",
             objdir=self.gpr_obj_dir,
             srcdirs=["../" * n + "src" for n in range(1, this_depth)],
-            exedir=self.abdir(attribute=True),
+            exedir=self.gpr_exe_dir,
             main_cargs="-fno-inline",
             deps=self.covctl.deps if self.covctl else [],
             extra=self.covctl.gpr() if self.covctl else "",
@@ -1533,6 +1535,9 @@ def mode_build(self):
             extracargs=self.extracargs,
             gargs=self.common_build_gargs() + ["--src-subdirs=gnatcov-instr"],
         )
+        maybe_relocate_binaries(
+            self.gpr_obj_dir, self.gpr_exe_dir, [exename_for(self.main())]
+        )
 
     def mode_execute(self, main):
         register_failure = not self.testcase.expect_failures

testsuite/SCOV/minicheck.py

@@ -17,11 +17,13 @@
 
 from SCOV.instr import (
     default_dump_channel,
+    maybe_relocate_binaries,
     xcov_convert_base64,
     xcov_instrument,
 )
 from SUITE.cutils import contents_of, indent
 from SUITE.tutils import (
+    exename_for,
     exepath_to,
     gprbuild,
     run_cov_program,
@@ -353,6 +355,8 @@ def gprbuild_wrapper(root_project):
         # multiple traces in the current directory.
         for m in mains:
             rm(srctrace_pattern_for(m, is_manual, manual_prj_name))
+            # Callback to run for each instrumented main
+            maybe_relocate_binaries(gpr_obj_dir, gpr_exe_dir, [exename_for(m)])
 
         patterns = set()
         trace_files = []

testsuite/SUITE/control.py

@@ -257,7 +257,13 @@ def __init__(self, runtime_name=None):
         self.has_exception_propagation = True
         self.discrs = []
 
-        if not self.runtime_name:
+        # Set specific scenario variables to always pass to any project loading
+        # command (gnatcov <command> -P or gprbuild / gprinstall)
+        self.gpr_scenario_vars = []
+
+        if "aamp" in self.runtime_name:
+            self.gpr_scenario_vars = ["-XLIBRARY_SUPPORT=no"]
+        elif not self.runtime_name:
             self.has_full_runtime = True
             self.discrs = ["RTS_FULL"]
         elif "embedded" in self.runtime_name:
@@ -349,6 +355,8 @@ def __init__(self, exeext, partiallinks, to_platform_specific_symbol=None):
     ),
     # x86_64-windows targets
     "x86_64.*mingw": TargetInfo(exeext=".exe", partiallinks=False),
+    # AAMP target
+    "aamp": TargetInfo(exeext=".axe", partiallinks=False),
     # default
     ".": TargetInfo(exeext="", partiallinks=False),
 }

testsuite/SUITE/cutils.py

@@ -11,7 +11,7 @@
 import sys
 import tempfile
 
-from e3.fs import mkdir
+from e3.fs import cp, mkdir
 from e3.os.fs import cd, which
 from e3.os.process import Run
 
@@ -309,3 +309,14 @@ def multi_range(*args, minus=None):
 class Identifier:
     def __init__(self, name):
         self.name = name
+
+
+def copy_to_dir(orig_dir, target_dir, filename):
+    """
+    Copy filename from orig_dir to target_dir.
+    """
+    if os.path.abspath(orig_dir) != os.path.abspath(target_dir):
+        cp(
+            os.path.join(orig_dir, filename),
+            os.path.join(target_dir, filename),
+        )

testsuite/SUITE/tutils.py

@@ -40,6 +40,7 @@
 from SUITE.cutils import (
     FatalError,
     contents_of,
+    list_to_file,
     text_to_file,
     to_list,
     unhandled_exception_in,
@@ -264,11 +265,9 @@ def gpr_common_args(project, auto_config_args=True):
     """
     gproptions = []
 
-    gproptions.append(
-        # verbose mode for verifiability in qualif mode.
-        # quiet mode for performance (less io) otherwise.
-        "-v" if thistest.options.qualif_level else "-q",
-    )
+    # If running in qualif mode, run with the verbose switch  for verifiability
+    if thistest.options.qualif_level:
+        gproptions.append("-v")
     if auto_config_args:
         gproptions.append(
             "--config={}".format(os.path.join(ROOT_DIR, BUILDER.SUITE_CGPR))
@@ -290,7 +289,8 @@ def gpr_common_args(project, auto_config_args=True):
     ):
         gproptions.append("-XLOADER=RAM")
 
-    return gproptions
+    # Add runtime specific scenario variables
+    return gproptions + RUNTIME_INFO.gpr_scenario_vars
 
 
 def gprbuild(
@@ -729,26 +729,28 @@ def xcov_suite_args(
         or any(arg.startswith("-P") for arg in covargs)
     )
 
+    result = (
+        gpr_common_args(project=None, auto_config_args=auto_config_args)
+        if project_handling_enabled
+        else []
+    )
+
     # If --config is asked and project handling is involved, pass it and stop
     # there. If there is a board, it must be described in the project file
     # (gnatcov's -P argument).
     if auto_config_args and project_handling_enabled:
-        return [
-            "--config={}".format(os.path.join(ROOT_DIR, BUILDER.SUITE_CGPR))
-        ]
+        return result
 
-    # Nothing to do if the caller does not want automatic --target/--RTS
+    # Nothing to add if the caller does not want automatic --target/--RTS
     # arguments.
     if not auto_target_args:
-        return []
+        return result
 
     # Otherwise, handle target and board information.
     #
     # Remember that the testsuite determines the target from the machine that
     # hosts the testsuite and from its own --host/--build/--target arguments...
-
-    result = []
-
+    #
     # If we have a specific target board specified with --board, use that:
     #
     #   --target=p55-elf --board=iSystem-5554
@@ -1015,6 +1017,37 @@ def run_cov_program(
     exec_args = exec_args or []
     inp = None
     use_pycross = False
+    if thistest.options.target:
+        # If we are testing for AAMP, use the facade simulator. It expects a
+        # configuration file (facade.cfg) in the executable dir, and the
+        # executable must be run through an executable.sod file, which sets
+        # up the simulator environment. This .sod file should be in the same
+        # directory as the executable.
+        if "aamp" in control.env.target.platform:
+            args.append("dosfsod.exe")
+            list_to_file(
+                [
+                    "sw tx on",
+                    '$TEXTIO = ""',
+                    "switch batch on",
+                    "fill 0000..ffff 0",
+                    "load " + executable,
+                    "go",
+                    "halt",
+                ],
+                "test.sod",
+            )
+            args.append("@test.sod")
+            cp(os.path.join(ROOT_DIR, "facade.cfg"), "facade.cfg")
+            args.extend(exec_args)
+            out = cmdrun(
+                args,
+                out=out,
+                env=env,
+                register_failure=register_failure,
+                for_pgm=True,
+            )
+            return out
 
     # If we are in a cross configuration, run the program using run-cross2
     if thistest.options.target and thistest.env.target.platform != "c":

testsuite/facade.cfg

@@ -0,0 +1,30 @@
+[FACADE]                 ## *MUST* be first line of file
+                         ## switches must begin in column 1
+                         ## no spaces allowed before the "="
+                         ## see config.h for valid switches and types
+
+[T5]                     ## test equipment section
+BASE_ADDR= 0000          #  T5 base address (hex)
+DHC_BASE_ADDR= 00000     #  deep history card base address (hex)
+BUS_TIMEOUT=  10         #  milliseconds (decimal)
+XFR_TIMEOUT=  10         #  milliseconds (decimal)
+CONS_TIMEOUT= 10         #  milliseconds (decimal)
+T5_RESET_HOLD= 8         #  target clock ticks (decimal)
+#TARGET_RESET_HOLD= 40   #  target clock ticks (decimal)
+#POD_FREQ_SELECT= 20     #  pod freq select for AAMP5vr1 pods
+                         #    target freq must be in one of following ranges:
+                         #     15-30 MHz (default)
+                         #     30-50 MHz
+                         #      5-15 MHz
+
+[DBG]                    ## debug engine section
+SHOW_PC= 1               # Update the PC in the console window
+
+[GUI]                    ## GUI section
+SCREEN_BUFSIZE= 500      # number of lines saved in console window (250-2500)
+MAX_SRC_WIN= 1           # specifies the maximum number of source windows
+                         # open at any given time (must be 1, 2, or 3)
+TITLE=v3.5               # String to use in the Title bar after Facade
+#TMPPATH=C:/TMP       # specifies the directory for scratch files
+                         #   (history and memory buffers)
+                         # default: working directory specified at installation

testsuite/tests/U211-014-setup/test.py

@@ -218,7 +218,7 @@ def check_full(
 )
 p = gprbuild(
     mixed_prj.project_file,
-    gargs=["--src-subdirs=gnatcov-instr"],
+    gargs=["--src-subdirs=gnatcov-instr", "-q"],
     trace_mode="src",
     runtime_project=rt_prj,
     out=log_file,

testsuite/tests/ext_annotations/gen/buf_dump/c_only/test.py

@@ -57,6 +57,7 @@
     mains=["main"],
     extra_instr_args=[f"--external-annotations={annotations}"],
     extra_coverage_args=["-axcov"],
+    extra_gprbuild_args=["-q"],
     dump_trigger="manual",
     manual_prj_name="main",
     tolerate_instrument_messages=instr_warning,

testsuite/tests/ext_annotations/gen/buf_dump/cpp_only/test.py

@@ -57,6 +57,7 @@
     mains=["main"],
     extra_instr_args=[f"--external-annotations={annotations}"],
     extra_coverage_args=["-axcov"],
+    extra_gprbuild_args=["-q"],
     dump_trigger="manual",
     manual_prj_name="main",
     tolerate_instrument_messages=instr_warning,

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

@@ -24,6 +24,7 @@
     extra_coverage_args=["-axcov", "--output-dir=xcov"],
     gpr_obj_dir=obj_dir,
     gpr_exe_dir=obj_dir,
+    extra_gprbuild_args=["-q"],
     extra_gprbuild_cargs=["-gnatwae"],
     check_gprbuild_output=True,
     trace_mode="src",

testsuite/tests/instr-cov/manual-dump/c_only/test.py

@@ -45,6 +45,7 @@
     covlevel="stmt",
     mains=["main"],
     extra_coverage_args=["-axcov"],
+    extra_gprbuild_args=["-q"],
     dump_trigger="manual",
     manual_prj_name="main",
     tolerate_instrument_messages=instr_warning,

testsuite/tests/instr-cov/manual-dump/cpp_only/test.py

@@ -45,6 +45,7 @@
     covlevel="stmt",
     mains=["main"],
     extra_coverage_args=["-axcov"],
+    extra_gprbuild_args=["-q"],
     dump_trigger="manual",
     manual_prj_name="main",
     tolerate_instrument_messages=instr_warning,