def test_notebooks(notebook_path, base_env):
"""Ensures testing the notebooks in isolated virtual environments."""
tmpdir, proto_dir = base_env
notebook_file = os.path.basename(notebook_path)
dir_name = notebook_file.rstrip(".ipynb")
notebook_env = os.path.join(tmpdir, f"{dir_name}")
cmd = f"""
{proto_dir}/bin/virtualenv-clone {proto_dir} {notebook_env}
cd {notebook_env}
. ./bin/activate
papermill {notebook_path}"""
stdout, stderr, status = shell_tools.run_shell(
cmd=cmd,
log_run_to_stderr=False,
raise_on_fail=False,
out=shell_tools.TeeCapture(),
err=shell_tools.TeeCapture(),
)
if status != 0:
print(stdout)
print(stderr)
pytest.fail(f"Notebook failure: {notebook_file}")
def test_notebooks_against_released_cirq(notebook_path, base_env):
"""Tests the notebooks in isolated virtual environments."""
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"
tmpdir, proto_dir = base_env
notebook_file = os.path.basename(notebook_path)
dir_name = notebook_file.rstrip(".ipynb")
notebook_env = os.path.join(tmpdir, f"{dir_name}")
cmd = f"""
mkdir -p out/{notebook_rel_dir}
{proto_dir}/bin/virtualenv-clone {proto_dir} {notebook_env}
cd {notebook_env}
. ./bin/activate
papermill {notebook_path} {os.getcwd()}/{out_path}"""
_, stderr, status = shell_tools.run_shell(
cmd=cmd,
log_run_to_stderr=False,
raise_on_fail=False,
out=shell_tools.TeeCapture(),
err=shell_tools.TeeCapture(),
)
if status != 0:
print(stderr)
pytest.fail(
f"Notebook failure: {notebook_file}, please see {out_path} for the output "
f"notebook (in Github Actions, you can download it from the workflow artifact"
f" 'notebook-outputs')"
)
def test_notebooks_against_released_cirq(partition, notebook_path, base_env):
"""Tests the notebooks in isolated virtual environments.
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"
tmpdir, proto_dir = base_env
notebook_file = os.path.basename(notebook_path)
dir_name = notebook_file.rstrip(".ipynb")
notebook_env = os.path.join(tmpdir, f"{dir_name}")
rewritten_notebook_descriptor, rewritten_notebook_path = rewrite_notebook(
notebook_path)
cmd = f"""
mkdir -p out/{notebook_rel_dir}
{proto_dir}/bin/virtualenv-clone {proto_dir} {notebook_env}
cd {notebook_env}
. ./bin/activate
papermill {rewritten_notebook_path} {os.getcwd()}/{out_path}"""
_, stderr, status = shell_tools.run_shell(
cmd=cmd,
log_run_to_stderr=False,
raise_on_fail=False,
out=shell_tools.TeeCapture(),
err=shell_tools.TeeCapture(),
# important to get rid of PYTHONPATH specifically, which contains
# the Cirq repo path due to check/pytest
env={},
)
if status != 0:
print(stderr)
pytest.fail(
f"Notebook failure: {notebook_file}, please see {out_path} for the output "
f"notebook (in Github Actions, you can download it from the workflow artifact"
f" 'notebook-outputs'). \n"
f"If this is a new failure in this notebook due to a new change, "
f"that is only available in master for now, consider adding `pip install --pre cirq` "
f"instead of `pip install cirq` to this notebook, and exclude it from "
f"dev_tools/notebooks/isolated_notebook_test.py.")
if rewritten_notebook_descriptor:
os.close(rewritten_notebook_descriptor)
def run(
*,
script_file: str,
tmpdir_factory: '_pytest.tmpdir.TempdirFactory',
arg: str = '',
setup: str = '',
additional_intercepts: Iterable[str] = (),
) -> shell_tools.CommandOutput:
"""Invokes the given script within a temporary test environment."""
with open(script_file) as f:
script_lines = f.readlines()
# Create a unique temporary directory
dir_path = tmpdir_factory.mktemp('tmp', numbered=True)
file_path = os.path.join(dir_path, 'test-script.sh')
intercepted = [
'python',
'python3',
'pylint',
'pytest',
'mypy',
'black',
*additional_intercepts,
]
assert script_lines[0] == '#!/usr/bin/env bash\n'
for e in intercepted:
script_lines.insert(1, e + '() {\n echo INTERCEPTED ' + e + ' $@\n}\n')
with open(file_path, 'w') as f:
f.writelines(script_lines)
cmd = r"""
dir=$(git rev-parse --show-toplevel)
cd {}
git init --quiet --initial-branch master
git config --local user.name 'Me'
git config --local user.email '<>'
git commit -m init --allow-empty --quiet --no-gpg-sign
{}
mkdir -p dev_tools
touch dev_tools/pypath
chmod +x ./test-script.sh
./test-script.sh {}
""".format(
dir_path, setup, arg
)
return shell_tools.run_shell(
cmd=cmd,
log_run_to_stderr=False,
raise_on_fail=False,
out=shell_tools.TeeCapture(),
err=shell_tools.TeeCapture(),
)
def test_notebooks_against_released_cirq(notebook_path):
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"
cmd = f"""mkdir -p out/{notebook_rel_dir}
papermill {notebook_path} {out_path}"""
stdout, stderr, status = shell_tools.run_shell(
cmd=cmd,
log_run_to_stderr=False,
raise_on_fail=False,
out=shell_tools.TeeCapture(),
err=shell_tools.TeeCapture(),
)
if status != 0:
print(stderr)
pytest.fail(
f"Notebook failure: {notebook_file}, please see {out_path}")
def test_notebooks_against_released_cirq(notebook_path):
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"
cmd = f"""mkdir -p out/{notebook_rel_dir}
papermill {notebook_path} {out_path}"""
_, stderr, status = shell_tools.run_shell(
cmd=cmd,
log_run_to_stderr=False,
raise_on_fail=False,
out=shell_tools.TeeCapture(),
err=shell_tools.TeeCapture(),
)
if status != 0:
print(stderr)
pytest.fail(
f"Notebook failure: {notebook_file}, please see {out_path} for the output "
f"notebook (in Github Actions, you can download it from the workflow artifact"
f" 'notebook-outputs')")
def run(*,
script_file: str,
arg: str = '',
setup: str = '') -> shell_tools.CommandOutput:
"""Invokes the given script within a temporary test environment."""
with open(script_file) as f:
script_lines = f.readlines()
intercepted = [
'python',
'python2',
'python3',
'pylint',
'pytest',
'mypy',
]
assert script_lines[0] == '#!/usr/bin/env bash\n'
for e in intercepted:
script_lines.insert(1,
e + '() {\n echo INTERCEPTED ' + e + ' $@\n}\n')
with cirq.testing.TempDirectoryPath() as dir_path:
with open(os.path.join(dir_path, 'test-script'), 'w') as f:
f.writelines(script_lines)
cmd = r"""
dir=$(git rev-parse --show-toplevel)
cd {}
git init --quiet
git commit -m init --allow-empty --quiet --no-gpg-sign
{}
chmod +x ./test-script
./test-script {}
""".format(dir_path, setup, arg)
return shell_tools.run_shell(cmd=cmd,
log_run_to_stderr=False,
raise_on_fail=False,
out=shell_tools.TeeCapture(),
err=shell_tools.TeeCapture())
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"
rewritten_notebook_descriptor, rewritten_notebook_path = rewrite_notebook(notebook_path)
papermill_flags = "--no-request-save-on-cell-execute --autosave-cell-every 0"
cmd = f"""mkdir -p out/{notebook_rel_dir}
papermill {rewritten_notebook_path} {out_path} {papermill_flags}"""
_, stderr, status = shell_tools.run_shell(
cmd=cmd,
log_run_to_stderr=False,
raise_on_fail=False,
out=shell_tools.TeeCapture(),
err=shell_tools.TeeCapture(),
)
if status != 0:
print(stderr)
pytest.fail(
f"Notebook failure: {notebook_file}, please see {out_path} for the output "
f"notebook (in Github Actions, you can download it from the workflow artifact"
f" 'notebook-outputs')"
)
if rewritten_notebook_descriptor:
os.close(rewritten_notebook_descriptor)
def run_shell(*args, **kwargs):
return shell_tools.run_shell(*args, log_run_to_stderr=False, **kwargs)
def run_shell(*args, **kwargs):
return shell_tools.run_shell(*args, log_run_to_stderr=False, **kwargs)