Merge lp:~mvo/software-center/recagent-test-cleanup into lp:software-center

[Michael Vogt]

Small branch that consolidates code in test_recagent into common
functions

[Gary Lasker (gary-lasker)]

Hi Michael, this all seems good and the cleanup is great. I assume all of these tests are working for you now, but I am consistently getting 401 errors for three of the tests (see below). It's late though, we can look at this tomorrow.

$ PYTHONPATH=. python tests/test_recagent.py
.No handlers could be found for logger "softwarecenter.backend.spawn_helper"
F.F..F..s
======================================================================
FAIL: test_recagent_post_submit_profile (__main__.TestRecommenderAgent)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "tests/test_recagent.py", line 81, in test_recagent_post_submit_profile
    self.assertServerReturnsWithNoError()
  File "tests/test_recagent.py", line 68, in assertServerReturnsWithNoError
    self.assertFalse(self.error, "got error: '%s'" % self.error_msg)
AssertionError: got error: 'WARNING:__main__:401: {'status': '401', 'content-length': '22', 'via': '1.1 myrica.canonical.com:3128 (squid/2.7.STABLE7)', 'x-cache': 'MISS from myrica.canonical.com', 'x-cache-lookup': 'MISS from myrica.canonical.com:3128', 'expires': 'Wed, 29 Aug 2012 02:04:18 GMT', 'vary': 'Authorization,Accept-Encoding', '-content-encoding': 'gzip', 'server': 'Apache/2.2.22 (Ubuntu)', 'last-modified': 'Wed, 29 Aug 2012 02:04:18 GMT', 'etag': '"7e287fc885d9fdcf42da3a12f38572c1"', 'strict-transport-security': 'max-age=2592000', 'cache-control': 'max-age=0', 'date': 'Wed, 29 Aug 2012 02:04:18 GMT', 'content-type': 'text/html; charset=utf-8', 'www-authenticate': 'OAuth realm="SoftwareCenter Agent"'}
'

======================================================================
FAIL: test_recagent_query_profile (__main__.TestRecommenderAgent)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "tests/test_recagent.py", line 97, in test_recagent_query_profile
    self.assertServerReturnsWithNoError()
  File "tests/test_recagent.py", line 68, in assertServerReturnsWithNoError
    self.assertFalse(self.error, "got error: '%s'" % self.error_msg)
AssertionError: got error: 'WARNING:__main__:401: {'status': '401', 'content-length': '22', 'via': '1.1 myrica.canonical.com:3128 (squid/2.7.STABLE7)', 'x-cache': 'MISS from myrica.canonical.com', 'x-cache-lookup': 'MISS from myrica.canonical.com:3128', 'expires': 'Wed, 29 Aug 2012 02:04:24 GMT', 'vary': 'Authorization,Accept-Encoding', '-content-encoding': 'gzip', 'server': 'Apache/2.2.22 (Ubuntu)', 'last-modified': 'Wed, 29 Aug 2012 02:04:24 GMT', 'etag': '"7e287fc885d9fdcf42da3a12f38572c1"', 'strict-transport-security': 'max-age=2592000', 'cache-control': 'max-age=0', 'date': 'Wed, 29 Aug 2012 02:04:24 GMT', 'content-type': 'text/html; charset=utf-8', 'www-authenticate': 'OAuth realm="SoftwareCenter Agent"'}
'

======================================================================
FAIL: test_recagent_query_recommend_me (__main__.TestRecommenderAgent)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "tests/test_recagent.py", line 102, in test_recagent_query_recommend_me
    self.assertServerReturnsWithNoErro...

[Michael Vogt (mvo)]

On Wed, Aug 29, 2012 at 02:07:19AM -0000, Gary Lasker wrote:
> Hi Michael, this all seems good and the cleanup is great. I assume all of these tests are working for you now, but I am consistently getting 401 errors for three of the tests (see below). It's late though, we can look at this tomorrow.

Thanks, I guess we need to add skip decorators again for those, it
seems to be dependant on the account of maybe on the time the tests
are run :) I wonder if instead we should build a mock service but I
guess that is a bit too much work :/

