[#392] add iRODSResource properties: parent_name, parent_id, hierarchy_string

Author: d-w-moore

irods/resource.py

@@ -7,6 +7,9 @@
 class iRODSResource(object):
 
     def __init__(self, manager, result=None):
+        self._hierarchy_string = ''
+        self._parent_name = ''
+        self._parent_id = ''
         '''
         self.id = result[Resource.id]
         self.name = result[Resource.name]
@@ -38,6 +41,54 @@ def __init__(self, manager, result=None):
 
         self._meta = None
 
+
+    ## Cached properties to expose parent id or name regardless whether the DB model is iRODS 4.1- or 4.2+
+
+    @property
+    def parent_id(self):
+        if self.parent is None:
+            return None
+        if self._parent_id == '':
+            sess = self.manager.sess
+            if sess.server_version >= (4, 2, 0):
+                self._parent_id = self.parent
+            else:
+                self._parent_id = sess.query(Resource).filter(Resource.name == self.parent).one()[Resource.id]
+        return int(self._parent_id)
+
+
+    @property
+    def parent_name(self):
+        if self.parent is None:
+            return None
+        if self._parent_name == '':
+            sess = self.manager.sess
+            if sess.server_version < (4, 2, 0):
+                self._parent_name = self.parent
+            else:
+                self._parent_name = sess.query(Resource).filter(Resource.id == self.parent).one()[Resource.name]
+        return self._parent_name
+
+    ## Cached property to expose resource hierarchy string
+
+    @property
+    def hierarchy_string(self):
+        if self._hierarchy_string == '':
+            self._hierarchy_string = ';'.join(r.name for r in self.hierarchy_as_list_of_resource_objects())
+        return self._hierarchy_string
+
+    ## Retrieve chain of parent objects to top level parent
+
+    def hierarchy_as_list_of_resource_objects(self):
+        trace_to_root = [self]
+        sess = self.manager.sess
+        r = self.parent_id
+        while r is not None:
+            parent = sess.query(Resource).filter(Resource.id == r).one()
+            trace_to_root.append(iRODSResource(self.manager, parent))
+            r = trace_to_root[-1].parent_id
+        return list(reversed(trace_to_root))
+
     @property
     def metadata(self):
         if not self._meta:

irods/test/resource_test.py

@@ -0,0 +1,62 @@
+#! /usr/bin/env python
+from __future__ import absolute_import
+import os
+import six
+import sys
+import unittest
+
+from irods.test import helpers
+
+class TestResource(unittest.TestCase):
+
+    from helpers import create_simple_resc_hierarchy
+
+    def setUp(self):
+        self.sess = helpers.make_session()
+
+    def test_resource_properties_for_parent_and_hierarchy_at_3_levels__392(self):
+        ses = self.sess
+        root = "deferred_392"
+        pt = "pt_392"
+        leaf = "leaf_392"
+        root_resc = ses.resources.create(root,"deferred")
+        try:
+            # Create two (passthru + storage) hierarchies below the root: ie. pt0;leaf0 and pt1;leaf1
+            with self.create_simple_resc_hierarchy(pt + "_0", leaf + "_0"), \
+                 self.create_simple_resc_hierarchy(pt + "_1", leaf + "_1"):
+                try:
+                    # Adopt both passthru's as children under the main root (deferred) node.
+                    ses.resources.add_child(root, pt + "_0")
+                    ses.resources.add_child(root, pt + "_1")
+                    # Now we have two different 3-deep hierarchies (root;pt0;leaf0 and root;pt1;leaf) sharing the same root node.
+                    # Descend each and make sure the relationships hold
+                    for mid in root_resc.children:
+                        hierarchy = [root_resc, mid, mid.children[0]]
+                        parent_resc = None
+                        hier_str = root
+                        # Assert that the hierarchy and parent properties hold at each level, in both tree branches.
+                        for n,resc in enumerate(hierarchy):
+                            if n > 0:
+                                hier_str += ";{}".format(resc.name)
+                            self.assertEqual(resc.parent_id, (None if n == 0 else parent_resc.id))
+                            self.assertEqual(resc.parent_name, (None if n == 0 else parent_resc.name))
+                            self.assertEqual(resc.hierarchy_string, hier_str)
+                            self.assertIs(type(resc.hierarchy_string), str)                   # type of hierarchy field is string.
+                            if resc.parent is None:
+                                self.assertIs(resc.parent_id, None)
+                                self.assertIs(resc.parent_name, None)
+                            else:
+                                self.assertIn(type(resc.parent_id), six.integer_types) # type of a non-null id field is integer.
+                                self.assertIs(type(resc.parent_name), str)             # type of a non-null name field is string.
+                            parent_resc = resc
+                finally:
+                    ses.resources.remove_child(root, pt + "_0")
+                    ses.resources.remove_child(root, pt + "_1")
+        finally:
+            ses.resources.remove(root)
+
+
+if __name__ == '__main__':
+    # let the tests find the parent irods lib
+    sys.path.insert(0, os.path.abspath('../..'))
+    unittest.main()