Add CTest for testing Qiskit C++ (#119)

doichanj · web-flow · commit edb7e1906aa5 · 2025-09-29T14:54:57.000+09:00
* Add ctest

* igonore test/Testing

* igonore test/Testing

* fix path to clone Qiskit

* Fix boundary data type in obs

* add circuit test cases

* restore commented line

* fix sx test

* modify readme
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -0,0 +1,33 @@
+name: Qiskit C++ test cases
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+    tests:
+        name: tests-qiskit-cpp-${{ matrix.os }}
+        runs-on: ${{ matrix.os }}
+        strategy:
+            fail-fast: false
+            matrix:
+                os:
+                - ubuntu-latest
+                - macos-13
+                - macos-14
+                - ubuntu-24.04-arm
+                - windows-latest
+        steps:
+            - uses: actions/checkout@v5
+            - name: install deps
+              run: cargo install cbindgen
+            - name: clone Qiskit
+              uses: actions/checkout@v5
+              with:
+                repository: Qiskit/qiskit
+                path: test/deps/qiskit
+            - name: Run tests
+              run: |
+                  cd test
+                  make
diff --git a/.gitignore b/.gitignore
@@ -50,6 +50,10 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 cover/
+samples/build
+test/build
+test/deps
+test/Testing
 
 # Translations
 *.mo
diff --git a/README.md b/README.md
@@ -78,25 +78,27 @@ Qiskit C++ only has C++ header files. There is nothing to do to build the SDK.
 
 ### Running examples
 
-Examples are available in [this directory](./tests).
+Examples are available in [this directory](./samples).
 
 #### Building examples
 
 To build application using Qiskit C++, add path to Qiskit C-API, include path to `qiskit.h` (installed in `dist/c/include`) and library `libqiskit.so` (installed in `dist/c/lib`) or `qiskit_cext.dll.lib` (generated in `target/release`) for Windows.
-See ./CMakeLists.txt for example to make test program.
+See ./samples/CMakeLists.txt for example to make test program.
 
 ```shell-session
+$ cd samples
 $ mkdir build
 $ cd build
 $ cmake -DQISKIT_ROOT=Path_to_qiskit ..
 $ make
 ```
 
-If you want to build sampler/transpiler example, you will need one of qiskit-ibm-runtime C or QRMI.
+If you want to build sampler or transpiler example, you will need one of qiskit-ibm-runtime C or QRMI.
 
 Then example can be built by setting `QISKIT_IBM_RUNTIME_C_ROOT` or `QRMI_ROOT` to cmake.
 
 ```shell-session
+$ cd samples
 $ mkdir build
 $ cd build
 $ cmake -DQISKIT_ROOT=Path_to_qiskit -DQISKIT_IBM_RUNTIME_C_ROOT="path to qiskit-ibm-runtime C" or -DQRMI_ROOT="path to QRMI" ..
@@ -121,13 +123,10 @@ Refer to `./src/providers/qrmi_backend.hpp` and `./src/providers/qrmi_job.hpp` f
 
 Regardless if you are part of the core team or an external contributor, welcome and thank you for contributing to Qiskit C++
 
-### Solving linting/format issues
-
-Contributor must execute the commands below and fix any issues before submitting Pull Request.
-
 ### Running unit test
 
-Contributor must execute the command below and fix any issues before submitting Pull Request.
+Contributor must add test cases under ./test directory if you have added new features to Qiskit C++.
+Also all the test cases running on the github repository should be passed.
 
 ### Checking API document
 
diff --git a/samples/CMakeLists.txt b/samples/CMakeLists.txt
@@ -76,7 +76,7 @@ function(add_application APP_NAME CPP_FILE)
       ${QRMI_ROOT}
       ${QISKIT_IBM_RUNTIME_C_ROOT}/include
       ${SAMPLES_PATH}
-      ${CMAKE_CURRENT_SOURCE_DIR}/src
+      ${CMAKE_CURRENT_SOURCE_DIR}/../src
       nlohmann_json::nlohmann_json
   )
 
@@ -85,14 +85,13 @@ endfunction()
 
 function(add_application_test TEST_NAME APP_NAME CPP_FILE)
   add_application(${APP_NAME} ${CPP_FILE})
-  target_include_directories(${APP_NAME} PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/tests/external)
   add_test(NAME ${TEST_NAME} COMMAND ${APP_NAME})
 endfunction()
 
-add_application(circuit_test tests/circuit_test.cpp)
-add_application(observable_test tests/observable_test.cpp)
+add_application(circuit_test circuit_test.cpp)
+add_application(observable_test observable_test.cpp)
 
 if(QRMI_ROOT OR QISKIT_IBM_RUNTIME_C_ROOT)
-  add_application(sampler_test tests/sampler_test.cpp)
-  add_application(transpile_test tests/transpile_test.cpp)
+  add_application(sampler_test sampler_test.cpp)
+  add_application(transpile_test transpile_test.cpp)
 endif()
diff --git a/samples/circuit_test.cpp b/samples/circuit_test.cpp
diff --git a/samples/observable_test.cpp b/samples/observable_test.cpp
diff --git a/samples/sampler_test.cpp b/samples/sampler_test.cpp
diff --git a/samples/transpile_test.cpp b/samples/transpile_test.cpp
diff --git a/src/circuit/library/standard_gates/i.hpp b/src/circuit/library/standard_gates/i.hpp
@@ -29,7 +29,7 @@ class IGate : public Instruction {
 public:
     IGate(void)
     {
-        name_ = "i";
+        name_ = "id";
         num_qubits_ = 1;
         num_clbits_ = 0;
         map_ = QkGate_I;
diff --git a/src/circuit/library/standard_gates/standard_gates.hpp b/src/circuit/library/standard_gates/standard_gates.hpp
@@ -57,7 +57,7 @@ std::unordered_map<std::string, Instruction> get_standard_gate_name_mapping(void
     std::unordered_map<std::string, Instruction> name_mapping;
     name_mapping["global_phase"] = GlobalPhaseGate();
     name_mapping["h"] = HGate();
-    name_mapping["i"] = IGate();
+    name_mapping["id"] = IGate();
     name_mapping["x"] = XGate();
     name_mapping["y"] = YGate();
     name_mapping["z"] = ZGate();
@@ -105,7 +105,7 @@ std::unordered_map<std::string, Instruction> get_standard_gate_name_mapping(void
     name_mapping["cswap"] = CSwapGate();
     name_mapping["rccx"] = RCCXGate();
     name_mapping["mcx"] = MCXGate();
-    name_mapping["c3sx"] = C3XGate();
+    name_mapping["c3sx"] = C3SXGate();
     name_mapping["rcccx"] = RC3XGate();
     return name_mapping;
 }
diff --git a/src/circuit/quantumcircuit_impl.hpp b/src/circuit/quantumcircuit_impl.hpp
@@ -1122,12 +1122,27 @@ CircuitInstruction QuantumCircuit::operator[](uint_t i)
         auto name_map = get_standard_gate_name_mapping();
         QkCircuitInstruction *op = new QkCircuitInstruction;
         qk_circuit_get_instruction(rust_circuit_.get(), i, op);
-        reg_t qubits(op->qubits, op->qubits + op->num_qubits);
-        reg_t clbits(op->clbits, op->qubits + op->num_clbits);
-        std::vector<double> params(op->params, op->params + op->num_params);
+        reg_t qubits;
+        if (op->num_qubits > 0) {
+            qubits.resize(op->num_qubits);
+            for (int i = 0; i < op->num_qubits; i++)
+                qubits[i] = op->qubits[i];
+        }
+        std::vector<double> params;
+        if (op->num_params > 0) {
+            params.resize(op->num_params);
+            for (int i = 0; i < op->num_params; i++)
+                params[i] = op->params[i];
+        }
         auto gate = name_map.find(op->name);
         if (gate == name_map.end())
         {
+            reg_t clbits;
+            if (op->num_clbits > 0) {
+                clbits.resize(op->num_clbits);
+                for (int i = 0; i < op->num_clbits; i++)
+                    clbits[i] = op->clbits[i];
+            }
             if (strcmp(op->name, "measure") == 0)
             {
                 qk_circuit_instruction_clear(op);
diff --git a/src/quantum_info/sparse_observable.hpp b/src/quantum_info/sparse_observable.hpp
@@ -37,7 +37,7 @@ class SparseObservable
     {
         obs_ = nullptr;
     }
-    SparseObservable(uint_t num_qubits, std::vector<std::complex<double>> &coeffs, std::vector<QkBitTerm> &terms, reg_t &indicies, reg_t &boundaries);
+    SparseObservable(uint_t num_qubits, std::vector<std::complex<double>> &coeffs, std::vector<QkBitTerm> &terms, reg_t &indicies, std::vector<size_t> &boundaries);
     SparseObservable(const SparseObservable &other);
 
     ~SparseObservable()
@@ -146,7 +146,7 @@ class SparseObservable
     std::string to_string(void);
 };
 
-SparseObservable::SparseObservable(uint_t num_qubits, std::vector<std::complex<double>> &coeffs, std::vector<QkBitTerm> &bits, reg_t &indicies, reg_t &boundaries)
+SparseObservable::SparseObservable(uint_t num_qubits, std::vector<std::complex<double>> &coeffs, std::vector<QkBitTerm> &bits, reg_t &indicies, std::vector<size_t> &boundaries)
 {
     std::vector<std::uint32_t> idx32(indicies.size());
     for (int i = 0; i < indicies.size(); i++)
@@ -204,7 +204,7 @@ SparseObservable SparseObservable::compose(SparseObservable &other)
 SparseObservable SparseObservable::from_label(std::string &label)
 {
     reg_t indices;
-    reg_t boundaries(2);
+    std::vector<size_t> boundaries(2);
     uint_t num_qubits = label.length();
     std::vector<QkBitTerm> terms;
     std::vector<std::complex<double>> coeff(1);
@@ -255,7 +255,7 @@ SparseObservable SparseObservable::from_label(std::string &label)
 SparseObservable SparseObservable::from_list(std::vector<std::pair<std::string, std::complex<double>>> &list, uint_t num_qubits_in)
 {
     reg_t indices;
-    reg_t boundaries;
+    std::vector<size_t> boundaries;
     uint_t num_qubits = num_qubits_in;
     std::vector<QkBitTerm> terms;
     std::vector<std::complex<double>> coeffs;
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -0,0 +1,70 @@
+# This file is inspired by the description of handling a larger number of tests
+# provided here:
+# https://cmake.org/cmake/help/book/mastering-cmake/chapter/Testing%20With%20CMake%20and%20CTest.html
+cmake_minimum_required (VERSION 3.27)
+
+set(CMAKE_CXX_STANDARD 11)
+
+# The C API is provided by the qiskit_cext Rust crate. Its header gets
+# generated by cbindgen (see `make cheader`).
+find_library (qiskit qiskit_cext PATHS deps/qiskit/target/release REQUIRED)
+
+# All files in this directory (non-recursively! use GLOB_RECURSE if that becomes
+# necessary) which match the pattern `test_*.cpp` are discovered as test files by
+# the command below. All paths are stored relative to the location of this file.
+file (
+    GLOB discovered_tests
+    LIST_DIRECTORIES FALSE
+    RELATIVE ${CMAKE_CURRENT_SOURCE_DIR}
+    test_*.cpp
+)
+
+# install nlohmann/json
+include(FetchContent)
+FetchContent_Declare(json URL https://github.com/nlohmann/json/releases/download/v3.12.0/json.tar.xz)
+FetchContent_MakeAvailable(json)
+
+# The following creates a test driver program which gathers all discovered test
+# files into a single executable. This has the benefit that a single test
+# executable is built and run rather than invididual ones for every individual
+# test file.
+create_test_sourcelist (source_files test_driver.c ${discovered_tests})
+
+add_library(common STATIC common.c)
+# Actually define the test driver program executable to be built...
+add_executable (test_driver ${source_files})
+# ...include the location of the header file...
+target_include_directories (test_driver PRIVATE ${CMAKE_SOURCE_DIR} nlohmann_json::nlohmann_json ../src deps/qiskit/dist/c/include)
+# ...and linked with the qiskit library.
+target_link_libraries (test_driver ${qiskit} common nlohmann_json::nlohmann_json)
+
+# On MSVC we need to link the Python dll, we search it here and adjust the PATH in the tests below
+if (MSVC)
+    # Store the directory where the qiskit_cext.dll is located.
+    get_filename_component(qiskit_dll_dir ${qiskit} DIRECTORY)
+    find_package(Python REQUIRED Interpreter Development)
+endif ()
+
+enable_testing()
+
+# Finally, we must define each test to be executed through `ctest` which we do
+# by iterating over all discovered tests and registering it for execution.
+foreach (test ${discovered_tests})
+    # NOTE: the following enforces that every test filename contains its main
+    # test logic in a function with the same name (minus the extension)
+    get_filename_component (test_name ${test} NAME_WE)
+
+    # The way that a test gets executed through the driver program is by
+    # providing the test name as the only argument.
+    add_test (
+        NAME ${test_name}
+        COMMAND test_driver ${test_name}
+    )
+
+    # add Python dll to the PATH of the tests
+    if (MSVC)
+        set_tests_properties(
+            ${test_name} PROPERTIES ENVIRONMENT "PATH=%PATH%\;${qiskit_dll_dir}\;${Python_RUNTIME_LIBRARY_DIRS}"
+        )
+    endif ()
+endforeach ()
diff --git a/test/Makefile b/test/Makefile
@@ -0,0 +1,28 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+DIR_TEST_BUILD = build
+
+default:
+	$(MAKE) -C deps/qiskit c
+
+	# -S specifically specifies the source path to be the current folder
+	# -B specifically specifies the build path to be inside test/c/build
+	cmake -S. -B$(DIR_TEST_BUILD)
+	cmake --build $(DIR_TEST_BUILD)
+	# -V ensures we always produce a logging output to indicate the subtests
+	# -C Debug is needed for windows to work, if you don't specify Debug (or
+	#  release) explicitly ctest doesn't run on windows
+	ctest -V -C Debug --test-dir $(DIR_TEST_BUILD)
+
+clean:
+	rm -rf $(DIR_TEST_BUILD)
diff --git a/test/common.c b/test/common.c
@@ -0,0 +1,39 @@
+// This code is part of Qiskit.
+//
+// (C) Copyright IBM 2024.
+//
+// This code is licensed under the Apache License, Version 2.0. You may
+// obtain a copy of this license in the LICENSE.txt file in the root directory
+// of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+//
+// Any modifications or derivative works of this code must retain this
+// copyright notice, and modified files need to carry a notice indicating
+// that they have been altered from the originals.
+
+#include "common.h"
+#include <stdio.h>
+#include <string.h>
+
+// A function to run a test function of a given name. This function will also
+// post-process the returned `TestResult` to product a minimal info message for
+// the developer running the test suite.
+int run(const char *name, int (*test_function)(void)) {
+    // TODO: we could consider to change the return value of our test functions
+    // to be a struct containing the integer return value and a custom error
+    // message which could then be included below.
+    int result = test_function();
+    int did_fail = 1;
+    char *msg;
+    if (result == Ok) {
+        did_fail = 0;
+        msg = "Ok";
+    } else if (result == EqualityError) {
+        msg = "FAILED with an EqualityError";
+    } else {
+        msg = "FAILED with unknown error";
+    }
+    fprintf(stderr, "--- %-30s: %s\n", name, msg);
+    fflush(stderr);
+
+    return did_fail;
+}
diff --git a/test/common.h b/test/common.h
@@ -0,0 +1,32 @@
+// This code is part of Qiskit.
+//
+// (C) Copyright IBM 2024.
+//
+// This code is licensed under the Apache License, Version 2.0. You may
+// obtain a copy of this license in the LICENSE.txt file in the root directory
+// of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+//
+// Any modifications or derivative works of this code must retain this
+// copyright notice, and modified files need to carry a notice indicating
+// that they have been altered from the originals.
+
+#include <stdio.h>
+
+// An enumeration of test results. These should be returned by test functions to
+// indicate what kind of error occurred. This will be used to produce more
+// helpful messages for the developer running the test suite.
+enum TestResult {
+    Ok,
+    EqualityError,
+    RuntimeError,
+    NullptrError, // an unexpected null pointer
+};
+
+// A macro for running a test function. This calls the run function below with
+// the provided function and its name.
+#define RUN_TEST(f) run(#f, f)
+
+// A function to run a test function of a given name. This function will also
+// post-process the returned `TestResult` to product a minimal info message for
+// the developer running the test suite.
+int run(const char *name, int (*test_function)(void));
diff --git a/test/test_circuit.cpp b/test/test_circuit.cpp

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ class IGate : public Instruction {`
`29`	`29`	`public:`
`30`	`30`	`IGate(void)`
`31`	`31`	`{`
`32`		`- name_ = "i";`
	`32`	`+ name_ = "id";`
`33`	`33`	`num_qubits_ = 1;`
`34`	`34`	`num_clbits_ = 0;`
`35`	`35`	`map_ = QkGate_I;`