Merge lp:~mvo/software-center/get-installed-apps-instead-of-pkgs into lp:software-center

[Michael Vogt]

This branch adds a mock test and moves the logic into the backend.

[Gary Lasker (gary-lasker)]

Hi mvo!! Thanks for this! I found some test failures and so made a few updates to fix these and also made other small needed fixes. I took the opportunity to do a bit of additional refactoring/simplifying as well to fully move the recommender UUID into the backend code.

You can see the updates that I made in my branch lp:~gary-lasker/software-center/get-installed-apps-instead-of-pkgs-tweaks.

The new test is really cool, and this is a nice bit of refactoring, thank you again!

review: Approve

=== modified file 'softwarecenter/backend/recagent.py'
--- softwarecenter/backend/recagent.py	2012-02-13 01:27:59 +0000
+++ softwarecenter/backend/recagent.py	2012-02-17 14:27:17 +0000
@@ -25,6 +25,10 @@
 import softwarecenter.paths
 from spawn_helper import SpawnHelper
 
+from softwarecenter.config import get_config
+from softwarecenter.db.utils import get_installed_apps_list
+from softwarecenter.utils import get_uuid
+
 LOG = logging.getLogger(__name__)
 
 class RecommenderAgent(GObject.GObject):
@@ -38,11 +42,11 @@
                      GObject.TYPE_NONE, 
                      (GObject.TYPE_PYOBJECT,),
                     ),
-        "submit-profile" : (GObject.SIGNAL_RUN_LAST,
+        "submit-profile-finished" : (GObject.SIGNAL_RUN_LAST,
                             GObject.TYPE_NONE, 
-                            (GObject.TYPE_PYOBJECT,),
+                            (GObject.TYPE_PYOBJECT, str),
                            ),
-        "submit-anon-profile" : (GObject.SIGNAL_RUN_LAST,
+        "submit-anon-profile-finished" : (GObject.SIGNAL_RUN_LAST,
                                  GObject.TYPE_NONE, 
                                  (GObject.TYPE_PYOBJECT,),
                                 ),
@@ -68,9 +72,30 @@
                   ),
         }
     
-    def __init__(self, xid=None):
+    def __init__(self, db, xid=None):
         GObject.GObject.__init__(self)
         self.xid = xid
+        self.db = db
+        self.recommender_uuid = ""
+
+    def _get_recommender_uuid(self):
+        # FIXME: probs should just pass this on in instead of reading config
+        config = get_config()
+        if config.has_option("general", "recommender_uuid"):
+            self.recommender_uuid = config.get("general",
+                                               "recommender_uuid")
+        else:
+            self.recommender_uuid = get_uuid()
+        return self.recommender_uuid
+
+    def _generate_submit_profile_data(self, recommender_uuid, package_list):
+        submit_profile_data = [
+            {
+                'uuid': recommender_uuid, 
+                'package_list': package_list
+            }
+        ]
+        return submit_profile_data
         
     def query_server_status(self):
         # build the command
@@ -82,7 +107,17 @@
         spawner.run_generic_piston_helper(
             "SoftwareCenterRecommenderAPI", "server_status")
             
-    def query_submit_profile(self, data):
+    def post_submit_profile(self):
+        """ This will post the users profile to the recommender server
+            and also generate the UUID for the user if that is not 
+            there yet
+        """
+        # garther the data
+        recommender_uuid = self._get_recommender_uuid()
+        installed_pkglist = [app.pkgname 
+                             for app in get_installed_apps_list(self.db)]
+        data = self._generate_submit_profile_data(
+            recommender_uuid, installed_pkglist)
         # build the command
         spawner = SpawnHelper()
         spawner.parent_xid = self.xid
@@ -94,7 +129,7 @@
             "submit_profile",
             data=data)
             
-    def query_submit_anon_profile(self, uuid, installed_packages, extra):
+    def post_submit_anon_profile(self, uuid, installed_packages, extra):
         # build the command
         spawner = SpawnHelper()
         spawner.parent_xid = self.xid
@@ -166,7 +201,11 @@
         self.emit("profile", piston_profile)
         
     def _on_submit_profile_data(self, spawner, piston_submit_profile):
-        self.emit("submit-profile", piston_submit_profile)
+        self.emit("submit-profile-finished", 
+                  piston_submit_profile, 
+                  # FIXME: do we need this or is this part of the 
+                  #        piston_submit_profile response?
+                  self.recommender_uuid)
         
     def _on_submit_anon_profile_data(self, spawner, piston_submit_anon_profile):
         self.emit("submit-anon_profile", piston_submit_anon_profile)

