test_all_notebooks.py

"""This file is intended to be the target of a pytest run.

It will find all .ipynb files in the current directory, ignoring directories
which start with . and any files which match patterins found in the file
.testignore

Example .testignore pattern to ignore files in a directory:

    under_construction/*

Sample invocations of pytest which make the output nicely readable:

    pytest --verbose --durations=5 test.py

If you install pytest-xdist you can run tests in parallel with

    pytest --verbose --durations=5 -n 4 test.py

"""

import pathlib

import pytest

import nbformat
from nbconvert.preprocessors import ExecutePreprocessor, CellExecutionError

# Default search path is the current directory
searchpath = pathlib.Path('.')

# Read patterns from .testignore file
ignores = [line.strip() for line in open('.testignore') if line.strip()]

# Ignore hidden folders (startswith('.')) and files matching ignore patterns
notebooks = [notebook for notebook in searchpath.glob('**/*.ipynb')
             if not (any(parent.startswith('.')
                         for parent in notebook.parent.parts)
                     or any(notebook.match(pattern)
                            for pattern in ignores))]

notebooks.sort()
ids = [str(n) for n in notebooks]

@pytest.mark.parametrize("notebook", notebooks, ids=ids)
def test_run_notebook(notebook):
    """Read and execute notebook

    The method here is directly from the nbconvert docs

    Note that there is no error handling in this file as any errors will be
    caught by pytest

    """
    with open(notebook) as f:
        nb = nbformat.read(f, as_version=4)
    ep = ExecutePreprocessor(timeout=600)
    ep.preprocess(nb, {'metadata': {'path': notebook.parent}})