test_notebooks.py

import os
from pathlib import Path
import shutil
import platform
import pytest


# Notebooks that we don't expect to execute successfully
# Notebook: reason
xfail_notebooks = {
    '00_python_basics_review.ipynb': 'intentional error',
    '01_functions_scripts.ipynb': 'intentional error',
    '06_matplotlib.ipynb': 'notebook intentionally incomplete',
    '00_python_basics_review__solutions.ipynb': 'intentional error',
    '01_functions_script__solution.ipynb': 'intentional error',
    '06-Project-structured.ipynb': 'intentionally incomplete information',
    '02-Building-Post-Processing-MODFLOW6.ipynb' : 'intentionally incomplete information'
    
    
}

# Notebooks that we expect to have issues with autotesting on specific
# platforms
# Notebook : (platforms,), reason
skip_notebooks = {
    "10_modpath_particle_tracking-demo.ipynb" : [("darwin"), "transient timeout"]
}

def included_notebooks():
    include = ['notebooks/part0_python_intro',
               'notebooks/part0_python_intro/solutions',
               'notebooks/part1_flopy/',
               'notebooks/part1_flopy/solutions'
               ]
    files = []
    for folder in include:
        files += sorted(list(Path(folder).glob('*.ipynb')))
    files_with_xfails = []
    for f in files:
        if f.name in xfail_notebooks:
            param_input = pytest.param(
                f, marks=pytest.mark.xfail(reason=xfail_notebooks[f.name]))
        elif f.name in skip_notebooks and \
                platform.system().lower() in skip_notebooks[f.name][0]:
            param_input = pytest.param(
                f, marks=pytest.mark.skip(reason=skip_notebooks[f.name][-1])
            )
        else:
            param_input = f
        files_with_xfails.append(param_input)
    return files_with_xfails


@pytest.fixture(params=included_notebooks(), scope='module')
def notebook(request):
    return request.param


@pytest.fixture(scope='module')
def testdir(request):
    outdir = os.path.join('tests/temp')
    if os.path.isdir(outdir):
        shutil.rmtree(outdir)
    os.mkdir(outdir)

    def teardown():
        if os.path.isdir(outdir):
            shutil.rmtree(outdir)
    request.addfinalizer(teardown)
    return outdir


def test_notebook(notebook, testdir):
    # run autotest on each notebook
    path, fname = os.path.split(notebook)
    
    cmd = ('jupyter ' + 'nbconvert '
           '--ExecutePreprocessor.timeout=600 '
           '--ExecutePreprocessor.kernel_name=python3 '
           '--to ' + 'notebook '
           f'--execute {notebook} '
           f'--output-dir {testdir} '
           f'--output {fname}')
    ival = os.system(cmd)
    assert ival == 0, f'could not run {fname}'