Merge pull request #417 from bwheelz36/add_run_notebooks_test

Add run notebooks test

.github/workflows/run_tests.yml

@@ -1,7 +1,6 @@
 # This workflow will install Python dependencies, run tests and lint with a single version of Python
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-
 name: tests
 
 on:
@@ -27,14 +26,21 @@ jobs:
       uses: actions/setup-python@v3
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
+    - name: Install test dependencies
       run: |
         python -m pip install --upgrade pip
         pip install pytest
         pip install pytest-cov
         pip install coverage
+    - name: Install notebook dependencies
+      run: |
+        pip install nbformat
+        pip install nbconvert
+        pip install jupyter
+        pip install matplotlib
+    - name: Install package
+      run: |
         pip install -e .
-
     - name: Test with pytest
       run: |
         pytest --cov-report xml --cov=bayes_opt/

examples/basic-tour.ipynb

@@ -487,7 +487,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -501,7 +501,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.5.2"
+   "version": "3.9.6"
   }
  },
  "nbformat": 4,

tests/test_notebooks_run.py

@@ -0,0 +1,29 @@
+"""
+collect all notebooks in examples, and check that they run without error
+"""
+
+import nbformat
+from nbconvert.preprocessors import ExecutePreprocessor
+from pathlib import Path
+from glob import glob
+this_file_loc = Path(__file__).parent
+
+def check_notebook_runs(notebook_loc):
+
+    try:
+        with open(notebook_loc, encoding='utf8') as f:
+            nb = nbformat.read(f, as_version=4)
+        ep = ExecutePreprocessor(timeout=600, kernel_name='python3')
+        ep.preprocess(nb, {'metadata': {'path': Path(notebook_loc).parent}})
+    except Exception as e:
+        print(f'failed to run notebook {notebook_loc}: rethrowing exception:')
+        raise e
+
+def test_all_notebooks_run():
+    # get all notebooks:
+    notebooks = glob(str(this_file_loc.parent / 'examples' / '*.ipynb'))
+    notebooks_not_to_run = ['put_notebooks_to_skip_here']
+    for notebook in notebooks:
+        if any([nb in notebook for nb in notebooks_not_to_run]):
+            continue
+        check_notebook_runs(notebook)