~saprativejana/mailman/install_doc

« back to all changes in this revision

Viewing changes to src/mailman/rest/tests/test_uids.py

  • Committer: Barry Warsaw
  • Date: 2015-02-13 08:13:06 UTC
  • Revision ID: barry@list.org-20150213081306-1b567rjfxqw45ti6
 * A new API is provided to support non-production testing infrastructures,
   allowing a client to cull all orphaned UIDs via ``DELETE`` on
   ``<api>/reserved/uids/orphans``.  Note that *no guarantees* of API
   stability will ever be made for resources under ``reserved``.
   (LP: #1420083)

Also:

- Allow @dbconnection methods to be @staticmethods taking only one argument,
  the store to perform the query on.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2015 by the Free Software Foundation, Inc.
 
2
#
 
3
# This file is part of GNU Mailman.
 
4
#
 
5
# GNU Mailman is free software: you can redistribute it and/or modify it under
 
6
# the terms of the GNU General Public License as published by the Free
 
7
# Software Foundation, either version 3 of the License, or (at your option)
 
8
# any later version.
 
9
#
 
10
# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT
 
11
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 
12
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 
13
# more details.
 
14
#
 
15
# You should have received a copy of the GNU General Public License along with
 
16
# GNU Mailman.  If not, see <http://www.gnu.org/licenses/>.
 
17
 
 
18
"""Test deletion of orphaned UIDs.
 
19
 
 
20
There is no doctest for this functionality, since it's only useful for testing
 
21
of external clients of the REST API.
 
22
"""
 
23
 
 
24
__all__ = [
 
25
    'TestUIDs',
 
26
    ]
 
27
 
 
28
 
 
29
import unittest
 
30
 
 
31
from mailman.config import config
 
32
from mailman.database.transaction import transaction
 
33
from mailman.interfaces.usermanager import IUserManager
 
34
from mailman.model.uid import UID
 
35
from mailman.testing.helpers import call_api
 
36
from mailman.testing.layers import RESTLayer
 
37
from zope.component import getUtility
 
38
 
 
39
 
 
40
 
 
41
class TestUIDs(unittest.TestCase):
 
42
    layer = RESTLayer
 
43
 
 
44
    def test_delete_orphans(self):
 
45
        # When users are deleted, their UIDs are generally not deleted.  We
 
46
        # never delete rows from that table in order to guarantee no
 
47
        # duplicates.  However, some external testing frameworks want to be
 
48
        # able to reset the UID table, so they can use this interface to do
 
49
        # so.  See LP: #1420083.
 
50
        #
 
51
        # Create some users.
 
52
        manager = getUtility(IUserManager)
 
53
        users_by_uid = {}
 
54
        with transaction():
 
55
            for i in range(10):
 
56
                user = manager.create_user()
 
57
                users_by_uid[user.user_id] = user
 
58
                # The testing infrastructure does not record the UIDs for new
 
59
                # user options, so do that now to mimic the real system.
 
60
                UID.record(user.user_id)
 
61
        # We now have 10 unique uids.
 
62
        self.assertEqual(len(users_by_uid), 10)
 
63
        # Now delete all the users.
 
64
        with transaction():
 
65
            for user in list(users_by_uid.values()):
 
66
                manager.delete_user(user)
 
67
        # There are still 10 unique uids in the database.
 
68
        self.assertEqual(UID.get_total_uid_count(), 10)
 
69
        # Cull the orphan UIDs.
 
70
        content, response = call_api(
 
71
            'http://localhost:9001/3.0/reserved/uids/orphans',
 
72
            method='DELETE')
 
73
        self.assertEqual(response.status, 204)
 
74
        # Now there are no uids in the table.
 
75
        config.db.abort()
 
76
        self.assertEqual(UID.get_total_uid_count(), 0)