Update catch2 v3

.github/CHANGELOG.md

@@ -35,6 +35,9 @@
 
 <h3>Internal changes ⚙️</h3>
 
+- Update Catch2 testing framework to v3.11.
+  [(#1350)](https://github.com/PennyLaneAI/pennylane-lightning/pull/1350)
+
 - Update internal dependencies versions for Nanobind (2.11), cmake (3.26), sphinxcontrib-htmlhelp (2.1.0)
   [(#1347)](https://github.com/PennyLaneAI/pennylane-lightning/pull/1347)
 

.github/workflows/tests_lgpumpi_cpp.yml

@@ -167,7 +167,7 @@ jobs:
           mkdir -p ./tests/results
           test_status=0
           for file in *runner ; do ./$file  --reporter junit --out ./tests/results/report_$file.xml && echo "Test $file Success!" || { cat ./tests/results/report_$file.xml; test_status=1; } done;
-          for file in *runner_mpi ; do mpirun -np 2 ./$file --reporter junit --out ./tests/results/report_$file.xml && echo "Test $file Success!" || { cat ./tests/results/report_$file.xml; test_status=1; } done;
+          for file in *runner_mpi ; do mpirun -np 2 ./$file --order decl --reporter junit --out ./tests/results/report_$file.xml && echo "Test $file Success!" || { cat ./tests/results/report_$file.xml; test_status=1; } done;
           if [ $test_status -ne 0 ]; then
             echo "Tests failed. Exiting with error code."
             exit 1

.github/workflows/tests_lkmpi_cuda_cpp.yml

@@ -193,8 +193,8 @@ jobs:
           mkdir -p ./tests/results
           test_status=0
           for file in *runner ; do ./$file  --reporter junit --out ./tests/results/report_$file.xml && echo "Test $file Success!" || { cat ./tests/results/report_$file.xml; test_status=1; } done;
-          for file in lightning_kokkos*runner_mpi ; do mpirun -np 4 ./$file --reporter junit --out ./tests/results/report_$file.xml && echo "Test $file Success!" || { cat ./tests/results/report_$file.xml; test_status=1; } done;
-          for file in utils_*runner_mpi ; do mpirun -np 2 ./$file --reporter junit --out ./tests/results/report_$file.xml && echo "Test $file Success!" || { cat ./tests/results/report_$file.xml; test_status=1; } done;
+          for file in lightning_kokkos*runner_mpi ; do mpirun -np 4 ./$file --order decl --reporter junit --out ./tests/results/report_$file.xml && echo "Test $file Success!" || { cat ./tests/results/report_$file.xml; test_status=1; } done;
+          for file in utils_*runner_mpi ; do mpirun -np 2 ./$file --order decl --reporter junit --out ./tests/results/report_$file.xml && echo "Test $file Success!" || { cat ./tests/results/report_$file.xml; test_status=1; } done;
           if [ $test_status -ne 0 ]; then
             echo "Tests failed. Exiting with error code."
             exit 1

Makefile

@@ -156,23 +156,23 @@ test-cpp-mpi:
 		  $(OPTIONS)
 ifdef target
 	cmake --build ./BuildTests $(VERBOSE) --target $(target)
-	mpirun -np 2 ./BuildTests/$(target)
+	mpirun -np 2 ./BuildTests/$(target) --order decl
 else
 	cmake --build ./BuildTests $(VERBOSE)
-	
+
 	if [ "$(PL_BACKEND)" = "lightning_gpu" ]; then \
 		for file in ./BuildTests/*_test_runner_mpi; do \
 			echo "Running $$file"; \
-			mpirun -np 2 $$file ; \
+			mpirun -np 2 $$file --order decl ; \
 		done ; \
 	elif [ "$(PL_BACKEND)" = "lightning_kokkos" ]; then \
 		for file in ./BuildTests/lightning_kokkos*test_runner_mpi; do \
 			echo "Running $$file"; \
-			mpirun -np 4 $$file ; \
+			mpirun -np 4 $$file --order decl ; \
 		done ; \
 		for file in ./BuildTests/utils_test_runner_mpi; do \
 			echo "Running $$file"; \
-			mpirun -np 2 $$file ; \
+			mpirun -np 2 $$file --order decl ; \
 		done; \
 	fi
 endif

cmake/support_tests.cmake

@@ -13,7 +13,7 @@ macro(FetchAndIncludeCatch)
     FetchContent_Declare(
     Catch2
     GIT_REPOSITORY https://github.com/catchorg/Catch2.git
-    GIT_TAG        v2.13.10
+    GIT_TAG        v3.11.0
     )
 
     FetchContent_MakeAvailable(Catch2)
@@ -22,7 +22,7 @@ macro(FetchAndIncludeCatch)
     set_target_properties(Catch2 PROPERTIES INTERFACE_SYSTEM_INCLUDE_DIRECTORIES "${CATCH2_IID}")
 
     # Required for catch_discover_tests() and include(Catch)
-    list(APPEND CMAKE_MODULE_PATH ${catch2_SOURCE_DIR}/contrib)
+    list(APPEND CMAKE_MODULE_PATH ${catch2_SOURCE_DIR}/extras)
 
     include(Catch)
 endmacro()
@@ -48,4 +48,4 @@ macro(ProcessTestOptions target_name)
         message(STATUS "ENABLE_NATIVE is ON. Use -march=native for cpptests.")
         target_compile_options(${target_name} INTERFACE -march=native)
     endif()
-endmacro()
+endmacro()

pennylane_lightning/core/_version.py

@@ -16,4 +16,4 @@
 Version number (major.minor.patch[-label])
 """
 
-__version__ = "0.45.0-dev25"
+__version__ = "0.45.0-dev26"

pennylane_lightning/core/algorithms/tests/Test_AdjointJacobian.cpp

@@ -11,7 +11,8 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-#include <catch2/catch.hpp>
+#include <catch2/catch_test_macros.hpp>
+#include <catch2/generators/catch_generators.hpp>
 
 #include "Error.hpp" // LightningException
 #include "JacobianData.hpp"

pennylane_lightning/core/algorithms/tests/mpi/Test_AdjointJacobianMPI.cpp

@@ -11,7 +11,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-#include <catch2/catch.hpp>
+#include <catch2/catch_test_macros.hpp>
 
 #include "JacobianData.hpp"
 #include "TestHelpers.hpp" //PLApprox

pennylane_lightning/core/algorithms/tests/mpi/runner_algorithms_mpi.cpp

@@ -1,5 +1,5 @@
 #define CATCH_CONFIG_RUNNER
-#include <catch2/catch.hpp>
+#include <catch2/catch_session.hpp>
 #include <mpi.h>
 
 int main(int argc, char *argv[]) {

pennylane_lightning/core/algorithms/tests/runner_algorithms.cpp

@@ -1,2 +1,3 @@
-#define CATCH_CONFIG_MAIN
-#include <catch2/catch.hpp>
+#include <catch2/catch_session.hpp>
+
+int main(int argc, char *argv[]) { return Catch::Session().run(argc, argv); }

pennylane_lightning/core/bindings/BindingsMPI.hpp

@@ -427,7 +427,7 @@ void registerBackendAgnosticAlgorithmsMPI(nb::module_ &m) {
  *
  * @param m Nanobind module
  */
-inline void registerInfoMPI(nb::module_ &m) {
+inline void registerInfoMPI([[maybe_unused]] nb::module_ &m) {
     // This function is now empty - MPI manager registration moved to
     // backend-specific
 }

pennylane_lightning/core/catalyst/tests/Test_LightningDriver.cpp

@@ -13,8 +13,9 @@
 // limitations under the License.
 
 #include "TestHelpers.hpp"
-#include "catch2/catch.hpp"
 #include <algorithm>
+#include <catch2/catch_test_macros.hpp>
+#include <catch2/matchers/catch_matchers_string.hpp>
 #include <numeric>
 #include <string>
 
@@ -162,7 +163,7 @@ TEST_CASE("Check an unsupported operation", "[Driver]") {
     REQUIRE_THROWS_WITH(
         Lightning::lookup_gates(Lightning::simulator_gate_info,
                                 "UnsupportedGateName"),
-        Catch::Contains(
+        Catch::Matchers::ContainsSubstring(
             "The given operation is not supported by the simulator"));
 }
 
@@ -447,8 +448,9 @@ TEST_CASE("Cannot reuse entangled qubit when allocating", "[Driver]") {
 
     REQUIRE_THROWS_WITH(
         sim->AllocateQubit(),
-        Catch::Contains("Cannot reuse qubit: qubit is entangled with remaining "
-                        "qubits. Release qubits must be disentangled."));
+        Catch::Matchers::ContainsSubstring(
+            "Cannot reuse qubit: qubit is entangled with remaining "
+            "qubits. Release qubits must be disentangled."));
 }
 
 TEST_CASE("Release one qubit from entangled qubits", "[Driver]") {
@@ -478,8 +480,9 @@ TEST_CASE("Release one qubit from entangled qubits", "[Driver]") {
 
     REQUIRE_THROWS_WITH(
         sim->PartialProbs(probs_view, {static_qubits[0], static_qubits[1]}),
-        Catch::Contains("Cannot release qubits: released qubits are entangled "
-                        "with remaining qubits"));
+        Catch::Matchers::ContainsSubstring(
+            "Cannot release qubits: released qubits are entangled "
+            "with remaining qubits"));
 }
 
 TEST_CASE("Release all entangled qubits", "[Driver]") {

pennylane_lightning/core/catalyst/tests/Test_LightningQubitManager.cpp

@@ -16,7 +16,8 @@
 #include <optional>
 #include <set>
 
-#include "catch2/catch.hpp"
+#include <catch2/catch_test_macros.hpp>
+#include <catch2/matchers/catch_matchers_string.hpp>
 
 #include "LightningQubitManager.hpp"
 
@@ -98,12 +99,14 @@ TEST_CASE("Test lightning qubit manager invalid IDs", "[Utils]") {
     size_t device_qubit_id = 0;
 
     QubitIdType q = manager.Allocate(device_qubit_id);
-    REQUIRE_THROWS_WITH(manager.getProgramId(device_qubit_id + 42),
-                        Catch::Contains("Invalid device qubit ID"));
-    REQUIRE_THROWS_WITH(manager.getDeviceId(q + 42),
-                        Catch::Contains("Invalid program qubit ID"));
-
     REQUIRE_THROWS_WITH(
-        manager.Release(q + 42),
-        Catch::Contains("Cannot release qubit, the given ID is invalid"));
+        manager.getProgramId(device_qubit_id + 42),
+        Catch::Matchers::ContainsSubstring("Invalid device qubit ID"));
+    REQUIRE_THROWS_WITH(
+        manager.getDeviceId(q + 42),
+        Catch::Matchers::ContainsSubstring("Invalid program qubit ID"));
+
+    REQUIRE_THROWS_WITH(manager.Release(q + 42),
+                        Catch::Matchers::ContainsSubstring(
+                            "Cannot release qubit, the given ID is invalid"));
 }

pennylane_lightning/core/catalyst/tests/runner_catalyst.cpp

@@ -1,2 +1,3 @@
-#define CATCH_CONFIG_MAIN
-#include <catch2/catch.hpp>
+#include <catch2/catch_session.hpp>
+
+int main(int argc, char *argv[]) { return Catch::Session().run(argc, argv); }