summaryrefslogtreecommitdiff
path: root/tests/couch/test_atomicity.py
blob: 05932abf7a14c990a2c43801f3a2cd3b2fc147e7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
# -*- coding: utf-8 -*-
# test_couch_operations_atomicity.py
# Copyright (C) 2013, 2014 LEAP
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
Test atomicity of couch operations.
"""
import os
import pytest
import threading

from six.moves.urllib.parse import urljoin
from twisted.internet import defer
from uuid import uuid4

from leap.soledad.client import Soledad
from leap.soledad.common.couch.state import CouchServerState
from leap.soledad.common.couch import CouchDatabase

from test_soledad.util import (
    make_token_soledad_app,
    make_soledad_document_for_test,
    soledad_sync_target,
)
from test_soledad.util import CouchDBTestCase
from test_soledad.u1db_tests import TestCaseWithServer


REPEAT_TIMES = 20


@pytest.mark.needs_couch
@pytest.mark.usefixtures('method_tmpdir')
class CouchAtomicityTestCase(CouchDBTestCase, TestCaseWithServer):

    @staticmethod
    def make_app_after_state(state):
        return make_token_soledad_app(state)

    make_document_for_test = make_soledad_document_for_test

    sync_target = soledad_sync_target

    def _soledad_instance(self, user=None, passphrase=u'123',
                          prefix='',
                          secrets_path='secrets.json',
                          local_db_path='soledad.u1db', server_url='',
                          cert_file=None, auth_token=None):
        """
        Instantiate Soledad.
        """
        user = user or self.user

        # this callback ensures we save a document which is sent to the shared
        # db.
        def _put_doc_side_effect(doc):
            self._doc_put = doc

        soledad = Soledad(
            user,
            passphrase,
            secrets_path=os.path.join(self.tempdir, prefix, secrets_path),
            local_db_path=os.path.join(
                self.tempdir, prefix, local_db_path),
            server_url=server_url,
            cert_file=cert_file,
            auth_token=auth_token,
            shared_db=self.get_default_shared_mock(_put_doc_side_effect))
        self.addCleanup(soledad.close)
        return soledad

    def make_app(self):
        self.request_state = CouchServerState(self.couch_url)
        return self.make_app_after_state(self.request_state)

    def setUp(self):
        TestCaseWithServer.setUp(self)
        CouchDBTestCase.setUp(self)
        self.user = ('user-%s' % uuid4().hex)
        self.db = CouchDatabase.open_database(
            urljoin(self.couch_url, 'user-' + self.user),
            create=True,
            replica_uid='replica')
        self.startTwistedServer()

    def tearDown(self):
        self.db.delete_database()
        self.db.close()
        CouchDBTestCase.tearDown(self)
        TestCaseWithServer.tearDown(self)

    #
    # Sequential tests
    #

    def test_correct_transaction_log_after_sequential_puts(self):
        """
        Assert that the transaction_log increases accordingly with sequential
        puts.
        """
        doc = self.db.create_doc({'ops': 0})
        docs = [doc.doc_id]
        for i in range(0, REPEAT_TIMES):
            self.assertEqual(
                i + 1, len(self.db._get_transaction_log()))
            doc.content['ops'] += 1
            self.db.put_doc(doc)
            docs.append(doc.doc_id)

        # assert length of transaction_log
        transaction_log = self.db._get_transaction_log()
        self.assertEqual(
            REPEAT_TIMES + 1, len(transaction_log))

        # assert that all entries in the log belong to the same doc
        self.assertEqual(REPEAT_TIMES + 1, len(docs))
        for doc_id in docs:
            self.assertEqual(
                REPEAT_TIMES + 1,
                len(filter(lambda t: t[0] == doc_id, transaction_log)))

    def test_correct_transaction_log_after_sequential_deletes(self):
        """
        Assert that the transaction_log increases accordingly with sequential
        puts and deletes.
        """
        docs = []
        for i in range(0, REPEAT_TIMES):
            doc = self.db.create_doc({'ops': 0})
            self.assertEqual(
                2 * i + 1, len(self.db._get_transaction_log()))
            docs.append(doc.doc_id)
            self.db.delete_doc(doc)
            self.assertEqual(
                2 * i + 2, len(self.db._get_transaction_log()))

        # assert length of transaction_log
        transaction_log = self.db._get_transaction_log()
        self.assertEqual(
            2 * REPEAT_TIMES, len(transaction_log))

        # assert that each doc appears twice in the transaction_log
        self.assertEqual(REPEAT_TIMES, len(docs))
        for doc_id in docs:
            self.assertEqual(
                2,
                len(filter(lambda t: t[0] == doc_id, transaction_log)))

    @defer.inlineCallbacks
    def test_correct_sync_log_after_sequential_syncs(self):
        """
        Assert that the sync_log increases accordingly with sequential syncs.
        """
        sol = self._soledad_instance(
            auth_token='auth-token',
            server_url=self.getURL())
        source_replica_uid = sol._dbpool.replica_uid

        def _create_docs():
            deferreds = []
            for i in xrange(0, REPEAT_TIMES):
                deferreds.append(sol.create_doc({}))
            return defer.gatherResults(deferreds)

        def _assert_transaction_and_sync_logs(results, sync_idx):
            # assert sizes of transaction and sync logs
            self.assertEqual(
                sync_idx * REPEAT_TIMES,
                len(self.db._get_transaction_log()))
            gen, _ = self.db._get_replica_gen_and_trans_id(source_replica_uid)
            self.assertEqual(sync_idx * REPEAT_TIMES, gen)

        def _assert_sync(results, sync_idx):
            gen, docs = results
            self.assertEqual((sync_idx + 1) * REPEAT_TIMES, gen)
            self.assertEqual((sync_idx + 1) * REPEAT_TIMES, len(docs))
            # assert sizes of transaction and sync logs
            self.assertEqual((sync_idx + 1) * REPEAT_TIMES,
                             len(self.db._get_transaction_log()))
            target_known_gen, target_known_trans_id = \
                self.db._get_replica_gen_and_trans_id(source_replica_uid)
            # assert it has the correct gen and trans_id
            conn_key = sol._dbpool._u1dbconnections.keys().pop()
            conn = sol._dbpool._u1dbconnections[conn_key]
            sol_gen, sol_trans_id = conn._get_generation_info()
            self.assertEqual(sol_gen, target_known_gen)
            self.assertEqual(sol_trans_id, target_known_trans_id)

        # sync first time and assert success
        results = yield _create_docs()
        _assert_transaction_and_sync_logs(results, 0)
        yield sol.sync()
        results = yield sol.get_all_docs()
        _assert_sync(results, 0)

        # create more docs, sync second time and assert success
        results = yield _create_docs()
        _assert_transaction_and_sync_logs(results, 1)
        yield sol.sync()
        results = yield sol.get_all_docs()
        _assert_sync(results, 1)

    #
    # Concurrency tests
    #

    class _WorkerThread(threading.Thread):

        def __init__(self, params, run_method):
            threading.Thread.__init__(self)
            self._params = params
            self._run_method = run_method

        def run(self):
            self._run_method(self)

    def test_correct_transaction_log_after_concurrent_puts(self):
        """
        Assert that the transaction_log increases accordingly with concurrent
        puts.
        """
        pool = threading.BoundedSemaphore(value=1)
        threads = []
        docs = []

        def _run_method(self):
            doc = self._params['db'].create_doc({})
            pool.acquire()
            self._params['docs'].append(doc.doc_id)
            pool.release()

        for i in range(0, REPEAT_TIMES):
            thread = self._WorkerThread(
                {'docs': docs, 'db': self.db},
                _run_method)
            thread.start()
            threads.append(thread)

        for thread in threads:
            thread.join()

        # assert length of transaction_log
        transaction_log = self.db._get_transaction_log()
        self.assertEqual(
            REPEAT_TIMES, len(transaction_log))

        # assert all documents are in the log
        self.assertEqual(REPEAT_TIMES, len(docs))
        for doc_id in docs:
            self.assertEqual(
                1,
                len(filter(lambda t: t[0] == doc_id, transaction_log)))

    def test_correct_transaction_log_after_concurrent_deletes(self):
        """
        Assert that the transaction_log increases accordingly with concurrent
        puts and deletes.
        """
        threads = []
        docs = []
        pool = threading.BoundedSemaphore(value=1)

        # create/delete method that will be run concurrently
        def _run_method(self):
            doc = self._params['db'].create_doc({})
            pool.acquire()
            docs.append(doc.doc_id)
            pool.release()
            self._params['db'].delete_doc(doc)

        # launch concurrent threads
        for i in range(0, REPEAT_TIMES):
            thread = self._WorkerThread({'db': self.db}, _run_method)
            thread.start()
            threads.append(thread)

        # wait for threads to finish
        for thread in threads:
            thread.join()

        # assert transaction log
        transaction_log = self.db._get_transaction_log()
        self.assertEqual(
            2 * REPEAT_TIMES, len(transaction_log))
        # assert that each doc appears twice in the transaction_log
        self.assertEqual(REPEAT_TIMES, len(docs))
        for doc_id in docs:
            self.assertEqual(
                2,
                len(filter(lambda t: t[0] == doc_id, transaction_log)))

    def test_correct_sync_log_after_concurrent_puts_and_sync(self):
        """
        Assert that the sync_log is correct after concurrent syncs.
        """
        docs = []

        sol = self._soledad_instance(
            auth_token='auth-token',
            server_url=self.getURL())

        def _save_doc_ids(results):
            for doc in results:
                docs.append(doc.doc_id)

        # create documents in parallel
        deferreds = []
        for i in range(0, REPEAT_TIMES):
            d = sol.create_doc({})
            deferreds.append(d)

        # wait for documents creation and sync
        d = defer.gatherResults(deferreds)
        d.addCallback(_save_doc_ids)
        d.addCallback(lambda _: sol.sync())

        def _assert_logs(results):
            transaction_log = self.db._get_transaction_log()
            self.assertEqual(REPEAT_TIMES, len(transaction_log))
            # assert all documents are in the remote log
            self.assertEqual(REPEAT_TIMES, len(docs))
            for doc_id in docs:
                self.assertEqual(
                    1,
                    len(filter(lambda t: t[0] == doc_id, transaction_log)))

        d.addCallback(_assert_logs)
        d.addCallback(lambda _: sol.close())

        return d

    @defer.inlineCallbacks
    def test_concurrent_syncs_do_not_fail(self):
        """
        Assert that concurrent attempts to sync end up being executed
        sequentially and do not fail.
        """
        docs = []

        sol = self._soledad_instance(
            auth_token='auth-token',
            server_url=self.getURL())

        deferreds = []
        for i in xrange(0, REPEAT_TIMES):
            d = sol.create_doc({})
            d.addCallback(lambda doc: docs.append(doc.doc_id))
            d.addCallback(lambda _: sol.sync())
            deferreds.append(d)
        yield defer.gatherResults(deferreds, consumeErrors=True)

        transaction_log = self.db._get_transaction_log()
        self.assertEqual(REPEAT_TIMES, len(transaction_log))
        # assert all documents are in the remote log
        self.assertEqual(REPEAT_TIMES, len(docs))
        for doc_id in docs:
            self.assertEqual(
                1,
                len(filter(lambda t: t[0] == doc_id, transaction_log)))