Changeset c9c68cb4856333078390a4fedecaed57636682bc

Timestamp:

05/28/2011 02:56:31 PM (2 years ago)

Author:

Loic Dachary <loic@…>

Children:

cbaf5abc0bd22defc08e9cee4c5e9ba77daf7791

Parents:

aff7187e7c0c6e5a15b2ac000e44a46a8f578b10

git-committer:

Loic Dachary <loic@…> (05/28/2011 02:56:31 PM)

Message:

Add the listen and notify functions to CardstoriesServices?. listen() returns a deferred that will be called when a) the service is started (type start), b) the service is stopped (type stop), c) a game is deleted (type delete), d) a game has changed (type change). The result argument of the callback is a map with a "type" member set as explained above. When the type is either "delete" or "change", it the "game" member is the CardstoriesGame? object to which the even relates. The "detail" member further describes the event when the "type" is "change" or it is set to None when the "type" is "delete". refs#62

Files:

• cardstories/service.py (modified) (4 diffs)
• tests/test_service.py (modified) (4 diffs)

cardstories/service.py

@@ -55 +55 @@
         self.games = {}
         self.players = {}
+        self.listeners = []
+
+    def listen(self):
+        d = defer.Deferred()
+        self.listeners.append(d)
+        return d
+
+    def notify(self, result):
+        if hasattr(self, 'notify_running'):
+            raise UserWarning, 'recursive call to notify'
+        self.notify_running = True
+        listeners = self.listeners
+        self.listeners = []
+        def error(reason):
+            reason.printDetailedTraceback()
+            return True
+        for listener in listeners:
+            listener.addErrback(error)
+            listener.callback(result)
+        del self.notify_running
 
     def startService(self):
@@ -69 +89 @@
         db.close()
         self.db = adbapi.ConnectionPool("sqlite3", database=database, cp_noisy=True)
+        self.notify({'type': 'start'})
         
     def stopService(self):
+        self.notify({'type': 'stop'})
         for game in self.games.values():
             game.destroy()
@@ -171 +193 @@
     def game_notify(self, args, game_id):
         if args == None:
+            self.notify({'type': 'delete', 'game': self.games[game_id], 'details': args})
             del self.games[game_id]
             return False
@@ -176 +199 @@
             return False
         game = self.games[game_id]
+        self.notify({'type': 'change', 'game': game, 'details': args})
         for player_id in game.get_players():
             if self.players.has_key(player_id):

tests/test_service.py

@@ -32 +32 @@
 base.DelayedCall.debug = True
 
+class CardstoriesServiceTestNotify(unittest.TestCase):
+    
+    def test00_notify(self):
+        service = CardstoriesService({})
+        d = service.listen()
+        def check(result):
+            self.assertTrue(result)
+            service.checked = True
+            return result
+        d.addCallback(check)
+        service.notify(True)
+        self.assertTrue(service.checked)
+
+    def test01_notify_recursive(self):
+        service = CardstoriesService({})
+        d = service.listen()
+        def recurse(result):
+            try:
+                service.notify(False)
+            except UserWarning, e:
+                self.failUnlessSubstring('recurs', e.args[0])
+                service.recursed = True
+            return result
+        d.addCallback(recurse)
+        service.notify(True)
+        self.assertTrue(service.recursed)
+
+    def test02_notify_ignore_exception(self):
+        service = CardstoriesService({})
+        d = service.listen()
+        def fail(result):
+            service.raised = True
+            raise UserWarning, 'raise exception'
+        d.addCallback(fail)
+        service.notify(True)
+        self.assertTrue(service.raised)
+
 class CardstoriesServiceTestInit(unittest.TestCase):
 
@@ -38 +75 @@
         service = CardstoriesService({'db': database})
         self.assertFalse(os.path.exists(database))
+        def start(event):
+            self.assertEqual(event['type'], 'start')
+            service.notified_start = True
+            return event
+        service.listen().addCallback(start)
         service.startService()
+        self.assertTrue(service.notified_start)
         self.assertTrue(os.path.exists(database))
-        return service.stopService()
+        def stop(event):
+            self.assertEqual(event['type'], 'stop')
+            service.notified_stop = True
+            return event
+        service.listen().addCallback(stop)
+        d = service.stopService()
+        self.assertTrue(service.notified_stop)
+        return d
 
     @defer.inlineCallbacks
@@ -395 +445 @@
             self.assertEquals(result['player_id'], [owner_id])
             self.assertEquals(result['game_id'], [game.id])
+            game.checked = True
             return result
         d.addCallback(check)
+        def change(event):
+            self.assertTrue(event['type'], 'change')
+            self.assertTrue(event['game'].get_id(), game.get_id())
+            game.changed = True
+        self.service.listen().addCallback(change)
         game.touch() # calls game_notify indirectly
+        self.assertTrue(game.checked)
+        self.assertTrue(game.changed)
+        #
+        # Event notification when a game is destroyed
+        #
+        def destroy(event):
+            self.assertTrue(event['type'], 'delete')
+            self.assertTrue(event['game'].get_id(), game.get_id())
+            game.destroyed = True
+        self.service.listen().addCallback(destroy)            
+        game.destroy()
+        self.assertTrue(game.destroyed)
         #
         # calling game_notify on a non existent game is a noop
@@ -564 +632 @@
 #    loader.methodPrefix = "test11_"
     suite = loader.suiteFactory()
+    suite.addTest(loader.loadClass(CardstoriesServiceTestNotify))
     suite.addTest(loader.loadClass(CardstoriesServiceTestInit))
     suite.addTest(loader.loadClass(CardstoriesServiceTest))