Merge lp:~achiang/hydrazine/hydrazine-show-valid-named-enums into lp:hydrazine

[Alex Chiang]

  bugclient: add input validation for 'filter' command, other NamedEnums

  Give the NamedEnum() class a new method, 'show_valid()'.

  This gives us a standard way to handle error checking if the user
  enters an invalid enum.

  Harden the 'filter' command so it doesn't puke when you just type it
  without any arguments, such as the stack trace below:

        hydrazine(None)> filter
        Traceback (most recent call last):
          File "./bugclient", line 541, in <module>
            main(sys.argv)
          File "./bugclient", line 537, in main
            cmd.cmdloop()
          File "/usr/lib/python2.7/cmd.py", line 142, in cmdloop
            stop = self.onecmd(line)
          File "./bugclient", line 399, in onecmd
            return cmd.Cmd.onecmd(self, cmdline)
          File "/usr/lib/python2.7/cmd.py", line 219, in onecmd
            return func(arg)
          File "./bugclient", line 175, in do_filter
            if not (args[0]):
        IndexError: list index out of range

[Martin Pool (mbp)]

  vote approve
  review approve

review: Approve

=== modified file 'bugclient'
--- bugclient	2011-10-12 14:06:44 +0000
+++ bugclient	2011-10-12 22:07:25 +0000
@@ -33,6 +33,10 @@
     def get_all(self):
         return self.enums
 
+    def show_valid(self):
+        print "Sorry, valid entries are:"
+        _show_columnated(self.enums)
+
 status_enum = NamedEnum(['Confirmed', 'Triaged', 'Fix Committed',
                            'Fix Released', 'In Progress', "Won't Fix",
                            'Incomplete', 'Invalid', 'New'])
@@ -168,9 +172,8 @@
     filter clear                         # remove all filters
         """
         args = line.split()
-        if not filter_enum.get(args[0]):
-            print 'Invalid filter. Valid filters are:'
-            _show_columnated(filter_enum.get_all())
+        if not args or filter_enum.get(args[0]) == None:
+            filter_enum.show_valid()
             return
 
         if args[0] == "clear":
@@ -178,8 +181,7 @@
             return
         elif args[0] == "status":
             if status_enum.get(' '.join(args[1:])) == None:
-                print 'invalid status, valid values are:'
-                _show_columnated(status_enum.get_all())
+                status_enum.show_valid()
                 return
             else:
                 # Normalize status, and toss old junk
@@ -195,8 +197,7 @@
             return
         new_importance = importance_enum.get(line)
         if new_importance is None:
-            print 'invalid importance, valid values are:'
-            _show_columnated(importance_enum.get_all())
+            importance_enum.show_valid()
             return
         print '#%d changing importance %s => %s' % (self.bug.id, task.importance, new_importance)
         task.importance = new_importance
@@ -314,8 +315,7 @@
             return
         new_status = status_enum.get(line)
         if new_status is None:
-            print 'invalid status, valid values are:'
-            _show_columnated(status_enum.get_all())
+            status_enum.show_valid()
             return
         print '#%d changing status %s => %s' % (self.bug.id, task.status, new_status)
         task.status = new_status