Merge lp:~gary-lasker/software-center/lobby-recommends-fixes into lp:software-center

[Gary Lasker]

This branch fixes the problem where after the user opts in to the recommendations service, the opt-in panel is incorrectly displayed again. With this fix, the recommendations are displayed properly after they are downloaded from the server.

The branch also enables the "More" button to that can be used to display the list view for the recommendations.

[Michael Vogt (mvo)]

Thanks, this works fine, but its lacking a test. I added one (two actually) in lp:~mvo/software-center/lobby-recommends-fixes

[lp:~gary-lasker/software-center/lobby-recommends-fixes]

2801. By Gary Lasker on 2012-03-01

merge from lp:~mvo/software-center/lobby-recommends-fixes, thanks mvo

[Gary Lasker (gary-lasker)]

Thanks Michael! I've merged your branch into mine if you'd like to re-review.

One comment is that I noticed you changed my hide() of the opt-in panel to use a destroy() instead. I didn't see it as a big deal to to use a simple hide() because it will only ever be made when opt-in is being offered, so the widgets are hidden only during the session where the user actually opt-in and the view switches to the recommendations. Once opted-in, the opt-in panel is never made again. But, I think either should be fine.

Thanks again!

=== modified file 'softwarecenter/testutils.py'
--- softwarecenter/testutils.py	2012-02-15 16:55:32 +0000
+++ softwarecenter/testutils.py	2012-03-01 15:51:20 +0000
@@ -194,7 +194,7 @@
 def make_recommender_agent_recommend_me_dict():
     # best to have a list of likely not-installed items
     app_dict = {
-        u'recommendations': [
+        u'data': [
             {
                 u'package_name': u'clementine'
             }, 
 
=== modified file 'softwarecenter/ui/gtk3/widgets/recommendations.py'
--- softwarecenter/ui/gtk3/widgets/recommendations.py	2012-02-29 19:58:05 +0000
+++ softwarecenter/ui/gtk3/widgets/recommendations.py	2012-03-01 15:51:20 +0000
@@ -80,19 +80,20 @@
         
         # if we already have a recommender UUID, then the user is already
         # opted-in to the recommender service
+        self.recommended_for_you_content = None
         if self.recommender_agent.recommender_uuid:
             self._update_recommended_for_you_content()
         else:
             self._show_opt_in_view()
             
-        self.add(self.recommended_for_you_content)
-
     def _show_opt_in_view(self):
         # opt in box
         vbox = Gtk.Box.new(Gtk.Orientation.VERTICAL, StockEms.MEDIUM)
         vbox.set_border_width(StockEms.LARGE)
         self.opt_in_vbox = vbox  # for tests
         self.recommended_for_you_content = vbox  # hook it up to the rest
+        
+        self.add(self.recommended_for_you_content)
 
         # opt in button
         button = Gtk.Button(_("Turn On Recommendations"))
@@ -146,7 +147,14 @@
         self._hide_recommended_for_you_panel()
         
     def _update_recommended_for_you_content(self):
+        # destroy the old content to ensure we don't see it twice
+        # (also removes the opt-in panel if it was there)
+        if self.recommended_for_you_content:
+            self.recommended_for_you_content.destroy()
+        # add the new stuff
+        self.header_implements_more_button()
         self.recommended_for_you_content = FlowableGrid()
+        self.add(self.recommended_for_you_content)
         self.spinner_notebook.show_spinner(_("Receiving recommendations…"))
         # get the recommendations from the recommender agent
         self.recommended_for_you_cat = RecommendedForYouCategory()
@@ -160,7 +168,6 @@
         docs = cat.get_documents(self.catview.db)
         # display the recommendedations
         if len(docs) > 0:
-            self.header_implements_more_button()
             self.catview._add_tiles_to_flowgrid(docs,
                                         self.recommended_for_you_content, 8)
             self.recommended_for_you_content.show_all()
@@ -234,14 +241,29 @@
         self.hide()
     
 
-
-def get_test_window_recommendations_panel_lobby():
+# test helpers
+def get_test_window():
     import softwarecenter.log
     softwarecenter.log.root.setLevel(level=logging.DEBUG)
     fmt = logging.Formatter("%(name)s - %(message)s", None)
     softwarecenter.log.handler.setFormatter(fmt)
     
-    view = RecommendationsPanelLobby()
+
+    # this is *way* to complicated we should *not* need a CatView
+    # here! see FIXME in RecommendationsPanel.__init__()
+    from softwarecenter.ui.gtk3.views.catview_gtk import CategoriesViewGtk
+    from softwarecenter.testutils import (
+        get_test_db, get_test_pkg_info, get_test_gtk3_icon_cache)
+    cache = get_test_pkg_info()
+    db = get_test_db()
+    icons = get_test_gtk3_icon_cache()
+    catview = CategoriesViewGtk(softwarecenter.paths.datadir,
+                                softwarecenter.paths.APP_INSTALL_PATH,
+                                cache, 
+                                db,
+                                icons)
+
+    view = RecommendationsPanelLobby(catview)
 
     win = Gtk.Window()
     win.connect("destroy", lambda x: Gtk.main_quit())
@@ -254,5 +276,5 @@
     
 
 if __name__ == "__main__":
-    win = get_test_window_recommendations_panel_lobby()
+    win = get_test_window()
     Gtk.main()
 
=== modified file 'test/gtk3/test_catview.py'
--- test/gtk3/test_catview.py	2012-02-28 21:27:59 +0000
+++ test/gtk3/test_catview.py	2012-03-01 15:51:20 +0000
@@ -1,4 +1,4 @@
-from gi.repository import Gtk
+from gi.repository import Gtk, GObject
 import time
 import unittest
 from mock import patch
@@ -128,9 +128,18 @@
         from softwarecenter.ui.gtk3.widgets.containers import FramedHeaderBox
         self.assertTrue(rec_panel.spinner_notebook.get_current_page() == FramedHeaderBox.SPINNER)
         self.assertTrue(rec_panel.opt_in_vbox.get_property("visible"))
-        self.assertTrue(rec_panel.spinner.spinner_label)
-        win.destroy()
-        
+        # now pretent that we got data and ensure its displayed
+        rec_panel._update_recommended_for_you_content()
+        rec_panel.recommended_for_you_cat._recommend_me_result(
+            None, make_recommender_agent_recommend_me_dict())
+        self._p()
+        self.assertTrue(rec_panel.recommended_for_you_content.get_property("visible"))
+        self.assertFalse(rec_panel.opt_in_vbox.get_property("visible"))
+        # exit after brief timeout
+        TIMEOUT=100
+        GObject.timeout_add(TIMEOUT, lambda: win.destroy())
+        Gtk.main()
+
     # patch out the agent query method to avoid making the actual server call
     @patch('softwarecenter.backend.recagent.RecommenderAgent'
            '.post_submit_profile')
@@ -179,6 +188,6 @@
 
 
 if __name__ == "__main__":
-    import logging
-    logging.basicConfig(level=logging.DEBUG)
+    #import logging
+    #logging.basicConfig(level=logging.DEBUG)
     unittest.main()
 
=== added file 'test/gtk3/test_recommendations_widgets.py'
--- test/gtk3/test_recommendations_widgets.py	1970-01-01 00:00:00 +0000
+++ test/gtk3/test_recommendations_widgets.py	2012-03-01 15:51:20 +0000
@@ -0,0 +1,30 @@
+#!/usr/bin/python
+
+from gi.repository import Gtk, GObject
+import unittest
+
+from testutils import setup_test_env
+setup_test_env()
+
+from softwarecenter.ui.gtk3.widgets.recommendations import get_test_window
+
+# window destory timeout
+TIMEOUT=100
+
+# FIXME: the code from test_catview that tests the lobby widget should
+#        move here as it should be fine to test it in isolation
+
+class TestRecommendationsWidgets(unittest.TestCase):
+
+    def test_recommendations_widgets(self):
+        win = get_test_window()
+        win.show_all()
+        GObject.timeout_add(TIMEOUT, lambda: win.destroy())
+        Gtk.main()
+
+
+
+if __name__ == "__main__":
+    #import logging
+    #logging.basicConfig(level=logging.DEBUG)
+    unittest.main()