From d09de49747f20b7c5c60ad2b8c55258aa1932ca2 Mon Sep 17 00:00:00 2001
From: "kodiakhq[bot]" <49736102+kodiakhq[bot]@users.noreply.github.com>
Date: Tue, 30 Jan 2024 12:03:45 +0000
Subject: [PATCH] Address API change in Python 3.12 unittest module (#4852)

Starting with Python 3.12, package `unittest` returns exit code 5 when all tests are skipped. By default, CTest treats any non-zero exit code as a failure. This can be remediated by setting test property [`SKIP_RETURN_CODE`](https://cmake.org/cmake/help/latest/prop_test/SKIP_RETURN_CODE.html) to 5.

Description of changes:
- skipped tests are no longer treated as failures by CTest
---
 testsuite/python/CMakeLists.txt             | 1 +
 testsuite/scripts/CMakeLists.txt            | 1 +
 testsuite/scripts/benchmarks/CMakeLists.txt | 1 +
 testsuite/scripts/samples/CMakeLists.txt    | 1 +
 testsuite/scripts/tutorials/CMakeLists.txt  | 2 ++
 5 files changed, 6 insertions(+)

diff --git a/testsuite/python/CMakeLists.txt b/testsuite/python/CMakeLists.txt
index 85fb180db53..631c12b0fad 100644
--- a/testsuite/python/CMakeLists.txt
+++ b/testsuite/python/CMakeLists.txt
@@ -57,6 +57,7 @@ function(PYTHON_TEST)
   endif()
   set_tests_properties(${TEST_NAME} PROPERTIES PROCESSORS ${TEST_NUM_PROC}
                                                DEPENDS "${TEST_DEPENDS}")
+  set_tests_properties(${TEST_NAME} PROPERTIES SKIP_RETURN_CODE 5)
 
   if("gpu" IN_LIST TEST_LABELS AND WITH_CUDA)
     set_tests_properties(${TEST_NAME} PROPERTIES RESOURCE_LOCK GPU)
diff --git a/testsuite/scripts/CMakeLists.txt b/testsuite/scripts/CMakeLists.txt
index a00b6de1999..f243638a25a 100644
--- a/testsuite/scripts/CMakeLists.txt
+++ b/testsuite/scripts/CMakeLists.txt
@@ -39,6 +39,7 @@ macro(PYTHON_SCRIPTS_TEST)
   string(REGEX REPLACE "^test_" "${TEST_TYPE}_" TEST_NAME ${TEST_NAME})
   add_test(${TEST_NAME} ${CMAKE_BINARY_DIR}/pypresso ${PYPRESSO_OPTIONS}
            ${TEST_FILE_CONFIGURED})
+  set_tests_properties(${TEST_NAME} PROPERTIES SKIP_RETURN_CODE 5)
   set_tests_properties(${TEST_NAME} PROPERTIES FIXTURES_REQUIRED
                                                IMPORTLIB_WRAPPER)
   set_tests_properties(${TEST_NAME} PROPERTIES LABELS "${TEST_LABELS}")
diff --git a/testsuite/scripts/benchmarks/CMakeLists.txt b/testsuite/scripts/benchmarks/CMakeLists.txt
index c5880959cb1..9689b26ba92 100644
--- a/testsuite/scripts/benchmarks/CMakeLists.txt
+++ b/testsuite/scripts/benchmarks/CMakeLists.txt
@@ -25,6 +25,7 @@ endfunction(BENCHMARK_TEST)
 # configure Python module importlib_wrapper.py
 add_test(importlib_wrapper ${CMAKE_BINARY_DIR}/pypresso ${PYPRESSO_OPTIONS}
          ${TEST_FILE_CONFIGURED_IMPORTLIB_WRAPPER})
+set_tests_properties(importlib_wrapper PROPERTIES SKIP_RETURN_CODE 5)
 set_tests_properties(importlib_wrapper PROPERTIES FIXTURES_SETUP
                                                   IMPORTLIB_WRAPPER)
 set(benchmarks_tests ${benchmarks_tests}
diff --git a/testsuite/scripts/samples/CMakeLists.txt b/testsuite/scripts/samples/CMakeLists.txt
index d728c6b3a76..e0dfb1b85fa 100644
--- a/testsuite/scripts/samples/CMakeLists.txt
+++ b/testsuite/scripts/samples/CMakeLists.txt
@@ -25,6 +25,7 @@ endfunction(SAMPLE_TEST)
 # configure Python module importlib_wrapper.py
 add_test(importlib_wrapper ${CMAKE_BINARY_DIR}/pypresso ${PYPRESSO_OPTIONS}
          ${TEST_FILE_CONFIGURED_IMPORTLIB_WRAPPER})
+set_tests_properties(importlib_wrapper PROPERTIES SKIP_RETURN_CODE 5)
 set_tests_properties(importlib_wrapper PROPERTIES FIXTURES_SETUP
                                                   IMPORTLIB_WRAPPER)
 set(samples_tests ${samples_tests} ${TEST_FILE_CONFIGURED_IMPORTLIB_WRAPPER}
diff --git a/testsuite/scripts/tutorials/CMakeLists.txt b/testsuite/scripts/tutorials/CMakeLists.txt
index 6ea9dfb57b8..c6749295490 100644
--- a/testsuite/scripts/tutorials/CMakeLists.txt
+++ b/testsuite/scripts/tutorials/CMakeLists.txt
@@ -28,8 +28,10 @@ add_test(importlib_wrapper ${CMAKE_BINARY_DIR}/pypresso ${PYPRESSO_OPTIONS}
          ${TEST_FILE_CONFIGURED_IMPORTLIB_WRAPPER})
 add_test(convert ${CMAKE_BINARY_DIR}/pypresso ${PYPRESSO_OPTIONS}
          ${CMAKE_CURRENT_BINARY_DIR}/test_convert.py)
+set_tests_properties(importlib_wrapper PROPERTIES SKIP_RETURN_CODE 5)
 set_tests_properties(importlib_wrapper PROPERTIES FIXTURES_SETUP
                                                   IMPORTLIB_WRAPPER)
+set_tests_properties(convert PROPERTIES SKIP_RETURN_CODE 5)
 set_tests_properties(convert PROPERTIES FIXTURES_SETUP IMPORTLIB_WRAPPER)
 set(tutorials_tests ${tutorials_tests} ${TEST_FILE_CONFIGURED_IMPORTLIB_WRAPPER}
     PARENT_SCOPE)