Merge lp:~toshio/mailman/count into lp:mailman

[Toshio Kuratomi]

Expose the volume and count of members per mailing list in the rest api.

[Barry Warsaw (barry)]

Looks great! Another useful test (and it can be a unittest or doctest) would be to show that adding new members (probably behind the scenes) changes that members value. I'll mark this needs fixing for now, but that should be a pretty easy test to add.

As discussed at the sprint, we can make this more efficient later by adding an API to IRoster, but don't worry about that for this branch.

review: Needs Fixing

[lp:~toshio/mailman/count]

7118. By toshio <email address hidden> on 2012-03-15

Merge upstream

7119. By toshio <email address hidden> on 2012-03-15

Unittest to show that adding members to a list is reflected in the rest api

[Barry Warsaw (barry)]

Looks great, thanks. I'll make the one change that checks response.status == 200 via self.assertEquals().

review: Approve

=== modified file 'src/mailman/rest/docs/domains.rst'
--- src/mailman/rest/docs/domains.rst	2011-08-31 02:04:14 +0000
+++ src/mailman/rest/docs/domains.rst	2012-03-15 21:46:20 +0000
@@ -139,7 +139,7 @@
         fqdn_listname: [e-mail]
         http_etag: "..."
         ...
-        self_link: http://localhost:9001/3.0/lists/[e-mail]
+        volume: 1
     http_etag: "..."
     start: 0
     total_size: 1

=== modified file 'src/mailman/rest/docs/lists.rst'
--- src/mailman/rest/docs/lists.rst	2011-08-31 02:04:14 +0000
+++ src/mailman/rest/docs/lists.rst	2012-03-15 21:46:20 +0000
@@ -24,8 +24,10 @@
         http_etag: "..."
         list_name: test-one
         mail_host: example.com
+        member_count: 0
         real_name: Test-one
         self_link: http://localhost:9001/3.0/lists/[e-mail]
+        volume: 1
     http_etag: "..."
     start: 0
     total_size: 1
@@ -39,8 +41,10 @@
         http_etag: "..."
         list_name: test-one
         mail_host: example.com
+        member_count: 0
         real_name: Test-one
         self_link: http://localhost:9001/3.0/lists/[e-mail]
+        volume: 1
     http_etag: "..."
     start: 0
     total_size: 1
@@ -86,8 +90,10 @@
     http_etag: "..."
     list_name: test-two
     mail_host: example.com
+    member_count: 0
     real_name: Test-two
     self_link: http://localhost:9001/3.0/lists/[e-mail]
+    volume: 1
 
 However, you are not allowed to create a mailing list in a domain that does
 not exist.

=== modified file 'src/mailman/rest/lists.py'
--- src/mailman/rest/lists.py	2012-01-30 15:37:16 +0000
+++ src/mailman/rest/lists.py	2012-03-15 21:46:20 +0000
@@ -109,6 +109,8 @@
             mail_host=mlist.mail_host,
             list_name=mlist.list_name,
             real_name=mlist.real_name,
+            member_count=len(tuple(mlist.members.members)),
+            volume=mlist.volume,
             self_link=path_to('lists/{0}'.format(mlist.fqdn_listname)),
             )
 

=== modified file 'src/mailman/rest/tests/test_lists.py'
--- src/mailman/rest/tests/test_lists.py	2012-01-01 19:14:46 +0000
+++ src/mailman/rest/tests/test_lists.py	2012-03-15 21:46:20 +0000
@@ -28,12 +28,17 @@
 
 from urllib2 import HTTPError
 
+from zope.component import getUtility
+
+from mailman.app.lifecycle import create_list
+from mailman.config import config
+from mailman.interfaces.usermanager import IUserManager
 from mailman.testing.helpers import call_api
 from mailman.testing.layers import RESTLayer
 
 
 

-class TestLists(unittest.TestCase):
+class TestListsMissing(unittest.TestCase):
     layer = RESTLayer
 
     def test_missing_list_roster_member_404(self):
@@ -79,3 +84,40 @@
             self.assertEqual(exc.code, 404)
         else:
             raise AssertionError('Expected HTTPError')
+
+class TestLists(unittest.TestCase):
+    layer = RESTLayer
+
+    def setUp(self):
+        self._mlist = create_list('[e-mail]')
+        config.db.commit()
+        self._usermanager = getUtility(IUserManager)
+
+    def test_list_members_count(self):
+        # The list initially has 0 members
+        list_info, response = call_api('http://localhost:9001/3.0/lists/[e-mail]')
+        if response.status != 200:
+            raise AssertionError('Got an error from rest server: {0}'.format(response.status))
+        self.assertEqual(list_info['member_count'], 0)
+
+        # Add a member to a list
+        alice = self._usermanager.create_address('[e-mail]')
+        self._mlist.subscribe(alice)
+        config.db.commit()
+
+        # Make sure that the api returns one member now
+        list_info, response = call_api('http://localhost:9001/3.0/lists/[e-mail]')
+        if response.status != 200:
+            raise AssertionError('Got an error from rest server: {0}'.format(response.status))
+        self.assertEqual(list_info['member_count'], 1)
+
+        # Add a second member to it
+        bob = self._usermanager.create_address('[e-mail]')
+        self._mlist.subscribe(bob)
+        config.db.commit()
+
+        # Make sure that the api returns two members now
+        list_info, response = call_api('http://localhost:9001/3.0/lists/[e-mail]')
+        if response.status != 200:
+            raise AssertionError('Got an error from rest server: {0}'.format(response.status))
+        self.assertEqual(list_info['member_count'], 2)