=== modified file 'softwarecenter/db/database.py'
--- softwarecenter/db/database.py	2012-01-03 11:27:15 +0000
+++ softwarecenter/db/database.py	2012-02-17 14:27:17 +0000
@@ -374,6 +374,13 @@
                 pass
         return summary
 
+    def get_application(self, doc):
+        """ Return a application from a xapian document """
+        appname = self.get_appname(doc)
+        pkgname = self.get_pkgname(doc)
+        iconname = self.get_iconname(doc)
+        return Application(appname, pkgname, iconname)
+
     def get_pkgname(self, doc):
         """ Return a packagename from a xapian document """
         pkgname = doc.get_value(XapianValues.PKGNAME)

=== modified file 'softwarecenter/db/utils.py'
--- softwarecenter/db/utils.py	2012-02-15 09:06:51 +0000
+++ softwarecenter/db/utils.py	2012-02-17 14:27:17 +0000
@@ -30,6 +30,17 @@
                              xapian.Query("AP"+pkgname))
     return query
     
+def get_installed_apps_list(db):
+    """ return a list of installed applications """
+    apps = set()
+    for doc in db:
+        if db.get_appname(doc):
+            pkgname = db.get_pkgname(doc)
+            if (pkgname in db._aptcache and
+                db._aptcache[pkgname].is_installed):
+                apps.add(db.get_application(doc))
+    return apps
+
 def get_installed_package_list():
     """ return a set of all of the currently installed packages """
     from softwarecenter.db.pkginfo import get_pkg_info

=== modified file 'softwarecenter/ui/gtk3/widgets/recommendations.py'
--- softwarecenter/ui/gtk3/widgets/recommendations.py	2012-02-15 15:40:41 +0000
+++ softwarecenter/ui/gtk3/widgets/recommendations.py	2012-02-17 14:27:17 +0000
@@ -28,9 +28,7 @@
 from softwarecenter.db.categories import (RecommendedForYouCategory,
                                           AppRecommendationsCategory)
 from softwarecenter.backend.recagent import RecommenderAgent
-from softwarecenter.db.utils import get_installed_package_list
-from softwarecenter.utils import get_uuid
-from softwarecenter.config import get_config
+
 
 LOG = logging.getLogger(__name__)
 
@@ -80,17 +78,12 @@
         RecommendationsPanel.__init__(self, catview)
         self.set_header_label(_(u"Recommended for You"))
         
-        self.recommender_uuid = ""
-        # FIXME: probs should just pass this on in instead of reading config
         config = get_config()
         if config.has_option("general", "recommender_uuid"):
-            self.recommender_uuid = config.get("general",
-                                               "recommender_uuid")
-        
-        if not self.recommender_uuid:
+            self.recommender_uuid = config.get("general", "recommender_uuid")
+            self._update_recommended_for_you_content()
+        else:
             self._show_opt_in_view()
-        else:
-            self._update_recommended_for_you_content()
             
         self.add(self.recommended_for_you_content)
         self.header_implements_more_button()
@@ -132,22 +125,18 @@
     def _upload_user_profile(self):
         self.spinner.set_text(_("Submitting inventory…"))
         self.show_spinner()