> $ PYTHONPATH=. python tests/test_recagent.py
> .No handlers could be found for logger "softwarecenter.backend.spawn_helper"
> F.F..F..s
> ======================================================================
> FAIL: test_recagent_post_submit_profile (__main__.TestRecommenderAgent)
> ----------------------------------------------------------------------
> Traceback (most recent call last):
> File "tests/test_recagent.py", line 81, in test_recagent_post_submit_profile
> self.assertServerReturnsWithNoError()
> File "tests/test_recagent.py", line 68, in assertServerReturnsWithNoError
> self.assertFalse(self.error, "got error: '%s'" % self.error_msg)
> AssertionError: got error: 'WARNING:__main__:401: {'status': '401', 'content-length': '22', 'via': '1.1 myrica.canonical.com:3128 (squid/2.7.STABLE7)', 'x-cache': 'MISS from myrica.canonical.com', 'x-cache-lookup': 'MISS from myrica.canonical.com:3128', 'expires': 'Wed, 29 Aug 2012 02:04:18 GMT', 'vary': 'Authorization,Accept-Encoding', '-content-encoding': 'gzip', 'server': 'Apache/2.2.22 (Ubuntu)', 'last-modified': 'Wed, 29 Aug 2012 02:04:18 GMT', 'etag': '"7e287fc885d9fdcf42da3a12f38572c1"', 'strict-transport-security': 'max-age=2592000', 'cache-control': 'max-age=0', 'date': 'Wed, 29 Aug 2012 02:04:18 GMT', 'content-type': 'text/html; charset=utf-8', 'www-authenticate': 'OAuth realm="SoftwareCenter Agent"'}
> '
>
> ======================================================================
> FAIL: test_recagent_query_profile (__main__.TestRecommenderAgent)
> ----------------------------------------------------------------------
> Traceback (most recent call last):
> File "tests/test_recagent.py", line 97, in test_recagent_query_profile
> self.assertServerReturnsWithNoError()
> File "tests/test_recagent.py", line 68, in assertServerReturnsWithNoError
> self.assertFalse(self.error, "got error: '%s'" % self.error_msg)
> AssertionError: got error: 'WARNING:__main__:401: {'status': '401', 'content-length': '22', 'via': '1.1 myrica.canonical.com:3128 (squid/2.7.STABLE7)', 'x-cache': 'MISS from myrica.canonical.com', 'x-cache-lookup': 'MISS from myrica.canonical.com:3128', 'expires': 'Wed, 29 Aug 2012 02:04:24 GMT', 'vary': 'Authorization,Accept-Encoding', '-content-encoding': 'gzip', 'server': 'Apache/2.2.22 (Ubuntu)', 'last-modified': 'Wed, 29 Aug 2012 02:04:24 GMT', 'etag': '"7e287fc885d9fdcf42da3a12f38572c1"', 'strict-transport-security': 'max-age=2592000', 'cache-control': 'max-age=0', 'date': 'Wed, 29 Aug 2012 02:04:24 GMT', 'content-type': 'text/html; charset=utf-8', 'www-authenticate': 'OAuth realm="SoftwareCenter Agent"'}
> '
>
> ========...

[lp:~mvo/software-center/recagent-test-cleanup]

3128. By Michael Vogt on 2012-08-29

add some skip() decorators, refactor to move the Mock test into its own test case and simply it as it does not really need all the complex loop magic

[Michael Vogt (mvo)]

I added a bunch of skip() decorators now and also moved the mocked version into its own TestCase.

review: Needs Resubmitting

[Gary Lasker (gary-lasker)]

Thanks Michael, all good now!

review: Approve

=== modified file 'softwarecenter/backend/recagent.py'
--- softwarecenter/backend/recagent.py	2012-08-28 18:14:50 +0000
+++ softwarecenter/backend/recagent.py	2012-08-29 14:48:17 +0000
@@ -24,7 +24,7 @@
 import hashlib
 
 import softwarecenter.paths
-from spawn_helper import SpawnHelper
+from .spawn_helper import SpawnHelper
 
 from softwarecenter.config import get_config
 from softwarecenter.db.utils import get_installed_apps_list

=== modified file 'tests/test_recagent.py'
--- tests/test_recagent.py	2012-06-11 14:50:53 +0000
+++ tests/test_recagent.py	2012-08-29 14:48:17 +0000
@@ -10,12 +10,30 @@
 )
 setup_test_env()
 
+import softwarecenter
 from softwarecenter.backend.recagent import RecommenderAgent
 
 
