Merge lp:~agateau/checkbox/progress-bar into lp:checkbox

[Aurélien Gâteau]

This branch adds a progress bar to the main test window, showing how many tests remain to be run. The changes in the .ui looks heavy but it's just glade rewriting things: it just replace the GtkButtonBox holding the Test button with a GtkBox and inserts a GtkProgressBar to the left of the Test button.

[Daniel Manrique (roadmr)]

Thanks, this is awesome! It's easily one of the top five features requested in Checkbox.

Checkbox rev 1109 also had some rearranging of components in Glade, but Glade really made a mess of the XML files for what was meant to be a simple change. What I did was make the changes manually in the XML file and the patch came out much cleaner. If you have a moment, could you see if it's possible to do this here? If not, don't worry, I'll probably look into doing it manually myself and then test that all works well.

Thanks again, much appreciated.

[Brendan Donegan (brendan-donegan)]

Aurelien, thanks for the code! Do you agree with what Daniel said about changing the ui file manually? If so can you take care of it and resubmit, otherwise if you don't have the time then as Daniel mentioned please let us know and we may take care of it ourselves (giving you due credit of course!)

review: Needs Fixing

[Aurélien Gâteau (agateau)]

Sure, I am going to look into reworking the .ui change to something easier to read.

[lp:~agateau/checkbox/progress-bar]

1200. By Aurélien Gâteau on 2012-02-28

Redone changes to the Glade file by hand.

Should be easier to review now.

[Daniel Manrique (roadmr)]

Hi Aurélien!

Thanks for updating the glade file, I hope you're OK with the changes and it still fits your purpose.

One last thing before we move forward. I notice you're still carrying the progress information in the job itself. As I mentioned before, this feels like a forced use of the job to shuttle information to the frontend. I'm wondering if you have a specific reason for preferring this implementation; maybe it's something you are using elsewhere, or have future plans for it.

In any case, the mechanism I suggested (where an event gets fired which then is caught by the user_interface plugin which in turn sets a value in the UserInterface itself) is an alternative, although it's more complicated it avoids using the job for this purpose.

Please let me know if this is something you definitely want to be as you propose, or you'd be open to considering the other alternative (the progress bar will still work the same way).

Thanks!

review: Needs Information

[Aurélien Gâteau (agateau)]

I didn't have any specific idea in mind. It just felt like the easiest way to go, without having to patch all frontends. I am still struggling with checkbox codebase, so I don't always figure out the checkbox-way to do things.

Will have a look at this on monday.

[Daniel Manrique (roadmr)]

Hi Aurelien,

I'll merge this, based on your latest comment I took the liberty of replacing the mechanism to convey the progress information to the one I suggested, which is also generic enough to be used (or ignored, as needed) by all frontends.

Incidentally, the mechanism used to carry a variable from the core to the frontend is also being used for carrying a report_url variable, so it seems generic enough :)

Thanks!

review: Approve

[Aurélien Gâteau (agateau)]

Sounds good, thanks!

=== modified file 'checkbox_gtk/gtk_interface.py'
--- checkbox_gtk/gtk_interface.py	2012-02-22 17:16:30 +0000
+++ checkbox_gtk/gtk_interface.py	2012-02-28 14:37:18 +0000
@@ -519,6 +519,12 @@
             self._set_hyper_text_view("hyper_text_view_test",
                 test["description"])
 
+        # Update progress bar
+        bar = self._get_widget("progressbar_test")
+        done, total = test["progress"]
+        bar.set_text("%d/%d" % (done, total))
+        bar.set_fraction(float(done) / total)
+
         # Set buttons
         if "command" in test:
             self._set_sensitive("button_test", True)
 
=== modified file 'gtk/checkbox-gtk.ui'
--- gtk/checkbox-gtk.ui	2011-11-04 20:32:54 +0000
+++ gtk/checkbox-gtk.ui	2012-02-28 14:37:18 +0000
@@ -165,9 +165,22 @@
                   </packing>
                 </child>
                 <child>
-                  <object class="GtkHButtonBox" id="hbuttonbox_test">
+                  <object class="GtkBox" id="box_test">
                     <property name="visible">True</property>
-                    <property name="layout_style">end</property>
+                    <property name="can_focus">False</property>
+                    <property name="spacing">6</property>
+                    <child>
+                      <object class="GtkProgressBar" id="progressbar_test">
+                        <property name="visible">True</property>
+                        <property name="can_focus">False</property>
+                        <property name="show_text">True</property>
+                      </object>
+                      <packing>
+                        <property name="expand">True</property>
+                        <property name="fill">True</property>
+                        <property name="position">0</property>
+                      </packing>
+                    </child>
                     <child>
                       <object class="GtkButton" id="button_test">
                         <property name="label" translatable="yes">_Test</property>
@@ -179,7 +192,7 @@
                       <packing>
                         <property name="expand">False</property>
                         <property name="fill">False</property>
-                        <property name="position">0</property>
+                        <property name="position">1</property>
                       </packing>
                     </child>
                   </object>
 
=== modified file 'plugins/jobs_prompt.py'
--- plugins/jobs_prompt.py	2012-02-22 21:54:24 +0000
+++ plugins/jobs_prompt.py	2012-02-28 14:37:18 +0000
@@ -127,7 +127,11 @@
             if not messages:
                 break
 
+            done_count = self.store.get_pending_offset()
+            pending_count = self.store.count_pending_messages()
+
             job = messages[0]
+            job["progress"] = (done_count, done_count + pending_count)
             self._manager.reactor.fire("prompt-job", interface, job)
             self.store.update(job)