-        self.recommender_uuid = get_uuid()
-        installed_pkglist = list(get_installed_package_list())
-        self.recommender_agent.connect("submit-profile",
+        self.recommender_agent.connect("submit-profile-finished",
                                   self._on_profile_submitted)
         self.recommender_agent.connect("error",
                                   self._on_profile_submitted_error)
-        self.recommender_agent.query_submit_profile(
-                self._generate_submit_profile_data(self.recommender_uuid, 
-                                                   installed_pkglist))
+        self.recommender_agent.do_submit_profile()
                                                 
-    def _on_profile_submitted(self):
+    def _on_profile_submitted(self, agent, profile, recommender_uuid):
         # after the user profile data has been uploaded, make the request
         # and load the the recommended_for_you content
         LOG.debug("The recommendations profile has been successfully "
                   "submitted to the recommender agent")
-        self.emit("recommendations-opt-in", self.recommender_uuid)
+        self.emit("recommendations-opt-in", recommender_uuid)
         self._update_recommended_for_you_content()
         
     def _on_profile_submitted_error(self, agent, msg):
@@ -195,16 +184,6 @@
         # and hide the pane
         self.hide()
         
-    def _generate_submit_profile_data(self,
-                                      recommender_uuid,
-                                      package_list):
-        submit_profile_data = [
-            {
-                'uuid': recommender_uuid, 
-                'package_list': package_list
-            }
-        ]
-        return submit_profile_data
         
 class RecommendationsPanelDetails(RecommendationsPanel):
     """

=== modified file 'test/test_database.py'
--- test/test_database.py	2012-02-15 16:55:32 +0000
+++ test/test_database.py	2012-02-17 14:27:17 +0000
@@ -458,11 +458,24 @@
         self.assertTrue(len(enquirer.get_docids()) > 0)
         # FIXME: test more of the interface
         
+class UtilsTestCase(unittest.TestCase):
+
     def test_utils_get_installed_package_list(self):
         from softwarecenter.db.utils import get_installed_package_list
         installed_pkgs = get_installed_package_list()
         self.assertTrue(len(installed_pkgs) > 0)
 
+    def test_utils_get_installed_apps_list(self):
+        from softwarecenter.db.utils import (
+            get_installed_package_list,get_installed_apps_list)
+        db = get_test_db()
+        # installed pkgs
+        installed_pkgs = get_installed_package_list()
+        # the installed apps
+        installed_apps = get_installed_apps_list(db)
+        self.assertTrue(len(installed_apps) > 0)
+        self.assertTrue(len(installed_pkgs) > len(installed_apps))
+
 
 def make_purchased_app_details(db=None, supported_series=None):
     """Return an AppDetail instance with the required attributes."""

=== modified file 'test/test_recagent.py'
--- test/test_recagent.py	2012-02-15 17:06:32 +0000
+++ test/test_recagent.py	2012-02-17 14:27:17 +0000
@@ -3,13 +3,19 @@
 from gi.repository import GObject
 import unittest
 import os
+import uuid
+
+from mock import patch
 
 from testutils import setup_test_env
 setup_test_env()
 
 from softwarecenter.backend.recagent import RecommenderAgent
 
-from softwarecenter.testutils import make_recommender_profile_upload_data
+from softwarecenter.testutils import (
+    make_recommender_profile_upload_data, 
+    get_test_db,
+)
 
 class TestRecommenderAgent(unittest.TestCase):
     """ tests the recommender agent """
@@ -27,7 +33,26 @@
         else:
             os.environ["SOFTWARE_CENTER_RECOMMENDER_HOST"] = self.orig_host
 
-    def on_query_done(self, recagent, data):
+    @patch('softwarecenter.backend.recagent.SpawnHelper'
+           '.run_generic_piston_helper')
+    def test_mocked_recagent_post_submit_profile(self, mock_spawn_helper_run):
+        def _patched_on_submit_profile_data(*args, **kwargs):
+            piston_submit_profile = {}
+            recommender_agent.emit("submit-profile-finished", 
+                                   piston_submit_profile, 
+                                   uuid.uuid1())
+        mock_spawn_helper_run.side_effect = _patched_on_submit_profile_data
+        db = get_test_db()
+        recommender_agent = RecommenderAgent(db)
+        recommender_agent.connect("submit-profile-finished", self.on_query_done)
+        recommender_agent.connect("error", self.on_query_error)
+        recommender_agent.post_submit_profile()
+        self.assertFalse(self.error)
+        args, kwargs =  mock_spawn_helper_run.call_args
+        self.assertNotEqual(kwargs['data'][0]['uuid'], None)
+        self.assertNotEqual(kwargs['data'][0]['package_list'], [])
+
+    def on_query_done(self, recagent, data, uuid=""):
         print "query done, data: '%s'" % data
         self.loop.quit()
         
@@ -45,15 +70,16 @@
         self.loop.run()
         self.assertFalse(self.error)
         
-    # FIXME: disabled for now as the server is not quite working
-    def disabled_test_recagent_query_submit_profile(self):
+    def disabled_test_recagent_post_submit_profile(self, mock_request):
         # NOTE: This requires a working recommender host that is reachable
-        recommender_agent = RecommenderAgent()
-        recommender_agent.connect("submit-profile", self.on_query_done)
+        db = get_test_db()
+        recommender_agent = RecommenderAgent(db)
+        recommender_agent.connect("submit-profile-finished", self.on_query_done)
         recommender_agent.connect("error", self.on_query_error)
-        recommender_agent.query_submit_profile(data=make_recommender_profile_upload_data())
+        recommender_agent.post_submit_profile()
         self.loop.run()
         self.assertFalse(self.error)
+        #print mock_request._post
         
 #    def disabled_test_recagent_query_submit_anon_profile(self):
 #        # NOTE: This requires a working recommender host that is reachable