Skip to content

Commit

Permalink
[7909,irods/irods_rule_engine_plugin_python 182] Add genquery2 order-…
Browse files Browse the repository at this point in the history
…by test for genquery python module.
  • Loading branch information
korydraughn committed Jul 22, 2024
1 parent a8f55ce commit 4956c04
Showing 1 changed file with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions scripts/irods/test/test_prep_genquery_iterator.py
Original file line number Diff line number Diff line change
Expand Up @@ -982,3 +982,60 @@ def main(rule_args, callback, rei):
f"[iteration=1] row: ['{self.admin.session_collection}']",
f"[iteration=2] row: ['{self.admin.session_collection}']"
])

@unittest.skipUnless(plugin_name == 'irods_rule_engine_plugin-python', 'Requires PREP.')
def test_genquery_iterator_supports_genquery2_order_by_clause__issue_7909(self):
iterations = 5

# Create some data objects and build a single string which captures the expected order
# of the rows returned by GenQuery2.
data_name_prefix = 'test_genquery_iterator_supports_genquery2_order_by_clause__issue_7909'
expected_output = ''
for i in reversed(range(iterations)):
self.admin.assert_icommand(['itouch', f'{data_name_prefix}.{i}'])
expected_output += f"writeLine: inString = ['{data_name_prefix}.{i}']\n"

# Create a rule file which, when executed, lists the data objects in the admin's
# session collection, but skips the first three entries of the resultset. The skipping
# of entries results in only seven entries being returned by the database.
rule_file = f'{self.admin.local_session_dir}/test_genquery_iterator_supports_genquery2_offset__issue_7909.r'
with open(rule_file, 'w') as rf:
rf.write(dedent(f'''
def main(rule_args, callback, rei):
from genquery import Query, Parser
for r in Query(callback, 'DATA_NAME', "COLL_NAME = '{self.admin.session_collection}'", order_by='DATA_NAME desc', parser=Parser.GENQUERY2):
callback.writeLine('stdout', f'{{r}}')
INPUT null
OUTPUT ruleExecOut
'''))

# Execute the rule.
rep_instance = IrodsConfig().default_rule_engine_plugin + '-instance'
self.admin.assert_icommand(['irule', '-r', rep_instance, '-F', rule_file], 'STDOUT', expected_output)

@unittest.skipUnless(plugin_name == 'irods_rule_engine_plugin-python', 'Requires PREP.')
def test_genquery_iterator_raises_exception_when_given_invalid_string_for_order_by_clause__issue_7909(self):
with temporary_core_file() as core:
attr_name = 'test_genquery_iterator_raises_exception_when_given_invalid_string_for_order_by_clause__issue_7909_error'

# The following rule triggers and attaches the exception message generated
# by the invalid GenQuery2 order-by string passed to the Query constructor.
core.add_rule(dedent(f'''
def pep_api_touch_pre(rule_args, callback, rei):
try:
from genquery import Query, Parser
Query(callback, 'COLL_NAME', "COLL_NAME = '{self.admin.session_collection}'", order_by='invalid', parser=Parser.GENQUERY2).first()
except RuntimeError as e:
callback.msiModAVUMetadata('-C', '{self.admin.session_collection}', 'add', '{attr_name}', str(e), '')
'''))

# Trigger the PEP.
# This will cause the rule to add an AVU to the session collection.
self.admin.assert_icommand(['itouch', 'issue_7909'], 'STDERR')

# Show the AVU containing the error exists on the session collection.
self.admin.assert_icommand(['imeta', 'ls', '-C', self.admin.session_collection], 'STDOUT', [
f'attribute: {attr_name}\n',
'[iRods__Error__Code:-167000]',
'[SYS_LIBRARY_ERROR]'
])

0 comments on commit 4956c04

Please sign in to comment.