[SYCL][Graph] Verbose E2E error messages

[EwanC]

The current error output from Graph E2E tests isn't particularly informative on the data that caused an assert to fail verification. As asserts are done on the whole container, rather than individual values. This change verifies each value individually so that a more informative error message can be printed when the assert fails. This is helpful for debugging issues that appear in CI but are hard to reproduce locally.

[julianmi]

Thanks, @EwanC. I think this is very valuable.

[mfrancepillois]

LGTM

[EwanC]

Moved to upstream PR intel#11666

[github-actions]

⚠️ Python code formatter, darker found issues in your code. ⚠️

You can test this locally with the following command:

darker --check --diff -r 8fe166fb4431645b6c7a26f4d88c0564e8d1d427..d65e8d90dde36ea07f6f38863e18536880ed99f0 buildbot/configure.py sycl/test-e2e/lit.cfg.py sycl/test/lit.cfg.py

View the diff from darker here.

--- buildbot/configure.py	2023-10-25 18:36:13.000000 +0000
+++ buildbot/configure.py	2023-10-26 08:31:11.890049 +0000
@@ -50,11 +50,11 @@
     llvm_enable_doxygen = 'OFF'
     llvm_enable_sphinx = 'OFF'
     llvm_build_shared_libs = 'OFF'
     llvm_enable_lld = 'OFF'
     sycl_enabled_plugins = ["opencl"]
-    sycl_preview_lib = 'ON'
+    sycl_preview_lib = "ON"
 
     sycl_enable_xpti_tracing = 'ON'
     xpti_enable_werror = 'OFF'
 
     if sys.platform != "darwin":
@@ -142,11 +142,11 @@
 
     if args.enable_plugin:
         sycl_enabled_plugins += args.enable_plugin
 
     if args.disable_preview_lib:
