def test_nb2(validator_name):
"""Test that a v2 notebook converted to current passes validation"""
set_validator(validator_name)
with TestsBase.fopen("test2.ipynb", "r") as f:
nb = read(f, as_version=4)
validate(nb)
assert isvalid(nb)
def test_nb4custom(validator_name):
"""Test that a notebook with a custom JSON mimetype passes validation"""
set_validator(validator_name)
with TestsBase.fopen("test4custom.ipynb", "r") as f:
nb = read(f, as_version=4)
validate(nb)
assert isvalid(nb)
def test_nb4_document_info(validator_name):
"""Test that a notebook with document_info passes validation"""
set_validator(validator_name)
with TestsBase.fopen("test4docinfo.ipynb", "r") as f:
nb = read(f, as_version=4)
validate(nb)
assert isvalid(nb)
def test_nb4jupyter_metadata_timings(validator_name):
"""Tests that a notebook with "timing" in metadata passes validation"""
set_validator(validator_name)
with TestsBase.fopen("test4jupyter_metadata_timings.ipynb", "r") as f:
nb = read(f, as_version=4)
validate(nb)
assert isvalid(nb)
def test_invalid_cell_id():
"""Test than an invalid cell id does not pass validation"""
with TestsBase.fopen("invalid_cell_id.ipynb", "r") as f:
nb = read(f, as_version=4)
with pytest.raises(ValidationError):
validate(nb)
assert not isvalid(nb)
def test_nb4(validator_name):
"""Test that a v4 notebook passes validation"""
set_validator(validator_name)
with TestsBase.fopen("test4.ipynb", "r") as f:
nb = read(f, as_version=4)
validate(nb)
assert isvalid(nb)
def test_repair_no_cell_ids():
"""Test that we will repair cells without ids if asked during validation"""
import nbformat
with TestsBase.fopen("v4_5_no_cell_id.ipynb", "r") as f:
# Avoids validate call from `.read`
nb = nbformat.from_dict(json.load(f))
validate(nb)
assert isvalid(nb)
def test_invalid_validator_raises_value_error_after_read():
"""Test that an invalid notebook with no version fails validation"""
set_validator("jsonschema")
with TestsBase.fopen("test2.ipynb", "r") as f:
nb = read(f, as_version=4)
set_validator("foobar")
with pytest.raises(ValueError):
validate(nb)
def test_future(validator_name):
"""Test that a notebook from the future with extra keys passes validation"""
set_validator(validator_name)
with TestsBase.fopen("test4plus.ipynb", "r") as f:
nb = read(f, as_version=4)
with pytest.raises(ValidationError):
validate(nb, version=4, version_minor=3)
assert not isvalid(nb, version=4, version_minor=3)
assert isvalid(nb)
def test_upgrade_downgrade_4_3_4(self):
"""Test that a v4 notebook downgraded to v3 and then upgraded to v4
passes validation tests"""
with self.fopen("test4.ipynb", "r") as f:
nb = read(f)
validate(nb)
nb = convert(nb, 3)
validate(nb)
nb = convert(nb, 4)
self.assertEqual(isvalid(nb), True)
def test_no_cell_ids():
"""Test that a cell without a cell ID does not pass validation"""
import nbformat
with TestsBase.fopen("v4_5_no_cell_id.ipynb", "r") as f:
# Avoids validate call from `.read`
nb = nbformat.from_dict(json.load(f))
with pytest.raises(ValidationError):
validate(nb, repair_duplicate_cell_ids=False)
# try again to verify that we didn't modify the content
with pytest.raises(ValidationError):
validate(nb, repair_duplicate_cell_ids=False)
def test_validation_error(validator_name):
set_validator(validator_name)
with TestsBase.fopen("invalid.ipynb", "r") as f:
nb = read(f, as_version=4)
with pytest.raises(ValidationError) as exception_info:
validate(nb)
s = str(exception_info.value)
assert re.compile(r"validating .required. in markdown_cell").search(s)
assert re.compile(r"source.* is a required property").search(s)
assert re.compile(r"On instance\[u?['\"].*cells['\"]\]\[0\]").search(s)
assert len(s.splitlines()) < 10
def test_invalid(validator_name):
"""Test than an invalid notebook does not pass validation"""
set_validator(validator_name)
# this notebook has a few different errors:
# - one cell is missing its source
# - invalid cell type
# - invalid output_type
with TestsBase.fopen("invalid.ipynb", "r") as f:
nb = read(f, as_version=4)
with pytest.raises(ValidationError):
validate(nb)
assert not isvalid(nb)
def is_valid_notebook(notebook_file):
with open(notebook_file) as myfile:
data = "".join(line for line in myfile)
try:
nb = reader_reads(data)
validate(nb)
return True
except ValidationError as e:
return False
except NotJSONError as e:
return False
def test_notebook_invalid_without_min_version():
with TestsBase.fopen("no_min_version.ipynb", "r") as f:
nb = read(f, as_version=4)
with pytest.raises(ValidationError):
validate(nb)
def validate4(obj, ref=None):
return validate(obj, ref, version=nbformat)
def test_validation_no_version(validator_name):
"""Test that an invalid notebook with no version fails validation"""
set_validator(validator_name)
with pytest.raises(ValidationError) as e:
validate({"invalid": "notebook"})
def test_validate_empty(validator_name):
"""Test that an empty notebook (invalid) fails validation"""
set_validator(validator_name)
with pytest.raises(ValidationError) as e:
validate({})
def validate4(obj, ref=None):
return validate(obj, ref, version=nbformat)
def test_strip_invalid_metadata():
with TestsBase.fopen("v4_5_invalid_metadata.ipynb", "r") as f:
nb = nbformat.from_dict(json.load(f))
assert not isvalid(nb)
validate(nb, strip_invalid_metadata=True)
assert isvalid(nb)
