[_120,_801] ticket attributes and ticket_iterator

Author: d-w-moore

irods/models.py

@@ -243,9 +243,8 @@ class Ticket(Model):
         write_byte_count = Column(Integer, "TICKET_WRITE_BYTE_COUNT", 2213)
         write_byte_limit = Column(Integer, "TICKET_WRITE_BYTE_LIMIT", 2214)
 
-    ## For now, use of these columns raises CAT_SQL_ERR in both PRC and iquest: (irods/irods#5929)
-    #       create_time = Column(String, 'TICKET_CREATE_TIME', 2209)
-    #       modify_time = Column(String, 'TICKET_MODIFY_TIME', 2210)
+        create_time = Column(DateTime, 'TICKET_CREATE_TIME', 2209, min_version = (4,3,0))
+        modify_time = Column(DateTime, 'TICKET_MODIFY_TIME', 2210, min_version = (4,3,0))
 
     class DataObject(Model):
         """For queries of R_DATA_MAIN when joining to R_TICKET_MAIN.

irods/test/ticket_test.py

@@ -1,17 +1,18 @@
 #! /usr/bin/env python
 
+import calendar
+import datetime
 import os
 import sys
-import unittest
 import time
-import calendar
+import unittest
 
 import irods.test.helpers as helpers
 import tempfile
 from irods.session import iRODSSession
 import irods.exception as ex
 import irods.keywords as kw
-from irods.ticket import Ticket
+from irods.ticket import ticket_iterator, Ticket
 from irods.models import TicketQuery, DataObject, Collection
 
 
@@ -48,7 +49,6 @@ def login(self, user):
             user=user.name,
             password=self.users[user.name],
         )
-
     @staticmethod
     def irods_homedir(sess, path_only=False):
         path = f"/{sess.zone}/home/{sess.username}"
@@ -73,6 +73,8 @@ def setUp(self):
             u = ses.users.get(ses.username)
             if u.type != "rodsadmin":
                 self.skipTest("""Test runnable only by rodsadmin.""")
+            self.rods_admin_name = ses.username
+
             self.host = ses.host
             self.port = ses.port
             self.zone = ses.zone
@@ -358,6 +360,29 @@ def test_coll_read_ticket_between_rodsusers(self):
                 os.unlink(file_.name)
             alice.cleanup()
 
+    def test_new_attributes_in_tickets__issue_801(self):
+        # Specifically we are testing that 'modify_time' and 'create_time' attributes function as expected,
+        # and that other attributes such as 'id' are also present.
+
+        bobs_ticket = None
+
+        try:
+            with self.login(self.bob) as bob:
+                bobs_ticket = Ticket(bob).issue('write', helpers.home_collection(bob))
+                time.sleep(2)
+                bobs_ticket.modify('add', 'user', self.rods_admin_name)
+
+                # Reload the ticket, this time with the full complement of attributes present.
+                bobs_ticket = next(ticket_iterator(bob, filter_args=[TicketQuery.Ticket.string == bobs_ticket.string]))
+
+                self.assertGreaterEqual(
+                    bobs_ticket.modify_time,
+                    bobs_ticket.create_time + datetime.timedelta(seconds=1)
+                )
+        finally:
+            if bobs_ticket:
+                bobs_ticket.delete()
+
 
 class TestTicketOps(unittest.TestCase):
 
@@ -456,6 +481,28 @@ def test_coll_ticket_write(self):
         self._ticket_write_helper(obj_type="coll")
 
 
+    def test_ticket_iterator__issue_120(self):
+
+        ses = self.sess
+        t = None
+
+        try:
+            # t first assigned as a "utility" Ticket object
+            t = Ticket(ses).issue('read', helpers.home_collection(ses))
+
+            # This time, t receives attributes from a query result: notably the id, which we use for the next test.
+            t = Ticket(
+                ses,
+                result=ses.query(TicketQuery.Ticket).filter(TicketQuery.Ticket.string == t.string).one()
+            )
+
+            # Check an id attribute is present and listed in the results from list_tickets
+            self.assertIn(t.id, (_.id for _ in ticket_iterator(ses)))
+        finally:
+            if t:
+                t.delete()
+
+
 if __name__ == "__main__":
     # let the tests find the parent irods lib
     sys.path.insert(0, os.path.abspath("../.."))

irods/ticket.py

@@ -27,17 +27,42 @@ def get_epoch_seconds(utc_timestamp):
     except ValueError:
         raise  # final try at conversion, so a failure is an error
 
+def ticket_iterator(session, filter_args=()):
+    return (
+        Ticket(session, result=row)
+        for row in session.query(TicketQuery.Ticket).filter(*filter_args)
+    )
 
 class Ticket:
+
     def __init__(self, session, ticket="", result=None, allow_punctuation=False):
         self._session = session
+
+        # Do an initial error and sanity check on result.
         try:
             if result is not None:
-                ticket = result[TicketQuery.Ticket.string]
-        except TypeError:
+                _ticket = result[TicketQuery.Ticket.string]
+        except (TypeError, KeyError):
             raise RuntimeError(
-                "If specified, 'result' parameter must be a TicketQuery.Ticket search result"
+                "If specified, 'result' parameter must be a TicketQuery.Ticket query result"
             )
+
+        # Process query result if given, and set object attributes from it.
+        if result is not None:
+            if _ticket != ticket != "":
+                raise RuntimeError(
+                    "A ticket name was specified but does not match the query result."
+                )
+            ticket = _ticket
+            for attr, value in TicketQuery.Ticket.__dict__.items():
+                if value is TicketQuery.Ticket.string: continue
+                if not attr.startswith("_"):
+                    try:
+                        setattr(self, attr, result[value])
+                    except KeyError:
+                        # backward compatibility with older schema versions
+                        pass
+
         self._ticket = (
             ticket if ticket else self._generate(allow_punctuation=allow_punctuation)
         )