-        sycl_preview_lib = 'OFF'
+        sycl_preview_lib = "OFF"
 
     install_dir = os.path.join(abs_obj_dir, "install")
 
     cmake_cmd = [
         "cmake",
@@ -253,20 +253,47 @@
     parser.add_argument("--docs", action='store_true', help="build Doxygen documentation")
     parser.add_argument("--werror", action='store_true', help="Treat warnings as errors")
     parser.add_argument("--shared-libs", action='store_true', help="Build shared libraries")
     parser.add_argument("--cmake-opt", action='append', help="Additional CMake option not configured via script parameters")
     parser.add_argument("--cmake-gen", default="Ninja", help="CMake generator")
-    parser.add_argument("--use-libcxx", action="store_true", help="build sycl runtime with libcxx")
-    parser.add_argument("--libcxx-include", metavar="LIBCXX_INCLUDE_PATH", help="libcxx include path")
-    parser.add_argument("--libcxx-library", metavar="LIBCXX_LIBRARY_PATH", help="libcxx library path")
-    parser.add_argument("--use-lld", action="store_true", help="Use LLD linker for build")
-    parser.add_argument("--llvm-external-projects", help="Add external projects to build. Add as comma seperated list.")
-    parser.add_argument("--ci-defaults", action="store_true", help="Enable default CI parameters")
-    parser.add_argument("--enable-plugin", action='append', help="Enable SYCL plugin")
-    parser.add_argument("--disable-preview-lib", action='store_true', help="Disable building of the SYCL runtime major release preview library")
-    parser.add_argument("--disable-fusion", action="store_true", help="Disable the kernel fusion JIT compiler")
-    parser.add_argument("--add_security_flags", type=str, choices=['none', 'default', 'sanitize'], default=None, help="Enables security flags for compile & link. Two values are supported: 'default' and 'sanitize'. 'Sanitize' option is an extension of 'default' set.")
+    parser.add_argument(
+        "--use-libcxx", action="store_true", help="build sycl runtime with libcxx"
+    )
+    parser.add_argument(
+        "--libcxx-include", metavar="LIBCXX_INCLUDE_PATH", help="libcxx include path"
+    )
+    parser.add_argument(
+        "--libcxx-library", metavar="LIBCXX_LIBRARY_PATH", help="libcxx library path"
+    )
+    parser.add_argument(
+        "--use-lld", action="store_true", help="Use LLD linker for build"
+    )
+    parser.add_argument(
+        "--llvm-external-projects",
+        help="Add external projects to build. Add as comma seperated list.",
+    )
+    parser.add_argument(
+        "--ci-defaults", action="store_true", help="Enable default CI parameters"
+    )
+    parser.add_argument("--enable-plugin", action="append", help="Enable SYCL plugin")
+    parser.add_argument(
+        "--disable-preview-lib",
+        action="store_true",
+        help="Disable building of the SYCL runtime major release preview library",
+    )
+    parser.add_argument(
+        "--disable-fusion",
+        action="store_true",
+        help="Disable the kernel fusion JIT compiler",
+    )
+    parser.add_argument(
+        "--add_security_flags",
+        type=str,
+        choices=["none", "default", "sanitize"],
+        default=None,
+        help="Enables security flags for compile & link. Two values are supported: 'default' and 'sanitize'. 'Sanitize' option is an extension of 'default' set.",
+    )
     args = parser.parse_args()
 
     print("args:{}".format(args))
 
     return do_configure(args)
--- sycl/test/lit.cfg.py	2023-10-25 16:32:20.000000 +0000
+++ sycl/test/lit.cfg.py	2023-10-26 08:31:12.008161 +0000
@@ -59,11 +59,11 @@
            lit_config.note("\tUnset "+var)
            llvm_config.with_environment(var,"")
 
 # If major release preview library is enabled we can enable the feature.
 if config.sycl_preview_lib_enabled == "ON":
-    config.available_features.add('preview-breaking-changes-supported')
+    config.available_features.add("preview-breaking-changes-supported")
 
 # Configure LD_LIBRARY_PATH or corresponding os-specific alternatives
 # Add 'libcxx' feature to filter out all SYCL abi tests when SYCL runtime
 # is built with llvm libcxx. This feature is added for Linux only since MSVC
 # CL compiler doesn't support to use llvm libcxx instead of MSVC STL.
--- sycl/test-e2e/lit.cfg.py	2023-10-25 16:32:20.000000 +0000
+++ sycl/test-e2e/lit.cfg.py	2023-10-26 08:31:12.290110 +0000
@@ -164,21 +164,25 @@
     config.substitutions.append( ('%level_zero_options', level_zero_options) )
 else:
     config.substitutions.append( ('%level_zero_options', '') )
 
 # Check for sycl-preview library
-check_preview_breaking_changes_file='preview_breaking_changes_link.cpp'
-with open(check_preview_breaking_changes_file, 'w') as fp:
-    fp.write('#include <sycl/sycl.hpp>')
-    fp.write('namespace sycl { inline namespace _V1 { namespace detail {')
-    fp.write('extern void PreviewMajorReleaseMarker();')
-    fp.write('}}}')
-    fp.write('int main() { sycl::detail::PreviewMajorReleaseMarker(); return 0; }')
-
-sp = subprocess.getstatusoutput(config.dpcpp_compiler+' -fsycl -fpreview-breaking-changes ' + check_preview_breaking_changes_file)
+check_preview_breaking_changes_file = "preview_breaking_changes_link.cpp"
+with open(check_preview_breaking_changes_file, "w") as fp:
+    fp.write("#include <sycl/sycl.hpp>")
+    fp.write("namespace sycl { inline namespace _V1 { namespace detail {")
+    fp.write("extern void PreviewMajorReleaseMarker();")
+    fp.write("}}}")
+    fp.write("int main() { sycl::detail::PreviewMajorReleaseMarker(); return 0; }")
+
+sp = subprocess.getstatusoutput(
+    config.dpcpp_compiler
+    + " -fsycl -fpreview-breaking-changes "
+    + check_preview_breaking_changes_file
+)
 if sp[0] == 0:
-    config.available_features.add('preview-breaking-changes-supported')
+    config.available_features.add("preview-breaking-changes-supported")
 
 # Check for CUDA SDK
 check_cuda_file='cuda_include.cpp'
 with open(check_cuda_file, 'w') as fp:
     fp.write('#include <cuda.h>\n')