Skip to content

Commit

Permalink
Add testing frameworks for notebooks, update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tharun571 authored and vgvassilev committed Jul 12, 2024
1 parent 4745f72 commit 7d20476
Show file tree
Hide file tree
Showing 5 changed files with 697 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ jobs:
shell: bash -l {0}
run: |
cd test
pytest -sv . --reruns 5
pytest -sv .
- name: Python tests Windows Systems
if: ${{ runner.os == 'windows' }}
Expand Down
5 changes: 3 additions & 2 deletions docs/source/debug.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ These steps are performed using the GNU Debugger (GDB), so ensure it is installe

.. code-block:: bash
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.
Expand All @@ -34,5 +35,5 @@ 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 `pytest -sv build/test/test_xcpp_kernel.py` to execute the python tests.
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.
2 changes: 2 additions & 0 deletions environment-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ dependencies:
# Test dependencies
- pytest
- jupyter_kernel_test>=0.5,<0.6
- papermill
- nbformat
- nbval
- pytest-rerunfailures
- doctest
Loading

0 comments on commit 7d20476

Please sign in to comment.