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
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
|
# -*- coding: utf-8 -*-
# test_couch.py
# Copyright (C) 2013 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 ObjectStore and Couch backend bits.
"""
import re
import copy
import shutil
from base64 import b64decode
from couchdb.client import Server
from u1db import errors
from leap.common.files import mkdir_p
from leap.soledad.common.tests import u1db_tests as tests
from leap.soledad.common.tests.u1db_tests import test_backends
from leap.soledad.common.tests.u1db_tests import test_sync
from leap.soledad.common import couch
import simplejson as json
#-----------------------------------------------------------------------------
# A wrapper for running couchdb locally.
#-----------------------------------------------------------------------------
import re
import os
import tempfile
import subprocess
import time
import unittest
# from: https://github.com/smcq/paisley/blob/master/paisley/test/util.py
# TODO: include license of above project.
class CouchDBWrapper(object):
"""
Wrapper for external CouchDB instance which is started and stopped for
testing.
"""
def start(self):
"""
Start a CouchDB instance for a test.
"""
self.tempdir = tempfile.mkdtemp(suffix='.couch.test')
path = os.path.join(os.path.dirname(__file__),
'couchdb.ini.template')
handle = open(path)
conf = handle.read() % {
'tempdir': self.tempdir,
}
handle.close()
confPath = os.path.join(self.tempdir, 'test.ini')
handle = open(confPath, 'w')
handle.write(conf)
handle.close()
# create the dirs from the template
mkdir_p(os.path.join(self.tempdir, 'lib'))
mkdir_p(os.path.join(self.tempdir, 'log'))
args = ['couchdb', '-n', '-a', confPath]
#null = open('/dev/null', 'w')
self.process = subprocess.Popen(
args, env=None, stdout=subprocess.PIPE, stderr=subprocess.PIPE,
close_fds=True)
# find port
logPath = os.path.join(self.tempdir, 'log', 'couch.log')
while not os.path.exists(logPath):
if self.process.poll() is not None:
raise Exception("""
couchdb exited with code %d.
stdout:
%s
stderr:
%s""" % (
self.process.returncode, self.process.stdout.read(),
self.process.stderr.read()))
time.sleep(0.01)
while os.stat(logPath).st_size == 0:
time.sleep(0.01)
PORT_RE = re.compile(
'Apache CouchDB has started on http://127.0.0.1:(?P<port>\d+)')
handle = open(logPath)
line = handle.read()
handle.close()
m = PORT_RE.search(line)
if not m:
self.stop()
raise Exception("Cannot find port in line %s" % line)
self.port = int(m.group('port'))
def stop(self):
"""
Terminate the CouchDB instance.
"""
self.process.terminate()
self.process.communicate()
shutil.rmtree(self.tempdir)
class CouchDBTestCase(unittest.TestCase):
"""
TestCase base class for tests against a real CouchDB server.
"""
def setUp(self):
"""
Make sure we have a CouchDB instance for a test.
"""
self.wrapper = CouchDBWrapper()
self.wrapper.start()
#self.db = self.wrapper.db
unittest.TestCase.setUp(self)
def tearDown(self):
"""
Stop CouchDB instance for test.
"""
self.wrapper.stop()
unittest.TestCase.tearDown(self)
#-----------------------------------------------------------------------------
# The following tests come from `u1db.tests.test_common_backend`.
#-----------------------------------------------------------------------------
class TestCouchBackendImpl(CouchDBTestCase):
def test__allocate_doc_id(self):
db = couch.CouchDatabase('http://localhost:' + str(self.wrapper.port),
'u1db_tests', ensure_ddocs=True)
doc_id1 = db._allocate_doc_id()
self.assertTrue(doc_id1.startswith('D-'))
self.assertEqual(34, len(doc_id1))
int(doc_id1[len('D-'):], 16)
self.assertNotEqual(doc_id1, db._allocate_doc_id())
#-----------------------------------------------------------------------------
# The following tests come from `u1db.tests.test_backends`.
#-----------------------------------------------------------------------------
def make_couch_database_for_test(test, replica_uid):
port = str(test.wrapper.port)
return couch.CouchDatabase('http://localhost:' + port, replica_uid,
replica_uid=replica_uid or 'test',
ensure_ddocs=True)
def copy_couch_database_for_test(test, db):
port = str(test.wrapper.port)
couch_url = 'http://localhost:' + port
new_dbname = db._replica_uid + '_copy'
new_db = couch.CouchDatabase(couch_url,
new_dbname,
replica_uid=db._replica_uid or 'test')
# copy all docs
old_couch_db = Server(couch_url)[db._replica_uid]
new_couch_db = Server(couch_url)[new_dbname]
for doc_id in old_couch_db:
doc = old_couch_db.get(doc_id)
# copy design docs
if ('u1db_rev' not in doc):
new_couch_db.save(doc)
# copy u1db docs
else:
new_doc = {
'_id': doc['_id'],
'u1db_transactions': doc['u1db_transactions'],
'u1db_rev': doc['u1db_rev']
}
attachments = []
if ('u1db_conflicts' in doc):
new_doc['u1db_conflicts'] = doc['u1db_conflicts']
for c_rev in doc['u1db_conflicts']:
attachments.append('u1db_conflict_%s' % c_rev)
new_couch_db.save(new_doc)
# save conflict data
attachments.append('u1db_content')
for att_name in attachments:
att = old_couch_db.get_attachment(doc_id, att_name)
if (att is not None):
new_couch_db.put_attachment(new_doc, att,
filename=att_name)
return new_db
def make_document_for_test(test, doc_id, rev, content, has_conflicts=False):
return couch.CouchDocument(
doc_id, rev, content, has_conflicts=has_conflicts)
COUCH_SCENARIOS = [
('couch', {'make_database_for_test': make_couch_database_for_test,
'copy_database_for_test': copy_couch_database_for_test,
'make_document_for_test': make_document_for_test, }),
]
class CouchTests(test_backends.AllDatabaseTests, CouchDBTestCase):
scenarios = COUCH_SCENARIOS
def tearDown(self):
self.db.delete_database()
test_backends.AllDatabaseTests.tearDown(self)
class CouchDatabaseTests(test_backends.LocalDatabaseTests, CouchDBTestCase):
scenarios = COUCH_SCENARIOS
def tearDown(self):
self.db.delete_database()
test_backends.LocalDatabaseTests.tearDown(self)
class CouchValidateGenNTransIdTests(
test_backends.LocalDatabaseValidateGenNTransIdTests, CouchDBTestCase):
scenarios = COUCH_SCENARIOS
def tearDown(self):
self.db.delete_database()
test_backends.LocalDatabaseValidateGenNTransIdTests.tearDown(self)
class CouchValidateSourceGenTests(
test_backends.LocalDatabaseValidateSourceGenTests, CouchDBTestCase):
scenarios = COUCH_SCENARIOS
def tearDown(self):
self.db.delete_database()
test_backends.LocalDatabaseValidateSourceGenTests.tearDown(self)
class CouchWithConflictsTests(
test_backends.LocalDatabaseWithConflictsTests, CouchDBTestCase):
scenarios = COUCH_SCENARIOS
def tearDown(self):
self.db.delete_database()
test_backends.LocalDatabaseWithConflictsTests.tearDown(self)
# Notice: the CouchDB backend does not have indexing capabilities, but we
# added in memory indexing for tests only.
class CouchIndexTests(test_backends.DatabaseIndexTests, CouchDBTestCase):
scenarios = COUCH_SCENARIOS
def tearDown(self):
self.db.delete_database()
test_backends.DatabaseIndexTests.tearDown(self)
#-----------------------------------------------------------------------------
# The following tests come from `u1db.tests.test_sync`.
#-----------------------------------------------------------------------------
target_scenarios = [
('local', {'create_db_and_target': test_sync._make_local_db_and_target}), ]
simple_doc = tests.simple_doc
nested_doc = tests.nested_doc
class CouchDatabaseSyncTargetTests(test_sync.DatabaseSyncTargetTests,
CouchDBTestCase):
scenarios = (tests.multiply_scenarios(COUCH_SCENARIOS, target_scenarios))
def setUp(self):
# we implement parents' setUp methods here to prevent from launching
# more couch instances then needed.
tests.TestCase.setUp(self)
self.server = self.server_thread = None
self.db, self.st = self.create_db_and_target(self)
self.other_changes = []
def tearDown(self):
self.db.delete_database()
test_sync.DatabaseSyncTargetTests.tearDown(self)
def test_sync_exchange_returns_many_new_docs(self):
# This test was replicated to allow dictionaries to be compared after
# JSON expansion (because one dictionary may have many different
# serialized representations).
doc = self.db.create_doc_from_json(simple_doc)
doc2 = self.db.create_doc_from_json(nested_doc)
self.assertTransactionLog([doc.doc_id, doc2.doc_id], self.db)
new_gen, _ = self.st.sync_exchange(
[], 'other-replica', last_known_generation=0,
last_known_trans_id=None, return_doc_cb=self.receive_doc)
self.assertTransactionLog([doc.doc_id, doc2.doc_id], self.db)
self.assertEqual(2, new_gen)
self.assertEqual(
[(doc.doc_id, doc.rev, json.loads(simple_doc), 1),
(doc2.doc_id, doc2.rev, json.loads(nested_doc), 2)],
[c[:-3] + (json.loads(c[-3]), c[-2]) for c in self.other_changes])
if self.whitebox:
self.assertEqual(
self.db._last_exchange_log['return'],
{'last_gen': 2, 'docs':
[(doc.doc_id, doc.rev), (doc2.doc_id, doc2.rev)]})
# The following tests need that the database have an index, so we fake one.
old_class = couch.CouchDatabase
from u1db.backends.inmemory import InMemoryIndex
class IndexedCouchDatabase(couch.CouchDatabase):
def __init__(self, url, dbname, replica_uid=None, full_commit=True,
session=None, ensure_ddocs=True):
old_class.__init__(self, url, dbname, replica_uid, full_commit,
session, ensure_ddocs=True)
self._indexes = {}
def _put_doc(self, old_doc, doc):
for index in self._indexes.itervalues():
if old_doc is not None and not old_doc.is_tombstone():
index.remove_json(old_doc.doc_id, old_doc.get_json())
if not doc.is_tombstone():
index.add_json(doc.doc_id, doc.get_json())
old_class._put_doc(self, old_doc, doc)
def create_index(self, index_name, *index_expressions):
if index_name in self._indexes:
if self._indexes[index_name]._definition == list(
index_expressions):
return
raise errors.IndexNameTakenError
index = InMemoryIndex(index_name, list(index_expressions))
_, all_docs = self.get_all_docs()
for doc in all_docs:
index.add_json(doc.doc_id, doc.get_json())
self._indexes[index_name] = index
def delete_index(self, index_name):
del self._indexes[index_name]
def list_indexes(self):
definitions = []
for idx in self._indexes.itervalues():
definitions.append((idx._name, idx._definition))
return definitions
def get_from_index(self, index_name, *key_values):
try:
index = self._indexes[index_name]
except KeyError:
raise errors.IndexDoesNotExist
doc_ids = index.lookup(key_values)
result = []
for doc_id in doc_ids:
result.append(self._get_doc(doc_id, check_for_conflicts=True))
return result
def get_range_from_index(self, index_name, start_value=None,
end_value=None):
"""Return all documents with key values in the specified range."""
try:
index = self._indexes[index_name]
except KeyError:
raise errors.IndexDoesNotExist
if isinstance(start_value, basestring):
start_value = (start_value,)
if isinstance(end_value, basestring):
end_value = (end_value,)
doc_ids = index.lookup_range(start_value, end_value)
result = []
for doc_id in doc_ids:
result.append(self._get_doc(doc_id, check_for_conflicts=True))
return result
def get_index_keys(self, index_name):
try:
index = self._indexes[index_name]
except KeyError:
raise errors.IndexDoesNotExist
keys = index.keys()
# XXX inefficiency warning
return list(set([tuple(key.split('\x01')) for key in keys]))
couch.CouchDatabase = IndexedCouchDatabase
sync_scenarios = []
for name, scenario in COUCH_SCENARIOS:
scenario = dict(scenario)
scenario['do_sync'] = test_sync.sync_via_synchronizer
sync_scenarios.append((name, scenario))
scenario = dict(scenario)
class CouchDatabaseSyncTests(test_sync.DatabaseSyncTests, CouchDBTestCase):
scenarios = sync_scenarios
def setUp(self):
self.db = None
self.db1 = None
self.db2 = None
self.db3 = None
test_sync.DatabaseSyncTests.setUp(self)
def tearDown(self):
self.db and self.db.delete_database()
self.db1 and self.db1.delete_database()
self.db2 and self.db2.delete_database()
self.db3 and self.db3.delete_database()
db = self.create_database('test1_copy', 'source')
db.delete_database()
db = self.create_database('test2_copy', 'target')
db.delete_database()
db = self.create_database('test3', 'target')
db.delete_database()
test_sync.DatabaseSyncTests.tearDown(self)
load_tests = tests.load_with_scenarios
|