Skip to content
Navigation Menu
{{ message }}
forked from cloudant/python-cloudant
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdatabase_tests.py
More file actions
1652 lines (1487 loc) · 63.5 KB
/
Copy pathdatabase_tests.py
File metadata and controls
1652 lines (1487 loc) · 63.5 KB
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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python
# Copyright (C) 2015, 2019 IBM Corp. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
_database_tests_
database module - Unit tests for CouchDatabase and CloudantDatabase classes
See configuration options for environment variables in unit_t_db_base
module docstring.
"""
import os
import unittest
import uuid
import mock
import requests
from cloudant._2to3 import UNICHR
from cloudant._common_util import response_to_json_dict
from cloudant.design_document import DesignDocument
from cloudant.document import Document
from cloudant.error import CloudantArgumentError, CloudantDatabaseException
from cloudant.feed import Feed, InfiniteFeed
from cloudant.index import Index, TextIndex, SpecialIndex
from cloudant.result import Result, QueryResult
from cloudant.security_document import SecurityDocument
from nose.plugins.attrib import attr
from tests.unit._test_util import LONG_NUMBER
from .unit_t_db_base import skip_if_not_cookie_auth, UnitTestDbBase, skip_if_iam
from .. import unicode_
class CloudantDatabaseExceptionTests(unittest.TestCase):
"""
Ensure CloudantDatabaseException functions as expected.
"""
def test_raise_without_code(self):
"""
Ensure that a default exception/code is used if none is provided.
"""
with self.assertRaises(CloudantDatabaseException) as cm:
raise CloudantDatabaseException()
self.assertEqual(cm.exception.status_code, 100)
def test_raise_using_invalid_code(self):
"""
Ensure that a default exception/code is used if invalid code is provided.
"""
with self.assertRaises(CloudantDatabaseException) as cm:
raise CloudantDatabaseException('foo')
self.assertEqual(cm.exception.status_code, 100)
def test_raise_without_args(self):
"""
Ensure that a default exception/code is used if the message requested
by the code provided requires an argument list and none is provided.
"""
with self.assertRaises(CloudantDatabaseException) as cm:
raise CloudantDatabaseException(400)
self.assertEqual(cm.exception.status_code, 100)
def test_raise_with_proper_code_and_args(self):
"""
Ensure that the requested exception is raised.
"""
with self.assertRaises(CloudantDatabaseException) as cm:
raise CloudantDatabaseException(400, 'foo')
self.assertEqual(cm.exception.status_code, 400)
@attr(db=['cloudant','couch'])
class DatabaseTests(UnitTestDbBase):
"""
CouchDatabase/CloudantDatabase unit tests
"""
def setUp(self):
"""
Set up test attributes
"""
super(DatabaseTests, self).setUp()
self.db_set_up()
def tearDown(self):
"""
Reset test attributes
"""
self.db_tear_down()
super(DatabaseTests, self).tearDown()
def test_constructor(self):
"""
Test instantiating a database
"""
self.assertEqual(self.db.client, self.client)
self.assertEqual(self.db.database_name, self.test_dbname)
self.assertEqual(self.db.r_session, self.client.r_session)
self.assertIsInstance(self.db.result, Result)
def test_bulk_docs_uses_custom_encoder(self):
"""
Test that the bulk_docs method uses the custom encoder
"""
self.set_up_client(auto_connect=True, encoder="AEncoder")
docs = [
{'_id': 'julia{0:03d}'.format(i), 'name': 'julia', 'age': i}
for i in range(3)
]
database = self.client[self.test_dbname]
with self.assertRaises(TypeError):
# since the encoder is a str a type error should be thrown.
database.bulk_docs(docs)
def test_missing_revisions_uses_custom_encoder(self):
"""
Test that missing_revisions uses the custom encoder.
"""
revs = ['1-1', '2-1', '3-1']
self.set_up_client(auto_connect=True, encoder="AEncoder")
database = self.client[self.test_dbname]
with self.assertRaises(TypeError):
# since the encoder is a str a type error should be thrown.
database.missing_revisions('no-such-doc', *revs)
def test_revs_diff_uses_custom_encoder(self):
"""
Test that revisions_diff uses the custom encoder.
"""
revs = ['1-1', '2-1', '3-1']
self.set_up_client(auto_connect=True, encoder="AEncoder")
database = self.client[self.test_dbname]
with self.assertRaises(TypeError):
database.revisions_diff('no-such-doc', *revs)
def test_retrieve_db_url(self):
"""
Test retrieving the database URL
"""
self.assertEqual(
self.db.database_url,
'/'.join((self.client.server_url, self.test_dbname))
)
@skip_if_not_cookie_auth
def test_retrieve_creds(self):
"""
Test retrieving client credentials. The client credentials are None if
CouchDB Admin Party mode was selected.
"""
if self.client.admin_party:
self.assertIsNone(self.db.creds)
else:
expected_keys = ['basic_auth', 'user_ctx']
self.assertTrue(
all(x in expected_keys for x in self.db.creds.keys())
)
self.assertTrue(self.db.creds['basic_auth'].startswith('Basic'))
self.assertEqual(self.db.creds['user_ctx']['name'], self.user)
def test_exists(self):
"""
Tests that the result of True is expected when the database exists,
and False is expected when the database is nonexistent remotely.
"""
self.assertTrue(self.db.exists())
# Construct a database object that does not exist remotely
fake_db = self.client._DATABASE_CLASS(self.client, 'no-such-db')
self.assertFalse(fake_db.exists())
def test_exists_raises_httperror(self):
"""
Test database exists raises an HTTPError.
"""
# Mock HTTPError when running against CouchDB and Cloudant
resp = requests.Response()
resp.status_code = 400
self.client.r_session.head = mock.Mock(return_value=resp)
with self.assertRaises(requests.HTTPError) as cm:
self.db.exists()
err = cm.exception
self.assertEqual(err.response.status_code, 400)
self.client.r_session.head.assert_called_with(self.db.database_url)
def test_create_db_delete_db(self):
"""
Test creating and deleting a database
"""
dbname = self.dbname()
db = self.client._DATABASE_CLASS(self.client, dbname)
try:
db.create()
self.assertTrue(db.exists())
# No issue should arise if attempting to create existing database
db_2 = db.create()
self.assertEqual(db, db_2)
# If we use throw_on_exists=True, it will raise a
# CloudantDatabaseException if the database already exists.
with self.assertRaises(CloudantDatabaseException) as cm:
db.create(throw_on_exists=True)
self.assertEqual(cm.exception.status_code, 412)
except Exception as err:
self.fail('Exception {0} was raised.'.format(str(err)))
finally:
db.delete()
self.assertFalse(db.exists())
def test_delete_exception(self):
"""
Test deleting a database that does not exist
"""
try:
fake_db = self.client._DATABASE_CLASS(self.client, 'no-such-db')
fake_db.delete()
self.fail('Above statement should raise an Exception')
except requests.HTTPError as err:
self.assertEqual(err.response.status_code, 404)
def test_retrieve_db_metadata(self):
"""
Test retrieving the database metadata information. The metadata values
may differ slightly each time it is retrieved such as is the case with
the update sequence, however, the metadata keys should always remain the
same. Therefore comparing keys is a valid test of this functionality.
"""
resp = self.db.r_session.get(
'/'.join((self.client.server_url, self.test_dbname)))
expected = response_to_json_dict(resp)
actual = self.db.metadata()
self.assertListEqual(list(actual.keys()), list(expected.keys()))
def test_retrieve_document_count(self):
"""
Test retrieving the number of documents currently in the database
"""
self.populate_db_with_documents(6)
self.assertEqual(self.db.doc_count(), 6)
def test_create_document_with_id(self):
"""
Test creating a document using a supplied document id
"""
data = {'_id': 'julia06', 'name': 'julia', 'age': 6}
doc = self.db.create_document(data)
self.assertEqual(self.db['julia06'], doc)
self.assertEqual(doc['_id'], data['_id'])
self.assertTrue(doc['_rev'].startswith('1-'))
self.assertEqual(doc['name'], data['name'])
self.assertEqual(doc['age'], data['age'])
self.assertIsInstance(doc, Document)
self.assertIsInstance(self.db['julia06'], Document)
try:
self.db.create_document(data, throw_on_exists=True)
self.fail('Above statement should raise a CloudantException')
except CloudantDatabaseException as err:
self.assertEqual(
str(err),
'Document with id julia06 already exists.'
)
def test_create_document_that_already_exists(self):
"""
Test creating a document that already exists
"""
data = {'_id': 'julia'}
doc = self.db.create_document(data)
self.assertEqual(self.db['julia'], doc)
self.assertTrue(doc['_rev'].startswith('1-'))
# attempt to recreate document
self.db.create_document(data, throw_on_exists=False)
def test_create_document_without_id(self):
"""
Test creating a document without supplying a document id
"""
data = {'name': 'julia', 'age': 6}
doc = self.db.create_document(data)
self.assertEqual(self.db[doc['_id']], doc)
self.assertTrue(doc['_rev'].startswith('1-'))
self.assertEqual(doc['name'], data['name'])
self.assertEqual(doc['age'], data['age'])
self.assertIsInstance(doc, Document)
self.assertIsInstance(self.db[doc['_id']], Document)
def test_create_design_document(self):
"""
Test creating a document using a supplied document id
"""
data = {'_id': '_design/julia06', 'name': 'julia', 'age': 6}
doc = self.db.create_document(data)
self.assertEqual(self.db['_design/julia06'], doc)
self.assertEqual(doc['_id'], data['_id'])
self.assertTrue(doc['_rev'].startswith('1-'))
self.assertEqual(doc['name'], data['name'])
self.assertEqual(doc['age'], data['age'])
self.assertEqual(doc.views, dict())
self.assertIsInstance(doc, DesignDocument)
self.assertIsInstance(self.db['_design/julia06'], DesignDocument)
def test_create_empty_document(self):
"""
Test creating an empty document
"""
empty_doc = self.db.new_document()
self.assertEqual(self.db[empty_doc['_id']], empty_doc)
self.assertTrue(all(x in ['_id', '_rev'] for x in empty_doc.keys()))
self.assertTrue(empty_doc['_rev'].startswith('1-'))
def test_retrieve_design_documents(self):
"""
Test retrieving all design documents
"""
map_func = 'function(doc) {\n emit(doc._id, 1); \n}'
data = {'_id': '_design/ddoc01','views': {'view01': {"map": map_func}}}
ddoc1 = self.db.create_document(data)
data = {'_id': '_design/ddoc02','views': {'view02': {"map": map_func}}}
ddoc2 = self.db.create_document(data)
raw_ddocs = self.db.design_documents()
self.assertEqual(len(raw_ddocs), 2)
self.assertTrue(
all(x in [raw_ddocs[0]['key'], raw_ddocs[1]['key']]
for x in self.db.keys()
)
)
self.assertTrue(
all(x in [raw_ddocs[0]['id'], raw_ddocs[1]['id']]
for x in self.db.keys()
)
)
self.assertTrue(
all(x in [raw_ddocs[0]['doc'], raw_ddocs[1]['doc']]
for x in [ddoc1, ddoc2]
)
)
def test_retrieve_design_document_list(self):
"""
Test retrieving a list of design document names
"""
map_func = 'function(doc) {\n emit(doc._id, 1); \n}'
data = {'_id': '_design/ddoc01','views': {'view01': {"map": map_func}}}
self.db.create_document(data)
data = {'_id': '_design/ddoc02','views': {'view02': {"map": map_func}}}
self.db.create_document(data)
ddoc_list = self.db.list_design_documents()
self.assertTrue(all(x in ddoc_list for x in self.db.keys()))
def test_retrieve_design_document(self):
"""
Test retrieve a specific design document
"""
# Get an empty design document object that does not exist remotely
local_ddoc = self.db.get_design_document('_design/ddoc01')
self.assertEqual(local_ddoc, {'_id': '_design/ddoc01', 'indexes': {},
'views': {}, 'lists': {}, 'shows': {}})
# Add the design document to the database
map_func = 'function(doc) {\n emit(doc._id, 1); \n}'
local_ddoc.add_view('view01', map_func)
local_ddoc.save()
# Get the recently created design document that now exists remotely
ddoc = self.db.get_design_document('_design/ddoc01')
self.assertEqual(ddoc, local_ddoc)
@skip_if_not_cookie_auth
def test_get_security_document(self):
"""
Test retrieving the database security document
"""
self.load_security_document_data()
sdoc = self.db.get_security_document()
self.assertIsInstance(sdoc, SecurityDocument)
self.assertDictEqual(sdoc, self.sdoc)
def test_retrieve_view_results(self):
"""
Test retrieving Result wrapped output from a design document view
"""
map_func = 'function(doc) {\n emit(doc._id, 1); \n}'
data = {'_id': '_design/ddoc01','views': {'view01': {"map": map_func}}}
self.db.create_document(data)
self.populate_db_with_documents()
# Test with default Result
rslt = self.db.get_view_result('_design/ddoc01', 'view01')
self.assertIsInstance(rslt, Result)
self.assertEqual(rslt[:1], rslt['julia000'])
# Test with custom Result
rslt = self.db.get_view_result(
'_design/ddoc01',
'view01',
descending=True,
reduce=False)
self.assertIsInstance(rslt, Result)
self.assertEqual(rslt[:1], rslt['julia099'])
def test_retrieve_raw_view_results(self):
"""
Test retrieving raw output from a design document view
"""
map_func = 'function(doc) {\n emit(doc._id, 1); \n}'
data = {'_id': '_design/ddoc01','views': {'view01': {"map": map_func}}}
self.db.create_document(data)
self.populate_db_with_documents()
raw_rslt = self.db.get_view_result(
'_design/ddoc01', 'view01', raw_result=True)
self.assertIsInstance(raw_rslt, dict)
self.assertEqual(len(raw_rslt.get('rows')), 100)
def test_all_docs_post(self):
"""
Test the all_docs POST request functionality using keys param
"""
# Create 200 documents with ids julia000, julia001, julia002, ..., julia199
self.populate_db_with_documents(200)
# Generate keys list for every other document created
# with ids julia000, julia002, julia004, ..., julia198
keys_list = ['julia{0:03d}'.format(i) for i in range(0, 200, 2)]
self.assertEqual(len(keys_list), 100)
rows = self.db.all_docs(keys=keys_list).get('rows')
self.assertEqual(len(rows), 100)
keys_returned = [row['key'] for row in rows]
self.assertTrue(all(x in keys_returned for x in keys_list))
def test_all_docs_post_empty_key_list(self):
"""
Test the all_docs POST request functionality using empty keys param
"""
self.populate_db_with_documents()
# Request all_docs using an empty key list
rows = self.db.all_docs(keys=[]).get('rows')
self.assertEqual(len(rows), 0)
def test_all_docs_post_multiple_params(self):
"""
Test the all_docs POST request functionality using keys and other params
"""
# Create 200 documents with ids julia000, julia001, julia002, ..., julia199
self.populate_db_with_documents(200)
# Generate keys list for every other document created
# with ids julia000, julia002, julia004, ..., julia198
keys_list = ['julia{0:03d}'.format(i) for i in range(0, 200, 2)]
self.assertEqual(len(keys_list), 100)
data = self.db.all_docs(limit=3, skip=10, keys=keys_list)
self.assertEqual(len(data.get('rows')), 3)
self.assertEqual(data['rows'][0]['key'], 'julia020')
self.assertEqual(data['rows'][1]['key'], 'julia022')
self.assertEqual(data['rows'][2]['key'], 'julia024')
def test_all_docs_get(self):
"""
Test the all_docs GET request functionality
"""
self.populate_db_with_documents()
data = self.db.all_docs(limit=3, skip=10)
self.assertEqual(len(data.get('rows')), 3)
self.assertEqual(data['rows'][0]['key'], 'julia010')
self.assertEqual(data['rows'][1]['key'], 'julia011')
self.assertEqual(data['rows'][2]['key'], 'julia012')
def test_all_docs_get_with_long_type(self):
"""
Test the all_docs GET request functionality
"""
self.populate_db_with_documents()
data = self.db.all_docs(limit=LONG_NUMBER, skip=10)
self.assertEqual(len(data.get('rows')), 1)
self.assertEqual(data['rows'][0]['key'], 'julia010')
data = self.db.all_docs(limit=1, skip=LONG_NUMBER)
self.assertEqual(len(data.get('rows')), 1)
def test_custom_result_context_manager(self):
"""
Test using the database custom result context manager
"""
self.populate_db_with_documents()
with self.db.custom_result(startkey='julia010', endkey='julia012') as rslt:
self.assertIsInstance(rslt, Result)
keys_returned = [i['key'] for i in rslt]
expected_keys = ['julia010', 'julia011', 'julia012']
self.assertTrue(all(x in keys_returned for x in expected_keys))
def test_keys(self):
"""
Test retrieving the document keys from the database
"""
self.assertEqual(list(self.db.keys()), [])
self.populate_db_with_documents(3)
self.assertEqual(
self.db.keys(remote=True),
['julia000', 'julia001', 'julia002']
)
def test_doc_id_in_db(self):
"""
Test checking if a document exists in a DB with in operator
"""
self.populate_db_with_documents(1)
self.assertTrue('julia000' in self.db)
def test_doc_id_not_in_db(self):
"""
Test checking if a document exists in a DB with in operator
"""
self.populate_db_with_documents(1)
self.assertFalse('julia001' in self.db)
def test_get_non_existing_doc_via_getitem(self):
"""
Test __getitem__ when retrieving a non-existing document
"""
try:
doc = self.db['no_such_doc']
self.fail('Above statement should raise a KeyError')
except KeyError:
pass
def test_get_db_via_getitem(self):
"""
Test __getitem__ when retrieving a document
"""
# Add a design document
map_func = 'function(doc) {\n emit(doc._id, 1); \n}'
expected_ddoc = self.db.get_design_document('_design/ddoc01')
expected_ddoc.add_view('view01', map_func)
expected_ddoc.save()
# Add three standard documents
self.populate_db_with_documents(3)
# Test __get_item__ for standard document
doc = self.db['julia001']
self.assertIsInstance(doc, Document)
self.assertEqual(doc.get('_id'), 'julia001')
self.assertTrue(doc.get('_rev').startswith('1-'))
self.assertEqual(doc.get('name'), 'julia')
self.assertEqual(doc.get('age'), 1)
# Test __get_item__ for design document
ddoc = self.db['_design/ddoc01']
self.assertIsInstance(ddoc, DesignDocument)
self.assertTrue(ddoc, expected_ddoc)
def test_document_iteration_under_fetch_limit(self):
"""
Test __iter__ works as expected when the number of documents in
the database is less than the database fetch limit
"""
docs = []
# Check iterating when no documents exist
for doc in self.db:
self.fail('There should be no documents in the database yet!!')
# Check that iteration yields appropriate contents
self.populate_db_with_documents(3)
age = 0
for doc in self.db:
self.assertIsInstance(doc, Document)
self.assertEqual(doc['_id'], 'julia{0:03d}'.format(age))
self.assertTrue(doc['_rev'].startswith('1-'))
self.assertEqual(doc['name'], 'julia')
self.assertEqual(doc['age'], age)
docs.append(doc)
age += 1
self.assertEqual(len(docs), 3)
# Check that the local database object has been populated
# with the appropriate documents
expected_keys = ['julia{0:03d}'.format(i) for i in range(3)]
self.assertTrue(all(x in self.db.keys()for x in expected_keys))
for id in self.db.keys():
doc = self.db.get(id)
self.assertIsInstance(doc, Document)
self.assertEqual(doc['_id'], id)
self.assertTrue(doc['_rev'].startswith('1-'))
self.assertEqual(doc['name'], 'julia')
self.assertEqual(doc['age'], int(id[len(id) - 3 : len(id)]))
def test_document_iteration_over_fetch_limit(self):
"""
Test __iter__ works as expected when the number of documents in
the database is more than the database fetch limit
"""
docs = []
# Check iterating when no documents exist
for doc in self.db:
self.fail('There should be no documents in the database yet!!')
# Check that iteration yields appropriate contents
self.populate_db_with_documents(103)
age = 0
for doc in self.db:
self.assertIsInstance(doc, Document)
self.assertEqual(doc['_id'], 'julia{0:03d}'.format(age))
self.assertTrue(doc['_rev'].startswith('1-'))
self.assertEqual(doc['name'], 'julia')
self.assertEqual(doc['age'], age)
docs.append(doc)
age += 1
self.assertEqual(len(docs), 103)
# Check that the local database object has been populated
# with the appropriate documents
expected_keys = ['julia{0:03d}'.format(i) for i in range(103)]
self.assertTrue(all(x in self.db.keys()for x in expected_keys))
for id in self.db.keys():
doc = self.db.get(id)
self.assertIsInstance(doc, Document)
self.assertEqual(doc['_id'], id)
self.assertTrue(doc['_rev'].startswith('1-'))
self.assertEqual(doc['name'], 'julia')
self.assertEqual(doc['age'], int(id[len(id) - 3: len(id)]))
def test_document_iteration_completeness(self):
"""
Test __iter__ works as expected, fetching all documents from the
database.
"""
for _ in self.db:
self.fail('There should be no documents in the database yet!!')
# sample code point ranges
include_ranges = [
(0x0023, 0x0026),
(0x00A1, 0x00AC),
(0x0370, 0x0377),
(0x037A, 0x037E),
(0x0384, 0x038A),
(0x16A0, 0x16F0),
(0x2C60, 0x2C7F)
]
all_docs = [{'_id': UNICHR(i) + UNICHR(j)} for a, b in include_ranges
for i in range(a, b)
for j in range(a, b)]
batch_size = 500
for i in range(0, len(all_docs), batch_size):
self.db.bulk_docs(all_docs[i:i+batch_size])
doc_count = 0
for i, doc in enumerate(self.db):
doc_count += 1
self.assertEqual(doc['_id'], all_docs[i]['_id'])
self.assertEqual(doc_count, len(all_docs))
def test_document_iteration_returns_valid_documents(self):
"""
This test will check that the __iter__ method returns documents that are
valid Document or DesignDocument objects and that they can be managed
remotely. In this test we will delete the documents as part of the test
to ensure that remote management is working as expected and confirming
that the documents are valid.
"""
self.populate_db_with_documents(3)
with DesignDocument(self.db, '_design/ddoc001') as ddoc:
ddoc.add_view('view001', 'function (doc) {\n emit(doc._id, 1);\n}')
docs = []
ddocs = []
for doc in self.db:
# A valid document must have a document_url
self.assertEqual(
doc.document_url,
'/'.join((self.db.database_url, doc['_id']))
)
if isinstance(doc, DesignDocument):
self.assertEqual(doc['_id'], '_design/ddoc001')
ddocs.append(doc)
elif isinstance(doc, Document):
self.assertTrue(
doc['_id'] in ['julia000', 'julia001', 'julia002']
)
docs.append(doc)
doc.delete()
# Confirm successful deletions
for doc in self.db:
self.fail('All documents should have been deleted!!!')
# Confirm that the correct number of Document (3) and DesignDocument (1)
# objects were returned
self.assertEqual(len(docs), 3)
self.assertEqual(len(ddocs), 1)
def test_bulk_docs_creation(self):
docs = [
{'_id': 'julia{0:03d}'.format(i), 'name': 'julia', 'age': i}
for i in range(3)
]
results = self.db.bulk_docs(docs)
self.assertEqual(len(results), 3)
i = 0
for result in results:
self.assertEqual(result['id'], 'julia{0:03d}'.format(i))
self.assertTrue(result['rev'].startswith('1-'))
i += 1
def test_bulk_docs_update(self):
"""
Test update of documents in bulk
"""
self.populate_db_with_documents(3)
docs = []
for doc in self.db:
doc['name'] = 'jules'
docs.append(doc)
results = self.db.bulk_docs(docs)
self.assertEqual(len(results), 3)
i = 0
for result in results:
self.assertEqual(result['id'], 'julia{0:03d}'.format(i))
self.assertTrue(result['rev'].startswith('2-'))
i += 1
age = 0
for doc in self.db:
self.assertEqual(doc['_id'], 'julia{0:03d}'.format(age))
self.assertTrue(doc['_rev'].startswith('2-'))
self.assertEqual(doc['name'], 'jules')
self.assertEqual(doc['age'], age)
age += 1
self.assertEqual(age, 3)
def test_missing_revisions(self):
"""
Test retrieving missing revisions
"""
doc = self.db.create_document(
{'_id': 'julia006', 'name': 'julia', 'age': 6}
)
# Test when the doc is not found
revs = ['1-1', '2-1', '3-1']
self.assertEqual(self.db.missing_revisions('no-such-doc', *revs), revs)
# Test all revs not found
self.assertEqual(self.db.missing_revisions('julia006', *revs), revs)
# Test when some revs not found
self.assertEqual(
self.db.missing_revisions('julia006', doc['_rev'], *revs), revs
)
# Test no missing revs
self.assertEqual(self.db.missing_revisions('julia006', doc['_rev']), [])
def test_revisions_diff(self):
"""
Test retrieving differences in revisions
"""
doc = self.db.create_document(
{'_id': 'julia006', 'name': 'julia', 'age': 6}
)
# Test when the doc is not found
revs = ['1-1', '2-1', '3-1']
self.assertEqual(
self.db.revisions_diff('no-such-doc', *revs),
{'no-such-doc': {'missing': revs}}
)
# Test differences
self.assertEqual(
self.db.revisions_diff('julia006', *revs),
{'julia006': {'missing': revs, 'possible_ancestors': [doc['_rev']]}}
)
# Test no differences
self.assertEqual(self.db.revisions_diff('julia006', doc['_rev']), {})
@mock.patch('cloudant._client_session.ClientSession.request')
def test_get_set_revision_limit(self, m_req):
"""
Test setting and getting revision limits
"""
# Setup mock responses.
mock_200_get_1 = mock.MagicMock()
type(mock_200_get_1).status_code = mock.PropertyMock(return_value=200)
type(mock_200_get_1).text = mock.PropertyMock(return_value='4321')
mock_200_get_2 = mock.MagicMock()
type(mock_200_get_2).status_code = mock.PropertyMock(return_value=200)
type(mock_200_get_2).text = mock.PropertyMock(return_value='1234')
mock_200_set = mock.MagicMock()
type(mock_200_set).status_code = mock.PropertyMock(return_value=200)
type(mock_200_set).text = mock.PropertyMock(return_value='{"ok":true}')
m_req.side_effect = [mock_200_get_1, mock_200_set, mock_200_get_2]
# Get current revisions limit.
self.assertEqual(self.db.get_revision_limit(), 4321)
# Set new revisions limit.
self.assertEqual(self.db.set_revision_limit(1234), {'ok': True})
# Get new revisions limit.
self.assertEqual(self.db.get_revision_limit(), 1234)
self.assertEquals(m_req.call_count, 3)
@attr(db='couch')
def test_view_clean_up(self):
"""
Test cleaning up old view files
"""
self.assertEqual(self.db.view_cleanup(), {'ok': True})
def test_changes_feed_call(self):
"""
Test that changes() method call constructs and returns a Feed object
"""
changes = self.db.changes(limit=100)
self.assertIs(type(changes), Feed)
self.assertEqual(changes._url, '/'.join([self.db.database_url, '_changes']))
self.assertIsInstance(changes._r_session, requests.Session)
self.assertFalse(changes._raw_data)
self.assertDictEqual(changes._options, {'limit': 100})
def test_changes_inifinite_feed_call(self):
"""
Test that infinite_changes() method call constructs and returns an
InfiniteFeed object
"""
changes = self.db.infinite_changes()
self.assertIsInstance(changes, InfiniteFeed)
self.assertEqual(changes._url, '/'.join([self.db.database_url, '_changes']))
self.assertIsInstance(changes._r_session, requests.Session)
self.assertFalse(changes._raw_data)
self.assertDictEqual(changes._options, {'feed': 'continuous'})
def test_get_list_function_result_with_invalid_argument(self):
"""
Test get_list_result by passing in invalid arguments
"""
with self.assertRaises(CloudantArgumentError) as cm:
self.db.get_list_function_result('ddoc001', 'list001', 'view001', foo={'bar': 'baz'})
err = cm.exception
self.assertEqual(str(err), 'Invalid argument foo')
def test_get_list_function_result(self):
"""
Test get_list_result executes a list function against a view's MapReduce
function.
"""
self.populate_db_with_documents()
ddoc = DesignDocument(self.db, '_design/ddoc001')
ddoc.add_view('view001', 'function (doc) {\n emit(doc._id, 1);\n}')
ddoc.add_list_function(
'list001',
'function(head, req) { provides(\'html\', function() '
'{var html = \'<html><body><ol>\\n\'; while (row = getRow()) '
'{ html += \'<li>\' + row.key + \':\' + row.value + \'</li>\\n\';} '
'html += \'</ol></body></html>\'; return html; }); }')
ddoc.save()
# Execute list function
resp = self.db.get_list_function_result(
'_design/ddoc001',
'list001',
'view001',
limit=5
)
self.assertEqual(
resp,
'<html><body><ol>\n'
'<li>julia000:1</li>\n'
'<li>julia001:1</li>\n'
'<li>julia002:1</li>\n'
'<li>julia003:1</li>\n'
'<li>julia004:1</li>\n'
'</ol></body></html>'
)
def test_get_show_result(self):
"""
Test get_show_result executes a show function against a document.
"""
self.populate_db_with_documents()
ddoc = DesignDocument(self.db, '_design/ddoc001')
ddoc.add_show_function(
'show001',
'function(doc, req) { '
'if (doc) { return \'Hello from \' + doc._id + \'!\'; } '
'else { return \'Hello, world!\'; } }')
ddoc.save()
doc = Document(self.db, 'doc001')
doc.save()
# Execute show function
resp = self.db.get_show_function_result(
'_design/ddoc001',
'show001',
'doc001'
)
self.assertEqual(
resp,
'Hello from doc001!'
)
@skip_if_iam
def test_create_doc_with_update_handler(self):
"""
Test update_handler_result executes an update handler function
that creates a new document
"""
self.populate_db_with_documents()
ddoc = DesignDocument(self.db, '_design/ddoc001')
ddoc['updates'] = {
'update001': 'function(doc, req) { if (!doc) { var new_doc = req.form; '
'new_doc._id = \'testDoc\'; return [new_doc, '
'\'Created new doc: \' + JSON.stringify(new_doc)]; }} '
}
ddoc.save()
resp = self.db.update_handler_result('ddoc001', 'update001', data={'message': 'hello'})
self.assertEqual(
resp,
'Created new doc: {"message":"hello","_id":"testDoc"}'
)
@skip_if_iam
def test_update_doc_with_update_handler(self):
"""
Test update_handler_result executes an update handler function
that updates a document with query parameters
"""
self.populate_db_with_documents()
ddoc = DesignDocument(self.db, '_design/ddoc001')
ddoc['updates'] = {
'update001': 'function(doc, req) { '
'var field = req.query.field; '
'var value = req.query.value; '
'var new_doc = doc; '
'doc[field] = value; '
'for(var key in req.form) doc[key]=req.form[key]; '
'var message = \'set \'+field+\' to \'+value'
'+\' and add data \'+ JSON.stringify(req.form); '
'return [doc, message]; } '
}
ddoc.save()
resp = self.db.update_handler_result('ddoc001', 'update001', 'julia001',
field='new_field', value='new_value',
data={'message': 'hello'})
self.assertEqual(
resp,
'set new_field to new_value and add data {"message":"hello"}'
)
ddoc_remote = Document(self.db, 'julia001')
ddoc_remote.fetch()
self.assertEqual(
ddoc_remote,
{'age': 1, 'name': 'julia', 'new_field': 'new_value',
'_rev': ddoc_remote['_rev'], '_id': 'julia001',
'message': 'hello'}
)
def test_update_handler_raises_httperror(self):
"""
Test update_handler_result raises an HTTPError.
"""
# Mock HTTPError when running against CouchDB or Cloudant
resp = requests.Response()
resp.status_code = 400
self.client.r_session.put = mock.Mock(return_value=resp)
with self.assertRaises(requests.HTTPError) as cm:
self.db.update_handler_result('ddoc001', 'update001', 'julia001',
field='new_field', value='new_value',
data={'message': 'hello'})
err = cm.exception
self.assertEqual(err.response.status_code, 400)
ddoc = DesignDocument(self.db, 'ddoc001')
self.client.r_session.put.assert_called_with(
'/'.join([ddoc.document_url, '_update', 'update001', 'julia001']),
data={'message': 'hello'},
params={'field': 'new_field', 'value': 'new_value'})
def test_database_request_fails_after_client_disconnects(self):
"""
Test that after disconnecting from a client any objects created based
on that client are not able to make requests.
"""
self.client.disconnect()
try:
with self.assertRaises(AttributeError):
self.db.metadata()
self.assertIsNone(self.db.r_session)
finally:
self.client.connect()
@attr(couchapi=2)
def test_create_json_index(self):
"""
Ensure that a JSON index is created as expected.
"""
index = self.db.create_query_index(fields=['name', 'age'])
self.assertIsInstance(index, Index)
You can’t perform that action at this time.