Fixed quiet history filter for linked items. Test for same fixed.

The original test didn't cover the case where the linked item in
the history/journal wasn't the same type as the item on which the
history was generated. This now pulls the history on a user
who has been linked to the nosy field of an issue.

Author: rouilj

roundup/hyperdb.py

@@ -1022,16 +1022,14 @@ def history(self, nodeid, enforceperm=True, skipquiet=True):
         perm = self.db.security.hasPermission
         journal = []
 
-        debug_logging = logger.isEnabledFor(logging.DEBUG)
-
         uid=self.db.getuid() # id of the person requesting the history
 
         for j in self.db.getjournal(self.classname, nodeid):
             # hide/remove journal entry if:
             #   property is quiet
             #   property is not (viewable or editable)
             id, evt_date, user, action, args = j
-            if debug_logging:
+            if logger.isEnabledFor(logging.DEBUG):
                 j_repr = "%s"%(j,)
             else:
                 j_repr=''
@@ -1061,47 +1059,58 @@ def history(self, nodeid, enforceperm=True, skipquiet=True):
                     continue
                 journal.append(j)
             elif action in ['link', 'unlink' ] and type(args) == type(()):
-                # hide/remove journal entry if:
-                #   link property (key) is quiet
-                #   link property is not (viewable or editable)
-                #   id/object (linkcl, linkid) that is linked/unlinked is not
-                #       (viewable or editable)
+                # definitions:
+                # myself - object whose history is being filtered
+                # linkee - object/class whose property is changing to
+                #          include/remove myself
+                # link property - property of the linkee class that is changing
+                #
+                # Remove the history item if
+                #   linkee.link property (key) is quiet
+                #   linkee class.link property is not (viewable or editable)
+                #       to user
+                #   [ should linkee object.link property is not
+                #      (viewable or editable) to user be included?? ]
+                #   linkee object (linkcl, linkid) is not
+                #       (viewable or editable) to user
                 if len(args) == 3:
-                    '''
                     # e.g. for issue3 blockedby adds link to issue5 with:
                     # j = id, evt_date, user, action, args
                     # 3|20170528045201.484|5|link|('issue', '5', 'blockedby')
                     linkcl, linkid, key = args
                     cls = self.db.getclass(linkcl)
                     # is the updated property quiet?
-                    if skipquiet and self.properties[key].quiet:
-                        logger.debug("skipping quiet property"
-                                     " %s::%s in %s",
-                                     self.classname, key, j_repr)
+                    if skipquiet and cls.properties[key].quiet:
+                        logger.debug("skipping quiet property: "
+                                     "%s %sed %s%s",
+                                     j_repr, action, self.classname, nodeid)
                         continue
-                    # property check on item we want history for
+                    # can user view the property in linkee class
                     if enforceperm and not (perm("View",
                             uid,
-                            self.classname,
+                            linkcl,
                             property=key) or perm("Edit",
                             uid,
-                            self.classname,
+                            linkcl,
                             property=key)):
-                        logger.debug("skipping unaccessible property %s::%s seen by user%s in %s",
-                                self.classname, key, uid, j_repr)
+                        logger.debug("skipping unaccessible property: "
+                                     "%s with uid %s %sed %s%s",
+                                     j_repr, uid, action,
+                                     self.classname, nodeid)
                         continue
-                    # check on object linked
+                    # check access to linkee object
                     if enforceperm and not (perm("View",
                             uid,
                             cls.classname,
                             itemid=linkid) or perm("Edit",
                             uid,
                             cls.classname,
                             itemid=linkid)):
-                        logger.debug("skipping unaccessible target %s%s for user%s in %s",
-                                      cls.classname, linkid, uid, j_repr)
+                        logger.debug("skipping unaccessible object: "
+                                     "%s uid %s %sed %s%s",
+                                     j_repr, uid, action,
+                                     self.classname, nodeid)
                         continue
-                    '''
                     journal.append(j)
                 else:
                     logger.error("Invalid %s journal entry for %s%s: %s",

test/db_test_base.py

@@ -983,6 +983,20 @@ def testViewPremJournal(self):
         pass
 
     def testQuietJournal(self):
+        ## This is an example of how to enable logging module
+        ## and report the results. It uses testfixtures
+        ## that can be installed via pip.
+        ## Uncomment below 2 lines:
+        import logging
+        from testfixtures import LogCapture
+        ## then run every call to roundup functions with:
+        #with LogCapture('roundup.hyperdb', level=logging.DEBUG) as l:
+        #    result=self.db.user.history('2')
+        #print l
+        ## change 'roundup.hyperdb' to the logging name you want to capture.
+        ## print l just prints the output. Run using:
+        ## ./run_tests.py --capture=no -k testQuietJournal test/test_anydbm.py
+
         # FIXME There should be a test via
         # template.py::_HTMLItem::history() and verify the output.
         # not sure how to get there from here. -- rouilj
@@ -1101,6 +1115,23 @@ def testQuietJournal(self):
         self.assertEqual('set', action)
         self.assertEqual(expected, args)
 
+        result=self.db.user.history('2')
+
+        # result should look like:
+        #  [('2', <Date 2017-08-29.01:42:44.283>, '1', 'link',
+        #      ('issue', '1', 'nosy')),
+        #   ('2', <Date 2017-08-29.01:42:40.227>, '1', 'create', {})]
+
+        expected2 = ('issue', '1', 'nosy')
+        (id, tx_date, user, action, args) = result[0]
+
+        self.assertEqual(len(result),2)
+
+        self.assertEqual('2', id)
+        self.assertEqual('1', user)
+        self.assertEqual('link', action)
+        self.assertEqual(expected2, args)
+
         # reset quiet props
         self.db.issue.properties['nosy'].quiet=True
         self.db.issue.properties['deadline'].quiet=True