-class TestRecommenderAgent(unittest.TestCase):
+class MockTestRecommenderAgent(unittest.TestCase):
+
+    @patch.object(softwarecenter.backend.recagent.SpawnHelper, 
+                  'run_generic_piston_helper')
+    def test_mocked_recagent_post_submit_profile(self, mock_spawn_helper_run):
+        recommender_agent = RecommenderAgent()
+        recommender_agent._calc_profile_id = lambda profile: "i-am-random"
+        db = get_test_db()
+        recommender_agent.post_submit_profile(db)
+        args, kwargs =  mock_spawn_helper_run.call_args
+        # ensure we have packages in the package list and the
+        # kwargs have the names we expect
+        self.assertNotEqual(kwargs['data'][0]['package_list'], [])
+
+
+class RealTestRecommenderAgent(unittest.TestCase):
     """ tests the recommender agent """
-
+    
+    @unittest.skipIf(os.getuid() == 0, 
+                     "this is not supported running as root")
     def setUp(self):
         self.loop = GObject.MainLoop(GObject.main_context_default())
         self.error = False
@@ -27,117 +45,78 @@
             self.addCleanup(os.environ.pop, "SOFTWARE_CENTER_RECOMMENDER_HOST")
         server = "https://rec.staging.ubuntu.com"
         os.environ["SOFTWARE_CENTER_RECOMMENDER_HOST"] = server
-
-    @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)
-        mock_spawn_helper_run.side_effect = _patched_on_submit_profile_data
-        recommender_agent = RecommenderAgent()
-        recommender_agent.connect("submit-profile-finished", self.on_query_done)
-        recommender_agent.connect("error", self.on_query_error)
-        recommender_agent._calc_profile_id = lambda profile: "i-am-random"
-        db = get_test_db()
-        recommender_agent.post_submit_profile(db)
-        self.assertFalse(self.error)
-        args, kwargs =  mock_spawn_helper_run.call_args
-        self.assertNotEqual(kwargs['data'][0]['package_list'], [])
+        # most tests need it
+        self.recommender_agent = RecommenderAgent()
+        self.recommender_agent.connect("error", self.on_query_error)
 
     def on_query_done(self, recagent, data):
-        # print "query done, data: '%s'" % data
+        #print "query done, data: '%s'" % data
         self.loop.quit()
+        self.error = False
+        self.error_msg = ""
 
     def on_query_error(self, recagent, error):
-        # print "query error received: ", error
+        #print "query error received: ", error
         self.loop.quit()
         self.error = True
+        self.error_msg = error
+
+    def assertServerReturnsWithNoError(self):
+        self.loop.run()
+        self.assertFalse(self.error, "got error: '%s'" % self.error_msg)
 
     def test_recagent_query_server_status(self):
-        # NOTE: This requires a working recommender host that is reachable
-        recommender_agent = RecommenderAgent()
-        recommender_agent.connect("server-status", self.on_query_done)
-        recommender_agent.connect("error", self.on_query_error)
-        recommender_agent.query_server_status()
-        self.loop.run()
-        self.assertFalse(self.error)
+        self.recommender_agent.connect("server-status", self.on_query_done)
+        self.recommender_agent.query_server_status()
+        self.assertServerReturnsWithNoError()
 
-    # FIXME: disabled for now as the server is not quite working
-    def disabled_test_recagent_post_submit_profile(self):
+    @unittest.skip("server returns 401")
+    def test_recagent_post_submit_profile(self):
         # NOTE: This requires a working recommender host that is reachable
-        recommender_agent = RecommenderAgent()
-        recommender_agent.connect("submit-profile-finished", self.on_query_done)
-        recommender_agent.connect("error", self.on_query_error)
         db = get_test_db()
-        recommender_agent.post_submit_profile(db)
-        self.loop.run()
-        self.assertFalse(self.error)
+        self.recommender_agent.connect(
+            "submit-profile-finished", self.on_query_done)
+        self.recommender_agent.post_submit_profile(db)
+        self.assertServerReturnsWithNoError()
         #print mock_request._post
