Upgrade self-contained-headers test suite

Author: AlexeySachkov

sycl/test/format.py

@@ -5,26 +5,55 @@
 import os
 import re
 
-SUFFIXES = {".hpp"}
-
-
 class SYCLHeadersTest(lit.formats.TestFormat):
     def getTestsForPath(
         self, testSuite, path_in_suite, filepath, litConfig, localConfig
     ):
+        # path_in_suite is a tuple like:
+        #   ('self-contained-headers', 'path/to', 'file.hpp')
+        test_path = testSuite.getSourcePath(path_in_suite) + ".cpp"
+        if os.path.exists(test_path):
+            # We have a dedicated special test for a header, let's use a file
+            # from the suite itself
+
+            # None is a special value we use to distinguish those two cases
+            filepath = None
+        else:
+            # We don't have a dedicated special test for a header, therefore we
+            # fallback to a generalized version of it
+
+            # SYCL headers may depend on some generated files and therefore we
+            # use headers from the build folder for testing
+            filepath = os.path.join(localConfig.sycl_include, *path_in_suite[1:])
+
         yield lit.Test.Test(testSuite, path_in_suite, localConfig, file_path=filepath)
 
     def getTestsInDirectory(self, testSuite, path_in_suite, litConfig, localConfig):
-        # We traverse build/sycl/include/sycl directory
-        source_path = os.path.join(localConfig.sycl_include, "sycl")
+        # To respect SYCL_LIB_DUMPS_ONLY mode
+        if ".cpp" not in localConfig.suffixes:
+            return
+
+        # As we add more files and folders into 'self-contained-headers', this
+        # method will be recursivelly called for them by lit discovery.
+        # However, we don't use the test folder as the source of tests but
+        # instead we use SYCL_SOURCE_DIR/include/sycl directory.
+        # Therefore, we exit early from here if `path_in_suite` conatins more
+        # than one element
+        assert path_in_suite[0] == "self-contained-headers"
+        if len(path_in_suite) > 1:
+            return
+
+        source_path = os.path.join(localConfig.sycl_include_source_dir, "sycl")
 
         # Optional filter can be passed through command line options
         headers_filter = localConfig.sycl_headers_filter
         for dirpath, _, filenames in os.walk(source_path):
-            relative_dirpath = dirpath[len(localConfig.sycl_include) + 1 :]
+            relative_dirpath = dirpath[len(localConfig.sycl_include_source_dir) + 1 :]
             for filename in filenames:
                 suffix = os.path.splitext(filename)[1]
-                if suffix not in SUFFIXES or suffix not in litConfig.suffixes:
+                # We only look at actual header files and not at their .inc/.def
+                # components
+                if suffix != ".hpp":
                     continue
                 filepath = os.path.join(dirpath, filename)
 
@@ -46,6 +75,17 @@ def getTestsInDirectory(self, testSuite, path_in_suite, litConfig, localConfig):
                     yield t
 
     def execute(self, test, litConfig):
+        if test.file_path is None:
+            # It means that we have a special test case for a header and we need
+            # to execute it as a regular lit sh test
+            return lit.TestRunner.executeShTest(
+                    test, litConfig,
+                    False, # execute_external
+                    [], # extra_substitutions
+                    [], # preamble_commands
+                )
+
+        # Otherwise we generate the test on the fly
         command = [
             test.config.clang,
             "-fsycl",

sycl/test/lit.site.cfg.py.in

@@ -9,6 +9,7 @@ config.sycl_tools_dir = lit_config.params.get('SYCL_TOOLS_DIR', "@LLVM_TOOLS_DIR
 config.sycl_include = lit_config.params.get('SYCL_INCLUDE', "@SYCL_INCLUDE@")
 config.sycl_obj_root = "@SYCL_BINARY_DIR@"
 config.sycl_source_dir = "@SYCL_SOURCE_DIR@/source"
+config.sycl_include_source_dir = "@SYCL_SOURCE_DIR@/include"
 config.sycl_libs_dir = lit_config.params.get('SYCL_LIBS_DIR', "@LLVM_LIBS_DIR@")
 config.target_triple = "@LLVM_TARGET_TRIPLE@"
 config.host_triple = "@LLVM_HOST_TRIPLE@"