Skip to content

Conversation

DeinAlptraum
Copy link
Contributor

As discussed in PR #142353, the current testsuite of the clang Python bindings has several issues:

  • It libclang.so cannot be loaded into python to run the testsuite, the whole ninja check-all aborts.
  • The result of running the testsuite isn't report like the lit-based tests, rendering them almost invisible.
  • The testsuite is disabled in a non-obvious way (RUN_PYTHON_TESTS) in tests/CMakeLists.txt, which again doesn't show up in the test results.

All these issues can be avoided by integrating the Python bindings tests with lit, which is what this patch does:

  • The actual test lives in clang/test/bindings/python/bindings.sh and is run by lit.
  • The current clang/bindings/python/tests directory (minus the now-subperfluous CMakeLists.txt) is moved into the same directory.
  • The check if libclang is loadable (originally from PR [clang][python][test] Check if libclang.so is loadable #142353) is now handled via a new lit feature, libclang-loadable.
  • The various ways to disable the tests have been turned into XFAILs as appropriate. This isn't complete and not completely tested yet.

Tested on sparc-sun-solaris2.11, sparcv9-sun-solaris2.11, i386-pc-solaris2.11, amd64-pc-solaris2.11, i686-pc-linux-gnu, and x86_64-pc-linux-gnu.

As discussed in PR llvm#142353, the current testsuite of the `clang` Python
bindings has several issues:

- It `libclang.so` cannot be loaded into `python` to run the testsuite, the
  whole `ninja check-all` aborts.
- The result of running the testsuite isn't report like the `lit`-based
  tests, rendering them almost invisible.
- The testsuite is disabled in a non-obvious way (`RUN_PYTHON_TESTS`) in
  `tests/CMakeLists.txt`, which again doesn't show up in the test results.

All these issues can be avoided by integrating the Python bindings tests
with `lit`, which is what this patch does:

- The actual test lives in `clang/test/bindings/python/bindings.sh` and is
  run by `lit`.
- The current `clang/bindings/python/tests` directory (minus the
  now-subperfluous `CMakeLists.txt`) is moved into the same directory.
- The check if `libclang` is loadable (originally from PR llvm#142353) is now
  handled via a new `lit` feature, `libclang-loadable`.
- The various ways to disable the tests have been turned into `XFAIL`s as
  appropriate.  This isn't complete and not completely tested yet.

Tested on `sparc-sun-solaris2.11`, `sparcv9-sun-solaris2.11`,
`i386-pc-solaris2.11`, `amd64-pc-solaris2.11`, `i686-pc-linux-gnu`, and
`x86_64-pc-linux-gnu`.
@llvmbot llvmbot added clang Clang issues not falling into any other category clang:as-a-library libclang and C++ API github:workflow labels Jul 3, 2025
@llvmbot
Copy link
Member

llvmbot commented Jul 3, 2025

@llvm/pr-subscribers-github-workflow

@llvm/pr-subscribers-clang

Author: Jannick Kremer (DeinAlptraum)

Changes

As discussed in PR #142353, the current testsuite of the clang Python bindings has several issues:

  • It libclang.so cannot be loaded into python to run the testsuite, the whole ninja check-all aborts.
  • The result of running the testsuite isn't report like the lit-based tests, rendering them almost invisible.
  • The testsuite is disabled in a non-obvious way (RUN_PYTHON_TESTS) in tests/CMakeLists.txt, which again doesn't show up in the test results.

All these issues can be avoided by integrating the Python bindings tests with lit, which is what this patch does:

  • The actual test lives in clang/test/bindings/python/bindings.sh and is run by lit.
  • The current clang/bindings/python/tests directory (minus the now-subperfluous CMakeLists.txt) is moved into the same directory.
  • The check if libclang is loadable (originally from PR #142353) is now handled via a new lit feature, libclang-loadable.
  • The various ways to disable the tests have been turned into XFAILs as appropriate. This isn't complete and not completely tested yet.

Tested on sparc-sun-solaris2.11, sparcv9-sun-solaris2.11, i386-pc-solaris2.11, amd64-pc-solaris2.11, i686-pc-linux-gnu, and x86_64-pc-linux-gnu.


Full diff: https://github.com/llvm/llvm-project/pull/146844.diff

40 Files Affected:

  • (modified) .github/workflows/libclang-python-tests.yml (+2-2)
  • (modified) clang/CMakeLists.txt (-1)
  • (removed) clang/bindings/python/tests/CMakeLists.txt (-66)
  • (modified) clang/test/CMakeLists.txt (+11)
  • (added) clang/test/bindings/python/bindings.sh (+32)
  • (added) clang/test/bindings/python/lit.local.cfg (+41)
  • (renamed) clang/test/bindings/python/tests/init.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/INPUTS/a.inc ()
  • (renamed) clang/test/bindings/python/tests/cindex/INPUTS/b.inc ()
  • (renamed) clang/test/bindings/python/tests/cindex/INPUTS/compile_commands.json ()
  • (renamed) clang/test/bindings/python/tests/cindex/INPUTS/header1.h ()
  • (renamed) clang/test/bindings/python/tests/cindex/INPUTS/header2.h ()
  • (renamed) clang/test/bindings/python/tests/cindex/INPUTS/header3.h ()
  • (renamed) clang/test/bindings/python/tests/cindex/INPUTS/hello.cpp ()
  • (renamed) clang/test/bindings/python/tests/cindex/INPUTS/include.cpp ()
  • (renamed) clang/test/bindings/python/tests/cindex/INPUTS/parse_arguments.c ()
  • (renamed) clang/test/bindings/python/tests/cindex/INPUTS/testfile.c ()
  • (renamed) clang/test/bindings/python/tests/cindex/init.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_access_specifiers.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_cdb.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_code_completion.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_comment.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_cursor.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_cursor_kind.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_diagnostics.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_enums.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_exception_specification_kind.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_file.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_index.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_lib.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_linkage.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_location.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_rewrite.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_source_range.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_tls_kind.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_token_kind.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_tokens.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_translation_unit.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/test_type.py ()
  • (renamed) clang/test/bindings/python/tests/cindex/util.py ()
diff --git a/.github/workflows/libclang-python-tests.yml b/.github/workflows/libclang-python-tests.yml
index 50ef4acf2feb1..43b50cec61716 100644
--- a/.github/workflows/libclang-python-tests.yml
+++ b/.github/workflows/libclang-python-tests.yml
@@ -10,15 +10,15 @@ on:
       - 'main'
     paths:
       - 'clang/bindings/python/**'
+      - 'clang/test/bindings/python/**'
       - 'clang/tools/libclang/**'
-      - 'clang/CMakeList.txt'
       - '.github/workflows/libclang-python-tests.yml'
       - '.github/workflows/llvm-project-tests.yml'
   pull_request:
     paths:
       - 'clang/bindings/python/**'
+      - 'clang/test/bindings/python/**'
       - 'clang/tools/libclang/**'
-      - 'clang/CMakeList.txt'
       - '.github/workflows/libclang-python-tests.yml'
       - '.github/workflows/llvm-project-tests.yml'
 
diff --git a/clang/CMakeLists.txt b/clang/CMakeLists.txt
index 94607a8e8473c..72386132bce9f 100644
--- a/clang/CMakeLists.txt
+++ b/clang/CMakeLists.txt
@@ -530,7 +530,6 @@ if( CLANG_INCLUDE_TESTS )
     clang_unit_site_config=${CMAKE_CURRENT_BINARY_DIR}/test/Unit/lit.site.cfg
   )
   add_subdirectory(test)
-  add_subdirectory(bindings/python/tests)
 
   if(CLANG_BUILT_STANDALONE)
     umbrella_lit_testsuite_end(check-all)
diff --git a/clang/bindings/python/tests/CMakeLists.txt b/clang/bindings/python/tests/CMakeLists.txt
deleted file mode 100644
index a0ddabc21bb41..0000000000000
--- a/clang/bindings/python/tests/CMakeLists.txt
+++ /dev/null
@@ -1,66 +0,0 @@
-# Test target to run Python test suite from main build.
-
-# Avoid configurations including '-include' from interfering with
-# our tests by setting CLANG_NO_DEFAULT_CONFIG.
-add_custom_target(check-clang-python
-    COMMAND ${CMAKE_COMMAND} -E env
-            CLANG_NO_DEFAULT_CONFIG=1
-            CLANG_LIBRARY_PATH=$<TARGET_FILE_DIR:libclang>
-            "${Python3_EXECUTABLE}" -m unittest discover
-    DEPENDS libclang
-    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/..)
-
-set(RUN_PYTHON_TESTS TRUE)
-set_target_properties(check-clang-python PROPERTIES FOLDER "Clang/Tests")
-
-# Tests require libclang.so which is only built with LLVM_ENABLE_PIC=ON
-if(NOT LLVM_ENABLE_PIC)
-  set(RUN_PYTHON_TESTS FALSE)
-endif()
-
-# Do not try to run if libclang was built with sanitizers because
-# the sanitizer library will likely be loaded too late to perform
-# interception and will then fail.
-# We could use LD_PRELOAD/DYLD_INSERT_LIBRARIES but this isn't
-# portable so its easier just to not run the tests when building
-# with ASan.
-if(NOT LLVM_USE_SANITIZER STREQUAL "")
-  set(RUN_PYTHON_TESTS FALSE)
-endif()
-
-# Tests fail on Windows, and need someone knowledgeable to fix.
-# It's not clear whether it's a test or a valid binding problem.
-if(WIN32)
-  set(RUN_PYTHON_TESTS FALSE)
-endif()
-
-# The Python FFI interface is broken on AIX: https://bugs.python.org/issue38628.
-if(${CMAKE_SYSTEM_NAME} MATCHES "AIX")
-  set(RUN_PYTHON_TESTS FALSE)
-endif()
-
-# AArch64, Hexagon, and Sparc have known test failures that need to be
-# addressed.
-# SystemZ has broken Python/FFI interface:
-# https://reviews.llvm.org/D52840#1265716
-if(${LLVM_NATIVE_ARCH} MATCHES "^(AArch64|Hexagon|Sparc|SystemZ)$")
-  set(RUN_PYTHON_TESTS FALSE)
-endif()
-
-# Tests will fail if cross-compiling for a different target, as tests will try
-# to use the host Python3_EXECUTABLE and make FFI calls to functions in target
-# libraries.
-if(CMAKE_CROSSCOMPILING)
-  # FIXME: Consider a solution that allows better control over these tests in
-  # a crosscompiling scenario. e.g. registering them with lit to allow them to
-  # be explicitly skipped via appropriate LIT_ARGS, or adding a mechanism to
-  # allow specifying a python interpreter compiled for the target that could
-  # be executed using qemu-user.
-  message(WARNING "check-clang-python not added to check-all as these tests fail in a cross-build setup")
-  set(RUN_PYTHON_TESTS FALSE)
-endif()
-
-if(RUN_PYTHON_TESTS)
-    set_property(GLOBAL APPEND PROPERTY
-                 LLVM_ALL_ADDITIONAL_TEST_TARGETS check-clang-python)
-endif()
diff --git a/clang/test/CMakeLists.txt b/clang/test/CMakeLists.txt
index e5b4a3bb84645..a9b88d4f4d9ec 100644
--- a/clang/test/CMakeLists.txt
+++ b/clang/test/CMakeLists.txt
@@ -205,6 +205,17 @@ add_custom_target(clang-test)
 add_dependencies(clang-test check-clang)
 set_target_properties(clang-test PROPERTIES FOLDER "Clang/Tests")
 
+# Allow running Clang Python binding tests separately from CI.
+add_lit_testsuite(check-clang-python "Running the Clang Python tests"
+  ${CMAKE_CURRENT_BINARY_DIR}
+  #LIT ${LLVM_LIT}
+  PARAMS ${CLANG_TEST_PARAMS}
+  DEPENDS ${CLANG_TEST_DEPS}
+  ARGS ${CLANG_TEST_EXTRA_ARGS} --filter=bindings.sh
+  # Avoid running tests twice.
+  EXCLUDE_FROM_CHECK_ALL
+  )
+
 # FIXME: This logic can be removed once all buildbots have moved
 # debuginfo-test from clang/test to llvm/projects or monorepo.
 if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/debuginfo-tests)
diff --git a/clang/test/bindings/python/bindings.sh b/clang/test/bindings/python/bindings.sh
new file mode 100755
index 0000000000000..9cc4815dda699
--- /dev/null
+++ b/clang/test/bindings/python/bindings.sh
@@ -0,0 +1,32 @@
+#!/bin/sh
+
+# UNSUPPORTED: !libclang-loadable
+
+# Tests fail on Windows, and need someone knowledgeable to fix.
+# It's not clear whether it's a test or a valid binding problem.
+# XFAIL: target={{.*windows.*}}
+
+# The Python FFI interface is broken on AIX: https://bugs.python.org/issue38628.
+# XFAIL: target={{.*-aix.*}}
+
+# Hexagon has known test failures that need to be addressed.
+# https://reviews.llvm.org/D52840#1265716
+# XFAIL: target={{hexagon-.*}}
+# python SEGVs on Linux/sparc64 when loading libclang.so.  Seems to be an FFI
+# issue, too.
+# XFAIL: target={{sparc.*-.*-linux.*}}
+
+# Tests will fail if cross-compiling for a different target, as tests will try
+# to use the host Python3_EXECUTABLE and make FFI calls to functions in target
+# libraries.
+#
+# FIXME: Consider a solution that allows better control over these tests in
+# a crosscompiling scenario. e.g. registering them with lit to allow them to
+# be explicitly skipped via appropriate LIT_ARGS, or adding a mechanism to
+# allow specifying a python interpreter compiled for the target that could
+# be executed using qemu-user.
+# REQUIRES: native
+
+# RUN: env PYTHONPATH=%S/../../../bindings/python \
+# RUN:   CLANG_LIBRARY_PATH=%libdir \
+# RUN:   %python -m unittest discover -s %S/tests
diff --git a/clang/test/bindings/python/lit.local.cfg b/clang/test/bindings/python/lit.local.cfg
new file mode 100644
index 0000000000000..cc3bdf8ba97d4
--- /dev/null
+++ b/clang/test/bindings/python/lit.local.cfg
@@ -0,0 +1,41 @@
+def is_libclang_loadable():
+    # Do not try to run if libclang was built with sanitizers because
+    # the sanitizer library will likely be loaded too late to perform
+    # interception and will then fail.
+    # We could use LD_PRELOAD/DYLD_INSERT_LIBRARIES but this isn't
+    # portable so its easier just to not run the tests when building
+    # with ASan.
+    if config.llvm_use_sanitizer != "":
+        return False
+    try:
+        sys.path.append(os.path.join(config.clang_src_dir, "bindings/python"))
+        from clang.cindex import Config
+        conf = Config()
+        Config.set_library_path(config.clang_lib_dir)
+        conf.lib
+        return True
+    except Exception as e:
+        # Expected failure modes are considered benign when nothing can be
+        # done about them.
+        #
+        # Cannot load a 32-bit libclang.so into a 64-bit python.
+        if "wrong ELF class: ELFCLASS32" in str(e):
+            return False
+        # If libclang.so is missing, it must have been disabled intentionally,
+        # e.g. by building with LLVM_ENABLE_PIC=OFF.
+        elif "No such file or directory" in str(e):
+            return False
+        # Unexpected failure modes need to be investigated to either fix an
+        # underlying bug or accept the failure, so return True.  This causes
+        # tests to run and FAIL, drawing developer attention.
+        else:
+            print("warning: unhandled failure in is_libclang_loadable: "
+                  + str(e), file=sys.stderr)
+            return True
+
+if is_libclang_loadable():
+    config.available_features.add("libclang-loadable")
+
+config.substitutions.append(('%libdir', config.clang_lib_dir))
+
+config.suffixes = ['.sh']
diff --git a/clang/bindings/python/tests/__init__.py b/clang/test/bindings/python/tests/__init__.py
similarity index 100%
rename from clang/bindings/python/tests/__init__.py
rename to clang/test/bindings/python/tests/__init__.py
diff --git a/clang/bindings/python/tests/cindex/INPUTS/a.inc b/clang/test/bindings/python/tests/cindex/INPUTS/a.inc
similarity index 100%
rename from clang/bindings/python/tests/cindex/INPUTS/a.inc
rename to clang/test/bindings/python/tests/cindex/INPUTS/a.inc
diff --git a/clang/bindings/python/tests/cindex/INPUTS/b.inc b/clang/test/bindings/python/tests/cindex/INPUTS/b.inc
similarity index 100%
rename from clang/bindings/python/tests/cindex/INPUTS/b.inc
rename to clang/test/bindings/python/tests/cindex/INPUTS/b.inc
diff --git a/clang/bindings/python/tests/cindex/INPUTS/compile_commands.json b/clang/test/bindings/python/tests/cindex/INPUTS/compile_commands.json
similarity index 100%
rename from clang/bindings/python/tests/cindex/INPUTS/compile_commands.json
rename to clang/test/bindings/python/tests/cindex/INPUTS/compile_commands.json
diff --git a/clang/bindings/python/tests/cindex/INPUTS/header1.h b/clang/test/bindings/python/tests/cindex/INPUTS/header1.h
similarity index 100%
rename from clang/bindings/python/tests/cindex/INPUTS/header1.h
rename to clang/test/bindings/python/tests/cindex/INPUTS/header1.h
diff --git a/clang/bindings/python/tests/cindex/INPUTS/header2.h b/clang/test/bindings/python/tests/cindex/INPUTS/header2.h
similarity index 100%
rename from clang/bindings/python/tests/cindex/INPUTS/header2.h
rename to clang/test/bindings/python/tests/cindex/INPUTS/header2.h
diff --git a/clang/bindings/python/tests/cindex/INPUTS/header3.h b/clang/test/bindings/python/tests/cindex/INPUTS/header3.h
similarity index 100%
rename from clang/bindings/python/tests/cindex/INPUTS/header3.h
rename to clang/test/bindings/python/tests/cindex/INPUTS/header3.h
diff --git a/clang/bindings/python/tests/cindex/INPUTS/hello.cpp b/clang/test/bindings/python/tests/cindex/INPUTS/hello.cpp
similarity index 100%
rename from clang/bindings/python/tests/cindex/INPUTS/hello.cpp
rename to clang/test/bindings/python/tests/cindex/INPUTS/hello.cpp
diff --git a/clang/bindings/python/tests/cindex/INPUTS/include.cpp b/clang/test/bindings/python/tests/cindex/INPUTS/include.cpp
similarity index 100%
rename from clang/bindings/python/tests/cindex/INPUTS/include.cpp
rename to clang/test/bindings/python/tests/cindex/INPUTS/include.cpp
diff --git a/clang/bindings/python/tests/cindex/INPUTS/parse_arguments.c b/clang/test/bindings/python/tests/cindex/INPUTS/parse_arguments.c
similarity index 100%
rename from clang/bindings/python/tests/cindex/INPUTS/parse_arguments.c
rename to clang/test/bindings/python/tests/cindex/INPUTS/parse_arguments.c
diff --git a/clang/bindings/python/tests/cindex/INPUTS/testfile.c b/clang/test/bindings/python/tests/cindex/INPUTS/testfile.c
similarity index 100%
rename from clang/bindings/python/tests/cindex/INPUTS/testfile.c
rename to clang/test/bindings/python/tests/cindex/INPUTS/testfile.c
diff --git a/clang/bindings/python/tests/cindex/__init__.py b/clang/test/bindings/python/tests/cindex/__init__.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/__init__.py
rename to clang/test/bindings/python/tests/cindex/__init__.py
diff --git a/clang/bindings/python/tests/cindex/test_access_specifiers.py b/clang/test/bindings/python/tests/cindex/test_access_specifiers.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_access_specifiers.py
rename to clang/test/bindings/python/tests/cindex/test_access_specifiers.py
diff --git a/clang/bindings/python/tests/cindex/test_cdb.py b/clang/test/bindings/python/tests/cindex/test_cdb.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_cdb.py
rename to clang/test/bindings/python/tests/cindex/test_cdb.py
diff --git a/clang/bindings/python/tests/cindex/test_code_completion.py b/clang/test/bindings/python/tests/cindex/test_code_completion.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_code_completion.py
rename to clang/test/bindings/python/tests/cindex/test_code_completion.py
diff --git a/clang/bindings/python/tests/cindex/test_comment.py b/clang/test/bindings/python/tests/cindex/test_comment.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_comment.py
rename to clang/test/bindings/python/tests/cindex/test_comment.py
diff --git a/clang/bindings/python/tests/cindex/test_cursor.py b/clang/test/bindings/python/tests/cindex/test_cursor.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_cursor.py
rename to clang/test/bindings/python/tests/cindex/test_cursor.py
diff --git a/clang/bindings/python/tests/cindex/test_cursor_kind.py b/clang/test/bindings/python/tests/cindex/test_cursor_kind.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_cursor_kind.py
rename to clang/test/bindings/python/tests/cindex/test_cursor_kind.py
diff --git a/clang/bindings/python/tests/cindex/test_diagnostics.py b/clang/test/bindings/python/tests/cindex/test_diagnostics.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_diagnostics.py
rename to clang/test/bindings/python/tests/cindex/test_diagnostics.py
diff --git a/clang/bindings/python/tests/cindex/test_enums.py b/clang/test/bindings/python/tests/cindex/test_enums.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_enums.py
rename to clang/test/bindings/python/tests/cindex/test_enums.py
diff --git a/clang/bindings/python/tests/cindex/test_exception_specification_kind.py b/clang/test/bindings/python/tests/cindex/test_exception_specification_kind.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_exception_specification_kind.py
rename to clang/test/bindings/python/tests/cindex/test_exception_specification_kind.py
diff --git a/clang/bindings/python/tests/cindex/test_file.py b/clang/test/bindings/python/tests/cindex/test_file.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_file.py
rename to clang/test/bindings/python/tests/cindex/test_file.py
diff --git a/clang/bindings/python/tests/cindex/test_index.py b/clang/test/bindings/python/tests/cindex/test_index.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_index.py
rename to clang/test/bindings/python/tests/cindex/test_index.py
diff --git a/clang/bindings/python/tests/cindex/test_lib.py b/clang/test/bindings/python/tests/cindex/test_lib.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_lib.py
rename to clang/test/bindings/python/tests/cindex/test_lib.py
diff --git a/clang/bindings/python/tests/cindex/test_linkage.py b/clang/test/bindings/python/tests/cindex/test_linkage.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_linkage.py
rename to clang/test/bindings/python/tests/cindex/test_linkage.py
diff --git a/clang/bindings/python/tests/cindex/test_location.py b/clang/test/bindings/python/tests/cindex/test_location.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_location.py
rename to clang/test/bindings/python/tests/cindex/test_location.py
diff --git a/clang/bindings/python/tests/cindex/test_rewrite.py b/clang/test/bindings/python/tests/cindex/test_rewrite.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_rewrite.py
rename to clang/test/bindings/python/tests/cindex/test_rewrite.py
diff --git a/clang/bindings/python/tests/cindex/test_source_range.py b/clang/test/bindings/python/tests/cindex/test_source_range.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_source_range.py
rename to clang/test/bindings/python/tests/cindex/test_source_range.py
diff --git a/clang/bindings/python/tests/cindex/test_tls_kind.py b/clang/test/bindings/python/tests/cindex/test_tls_kind.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_tls_kind.py
rename to clang/test/bindings/python/tests/cindex/test_tls_kind.py
diff --git a/clang/bindings/python/tests/cindex/test_token_kind.py b/clang/test/bindings/python/tests/cindex/test_token_kind.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_token_kind.py
rename to clang/test/bindings/python/tests/cindex/test_token_kind.py
diff --git a/clang/bindings/python/tests/cindex/test_tokens.py b/clang/test/bindings/python/tests/cindex/test_tokens.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_tokens.py
rename to clang/test/bindings/python/tests/cindex/test_tokens.py
diff --git a/clang/bindings/python/tests/cindex/test_translation_unit.py b/clang/test/bindings/python/tests/cindex/test_translation_unit.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_translation_unit.py
rename to clang/test/bindings/python/tests/cindex/test_translation_unit.py
diff --git a/clang/bindings/python/tests/cindex/test_type.py b/clang/test/bindings/python/tests/cindex/test_type.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/test_type.py
rename to clang/test/bindings/python/tests/cindex/test_type.py
diff --git a/clang/bindings/python/tests/cindex/util.py b/clang/test/bindings/python/tests/cindex/util.py
similarity index 100%
rename from clang/bindings/python/tests/cindex/util.py
rename to clang/test/bindings/python/tests/cindex/util.py

@DeinAlptraum
Copy link
Contributor Author

Next attempt after #146486.
The only change is, that I removed s390x from the XFAIL directive.

@DeinAlptraum DeinAlptraum merged commit 2532bde into llvm:main Jul 3, 2025
15 checks passed
@llvm-ci
Copy link
Collaborator

llvm-ci commented Jul 3, 2025

LLVM Buildbot has detected a new failure on builder clang-s390x-linux-lnt running on systemz-1 while building .github,clang at step 7 "ninja check 1".

Full details are available at: https://lab.llvm.org/buildbot/#/builders/136/builds/4462

Here is the relevant piece of the build log for the reference
Step 7 (ninja check 1) failure: stage 1 checked (failure)
******************** TEST 'Clang :: bindings/python/bindings.sh' FAILED ********************
Exit Code: 134

Command Output (stderr):
--
env PYTHONPATH=/home/uweigand/sandbox/buildbot/clang-s390x-linux-lnt/llvm/clang/test/bindings/python/../../../bindings/python    CLANG_LIBRARY_PATH=/home/uweigand/sandbox/buildbot/clang-s390x-linux-lnt/stage1/lib    "/home/uweigand/sandbox/bin/python3.10" -m unittest discover -s /home/uweigand/sandbox/buildbot/clang-s390x-linux-lnt/llvm/clang/test/bindings/python/tests # RUN: at line 30
+ env PYTHONPATH=/home/uweigand/sandbox/buildbot/clang-s390x-linux-lnt/llvm/clang/test/bindings/python/../../../bindings/python CLANG_LIBRARY_PATH=/home/uweigand/sandbox/buildbot/clang-s390x-linux-lnt/stage1/lib /home/uweigand/sandbox/bin/python3.10 -m unittest discover -s /home/uweigand/sandbox/buildbot/clang-s390x-linux-lnt/llvm/clang/test/bindings/python/tests
Invalid CXChildVisitResult!
UNREACHABLE executed at /home/uweigand/sandbox/buildbot/clang-s390x-linux-lnt/llvm/clang/tools/libclang/CIndex.cpp:243!
/home/uweigand/sandbox/buildbot/clang-s390x-linux-lnt/stage1/tools/clang/test/bindings/python/Output/bindings.sh.script: line 1: 1555993 Aborted                 env PYTHONPATH=/home/uweigand/sandbox/buildbot/clang-s390x-linux-lnt/llvm/clang/test/bindings/python/../../../bindings/python CLANG_LIBRARY_PATH=/home/uweigand/sandbox/buildbot/clang-s390x-linux-lnt/stage1/lib "/home/uweigand/sandbox/bin/python3.10" -m unittest discover -s /home/uweigand/sandbox/buildbot/clang-s390x-linux-lnt/llvm/clang/test/bindings/python/tests

--

********************


DeinAlptraum added a commit to DeinAlptraum/llvm-project that referenced this pull request Jul 3, 2025
DeinAlptraum added a commit that referenced this pull request Jul 3, 2025
@DeinAlptraum
Copy link
Contributor Author

We hit the

Invalid CXChildVisitResult!

assert in CIndex.cpp, which is marked llvm_unreachable()... the function covers all three variants of the CXChildVisitResult enum.

@Endilll I'm hitting supposedly unreachable code, only on this one platform apparently... if you have any idea why this is happening, I'd love to hear it. Note that the tests passed on the clang-s390x-linux-multistage runner.

Reverted in #146931

@Endilll
Copy link
Contributor

Endilll commented Jul 3, 2025

No idea why it blew up on that particular s390x buildbot.
@AaronBallman Any ideas?

@AaronBallman
Copy link
Collaborator

No idea why it blew up on that particular s390x buildbot. @AaronBallman Any ideas?

Err, I have no idea, I've never seen that sort of behavior before!

@DeinAlptraum
Copy link
Contributor Author

It seems that the clang-s390x-linux-multistage and clang-s390x-linux-lnt builders use the exact same cmake settings, so only one of them failing seems quite strange... @uweigand can you tell me what the difference between these two is/do you have any idea what might cause these failures on only one of them?

I'm currently considering just rebasing and trying again to see if that fixes it.

@uweigand
Copy link
Member

uweigand commented Jul 8, 2025

Both clang-s390x-linux and clang-s390x-linux-lnt failed with the same Clang::bindings.sh error:
https://lab.llvm.org/buildbot/#/builders/42/builds/5208
https://lab.llvm.org/buildbot/#/builders/136/builds/4462

The clang-s390x-linux-multistage run including this change did indeed pass:
https://lab.llvm.org/buildbot/#/builders/98/builds/1625

The main difference between this and the others is that in the multistage build, the clang that is used to run the test suite was itself built using (the same version of) clang as host compiler, while the other two build clang using the system GCC as host compiler.

It's not immediately obvious to me why the host compiler would make any difference on this particular PR ...

@DeinAlptraum
Copy link
Contributor Author

Thansk for the explainer! That gives me something to test, I will try a cross-compile with GCC and see if I can reproduce it locally.

It's not immediately obvious to me why the host compiler would make any difference on this particular PR ...

We are changing how the Clang-Python bindings are tested, and in the process revisiting which platforms are marked as XFAIL and UNSUPPORTED. system-z was previously unsupported, and moving it to XFAIL led to the issues you see here. So the failure isn't so much caused by something introduced in this PR, it's probably been failing for years but just wasn't tested.
If I can't find a way to resolve this, I'll probably just mark it as UNSUPPORTED again

@AaronBallman
Copy link
Collaborator

Thansk for the explainer! That gives me something to test, I will try a cross-compile with GCC and see if I can reproduce it locally.

It's not immediately obvious to me why the host compiler would make any difference on this particular PR ...

We are changing how the Clang-Python bindings are tested, and in the process revisiting which platforms are marked as XFAIL and UNSUPPORTED. system-z was previously unsupported, and moving it to XFAIL led to the issues you see here. So the failure isn't so much caused by something introduced in this PR, it's probably been failing for years but just wasn't tested. If I can't find a way to resolve this, I'll probably just mark it as UNSUPPORTED again

Ah, that makes sense, thank you for the explanation! I think UNSUPPORTED is a reasonable option.

@DeinAlptraum
Copy link
Contributor Author

I couldn't reproduce the issue when cross-compiling for s390x with my system GCC (15.1.1):

cmake -G Ninja -B build -S llvm -DCMAKE_C_COMPILER=gcc -DCMAKE_CXX_COMPILER=g++ \
    -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_ASSERTIONS=True \
    '-DLLVM_LIT_ARGS='"'"'-v -j4'"'"'' -DLLVM_CCACHE_BUILD=OFF \
    -DLLVM_ENABLE_ASSERTIONS=ON '-DLLVM_ENABLE_PROJECTS=llvm;clang-tools-extra;clang' \
    -DLLVM_ENABLE_RUNTIMES=compiler-rt -DLLVM_DEFAULT_TARGET_TRIPLE=s390x-unknown-linux-gnu

So I'm starting a new attempt at #148802, with s390x marked as UNSUPPORTED

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clang:as-a-library libclang and C++ API clang Clang issues not falling into any other category github:workflow
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants