issue2550522 - add transitive searching to filter in roundup-admin

issue2550522 - Add 'filter' command to command-line interface.

Filter command was actually added in 2.0.0, but this
issue requested transitive searching. So that:

    roundup-admin -i . filter issue assignedto.username=Admin

will work. This also fixes two bugs.

  If assignedto.username had no matches, all issues would be returned.

  admin.py had a find() call where the should have been a filter()
  call. Was tripped when -S, -c or -s were used.

Author: rouilj

CHANGES.txt

@@ -23,6 +23,17 @@ Fixed:
 - issue2550564 - Roundup sets "Precedence: bulk" on all outgoing mail,
   which seems wrong. Handle Auto-Submitted header on *inbound* email
   like we do precedence bulk. This is part of this issue.
+- roundup-admin filter calls find() not filter when using -s -c -S
+  (John Rouillard)
+
+Features:
+- issue2550522 - Add 'filter' command to command-line
+  interface. Filter command was actually added in 2.0.0, but this
+  issue requested transitive searching. So that:
+    roundup-admin -i . filter issue assignedto.username=Admin
+  will work. This also fixes a bug. If assignedto.username had no
+  matches, all issues would be returned.  This is also fixed.
+  (John Rouillard)
 
 2020-07-13 2.0.0
 

roundup/admin.py

@@ -746,9 +746,33 @@ def do_filter(self, args):
                 values = [ value ]
 
             props[propname] = []
+            # start handling transitive props
+            # given filter issue assignedto.roles=Admin
+            # start at issue
+            curclass = cl
+            lastprop = propname # handle case 'issue assignedto=admin'
+            if '.' in propname:
+                # start splitting transitive prop into components
+                # we end when we have no more links
+                for pn in propname.split('.'):
+                    try:
+                        lastprop=pn # get current component
+                        # get classname for this link
+                        try:
+                            curclassname = curclass.getprops()[pn].classname
+                        except KeyError:
+                            raise UsageError(_("Class %(curclassname)s has "
+                            "no property %(pn)s in %(propname)s." % locals()))
+                        # get class object
+                        curclass = self.get_class(curclassname)
+                    except AttributeError:
+                        # curclass.getprops()[pn].classname raises this
+                        # when we are at a non link/multilink property
+                        pass
+
             for value in values:
-                val = hyperdb.rawToHyperdb(self.db, cl, None,
-                                             propname, value)
+                val = hyperdb.rawToHyperdb(self.db, curclass, None,
+                                           lastprop, value)
                 props[propname].append(val)
 
         # now do the filter
@@ -764,7 +788,7 @@ def do_filter(self, args):
                         designator.append(classname + i)
                     print(self.separator.join(designator))
                 else:
-                    print(self.separator.join(cl.find(**props)))
+                    print(self.separator.join(cl.filter(None, **props)))
             else:
                 if self.print_designator:
                     id = cl.filter(None, **props)

roundup/hyperdb.py

@@ -620,6 +620,8 @@ def search(self, search_matches=None, sort=True, retired=False):
                         exact_match_spec[p.name] = exact
                     if subst:
                         filterspec[p.name] = subst
+                    elif not exact: # don't set if we have exact criteria
+                        filterspec[p.name] =[ '-1' ] # no match was found
                 else:
                     assert not isinstance(p.val, Exact_Match)
                     filterspec[p.name] = p.val

test/test_admin.py

@@ -553,6 +553,112 @@ def testFilter(self):
         print(out)
         self.assertEqual(sorted(eval(out)), ['1', '2'])
 
+        # Reopen the db closed by previous filter call
+        # 
+        # case: transitive property valid match
+        self.admin=AdminTool()
+        with captured_output() as (out, err):
+            sys.argv=['main', '-i', self.dirname, 'filter', 'issue',
+                      'assignedto.roles=Anonymous']
+            ret = self.admin.main()
+
+        out = out.getvalue().strip()
+        print(out)
+        self.assertEqual(out, "['2']")
+
+        # Reopen the db closed by previous filter call
+        #         self.admin=AdminTool()
+        # case: transitive propery invalid prop
+        self.admin=AdminTool()
+        with captured_output() as (out, err):
+            ''' assignedto is not a valid property=value, so
+                report error.
+            '''
+            sys.argv=['main', '-i', self.dirname, 'filter', 'issue',
+                      'assignedto.badprop=Admin']
+            ret = self.admin.main()
+
+        out = out.getvalue().strip()
+        expected='Error: Class user has no property badprop in assignedto.badprop.'
+        print(out[0:len(expected)])
+        self.assertEqual(expected, out[0:len(expected)])
+
+        # Reopen the db closed by previous filter call
+        # 
+        # case: transitive property invalid match
+        self.admin=AdminTool()
+        with captured_output() as (out, err):
+            sys.argv=['main', '-i', self.dirname,
+                      'filter', 'issue',
+                      'assignedto.username=NoNAme']
+            ret = self.admin.main()
+
+        out = out.getvalue().strip()
+        print("me: " + out)
+        print(err.getvalue().strip())
+        self.assertEqual(out, "[]")
+
+        # Reopen the db closed by previous filter call
+        # 
+        # case: transitive property invalid match
+        self.admin=AdminTool()
+        with captured_output() as (out, err):
+            sys.argv=['main', '-i', self.dirname, '-c',
+                      'filter', 'issue',
+                      'assignedto.username=NoNAme']
+            ret = self.admin.main()
+
+        out = out.getvalue().strip()
+        print("me: " + out)
+        print(err.getvalue().strip())
+        self.assertEqual(out, "")
+
+        # Reopen the db closed by previous filter call
+        # 
+        # case: transitive property invalid match
+        self.admin=AdminTool()
+        with captured_output() as (out, err):
+            sys.argv=['main', '-i', self.dirname, '-c',
+                      'filter', 'issue',
+                      'assignedto.username=A']
+            ret = self.admin.main()
+
+        out = out.getvalue().strip()
+        print("me: " + out)
+        print(err.getvalue().strip())
+        self.assertEqual(out, "1,2")
+
+        # Reopen the db closed by previous filter call
+        # 
+        # case: transitive property invalid match
+        self.admin=AdminTool()
+        with captured_output() as (out, err):
+            sys.argv=['main', '-i', self.dirname, '-s',
+                      'filter', 'issue',
+                      'assignedto.username=A']
+            ret = self.admin.main()
+
+        out = out.getvalue().strip()
+        print("me: " + out)
+        print(err.getvalue().strip())
+        self.assertEqual(out, "1 2")
+
+        # Reopen the db closed by previous filter call
+        # 
+        # case: transitive property invalid match
+        self.admin=AdminTool()
+        with captured_output() as (out, err):
+            sys.argv=['main', '-i', self.dirname, '-S', ':',
+                      'filter', 'issue',
+                      'assignedto.username=A']
+            ret = self.admin.main()
+
+        out = out.getvalue().strip()
+        print("me: " + out)
+        print(err.getvalue().strip())
+        self.assertEqual(out, "1:2")
+
+
     def disabletestHelpInitopts(self):
 
         ''' Note the tests will fail if you run this under pdb.