def test_list_with_limit_and_offset(self):
with session.make_session_for_existing_admin() as admin:
try:
file_count = 10
dir_name = 'test_list_collection_directory'
lib.make_large_local_tmp_dir(dir_name, file_count, 1024)
admin.assert_icommand(['iput', '-r', dir_name], 'STDOUT_SINGLELINE', 'Running')
admin.assert_icommand(['ils', '-l', '-r'], 'STDOUT_SINGLELINE', dir_name)
pwd, _ = lib.execute_command(['ipwd'])
pwd = pwd.rstrip()
logical_path = os.path.join(pwd, dir_name)
token = irods_rest.authenticate('rods', 'rods', 'native')
offset = 0
for i in range(1,10):
result = irods_rest.list(token, logical_path, 'false', 'false', 'false', offset, 1)
lst = json.loads(result)
assert(len(lst['_embedded']) == 1)
fn = 'junk000' + str(offset)
lp = lst['_embedded'][0]['logical_path']
print(fn+' vs '+lp)
assert(lp.find(fn) != -1)
offset = offset + 1
finally:
shutil.rmtree(dir_name)
admin.assert_icommand(['irm', '-f', '-r', dir_name])
def test_query_with_distinct_search_option_set_to_zero__issue_71(self):
with session.make_session_for_existing_admin() as admin:
other_resc = 'other_resc_71'
data_object = 'foo.issue_71'
try:
lib.create_ufs_resource(other_resc, admin)
admin.assert_icommand(['itouch', '-R', 'demoResc', data_object])
admin.assert_icommand(['irepl', '-R', other_resc, data_object])
admin.assert_icommand(['ils', '-l', data_object], 'STDOUT', [' 0 demoResc', ' 1 ' + other_resc])
token = irods_rest.authenticate(admin.username, admin.password, 'native')
# Search for data object. The no-distinct option should result in
# two rows being returned. One for each replica.
gql = "SELECT DATA_NAME WHERE DATA_NAME = '{0}'".format(data_object)
result = irods_rest.query(token, gql, 100, 0, 'general', _distinct='0')
print('*****************\n')
print(result)
print('*****************\n')
res = json.loads(result)
self.assertEqual(len(res['_embedded']), 2)
rows = res['_embedded']
self.assertEqual(rows[0][0], data_object)
self.assertEqual(rows[1][0], data_object)
finally:
admin.run_icommand(['irm', '-f', data_object])
admin.run_icommand(['iadmin', 'rmresc', other_resc])
def test_put_configuration(self):
file1 = "/etc/irods/test_rest_cfg_put_1.json"
file2 = "/etc/irods/test_rest_cfg_put_2.json"
# clean up
if os.path.exists(file1):
os.remove(file1)
if os.path.exists(file2):
os.remove(file2)
cfg = "%5B%7B%22file_name%22%3A%22test_rest_cfg_put_1.json%22%2C%20%22contents%22%3A%7B%22key0%22%3A%22value0%22%2C%22key1%22%20%3A%20%22value1%22%7D%7D%2C%7B%22file_name%22%3A%22test_rest_cfg_put_2.json%22%2C%22contents%22%3A%7B%22key2%22%20%3A%20%22value2%22%2C%22key3%22%20%3A%20%22value3%22%7D%7D%5D"
token = irods_rest.authenticate('rods', 'rods', 'native')
# put config files
irods_rest.put_configuration(token, cfg)
# config files should exist
assert(os.path.exists(file1))
assert(os.path.exists(file2))
# confirm contents for file1
with open(file1) as f:
data = json.load(f)
assert(data['key0'] == 'value0')
assert(data['key1'] == 'value1')
# confirm contents for file2
with open(file2) as f:
data = json.load(f)
assert(data['key2'] == 'value2')
assert(data['key3'] == 'value3')
# clean up /etc/irods
os.remove(file1)
os.remove(file2)
def test_list(self):
with session.make_session_for_existing_admin() as admin:
try:
file_count = 10
dir_name = 'test_list_collection_directory'
lib.make_large_local_tmp_dir(dir_name, file_count, 1024)
admin.assert_icommand(['iput', '-r', dir_name], 'STDOUT_SINGLELINE', 'Running')
admin.assert_icommand(['ils', '-l', '-r'], 'STDOUT_SINGLELINE', dir_name)
pwd, _ = lib.execute_command(['ipwd'])
pwd = pwd.rstrip()
logical_path = os.path.join(pwd, dir_name)
token = irods_rest.authenticate('rods', 'rods', 'native')
result = irods_rest.list(token, logical_path, 'false', 'false', 'false', 0, 100)
cnt = 0
lst = json.loads(result)
for entry in lst['_embedded']:
lp = entry['logical_path']
print(lp)
assert(lp.find('junk') != -1)
cnt = cnt + 1
assert(file_count == cnt)
finally:
shutil.rmtree(dir_name)
admin.assert_icommand(['irm', '-f', '-r', dir_name])
def test_stream_put_and_get(self):
with session.make_session_for_existing_admin() as admin:
try:
file_name = 'stream_put_and_get_file'
downloaded_file_name = file_name + '2'
with open(file_name, 'w') as f:
f.write('This is some test data. This is only a test.')
pwd, _ = lib.execute_command(['ipwd'])
pwd = pwd.rstrip()
logical_path = os.path.join(pwd, file_name)
token = irods_rest.authenticate('rods', 'rods', 'native')
irods_rest.put(token, file_name, logical_path)
admin.assert_icommand(['ils', '-l'], 'STDOUT_SINGLELINE', file_name)
irods_rest.get(token, downloaded_file_name, logical_path)
sz = os.path.getsize(file_name)
sz2 = os.path.getsize(downloaded_file_name)
print(str(sz) + ' vs ' + str(sz2))
assert(sz == sz2)
finally:
os.remove(file_name)
os.remove(downloaded_file_name)
admin.assert_icommand(['irm', '-f', file_name])
def test_query_with_case_sensitive_search_option_set_to_zero__issue_71(self):
with session.make_session_for_existing_admin() as admin:
pwd, _ = lib.execute_command(['ipwd'])
pwd = pwd.rstrip()
collection = os.path.join(pwd, 'test_query_with_case_sensitive_search_option_set_to_zero__issue_71')
try:
admin.assert_icommand(['imkdir', collection])
token = irods_rest.authenticate(admin.username, admin.password, 'native')
# Search for newly created collection using the case-sensitive search option.
gql = "SELECT COLL_NAME WHERE COLL_NAME = '{0}'".format(collection.upper())
result = irods_rest.query(token, gql, 1, 0, 'general', _case_sensitive='0')
print('*****************\n')
print(result)
print('*****************\n')
res = json.loads(result)
self.assertEqual(len(res['_embedded']), 1)
arr = res['_embedded'][0]
self.assertEqual(arr[0], collection)
finally:
admin.assert_icommand(['irmdir', collection])
def test_query_returns_error_on_invalid_options__issue_71(self):
with session.make_session_for_existing_admin() as admin:
token = irods_rest.authenticate(admin.username, admin.password, 'native')
result = irods_rest.query(token, 'select COLL_NAME', 1, 0, 'general', _case_sensitive='nopes')
self.assertIn('error', result)
result = irods_rest.query(token, 'select COLL_NAME', 1, 0, 'general', _distinct='nopes')
self.assertIn('error', result)
def test_zone_report(self):
with session.make_session_for_existing_admin() as admin:
zr0, _ = lib.execute_command(['izonereport'])
js0 = json.loads(zr0)
token = irods_rest.authenticate('rods', 'rods', 'native')
zr1 = irods_rest.zone_report(token)
js1 = json.loads(zr1)
assert(js0 == js1)
def test_access_with_explicit_arguments(self):
with session.make_session_for_existing_admin() as admin:
try:
file_name = 'test_access_object'
lib.make_file(file_name, 1024)
admin.assert_icommand(['iput', file_name])
admin.assert_icommand(['ils', '-l'], 'STDOUT_SINGLELINE', file_name)
pwd, _ = lib.execute_command(['ipwd'])
pwd = pwd.rstrip()
logical_path = os.path.join(pwd, file_name)
token = irods_rest.authenticate('rods', 'rods', 'native')
# The settings for the ticket.
ticket_type = 'write'
use_count = 50
write_file_count = 100
write_byte_count = 9999
seconds_until_expiration = 45
users = 'rods'
groups = 'rodsadmin'
hosts = 'irods.org'
json_string = irods_rest.access(token, logical_path, ticket_type, use_count,
write_file_count, write_byte_count, seconds_until_expiration,
users, groups, hosts)
json_object = json.loads(json_string)
ticket_id = json_object['headers']['irods-ticket'][0]
# Verify that the properties for the ticket are what we expect.
_, out, _ = admin.assert_icommand(['iticket', 'ls', ticket_id], 'STDOUT', [
'ticket type: ' + ticket_type,
'uses limit: ' + str(use_count),
'write file limit: ' + str(write_file_count),
'write byte limit: ' + str(write_byte_count),
'restricted-to user: '******'restricted-to group: ' + str(groups)
])
# Expiration time and host restrictions must be checked separately because the
# values for these fields are non-deterministic. The best we can do is show that
# the values did change.
self.assertNotIn('expire time: none', out)
self.assertNotIn('No host restrictions', out)
self.assertIn('restricted-to host: ', out)
admin.assert_icommand(['iticket', 'delete', ticket_id])
finally:
os.remove(file_name)
admin.assert_icommand(['irm', '-f', file_name])
def test_query_with_limit_and_offset(self):
with session.make_session_for_existing_admin() as admin:
try:
file_count = 10
dir_name = 'test_query_collection_directory'
lib.make_large_local_tmp_dir(dir_name, file_count, 1024)
admin.assert_icommand(['iput', '-r', dir_name],
'STDOUT_SINGLELINE', 'Running')
admin.assert_icommand(['ils', '-l', '-r'], 'STDOUT_SINGLELINE',
dir_name)
pwd, _ = lib.execute_command(['ipwd'])
pwd = pwd.rstrip()
logical_path = os.path.join(pwd, dir_name)
token = irods_rest.authenticate('rods', 'rods', 'native')
query = "SELECT COLL_NAME, DATA_NAME WHERE COLL_NAME = '" + logical_path + "'"
offset = 0
for i in range(1, 10):
fn = 'junk000' + str(offset)
result = irods_rest.query(token, query, 1, offset,
'general')
print('*****************\n')
print(result)
print('*****************\n')
res = json.loads(result)
assert (len(res['_embedded']) == 1)
arr = res['_embedded'][0]
assert (arr[0] == logical_path)
assert (arr[1] == fn)
offset = offset + 1
finally:
shutil.rmtree(dir_name)
admin.assert_icommand(['irm', '-f', '-r', dir_name])
def test_access(self):
with session.make_session_for_existing_admin() as admin:
try:
file_name = 'test_access_object'
lib.make_file(file_name, 1024)
admin.assert_icommand(['iput', file_name])
admin.assert_icommand(['ils', '-l'], 'STDOUT_SINGLELINE',
file_name)
pwd, _ = lib.execute_command(['ipwd'])
pwd = pwd.rstrip()
logical_path = os.path.join(pwd, file_name)
token = irods_rest.authenticate('rods', 'rods', 'native')
result = irods_rest.access(token, logical_path)
assert (result.find('error') == -1)
finally:
os.remove(file_name)
admin.assert_icommand(['irm', '-f', file_name])
def test_list_with_accoutrements(self):
with session.make_session_for_existing_admin() as admin:
try:
file_name = 'test_access_object'
lib.make_file(file_name, 1024)
admin.assert_icommand(['iput', file_name])
admin.assert_icommand(['ils', '-l'], 'STDOUT_SINGLELINE',
file_name)
pwd, _ = lib.execute_command(['ipwd'])
pwd = pwd.rstrip()
logical_path = os.path.join(pwd, file_name)
admin.assert_icommand([
'imeta', 'set', '-d', logical_path, 'attr', 'val', 'unit'
])
token = irods_rest.authenticate('rods', 'rods', 'native')
result = irods_rest.list(token, logical_path, 'true', 'true',
'true', 0, 0)
lst = json.loads(result)['_embedded'][0]
assert (lst['type'] == 'data_object')
md = lst['metadata'][0]
assert (md['attribute'] == 'attr')
assert (md['value'] == 'val')
assert (md['units'] == 'unit')
stat = lst['status_information']
assert (stat['last_write_time'] != '')
assert (stat['size'] == 1024)
perm = lst['permission_information']
assert (perm['rods'] == 'own')
finally:
os.remove(file_name)
admin.assert_icommand(['irm', '-f', file_name])
def test_changing_passwords_is_supported__issue_99(self):
# Show that the user can execute commands without error.
self.user.assert_icommand(['ils', '-ld'], 'STDOUT', [self.user.session_collection])
# Show that changing the user's password will require them to reauthenticate.
token = irods_rest.authenticate('rods', 'rods', 'native')
old_password = self.user.password
new_password = '******'
irods_rest.admin(token, 'modify', 'user', self.user.username, 'password', new_password, None, None, None)
self.user.assert_icommand(['ils', '-ld'], 'STDERR', ['CAT_INVALID_AUTHENTICATION'])
# Show that reauthenticating with the new password restores the user's ability
# to execute commands. This proves the REST API is able to change passwords without
# requiring the user to obfuscate the password first.
self.user.assert_icommand(['iinit', new_password])
self.user.assert_icommand(['ils', '-ld'], 'STDOUT', [self.user.session_collection])
# Restore the user's password for other tests.
irods_rest.admin(token, 'modify', 'user', self.user.username, 'password', old_password, None, None, None)
self.user.assert_icommand(['iinit', old_password])
self.user.assert_icommand(['ils', '-ld'], 'STDOUT', [self.user.session_collection])
def test_access_with_default_arguments(self):
with session.make_session_for_existing_admin() as admin:
try:
file_name = 'test_access_object'
lib.make_file(file_name, 1024)
admin.assert_icommand(['iput', file_name])
admin.assert_icommand(['ils', '-l'], 'STDOUT_SINGLELINE', file_name)
pwd, _ = lib.execute_command(['ipwd'])
pwd = pwd.rstrip()
logical_path = os.path.join(pwd, file_name)
token = irods_rest.authenticate('rods', 'rods', 'native')
json_string = irods_rest.access(token, logical_path)
assert(json_string.find('error') == -1)
json_object = json.loads(json_string)
ticket_id = json_object['headers']['irods-ticket'][0]
# Verify that the properties for the ticket are what we expect.
_, out, _ = admin.assert_icommand(['iticket', 'ls', ticket_id], 'STDOUT', [
'ticket type: read',
'uses limit: 0',
'write file limit: 0',
'write byte limit: 0',
'expire time: none',
'No user restrictions',
'No group restrictions',
'No host restrictions'
])
admin.assert_icommand(['iticket', 'delete', ticket_id])
finally:
os.remove(file_name)
admin.assert_icommand(['irm', '-f', file_name])
def test_access_returns_error_on_invalid_value_for_seconds_until_expiration_parameter(self):
with session.make_session_for_existing_admin() as admin:
try:
file_name = 'test_access_object'
lib.make_file(file_name, 1024)
admin.assert_icommand(['iput', file_name])
admin.assert_icommand(['ils', '-l'], 'STDOUT_SINGLELINE', file_name)
pwd, _ = lib.execute_command(['ipwd'])
pwd = pwd.rstrip()
logical_path = os.path.join(pwd, file_name)
token = irods_rest.authenticate('rods', 'rods', 'native')
json_string = irods_rest.access(token, logical_path, _seconds_until_expiration=-1)
assert(json_string.find('error') > 0)
json_object = json.loads(json_string)
self.assertEqual(json_object['error_code'], -130000)
finally:
os.remove(file_name)
admin.assert_icommand(['irm', '-f', file_name])
def test_authentication(self):
token = irods_rest.authenticate('rods', 'rods', 'native')
assert(token.find('827000') == -1)
def test_get_configuration(self):
token = irods_rest.authenticate('rods', 'rods', 'native')
result = irods_rest.get_configuration(token)
assert(result.find('advanced_settings') != -1)
def test_invalid_authentication(self):
token = irods_rest.authenticate('invalid', 'user', 'native')
assert(token.find('827000') != -1)
