review changes nr. 4

Author: d-w-moore

indexing_utilities.cpp

@@ -249,8 +249,8 @@ namespace irods {
 
 
         class  path_format_error: public std::runtime_error {
-                public:
-                        path_format_error(const std::string & s) : std::runtime_error(s.c_str()) {}
+        public:
+            path_format_error(const std::string & s) : std::runtime_error(s.c_str()) {}
         };
 
         template <typename T>

packaging/test_plugin_indexing.py

@@ -788,7 +788,7 @@ def test_coll_name():
     def test_indexing_permissions__81(self):
         with session.make_session_for_existing_admin() as admin_session,\
         indexing_plugin__installed(indexing_config = {'minimum_delay_time':'1', 'maximum_delay_time':'3'}):
-            List_Active_Task_IDs = lambda : self.active_task_ids(admin_session,self)
+            # - Define collections to be used for test.
             path_to_home = '/{0.zone_name}/home/{0.username}'.format(admin_session)
             test_path = path_to_home + "/" + self.test_coll_name()
             #  STRUCTURE: (HOME)-->test_dir/
@@ -802,11 +802,15 @@ def test_indexing_permissions__81(self):
             data_1 = sub_path1 + "/data1"
             data_2 = sub_path2 + "/data2"
             data_3 = sub_path3 + "/data3"
+            # - Define another index.
             INDEX_2 = DEFAULT_METADATA_INDEX+"_2"
             try:
+
                 # use two indices, to test that multiple index indicators are respected in recursive (-r) ichmod
                 create_metadata_index(DEFAULT_METADATA_INDEX)
                 create_metadata_index(INDEX_2)
+
+                # - Set up a test environment.
                 objects = [
                     ('create',      ['-C',{'path':test_path, 'delete_tree_when_done': True }]),
                     ('create',      ['-C',{'path':sub_path1 }]), #--> for ichmod user0 without '-r', on data_1 object only
@@ -821,33 +825,43 @@ def test_indexing_permissions__81(self):
                     ('sleep_for',   ['',{'seconds':5}]),
                     ('wait_for',    [self.delay_queue_is_empty, {'num_iter':45,'interval':2.125,'threshold':2}]),
                 ]
+
+                # - Enact test environment.
                 with self.logical_filesystem_for_indexing (objects,admin_session):
+
+                    # - Convenience functions.
                     expected_condition = lambda string: (operator.ge,1) if string != 'null' else (operator.eq,0)
                     num_hits_multiplier = lambda string: 1 if string != 'null' else 0
 
-                    for R_perm,W_perm in [('read','write'),('null','null')]:  # Test once for setting ACLs and once for enulling them.
+                    # - On first pass, add ACLs; on the second, enull them.  Index and test each time.
+
+                    for R_perm,W_perm in [('read','write'),('null','null')]:
 
                         hits_ = ([],[],[])
 
+                        # - Non-recursive ichmod and wait for results.
                         admin_session.assert_icommand('ichmod {0} {1} {2}'.format(R_perm,self.user0.username,data_1))
                         rep_result_0 = repeat_until(*expected_condition(R_perm), transform=make_number_of_hits_fcn(hits_[0])
                                                   ) (search_index_for_userPermissions_user_name) (DEFAULT_METADATA_INDEX,self.user0.username)
 
+                        # - Recursive ichmod and wait for results.
                         admin_session.assert_icommand('ichmod -r {0} {1} {2}'.format(W_perm,self.user1.username,sub_path2))
                         rep_result_1 = repeat_until(*expected_condition(W_perm), transform=make_number_of_hits_fcn(hits_[1])
                                                    ) (search_index_for_userPermissions_user_name) (INDEX_2,self.user1.username)
                         rep_result_2 = repeat_until(*expected_condition(W_perm), transform=make_number_of_hits_fcn(hits_[2])
                                                    ) (search_index_for_userPermissions_user_name) (DEFAULT_METADATA_INDEX,self.user1.username)
 
-                        self.assertTrue(all([rep_result_0, rep_result_1, rep_result_2]))  # Assert all conditions waited on were met.
+                        # - Assert all conditions waited on were met.
+                        self.assertTrue(all([rep_result_0, rep_result_1, rep_result_2]))
 
+                        # - Assert the expected number of index hits.
                         nhits = lambda array,user: len(list(filter((lambda _:any(e for e in _['_source']['userPermissions'] if e['user'] == user)),
                                                                                array[0]['hits']['hits'] )))
-
                         self.assertEqual( num_hits_multiplier(R_perm)*1,  nhits(hits_[0], self.user0.username) )
                         self.assertEqual( num_hits_multiplier(W_perm)*4,  nhits(hits_[1], self.user1.username) )
                         self.assertEqual( num_hits_multiplier(W_perm)*2,  nhits(hits_[2], self.user1.username) )
             finally:
+                # - Clean up
                 delete_metadata_index(DEFAULT_METADATA_INDEX)
                 delete_metadata_index(INDEX_2)