Merge lp:~roadmr/checkbox/twirly into lp:checkbox

[Daniel Manrique]

Fix bug 926104 by creating a spinning ascii twirler in the CLI to indicate that checkbox is doing something or waiting for input

A spinning ascii twirler to indicate that checkbox is doing something or waiting for input.

To test:

sudo -k; unset DISPLAY; PYTHONPATH=. bin/checkbox-cli -W data/whitelists/default.whitelist

[Brendan Donegan (brendan-donegan)]

Awesome! I'm left scratching my head why the same approach gave me problems (maybe I used wrong escape characters or something). Two observations though:

- I think it's a lot of code for something so simple, you can look in https://code.launchpad.net/~brendan-donegan/checkbox/spinner_and_pep8_fixes for the way I attempted it (it's about 3-4 lines). I don't mind either way how it's done really though.

- It would be good to give cli_interface.py a ritual pep8/pyflakes clean before submitting. At least it should pass the lint script.

Marking as needs fixing, but only for the pep8 clean - it's totally up to you if you want to simplify the implementation of the spinner/twirly.

review: Needs Fixing

[lp:~roadmr/checkbox/twirly]

1771. By Daniel Manrique on 2012-10-14

pep8 fixes and a small simplification to the twirler code

[Daniel Manrique (roadmr)]

Thanks for your review!

I applied pep8 fixes and slightly simplified the twirly code. I stole your index updating method, but I did keep the twirly class as I thought it better to keep this a bit isolated from the rest of the code.

review: Needs Resubmitting

[lp:~roadmr/checkbox/twirly]

1772. By Daniel Manrique on 2012-10-14

Merged from trunk

[Brendan Donegan (brendan-donegan)]

Perfect, thanks!

review: Approve

=== modified file 'checkbox_cli/cli_interface.py'
--- checkbox_cli/cli_interface.py	2012-06-12 15:03:42 +0000
+++ checkbox_cli/cli_interface.py	2012-10-14 01:15:25 +0000
@@ -133,7 +133,8 @@
                     default = "*" if option in defaults else " "
                     self.put_line("%s %s: %s" % (default, key, option))
 
-                response = self.get(_("Please choose (%s): ") % ("/".join(self.keys)))
+                response = self.get(_("Please choose (%s): ") %
+                                     ("/".join(self.keys)))
                 if response >= 0:
                     return response
 
@@ -151,7 +152,7 @@
                    string.digits + \
                    string.punctuation
 
-            keys = keys.replace(' ','')
+            keys = keys.replace(' ', '')
             keys = keys.replace('+', '')
 
             for key in keys:
@@ -202,6 +203,7 @@
 
             keys = []
             options = []
+
             def add_option(option, key=None):
                 """
                 Add option to list
@@ -272,12 +274,24 @@
     separator = ord("\n")
 
 
+class Twirly(object):
+    def __init__(self):
+        self.index = 0
+        self.twirlies = "-\\|/"
+
+    def next(self):
+        next_twirly = self.twirlies[self.index]
+        self.index = (self.index + 1) % len(self.twirlies)
+        return next_twirly
+
+
 class CLIProgressDialog(CLIDialog):
     """Command line progress dialog wrapper."""
 
     def __init__(self, text):
         super(CLIProgressDialog, self).__init__(text)
         self.progress_count = 0
+        self.twirly = Twirly()
 
     def set(self, progress=None):
         self.progress_count = (self.progress_count + 1) % 5
@@ -287,7 +301,9 @@
         if progress != None:
             self.put("\r%u%%" % (progress * 100))
         else:
-            self.put(".")
+            self.put("\b\b")
+            self.put(self.twirly.next())
+            self.put(" ")
         sys.stdout.flush()
 
 
@@ -365,7 +381,8 @@
         for option in keys:
             dialog.add_option(option)
 
-        dialog.add_option(_("Combine with character above to expand node"), "+")
+        dialog.add_option(_("Combine with character above to expand node"),
+                          "+")
         dialog.add_option(_("Space when finished"), " ")
 
         do_expand = False
@@ -395,14 +412,13 @@
             # Expand tree
             dialog.visible = False
             if options[result]:
-                branch_results =  results.get(result, {})
+                branch_results = results.get(result, {})
                 self.show_tree(result, options[result], branch_results)
                 if branch_results and result not in results:
                     results[result] = branch_results
 
         return results
 
-
     def show_report(self, text, results):
         """
         Show test case results in a tree hierarchy
@@ -410,7 +426,6 @@
         dialog = CLIReportDialog(text, results)
         dialog.run()
 
-
     def show_test(self, test, runner):
         options = list([ANSWER_TO_OPTION[a] for a in ALL_ANSWERS])
         if "command" in test:

=== modified file 'debian/changelog'
--- debian/changelog	2012-10-12 21:43:34 +0000
+++ debian/changelog	2012-10-14 01:15:25 +0000
@@ -9,7 +9,10 @@
   [Daniel Manrique]
   * [FEATURE] checkbox/job.py: Fixed intltool warning about unnamed
     parameters in string, applied pep8 fixes.
+  * checkbox-cli progress indicator is now static, spinning around instead of
+    filling the screen with dots. (LP: #926104)
   * Increased version number after final Ubuntu Quantal release.
+
   [Marc Tardif]
   * plugins/environment_info.py: Enabling environment to take precedence
     over configuration files.