def test_check_root_structure(self):
"""Test check_root_structure method."""
tempdir = os.path.join(tempfile.mkdtemp(prefix='test_root'), 'rrr')
s = Store(root=tempdir, disposition='identity')
# No declaration
os.mkdir(tempdir)
s.open_root_fs()
self.assertRaises(StoreException, s.check_root_structure)
# Wrong declaration
decl = os.path.join(tempdir, '0=something_else')
with open(decl, 'w', encoding="utf-8") as fh:
fh.close()
self.assertRaises(StoreException, s.check_root_structure)
# Two declarations
decl2 = os.path.join(tempdir, '0=ocfl_1.0')
with open(decl2, 'w', encoding="utf-8") as fh:
fh.write("not correct")
fh.close()
self.assertRaises(StoreException, s.check_root_structure)
os.remove(decl)
# Right file, wrong content
self.assertRaises(StoreException, s.check_root_structure)
os.remove(decl2)
# All good
with open(decl2, 'w', encoding="utf-8") as fh:
fh.write("ocfl_1.0\n")
fh.close()
self.assertTrue(s.check_root_structure())
# Spec "file" a directory
os.mkdir(os.path.join(tempdir, "ocfl_1.0.txt"))
self.assertRaises(StoreException, s.check_root_structure)
def test_validate(self):
"""Test validate method."""
for root in [
'extra_fixtures/good-storage-roots/fedora-root',
'extra_fixtures/good-storage-roots/simple-root'
]:
s = Store(root=root)
self.assertTrue(s.validate())
def test_init(self):
"""Test Store init."""
s = Store()
self.assertEqual(s.root, None)
self.assertEqual(s.disposition, None)
s = Store(root='a', disposition='b')
self.assertEqual(s.root, 'a')
self.assertEqual(s.disposition, 'b')
def test_open_root_fs(self):
"""Test open_root_fs method."""
s = Store()
self.assertIs(s.root_fs, None)
tempdir = tempfile.mkdtemp(prefix='test_open_root_fs')
print(tempdir)
s.root = tempdir
s.open_root_fs()
self.assertIsNot(s.root_fs, None)
# Error - open without create, then succeed with create
rootdir = os.path.join(tempdir, 'xyz')
s = Store()
s.root = rootdir
self.assertRaises(StoreException, s.open_root_fs)
s.open_root_fs(create=True)
self.assertIsNot(s.root_fs, None)
def test_object_path(self):
"""Test object_path method."""
s = Store(root='x/y', disposition='identity')
self.assertEqual(s.object_path('id1'), 'id1')
s = Store(root='z/a', disposition='uuid_quadtree')
self.assertEqual(
s.object_path('urn:uuid:6ba7b810-9dad-11d1-80b4-00c04fd430c8'),
'6ba7/b810/9dad/11d1/80b4/00c0/4fd4/30c8')
def test07_check_root(self):
"""Test check_root method."""
tempdir = os.path.join(tempfile.mkdtemp(prefix='test_root'), 'rrr')
s = Store(root=tempdir, disposition='identity')
# Not present
self.assertRaises(StoreException, s.check_root)
# File not dir
with open(tempdir, 'w') as fh:
fh.close()
self.assertRaises(StoreException, s.check_root)
os.remove(tempdir)
# No declaration
os.mkdir(tempdir)
self.assertRaises(StoreException, s.check_root)
def test_initialize(self):
"""Test initialize method."""
tempdir = tempfile.mkdtemp(prefix='test_init')
s = Store(root=tempdir, disposition='identity')
self.assertRaises(StoreException, s.initialize)
tempdir = os.path.join(tempdir, 'aaa')
s = Store(root=tempdir, disposition='identity')
s.initialize()
self.assertTrue(os.path.isfile(os.path.join(tempdir, '0=ocfl_1.0')))
def test_parse_layout_file(self):
"""Test parse_layout_file method."""
s = Store(root="mem://")
s.open_root_fs(create=True)
self.assertEqual(s.parse_layout_file(), (None, None))
s.root_fs.writetext('ocfl_layout.json',
'{"extension": "aa", "description": "bb"}')
self.assertEqual(s.parse_layout_file(), ("aa", "bb"))
s.root_fs.writetext('ocfl_layout.json', '["aa", "bb"]')
self.assertRaises(StoreException, s.parse_layout_file)
s.root_fs.writetext('ocfl_layout.json',
'{"extension": "yy", "description": ["zz"]}')
self.assertRaises(StoreException, s.parse_layout_file)
s.root_fs.remove('ocfl_layout.json')
s.root_fs.makedir('ocfl_layout.json')
self.assertRaises(StoreException, s.parse_layout_file)
def test_object_paths(self):
"""Test object_paths generator."""
s = Store(root='extra_fixtures/good-storage-roots/fedora-root')
s.open_root_fs()
paths = list(s.object_paths())
self.assertEqual(len(paths), 176)
self.assertIn('61/38/37/3fede0e4-d168-475a-9b51-edbed6f0d972', paths)
# Error cases
log_io = io.StringIO()
logger = logging.getLogger()
logger.addHandler(logging.StreamHandler(log_io))
s = Store(
root='zip://extra_fixtures/bad-storage-roots/simple-bad-root.zip'
) # Using ZipFS
s.open_root_fs()
paths = list(s.object_paths())
self.assertEqual(len(paths), 2)
self.assertEqual(s.num_traversal_errors, 5)
log_out = log_io.getvalue()
self.assertIn("E073 - path='/empty_dir'", log_out)
self.assertIn("E003d - path='/object_multiple_declarations'", log_out)
self.assertIn("E004a - path='/object_unknown_version', version='0.9'",
log_out)
self.assertIn(
"E004b - path='/object_unrecognized_declaration', declaration='0=special_object_yeah'",
log_out)
self.assertIn("E072 - path='/dir_with_file_but_no_declaration'",
log_out)
# Specific error cases
s = Store(
root=
'extra_fixtures/bad-storage-roots/E072_root_with_file_not_in_object'
)
s.open_root_fs()
s.log = ValidationLogger()
self.assertEqual(list(s.object_paths()), ['dir2/minimal_no_content'])
self.assertEqual(s.num_traversal_errors, 1)
self.assertIn('E072', s.log.codes)
#
s = Store(
root=
'zip://extra_fixtures/bad-storage-roots/E073_root_with_empty_dir.zip'
)
s.open_root_fs()
s.log = ValidationLogger()
self.assertEqual(list(s.object_paths()), [])
self.assertEqual(s.num_traversal_errors, 1)
self.assertIn('E073', s.log.codes)
def test_traversal_error(self):
"""Test traversal_error method."""
s = Store()
self.assertEqual(s.num_traversal_errors, 0)
s.traversal_error("oops")
self.assertEqual(s.num_traversal_errors, 1)
def test_dispositor(self):
"""Test dispositor property."""
s = Store(root='x', disposition='identity')
self.assertTrue(isinstance(s.dispositor, Identity))
def test_validate(self):
"""Test validate method."""
s = Store(root='extra_fixtures/good-storage-roots/fedora-root')
self.assertTrue(s.validate())
self.assertEqual(s.num_objects, 176)
self.assertEqual(s.good_objects, 176)
# Simple case of three objects
s = Store(root='extra_fixtures/good-storage-roots/simple-root')
self.assertTrue(s.validate())
self.assertEqual(s.num_objects, 3)
self.assertEqual(s.good_objects, 3)
# Reg extension will not give warning
s = Store(
root='extra_fixtures/good-storage-roots/reg-extension-dir-root')
self.assertTrue(s.validate())
self.assertEqual(s.num_objects, 1)
self.assertEqual(s.good_objects, 1)
self.assertNotIn('W901', s.log.codes)
# Unreg extension will give warning
s = Store(
root='extra_fixtures/good-storage-roots/unreg-extension-dir-root')
self.assertTrue(s.validate())
self.assertEqual(s.num_objects, 1)
self.assertEqual(s.good_objects, 1)
self.assertIn('W901', s.log.codes)
def test_spec_file(self):
"""Test spec_file property."""
s = Store(root='thingy')
self.assertEqual(s.spec_file, 'thingy/ocfl_1.0.txt')
def test05_object_path(self):
"""Test object_path method."""
s = Store(root='x/y', disposition='identity')
self.assertEqual(s.object_path('id1'), 'x/y/id1')
def test03_disposition_file(self):
"""Test disposition_file property."""
s = Store(root='x', disposition='y')
self.assertEqual(s.disposition_file, 'x/1=y')
def test02_declaration_file(self):
"""Test declaration_file property."""
s = Store(root='')
self.assertEqual(s.declaration_file, '0=ocfl_1.0')
s.root = 'a/b/c'
self.assertEqual(s.declaration_file, 'a/b/c/0=ocfl_1.0')
def test_validate(self):
"""Test validate method."""
s = Store(root='extra_fixtures/good-storage-roots/fedora-root')
self.assertTrue(s.validate())
def test_object_paths(self):
"""Test object_paths generator."""
s = Store(root='extra_fixtures/good-storage-roots/fedora-root')
paths = list(s.object_paths())
self.assertEqual(len(paths), 176)
