class _TestBatonAccessControlMapper(unittest.TestCase):
"""
Tests for `_BatonAccessControlMapper`.
"""
@abstractmethod
def create_mapper(self) -> _BatonAccessControlMapper:
"""
Creates a mapper to test with.
:return: the created mapper
"""
@abstractmethod
def create_irods_entity(self, name: str, access_controls: Iterable[AccessControl]) -> IrodsEntity:
"""
Creates an iRODS entity to test with
:param name: the name of the entity to create
:param access_controls: the access controls the entity should have
:return: the created entity
"""
def setUp(self):
self.test_with_baton = TestWithBaton(baton_setup=BATON_SETUP)
self.test_with_baton.setup()
self.setup_helper = SetupHelper(self.test_with_baton.icommands_location)
self.mapper = self.create_mapper()
self.users = []
for username in _USERNAMES:
user = User(username, self.test_with_baton.irods_server.users[0].zone)
self.setup_helper.create_user(user.name, user.zone)
self.users.append(user)
self.access_controls = [AccessControl(self.users[0], AccessControl.Level.WRITE),
AccessControl(self.users[1], AccessControl.Level.READ)]
self.access_control = AccessControl(self.users[2], AccessControl.Level.OWN)
def tearDown(self):
self.test_with_baton.tear_down()
def test_get_all_with_invalid_path(self):
self.assertRaises(FileNotFoundError, self.mapper.get_all, "/invalid")
def test_get_all_with_no_paths(self):
self.assertEqual(self.mapper.get_all([]), [])
def test_get_all_with_single_path(self):
entity = self.create_irods_entity(NAMES[0], self.access_controls)
self.assertEqual(self.mapper.get_all(entity.path), set(self.access_controls))
def test_get_all_with_multiple_path(self):
entity_1 = self.create_irods_entity(NAMES[0], self.access_controls)
entity_2 = self.create_irods_entity(NAMES[1], [self.access_control])
entity_3 = self.create_irods_entity(NAMES[2], [])
self.assertEqual(self.mapper.get_all([entity_1.path, entity_2.path, entity_3.path]),
[set(self.access_controls), {self.access_control}, set()])
def test_add_or_replace_with_invalid_path(self):
self.assertRaises(FileNotFoundError, self.mapper.add_or_replace, "/invalid", self.access_controls)
def test_add_or_replace_with_no_paths(self):
self.mapper.add_or_replace([], self.access_controls[0])
def test_add_or_replace_single_access_control(self):
entity = self.create_irods_entity(NAMES[0], [self.access_control])
self.mapper.add_or_replace(entity.path, self.access_controls[0])
self.assertCountEqual(self.mapper.get_all(entity.path), [self.access_control, self.access_controls[0]])
def test_add_or_replace_single_access_control_when_already_exists(self):
entity = self.create_irods_entity(NAMES[0], [self.access_control])
self.mapper.add_or_replace(entity.path, self.access_control)
self.assertEqual(self.mapper.get_all(entity.path), {self.access_control})
def test_add_or_replace_multiple_access_controls(self):
entity = self.create_irods_entity(NAMES[0], [self.access_control])
self.mapper.add_or_replace(entity.path, self.access_controls)
self.assertCountEqual(self.mapper.get_all(entity.path), [self.access_control] + self.access_controls)
def test_add_or_replace_multiple_access_controls_when_one_access_control_already_exists(self):
entity = self.create_irods_entity(NAMES[0], [self.access_control])
self.mapper.add_or_replace(entity.path, self.access_controls + [self.access_control])
self.assertEqual(self.mapper.get_all(entity.path), set(self.access_controls + [self.access_control]))
def test_set_with_invalid_path(self):
self.assertRaises(FileNotFoundError, self.mapper.set, "/invalid", self.access_controls)
def test_set_with_no_paths(self):
self.mapper.set([], self.access_controls)
def test_set_when_no_existing_access_controls(self):
entity = self.create_irods_entity(NAMES[0], ())
self.mapper.set(entity.path, self.access_controls)
self.assertEqual(self.mapper.get_all(entity.path), set(self.access_controls))
def test_set_when_existing_non_duplicate_access_controls(self):
entity = self.create_irods_entity(NAMES[0], [self.access_control])
self.mapper.set(entity.path, self.access_controls)
self.assertEqual(self.mapper.get_all(entity.path), set(self.access_controls))
def test_set_when_existing_duplicate_access_controls(self):
entity = self.create_irods_entity(NAMES[0], self.access_controls)
self.mapper.set(entity.path, self.access_controls)
self.assertEqual(self.mapper.get_all(entity.path), set(self.access_controls))
def test_revoke_with_invalid_path(self):
self.assertRaises(FileNotFoundError, self.mapper.revoke, "/invalid", self.access_control.user)
def test_revoke_with_no_paths(self):
self.mapper.revoke([], self.access_control.user)
def test_revoke_unset_access_control(self):
entity = self.create_irods_entity(NAMES[0], ())
self.mapper.revoke(entity.path, self.access_control.user)
self.assertEqual(self.mapper.get_all(entity.path), set())
def test_revoke_subset_of_access_controls(self):
entity = self.create_irods_entity(NAMES[0], self.access_controls + [self.access_control])
self.mapper.revoke(entity.path, [access_control.user for access_control in self.access_controls])
self.assertEqual(self.mapper.get_all(entity.path), {self.access_control})
def test_revoke_access_controls_using_string_representation_of_user(self):
entity = self.create_irods_entity(NAMES[0], [self.access_control])
self.mapper.revoke(entity.path, [str(self.access_control.user)])
self.assertEqual(self.mapper.get_all(entity.path), set())
def test_revoke_all_with_invalid_path(self):
self.assertRaises(FileNotFoundError, self.mapper.revoke_all, "/invalid")
def test_revoke_all_with_no_paths(self):
self.mapper.revoke_all([])
def test_revoke_all_with_single_path_and_no_access_controls(self):
entity = self.create_irods_entity(NAMES[0], ())
self.mapper.revoke_all(entity.path)
self.assertEqual(self.mapper.get_all(entity.path), set())
def test_revoke_all_with_single_path(self):
entity = self.create_irods_entity(NAMES[0], self.access_controls)
self.mapper.revoke_all(entity.path)
self.assertEqual(self.mapper.get_all(entity.path), set())
def test_revoke_all_with_multiple_paths(self):
entities = [self.create_irods_entity(name, self.access_controls) for name in NAMES]
paths = [entity.path for entity in entities]
self.mapper.revoke_all(paths)
self.assertEqual(self.mapper.get_all(paths), [set() for _ in range(len(paths))])
