def _list_changed_notebooks() -> Set[str]:
try:
rev = _find_base_revision()
output = subprocess.check_output(f'git diff --diff-filter=d --name-only {rev}'.split())
lines = output.decode('utf-8').splitlines()
# run all tests if this file or any of the dev tool dependencies change
if any(
l
for l in lines
if l.endswith("isolated_notebook_test.py") or l.startswith("dev_tools/requirements")
):
return list_all_notebooks()
return set(l for l in lines if l.endswith(".ipynb"))
except ValueError as e:
# It would be nicer if we could somehow automatically skip the execution of this completely,
# however, in order to be able to rely on parallel pytest (xdist) we need parametrization to
# work, thus this will be executed during the collection phase even when the notebook tests
# are not included (the "-m slow" flag is not passed to pytest). So, in order to not break
# the complete test collection phase in other tests where there is no git history
# (fetch-depth:1), we'll just swallow the error here with a warning.
warnings.warn(
f"No changed notebooks are tested "
f"(this is expected in non-notebook tests in CI): {e}"
)
return set()
# skipping vendor notebooks as we don't have auth sorted out
"**/aqt/*.ipynb",
"**/ionq/*.ipynb",
"**/google/*.ipynb",
"**/pasqal/*.ipynb",
# skipping fidelity estimation due to
# https://github.com/quantumlib/Cirq/issues/3502
"examples/*fidelity*",
# chemistry.ipynb requires openfermion, that installs cirq 0.9.1, which interferes
# with testing cirq itself...
'docs/tutorials/educators/chemistry.ipynb',
]
@pytest.mark.slow
@pytest.mark.parametrize("notebook_path", filter_notebooks(list_all_notebooks(), SKIP_NOTEBOOKS))
def test_notebooks_against_released_cirq(notebook_path):
"""Test that jupyter notebooks execute.
In order to speed up the execution of these tests an auxiliary file may be supplied which
performs substitutions on the notebook to make it faster.
Specifically for a notebook file notebook.ipynb, one can supply a file notebook.tst which
contains the substitutes. The substitutions are provide in the form `pattern->replacement`
where the pattern is what is matched and replaced. While the pattern is compiled as a
regular expression, it is considered best practice to not use complicated regular expressions.
Lines in this file that do not have `->` are ignored.
"""
notebook_file = os.path.basename(notebook_path)
notebook_rel_dir = os.path.dirname(os.path.relpath(notebook_path, "."))
out_path = f"out/{notebook_rel_dir}/{notebook_file[:-6]}.out.ipynb"
"**/aqt/*.ipynb",
"**/ionq/*.ipynb",
"**/google/*.ipynb",
"**/pasqal/*.ipynb",
# skipping fidelity estimation due to
# https://github.com/quantumlib/Cirq/issues/3502
"examples/*fidelity*",
# chemistry.ipynb requires openfermion, that installs cirq 0.9.1, which interferes
# with testing cirq itself...
'docs/tutorials/educators/chemistry.ipynb',
]
@pytest.mark.slow
@pytest.mark.parametrize("notebook_path",
filter_notebooks(list_all_notebooks(),
SKIP_NOTEBOOKS))
def test_notebooks_against_released_cirq(notebook_path):
"""Test that jupyter notebooks execute.
In order to speed up the execution of these tests an auxiliary file may be supplied which
performs substitutions on the notebook to make it faster.
Specifically for a notebook file notebook.ipynb, one can supply a file notebook.tst which
contains the substitutes. The substitutions are provide in the form `pattern->replacement`
where the pattern is what is matched and replaced. While the pattern is compiled as a
regular expression, it is considered best practice to not use complicated regular expressions.
Lines in this file that do not have `->` are ignored.
"""
notebook_file = os.path.basename(notebook_path)
notebook_rel_dir = os.path.dirname(os.path.relpath(notebook_path, "."))