Debugging and Testing

Debugging

These steps are performed using the GNU Debugger (GDB), so ensure it is installed in your environment. Then execute the command to build the project.

cd build
cmake -D CMAKE_BUILD_TYPE=Debug -D CMAKE_PREFIX_PATH=$CONDA_PREFIX -D CMAKE_INSTALL_PREFIX=$CONDA_PREFIX -D CMAKE_INSTALL_LIBDIR=lib ..

In the same folder, run the command and copy the JSON displayed in the terminal.

xcpp

Save the JSON in a new file in any folder. Before proceeding to the next step, ensure that Jupyter Console is installed in the environment. Open a new terminal and run the command in the folder where the JSON file is located.

jupyter console --existing yourJSONFile.json

Open a new terminal, navigate to the build directory, and run GDB to start debugging.

gdb xcpp

Testing

The source code for the c++ tests is located in test/test_interpreter.cpp. The source code for the python tests is located in test/test_xcpp_kernel.py. Write the necessary tests and build the project as described in the repository’s README or contributing guidelines. Then, execute build/test/test_xeus_cpp from the top level directory to verify if the c++ tests were successful. and in the test directory run pytest -sv build/test/test_xcpp_kernel.py to execute the python tests.