-
-     # NOTE: this server call is currently not needed and not used
-#    def disabled_test_recagent_query_submit_anon_profile(self):
-#        # NOTE: This requires a working recommender host that is reachable
-#        recommender_agent = RecommenderAgent()
-#        recommender_agent.connect("submit-anon-profile", self.on_query_done)
-#        recommender_agent.connect("error", self.on_query_error)
-#        recommender_agent.query_submit_anon_profile(
-#                uuid=recommender_uuid,
-#                installed_packages=["pitivi", "fretsonfire"],
-#                extra="")
-#        self.loop.run()
-#        self.assertFalse(self.error)
-
-    # FIXME: disabled for now as the server is not quite working
-    def disabled_test_recagent_query_profile(self):
-        # NOTE: This requires a working recommender host that is reachable
-        recommender_agent = RecommenderAgent()
-        recommender_agent.connect("profile", self.on_query_done)
-        recommender_agent.connect("error", self.on_query_error)
-        recommender_agent.query_profile(pkgnames=["pitivi", "fretsonfire"])
-        self.loop.run()
-        self.assertFalse(self.error)
-
-    # FIXME: disabled for now as the server is not quite working
-    def disabled_test_recagent_query_recommend_me(self):
-        # NOTE: This requires a working recommender host that is reachable
-        recommender_agent = RecommenderAgent()
-        recommender_agent.connect("recommend-me", self.on_query_done)
-        recommender_agent.connect("error", self.on_query_error)
-        recommender_agent.query_recommend_me()
-        self.loop.run()
-        self.assertFalse(self.error)
+        
+    @unittest.skip("server returns 401")
+    def test_recagent_query_submit_anon_profile(self):
+        self.recommender_agent.connect(
+            "submit-anon-profile-finished", self.on_query_done)
+        self.recommender_agent.post_submit_anon_profile(
+                uuid="xxxyyyzzz",
+                installed_packages=["pitivi", "fretsonfire"],
+                extra="")
+        self.assertServerReturnsWithNoError()
+
+    @unittest.skip("server returns 401")
+    def test_recagent_query_profile(self):
+        self.recommender_agent.connect("profile", self.on_query_done)
+        self.recommender_agent.query_profile(pkgnames=["pitivi", "fretsonfire"])
+        self.assertServerReturnsWithNoError()
+
+    @unittest.skip("server returns 401")
+    def test_recagent_query_recommend_me(self):
+        self.recommender_agent.connect("recommend-me", self.on_query_done)
+        self.recommender_agent.query_recommend_me()
+        self.assertServerReturnsWithNoError()
 
     def test_recagent_query_recommend_app(self):
-        # NOTE: This requires a working recommender host that is reachable
-        recommender_agent = RecommenderAgent()
-        recommender_agent.connect("recommend-app", self.on_query_done)
-        recommender_agent.connect("error", self.on_query_error)
-        recommender_agent.query_recommend_app("pitivi")
-        self.loop.run()
-        self.assertFalse(self.error)
+        self.recommender_agent.connect("recommend-app", self.on_query_done)
+        self.recommender_agent.query_recommend_app("pitivi")
+        self.assertServerReturnsWithNoError()
 
-    # disabled for now (2012-03-20) as the server is returning 504
-    def disabled_test_recagent_query_recommend_all_apps(self):
-        # NOTE: This requires a working recommender host that is reachable
-        recommender_agent = RecommenderAgent()
-        recommender_agent.connect("recommend-all-apps", self.on_query_done)
-        recommender_agent.connect("error", self.on_query_error)
-        recommender_agent.query_recommend_all_apps()
-        self.loop.run()
-        self.assertFalse(self.error)
+    def test_recagent_query_recommend_all_apps(self):
+        self.recommender_agent.connect("recommend-all-apps", self.on_query_done)
+        self.recommender_agent.query_recommend_all_apps()
+        self.assertServerReturnsWithNoError()
 
     def test_recagent_query_recommend_top(self):
-        # NOTE: This requires a working recommender host that is reachable
-        recommender_agent = RecommenderAgent()
-        recommender_agent.connect("recommend-top", self.on_query_done)
-        recommender_agent.connect("error", self.on_query_error)
-        recommender_agent.query_recommend_top()
-        self.loop.run()
-        self.assertFalse(self.error)
+        self.recommender_agent.connect("recommend-top", self.on_query_done)
+        self.recommender_agent.query_recommend_top()
+        self.assertServerReturnsWithNoError()
 
-    @unittest.skip('Disabled, should be re-enabled ASAP')
     def test_recagent_query_error(self):
         # NOTE: This tests the error condition itself! it simply forces an error
         #       'cuz there definitely isn't a server here  :)
@@ -150,5 +129,8 @@
         self.loop.run()
         self.assertTrue(self.error)
 
+
 if __name__ == "__main__":
+    #import logging
+    #logging.basicConfig(level=logging.DEBUG)
     unittest.main()