/
test_base_query.py
1505 lines (1210 loc) · 56.9 KB
/
test_base_query.py
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
# Copyright 2017 Google LLC 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.
import datetime
import unittest
import mock
class TestBaseQuery(unittest.TestCase):
@staticmethod
def _get_target_class():
from google.cloud.firestore_v1.query import Query
return Query
def _make_one(self, *args, **kwargs):
klass = self._get_target_class()
return klass(*args, **kwargs)
def test_constructor_defaults(self):
query = self._make_one(mock.sentinel.parent)
self.assertIs(query._parent, mock.sentinel.parent)
self.assertIsNone(query._projection)
self.assertEqual(query._field_filters, ())
self.assertEqual(query._orders, ())
self.assertIsNone(query._limit)
self.assertIsNone(query._offset)
self.assertIsNone(query._start_at)
self.assertIsNone(query._end_at)
self.assertFalse(query._all_descendants)
def _make_one_all_fields(
self, limit=9876, offset=12, skip_fields=(), parent=None, all_descendants=True
):
kwargs = {
"projection": mock.sentinel.projection,
"field_filters": mock.sentinel.filters,
"orders": mock.sentinel.orders,
"limit": limit,
"offset": offset,
"start_at": mock.sentinel.start_at,
"end_at": mock.sentinel.end_at,
"all_descendants": all_descendants,
}
for field in skip_fields:
kwargs.pop(field)
if parent is None:
parent = mock.sentinel.parent
return self._make_one(parent, **kwargs)
def test_constructor_explicit(self):
limit = 234
offset = 56
query = self._make_one_all_fields(limit=limit, offset=offset)
self.assertIs(query._parent, mock.sentinel.parent)
self.assertIs(query._projection, mock.sentinel.projection)
self.assertIs(query._field_filters, mock.sentinel.filters)
self.assertEqual(query._orders, mock.sentinel.orders)
self.assertEqual(query._limit, limit)
self.assertEqual(query._offset, offset)
self.assertIs(query._start_at, mock.sentinel.start_at)
self.assertIs(query._end_at, mock.sentinel.end_at)
self.assertTrue(query._all_descendants)
def test__client_property(self):
parent = mock.Mock(_client=mock.sentinel.client, spec=["_client"])
query = self._make_one(parent)
self.assertIs(query._client, mock.sentinel.client)
def test___eq___other_type(self):
query = self._make_one_all_fields()
other = object()
self.assertFalse(query == other)
def test___eq___different_parent(self):
parent = mock.sentinel.parent
other_parent = mock.sentinel.other_parent
query = self._make_one_all_fields(parent=parent)
other = self._make_one_all_fields(parent=other_parent)
self.assertFalse(query == other)
def test___eq___different_projection(self):
parent = mock.sentinel.parent
query = self._make_one_all_fields(parent=parent, skip_fields=("projection",))
query._projection = mock.sentinel.projection
other = self._make_one_all_fields(parent=parent, skip_fields=("projection",))
other._projection = mock.sentinel.other_projection
self.assertFalse(query == other)
def test___eq___different_field_filters(self):
parent = mock.sentinel.parent
query = self._make_one_all_fields(parent=parent, skip_fields=("field_filters",))
query._field_filters = mock.sentinel.field_filters
other = self._make_one_all_fields(parent=parent, skip_fields=("field_filters",))
other._field_filters = mock.sentinel.other_field_filters
self.assertFalse(query == other)
def test___eq___different_orders(self):
parent = mock.sentinel.parent
query = self._make_one_all_fields(parent=parent, skip_fields=("orders",))
query._orders = mock.sentinel.orders
other = self._make_one_all_fields(parent=parent, skip_fields=("orders",))
other._orders = mock.sentinel.other_orders
self.assertFalse(query == other)
def test___eq___different_limit(self):
parent = mock.sentinel.parent
query = self._make_one_all_fields(parent=parent, limit=10)
other = self._make_one_all_fields(parent=parent, limit=20)
self.assertFalse(query == other)
def test___eq___different_offset(self):
parent = mock.sentinel.parent
query = self._make_one_all_fields(parent=parent, offset=10)
other = self._make_one_all_fields(parent=parent, offset=20)
self.assertFalse(query == other)
def test___eq___different_start_at(self):
parent = mock.sentinel.parent
query = self._make_one_all_fields(parent=parent, skip_fields=("start_at",))
query._start_at = mock.sentinel.start_at
other = self._make_one_all_fields(parent=parent, skip_fields=("start_at",))
other._start_at = mock.sentinel.other_start_at
self.assertFalse(query == other)
def test___eq___different_end_at(self):
parent = mock.sentinel.parent
query = self._make_one_all_fields(parent=parent, skip_fields=("end_at",))
query._end_at = mock.sentinel.end_at
other = self._make_one_all_fields(parent=parent, skip_fields=("end_at",))
other._end_at = mock.sentinel.other_end_at
self.assertFalse(query == other)
def test___eq___different_all_descendants(self):
parent = mock.sentinel.parent
query = self._make_one_all_fields(parent=parent, all_descendants=True)
other = self._make_one_all_fields(parent=parent, all_descendants=False)
self.assertFalse(query == other)
def test___eq___hit(self):
query = self._make_one_all_fields()
other = self._make_one_all_fields()
self.assertTrue(query == other)
def _compare_queries(self, query1, query2, attr_name):
attrs1 = query1.__dict__.copy()
attrs2 = query2.__dict__.copy()
attrs1.pop(attr_name)
attrs2.pop(attr_name)
# The only different should be in ``attr_name``.
self.assertEqual(len(attrs1), len(attrs2))
for key, value in attrs1.items():
self.assertIs(value, attrs2[key])
@staticmethod
def _make_projection_for_select(field_paths):
from google.cloud.firestore_v1.types import query
return query.StructuredQuery.Projection(
fields=[
query.StructuredQuery.FieldReference(field_path=field_path)
for field_path in field_paths
]
)
def test_select_invalid_path(self):
query = self._make_one(mock.sentinel.parent)
with self.assertRaises(ValueError):
query.select(["*"])
def test_select(self):
query1 = self._make_one_all_fields(all_descendants=True)
field_paths2 = ["foo", "bar"]
query2 = query1.select(field_paths2)
self.assertIsNot(query2, query1)
self.assertIsInstance(query2, self._get_target_class())
self.assertEqual(
query2._projection, self._make_projection_for_select(field_paths2)
)
self._compare_queries(query1, query2, "_projection")
# Make sure it overrides.
field_paths3 = ["foo.baz"]
query3 = query2.select(field_paths3)
self.assertIsNot(query3, query2)
self.assertIsInstance(query3, self._get_target_class())
self.assertEqual(
query3._projection, self._make_projection_for_select(field_paths3)
)
self._compare_queries(query2, query3, "_projection")
def test_where_invalid_path(self):
query = self._make_one(mock.sentinel.parent)
with self.assertRaises(ValueError):
query.where("*", "==", 1)
def test_where(self):
from google.cloud.firestore_v1.types import StructuredQuery
from google.cloud.firestore_v1.types import document
from google.cloud.firestore_v1.types import query
query_inst = self._make_one_all_fields(
skip_fields=("field_filters",), all_descendants=True
)
new_query = query_inst.where("power.level", ">", 9000)
self.assertIsNot(query_inst, new_query)
self.assertIsInstance(new_query, self._get_target_class())
self.assertEqual(len(new_query._field_filters), 1)
field_pb = new_query._field_filters[0]
expected_pb = query.StructuredQuery.FieldFilter(
field=query.StructuredQuery.FieldReference(field_path="power.level"),
op=StructuredQuery.FieldFilter.Operator.GREATER_THAN,
value=document.Value(integer_value=9000),
)
self.assertEqual(field_pb, expected_pb)
self._compare_queries(query_inst, new_query, "_field_filters")
def _where_unary_helper(self, value, op_enum, op_string="=="):
from google.cloud.firestore_v1.types import StructuredQuery
query_inst = self._make_one_all_fields(skip_fields=("field_filters",))
field_path = "feeeld"
new_query = query_inst.where(field_path, op_string, value)
self.assertIsNot(query_inst, new_query)
self.assertIsInstance(new_query, self._get_target_class())
self.assertEqual(len(new_query._field_filters), 1)
field_pb = new_query._field_filters[0]
expected_pb = StructuredQuery.UnaryFilter(
field=StructuredQuery.FieldReference(field_path=field_path), op=op_enum
)
self.assertEqual(field_pb, expected_pb)
self._compare_queries(query_inst, new_query, "_field_filters")
def test_where_eq_null(self):
from google.cloud.firestore_v1.types import StructuredQuery
op_enum = StructuredQuery.UnaryFilter.Operator.IS_NULL
self._where_unary_helper(None, op_enum)
def test_where_gt_null(self):
with self.assertRaises(ValueError):
self._where_unary_helper(None, 0, op_string=">")
def test_where_eq_nan(self):
from google.cloud.firestore_v1.types import StructuredQuery
op_enum = StructuredQuery.UnaryFilter.Operator.IS_NAN
self._where_unary_helper(float("nan"), op_enum)
def test_where_le_nan(self):
with self.assertRaises(ValueError):
self._where_unary_helper(float("nan"), 0, op_string="<=")
def test_where_w_delete(self):
from google.cloud.firestore_v1 import DELETE_FIELD
with self.assertRaises(ValueError):
self._where_unary_helper(DELETE_FIELD, 0)
def test_where_w_server_timestamp(self):
from google.cloud.firestore_v1 import SERVER_TIMESTAMP
with self.assertRaises(ValueError):
self._where_unary_helper(SERVER_TIMESTAMP, 0)
def test_where_w_array_remove(self):
from google.cloud.firestore_v1 import ArrayRemove
with self.assertRaises(ValueError):
self._where_unary_helper(ArrayRemove([1, 3, 5]), 0)
def test_where_w_array_union(self):
from google.cloud.firestore_v1 import ArrayUnion
with self.assertRaises(ValueError):
self._where_unary_helper(ArrayUnion([2, 4, 8]), 0)
def test_order_by_invalid_path(self):
query = self._make_one(mock.sentinel.parent)
with self.assertRaises(ValueError):
query.order_by("*")
def test_order_by(self):
from google.cloud.firestore_v1.types import StructuredQuery
klass = self._get_target_class()
query1 = self._make_one_all_fields(
skip_fields=("orders",), all_descendants=True
)
field_path2 = "a"
query2 = query1.order_by(field_path2)
self.assertIsNot(query2, query1)
self.assertIsInstance(query2, klass)
order = _make_order_pb(field_path2, StructuredQuery.Direction.ASCENDING)
self.assertEqual(query2._orders, (order,))
self._compare_queries(query1, query2, "_orders")
# Make sure it appends to the orders.
field_path3 = "b"
query3 = query2.order_by(field_path3, direction=klass.DESCENDING)
self.assertIsNot(query3, query2)
self.assertIsInstance(query3, klass)
order_pb3 = _make_order_pb(field_path3, StructuredQuery.Direction.DESCENDING)
self.assertEqual(query3._orders, (order, order_pb3))
self._compare_queries(query2, query3, "_orders")
def test_limit(self):
query1 = self._make_one_all_fields(all_descendants=True)
limit2 = 100
query2 = query1.limit(limit2)
self.assertIsNot(query2, query1)
self.assertIsInstance(query2, self._get_target_class())
self.assertEqual(query2._limit, limit2)
self._compare_queries(query1, query2, "_limit")
# Make sure it overrides.
limit3 = 10
query3 = query2.limit(limit3)
self.assertIsNot(query3, query2)
self.assertIsInstance(query3, self._get_target_class())
self.assertEqual(query3._limit, limit3)
self._compare_queries(query2, query3, "_limit")
def test_offset(self):
query1 = self._make_one_all_fields(all_descendants=True)
offset2 = 23
query2 = query1.offset(offset2)
self.assertIsNot(query2, query1)
self.assertIsInstance(query2, self._get_target_class())
self.assertEqual(query2._offset, offset2)
self._compare_queries(query1, query2, "_offset")
# Make sure it overrides.
offset3 = 35
query3 = query2.offset(offset3)
self.assertIsNot(query3, query2)
self.assertIsInstance(query3, self._get_target_class())
self.assertEqual(query3._offset, offset3)
self._compare_queries(query2, query3, "_offset")
@staticmethod
def _make_collection(*path, **kw):
from google.cloud.firestore_v1 import collection
return collection.CollectionReference(*path, **kw)
@staticmethod
def _make_docref(*path, **kw):
from google.cloud.firestore_v1 import document
return document.DocumentReference(*path, **kw)
@staticmethod
def _make_snapshot(docref, values):
from google.cloud.firestore_v1 import document
return document.DocumentSnapshot(docref, values, True, None, None, None)
def test__cursor_helper_w_dict(self):
values = {"a": 7, "b": "foo"}
query1 = self._make_one(mock.sentinel.parent)
query1._all_descendants = True
query2 = query1._cursor_helper(values, True, True)
self.assertIs(query2._parent, mock.sentinel.parent)
self.assertIsNone(query2._projection)
self.assertEqual(query2._field_filters, ())
self.assertEqual(query2._orders, query1._orders)
self.assertIsNone(query2._limit)
self.assertIsNone(query2._offset)
self.assertIsNone(query2._end_at)
self.assertTrue(query2._all_descendants)
cursor, before = query2._start_at
self.assertEqual(cursor, values)
self.assertTrue(before)
def test__cursor_helper_w_tuple(self):
values = (7, "foo")
query1 = self._make_one(mock.sentinel.parent)
query2 = query1._cursor_helper(values, False, True)
self.assertIs(query2._parent, mock.sentinel.parent)
self.assertIsNone(query2._projection)
self.assertEqual(query2._field_filters, ())
self.assertEqual(query2._orders, query1._orders)
self.assertIsNone(query2._limit)
self.assertIsNone(query2._offset)
self.assertIsNone(query2._end_at)
cursor, before = query2._start_at
self.assertEqual(cursor, list(values))
self.assertFalse(before)
def test__cursor_helper_w_list(self):
values = [7, "foo"]
query1 = self._make_one(mock.sentinel.parent)
query2 = query1._cursor_helper(values, True, False)
self.assertIs(query2._parent, mock.sentinel.parent)
self.assertIsNone(query2._projection)
self.assertEqual(query2._field_filters, ())
self.assertEqual(query2._orders, query1._orders)
self.assertIsNone(query2._limit)
self.assertIsNone(query2._offset)
self.assertIsNone(query2._start_at)
cursor, before = query2._end_at
self.assertEqual(cursor, values)
self.assertIsNot(cursor, values)
self.assertTrue(before)
def test__cursor_helper_w_snapshot_wrong_collection(self):
values = {"a": 7, "b": "foo"}
docref = self._make_docref("there", "doc_id")
snapshot = self._make_snapshot(docref, values)
collection = self._make_collection("here")
query = self._make_one(collection)
with self.assertRaises(ValueError):
query._cursor_helper(snapshot, False, False)
def test__cursor_helper_w_snapshot_other_collection_all_descendants(self):
values = {"a": 7, "b": "foo"}
docref = self._make_docref("there", "doc_id")
snapshot = self._make_snapshot(docref, values)
collection = self._make_collection("here")
query1 = self._make_one(collection, all_descendants=True)
query2 = query1._cursor_helper(snapshot, False, False)
self.assertIs(query2._parent, collection)
self.assertIsNone(query2._projection)
self.assertEqual(query2._field_filters, ())
self.assertEqual(query2._orders, ())
self.assertIsNone(query2._limit)
self.assertIsNone(query2._offset)
self.assertIsNone(query2._start_at)
cursor, before = query2._end_at
self.assertIs(cursor, snapshot)
self.assertFalse(before)
def test__cursor_helper_w_snapshot(self):
values = {"a": 7, "b": "foo"}
docref = self._make_docref("here", "doc_id")
snapshot = self._make_snapshot(docref, values)
collection = self._make_collection("here")
query1 = self._make_one(collection)
query2 = query1._cursor_helper(snapshot, False, False)
self.assertIs(query2._parent, collection)
self.assertIsNone(query2._projection)
self.assertEqual(query2._field_filters, ())
self.assertEqual(query2._orders, ())
self.assertIsNone(query2._limit)
self.assertIsNone(query2._offset)
self.assertIsNone(query2._start_at)
cursor, before = query2._end_at
self.assertIs(cursor, snapshot)
self.assertFalse(before)
def test_start_at(self):
collection = self._make_collection("here")
query1 = self._make_one_all_fields(
parent=collection, skip_fields=("orders",), all_descendants=True
)
query2 = query1.order_by("hi")
document_fields3 = {"hi": "mom"}
query3 = query2.start_at(document_fields3)
self.assertIsNot(query3, query2)
self.assertIsInstance(query3, self._get_target_class())
self.assertEqual(query3._start_at, (document_fields3, True))
self._compare_queries(query2, query3, "_start_at")
# Make sure it overrides.
query4 = query3.order_by("bye")
values5 = {"hi": "zap", "bye": 88}
docref = self._make_docref("here", "doc_id")
document_fields5 = self._make_snapshot(docref, values5)
query5 = query4.start_at(document_fields5)
self.assertIsNot(query5, query4)
self.assertIsInstance(query5, self._get_target_class())
self.assertEqual(query5._start_at, (document_fields5, True))
self._compare_queries(query4, query5, "_start_at")
def test_start_after(self):
collection = self._make_collection("here")
query1 = self._make_one_all_fields(parent=collection, skip_fields=("orders",))
query2 = query1.order_by("down")
document_fields3 = {"down": 99.75}
query3 = query2.start_after(document_fields3)
self.assertIsNot(query3, query2)
self.assertIsInstance(query3, self._get_target_class())
self.assertEqual(query3._start_at, (document_fields3, False))
self._compare_queries(query2, query3, "_start_at")
# Make sure it overrides.
query4 = query3.order_by("out")
values5 = {"down": 100.25, "out": b"\x00\x01"}
docref = self._make_docref("here", "doc_id")
document_fields5 = self._make_snapshot(docref, values5)
query5 = query4.start_after(document_fields5)
self.assertIsNot(query5, query4)
self.assertIsInstance(query5, self._get_target_class())
self.assertEqual(query5._start_at, (document_fields5, False))
self._compare_queries(query4, query5, "_start_at")
def test_end_before(self):
collection = self._make_collection("here")
query1 = self._make_one_all_fields(parent=collection, skip_fields=("orders",))
query2 = query1.order_by("down")
document_fields3 = {"down": 99.75}
query3 = query2.end_before(document_fields3)
self.assertIsNot(query3, query2)
self.assertIsInstance(query3, self._get_target_class())
self.assertEqual(query3._end_at, (document_fields3, True))
self._compare_queries(query2, query3, "_end_at")
# Make sure it overrides.
query4 = query3.order_by("out")
values5 = {"down": 100.25, "out": b"\x00\x01"}
docref = self._make_docref("here", "doc_id")
document_fields5 = self._make_snapshot(docref, values5)
query5 = query4.end_before(document_fields5)
self.assertIsNot(query5, query4)
self.assertIsInstance(query5, self._get_target_class())
self.assertEqual(query5._end_at, (document_fields5, True))
self._compare_queries(query4, query5, "_end_at")
self._compare_queries(query4, query5, "_end_at")
def test_end_at(self):
collection = self._make_collection("here")
query1 = self._make_one_all_fields(parent=collection, skip_fields=("orders",))
query2 = query1.order_by("hi")
document_fields3 = {"hi": "mom"}
query3 = query2.end_at(document_fields3)
self.assertIsNot(query3, query2)
self.assertIsInstance(query3, self._get_target_class())
self.assertEqual(query3._end_at, (document_fields3, False))
self._compare_queries(query2, query3, "_end_at")
# Make sure it overrides.
query4 = query3.order_by("bye")
values5 = {"hi": "zap", "bye": 88}
docref = self._make_docref("here", "doc_id")
document_fields5 = self._make_snapshot(docref, values5)
query5 = query4.end_at(document_fields5)
self.assertIsNot(query5, query4)
self.assertIsInstance(query5, self._get_target_class())
self.assertEqual(query5._end_at, (document_fields5, False))
self._compare_queries(query4, query5, "_end_at")
def test__filters_pb_empty(self):
query = self._make_one(mock.sentinel.parent)
self.assertEqual(len(query._field_filters), 0)
self.assertIsNone(query._filters_pb())
def test__filters_pb_single(self):
from google.cloud.firestore_v1.types import StructuredQuery
from google.cloud.firestore_v1.types import document
from google.cloud.firestore_v1.types import query
query1 = self._make_one(mock.sentinel.parent)
query2 = query1.where("x.y", ">", 50.5)
filter_pb = query2._filters_pb()
expected_pb = query.StructuredQuery.Filter(
field_filter=query.StructuredQuery.FieldFilter(
field=query.StructuredQuery.FieldReference(field_path="x.y"),
op=StructuredQuery.FieldFilter.Operator.GREATER_THAN,
value=document.Value(double_value=50.5),
)
)
self.assertEqual(filter_pb, expected_pb)
def test__filters_pb_multi(self):
from google.cloud.firestore_v1.types import StructuredQuery
from google.cloud.firestore_v1.types import document
from google.cloud.firestore_v1.types import query
query1 = self._make_one(mock.sentinel.parent)
query2 = query1.where("x.y", ">", 50.5)
query3 = query2.where("ABC", "==", 123)
filter_pb = query3._filters_pb()
op_class = StructuredQuery.FieldFilter.Operator
expected_pb = query.StructuredQuery.Filter(
composite_filter=query.StructuredQuery.CompositeFilter(
op=StructuredQuery.CompositeFilter.Operator.AND,
filters=[
query.StructuredQuery.Filter(
field_filter=query.StructuredQuery.FieldFilter(
field=query.StructuredQuery.FieldReference(
field_path="x.y"
),
op=op_class.GREATER_THAN,
value=document.Value(double_value=50.5),
)
),
query.StructuredQuery.Filter(
field_filter=query.StructuredQuery.FieldFilter(
field=query.StructuredQuery.FieldReference(
field_path="ABC"
),
op=op_class.EQUAL,
value=document.Value(integer_value=123),
)
),
],
)
)
self.assertEqual(filter_pb, expected_pb)
def test__normalize_projection_none(self):
query = self._make_one(mock.sentinel.parent)
self.assertIsNone(query._normalize_projection(None))
def test__normalize_projection_empty(self):
projection = self._make_projection_for_select([])
query = self._make_one(mock.sentinel.parent)
normalized = query._normalize_projection(projection)
field_paths = [field_ref.field_path for field_ref in normalized.fields]
self.assertEqual(field_paths, ["__name__"])
def test__normalize_projection_non_empty(self):
projection = self._make_projection_for_select(["a", "b"])
query = self._make_one(mock.sentinel.parent)
self.assertIs(query._normalize_projection(projection), projection)
def test__normalize_orders_wo_orders_wo_cursors(self):
query = self._make_one(mock.sentinel.parent)
expected = []
self.assertEqual(query._normalize_orders(), expected)
def test__normalize_orders_w_orders_wo_cursors(self):
query = self._make_one(mock.sentinel.parent).order_by("a")
expected = [query._make_order("a", "ASCENDING")]
self.assertEqual(query._normalize_orders(), expected)
def test__normalize_orders_wo_orders_w_snapshot_cursor(self):
values = {"a": 7, "b": "foo"}
docref = self._make_docref("here", "doc_id")
snapshot = self._make_snapshot(docref, values)
collection = self._make_collection("here")
query = self._make_one(collection).start_at(snapshot)
expected = [query._make_order("__name__", "ASCENDING")]
self.assertEqual(query._normalize_orders(), expected)
def test__normalize_orders_w_name_orders_w_snapshot_cursor(self):
values = {"a": 7, "b": "foo"}
docref = self._make_docref("here", "doc_id")
snapshot = self._make_snapshot(docref, values)
collection = self._make_collection("here")
query = (
self._make_one(collection)
.order_by("__name__", "DESCENDING")
.start_at(snapshot)
)
expected = [query._make_order("__name__", "DESCENDING")]
self.assertEqual(query._normalize_orders(), expected)
def test__normalize_orders_wo_orders_w_snapshot_cursor_w_neq_exists(self):
values = {"a": 7, "b": "foo"}
docref = self._make_docref("here", "doc_id")
snapshot = self._make_snapshot(docref, values)
collection = self._make_collection("here")
query = (
self._make_one(collection)
.where("c", "<=", 20)
.order_by("c", "DESCENDING")
.start_at(snapshot)
)
expected = [
query._make_order("c", "DESCENDING"),
query._make_order("__name__", "DESCENDING"),
]
self.assertEqual(query._normalize_orders(), expected)
def test__normalize_orders_wo_orders_w_snapshot_cursor_w_neq_where(self):
values = {"a": 7, "b": "foo"}
docref = self._make_docref("here", "doc_id")
snapshot = self._make_snapshot(docref, values)
collection = self._make_collection("here")
query = self._make_one(collection).where("c", "<=", 20).end_at(snapshot)
expected = [
query._make_order("c", "ASCENDING"),
query._make_order("__name__", "ASCENDING"),
]
self.assertEqual(query._normalize_orders(), expected)
def test__normalize_cursor_none(self):
query = self._make_one(mock.sentinel.parent)
self.assertIsNone(query._normalize_cursor(None, query._orders))
def test__normalize_cursor_no_order(self):
cursor = ([1], True)
query = self._make_one(mock.sentinel.parent)
with self.assertRaises(ValueError):
query._normalize_cursor(cursor, query._orders)
def test__normalize_cursor_as_list_mismatched_order(self):
cursor = ([1, 2], True)
query = self._make_one(mock.sentinel.parent).order_by("b", "ASCENDING")
with self.assertRaises(ValueError):
query._normalize_cursor(cursor, query._orders)
def test__normalize_cursor_as_dict_mismatched_order(self):
cursor = ({"a": 1}, True)
query = self._make_one(mock.sentinel.parent).order_by("b", "ASCENDING")
with self.assertRaises(ValueError):
query._normalize_cursor(cursor, query._orders)
def test__normalize_cursor_w_delete(self):
from google.cloud.firestore_v1 import DELETE_FIELD
cursor = ([DELETE_FIELD], True)
query = self._make_one(mock.sentinel.parent).order_by("b", "ASCENDING")
with self.assertRaises(ValueError):
query._normalize_cursor(cursor, query._orders)
def test__normalize_cursor_w_server_timestamp(self):
from google.cloud.firestore_v1 import SERVER_TIMESTAMP
cursor = ([SERVER_TIMESTAMP], True)
query = self._make_one(mock.sentinel.parent).order_by("b", "ASCENDING")
with self.assertRaises(ValueError):
query._normalize_cursor(cursor, query._orders)
def test__normalize_cursor_w_array_remove(self):
from google.cloud.firestore_v1 import ArrayRemove
cursor = ([ArrayRemove([1, 3, 5])], True)
query = self._make_one(mock.sentinel.parent).order_by("b", "ASCENDING")
with self.assertRaises(ValueError):
query._normalize_cursor(cursor, query._orders)
def test__normalize_cursor_w_array_union(self):
from google.cloud.firestore_v1 import ArrayUnion
cursor = ([ArrayUnion([2, 4, 8])], True)
query = self._make_one(mock.sentinel.parent).order_by("b", "ASCENDING")
with self.assertRaises(ValueError):
query._normalize_cursor(cursor, query._orders)
def test__normalize_cursor_as_list_hit(self):
cursor = ([1], True)
query = self._make_one(mock.sentinel.parent).order_by("b", "ASCENDING")
self.assertEqual(query._normalize_cursor(cursor, query._orders), ([1], True))
def test__normalize_cursor_as_dict_hit(self):
cursor = ({"b": 1}, True)
query = self._make_one(mock.sentinel.parent).order_by("b", "ASCENDING")
self.assertEqual(query._normalize_cursor(cursor, query._orders), ([1], True))
def test__normalize_cursor_as_dict_with_dot_key_hit(self):
cursor = ({"b.a": 1}, True)
query = self._make_one(mock.sentinel.parent).order_by("b.a", "ASCENDING")
self.assertEqual(query._normalize_cursor(cursor, query._orders), ([1], True))
def test__normalize_cursor_as_dict_with_inner_data_hit(self):
cursor = ({"b": {"a": 1}}, True)
query = self._make_one(mock.sentinel.parent).order_by("b.a", "ASCENDING")
self.assertEqual(query._normalize_cursor(cursor, query._orders), ([1], True))
def test__normalize_cursor_as_snapshot_hit(self):
values = {"b": 1}
docref = self._make_docref("here", "doc_id")
snapshot = self._make_snapshot(docref, values)
cursor = (snapshot, True)
collection = self._make_collection("here")
query = self._make_one(collection).order_by("b", "ASCENDING")
self.assertEqual(query._normalize_cursor(cursor, query._orders), ([1], True))
def test__normalize_cursor_w___name___w_reference(self):
db_string = "projects/my-project/database/(default)"
client = mock.Mock(spec=["_database_string"])
client._database_string = db_string
parent = mock.Mock(spec=["_path", "_client"])
parent._client = client
parent._path = ["C"]
query = self._make_one(parent).order_by("__name__", "ASCENDING")
docref = self._make_docref("here", "doc_id")
values = {"a": 7}
snapshot = self._make_snapshot(docref, values)
expected = docref
cursor = (snapshot, True)
self.assertEqual(
query._normalize_cursor(cursor, query._orders), ([expected], True)
)
def test__normalize_cursor_w___name___wo_slash(self):
db_string = "projects/my-project/database/(default)"
client = mock.Mock(spec=["_database_string"])
client._database_string = db_string
parent = mock.Mock(spec=["_path", "_client", "document"])
parent._client = client
parent._path = ["C"]
document = parent.document.return_value = mock.Mock(spec=[])
query = self._make_one(parent).order_by("__name__", "ASCENDING")
cursor = (["b"], True)
expected = document
self.assertEqual(
query._normalize_cursor(cursor, query._orders), ([expected], True)
)
parent.document.assert_called_once_with("b")
def test__to_protobuf_all_fields(self):
from google.protobuf import wrappers_pb2
from google.cloud.firestore_v1.types import StructuredQuery
from google.cloud.firestore_v1.types import document
from google.cloud.firestore_v1.types import query
parent = mock.Mock(id="cat", spec=["id"])
query1 = self._make_one(parent)
query2 = query1.select(["X", "Y", "Z"])
query3 = query2.where("Y", ">", 2.5)
query4 = query3.order_by("X")
query5 = query4.limit(17)
query6 = query5.offset(3)
query7 = query6.start_at({"X": 10})
query8 = query7.end_at({"X": 25})
structured_query_pb = query8._to_protobuf()
query_kwargs = {
"from_": [
query.StructuredQuery.CollectionSelector(collection_id=parent.id)
],
"select": query.StructuredQuery.Projection(
fields=[
query.StructuredQuery.FieldReference(field_path=field_path)
for field_path in ["X", "Y", "Z"]
]
),
"where": query.StructuredQuery.Filter(
field_filter=query.StructuredQuery.FieldFilter(
field=query.StructuredQuery.FieldReference(field_path="Y"),
op=StructuredQuery.FieldFilter.Operator.GREATER_THAN,
value=document.Value(double_value=2.5),
)
),
"order_by": [_make_order_pb("X", StructuredQuery.Direction.ASCENDING)],
"start_at": query.Cursor(
values=[document.Value(integer_value=10)], before=True
),
"end_at": query.Cursor(values=[document.Value(integer_value=25)]),
"offset": 3,
"limit": wrappers_pb2.Int32Value(value=17),
}
expected_pb = query.StructuredQuery(**query_kwargs)
self.assertEqual(structured_query_pb, expected_pb)
def test__to_protobuf_select_only(self):
from google.cloud.firestore_v1.types import query
parent = mock.Mock(id="cat", spec=["id"])
query1 = self._make_one(parent)
field_paths = ["a.b", "a.c", "d"]
query2 = query1.select(field_paths)
structured_query_pb = query2._to_protobuf()
query_kwargs = {
"from_": [
query.StructuredQuery.CollectionSelector(collection_id=parent.id)
],
"select": query.StructuredQuery.Projection(
fields=[
query.StructuredQuery.FieldReference(field_path=field_path)
for field_path in field_paths
]
),
}
expected_pb = query.StructuredQuery(**query_kwargs)
self.assertEqual(structured_query_pb, expected_pb)
def test__to_protobuf_where_only(self):
from google.cloud.firestore_v1.types import StructuredQuery
from google.cloud.firestore_v1.types import document
from google.cloud.firestore_v1.types import query
parent = mock.Mock(id="dog", spec=["id"])
query1 = self._make_one(parent)
query2 = query1.where("a", "==", u"b")
structured_query_pb = query2._to_protobuf()
query_kwargs = {
"from_": [
query.StructuredQuery.CollectionSelector(collection_id=parent.id)
],
"where": query.StructuredQuery.Filter(
field_filter=query.StructuredQuery.FieldFilter(
field=query.StructuredQuery.FieldReference(field_path="a"),
op=StructuredQuery.FieldFilter.Operator.EQUAL,
value=document.Value(string_value=u"b"),
)
),
}
expected_pb = query.StructuredQuery(**query_kwargs)
self.assertEqual(structured_query_pb, expected_pb)
def test__to_protobuf_order_by_only(self):
from google.cloud.firestore_v1.types import StructuredQuery
from google.cloud.firestore_v1.types import query
parent = mock.Mock(id="fish", spec=["id"])
query1 = self._make_one(parent)
query2 = query1.order_by("abc")
structured_query_pb = query2._to_protobuf()
query_kwargs = {
"from_": [
query.StructuredQuery.CollectionSelector(collection_id=parent.id)
],
"order_by": [_make_order_pb("abc", StructuredQuery.Direction.ASCENDING)],
}
expected_pb = query.StructuredQuery(**query_kwargs)
self.assertEqual(structured_query_pb, expected_pb)
def test__to_protobuf_start_at_only(self):
# NOTE: "only" is wrong since we must have ``order_by`` as well.
from google.cloud.firestore_v1.types import StructuredQuery
from google.cloud.firestore_v1.types import document
from google.cloud.firestore_v1.types import query
parent = mock.Mock(id="phish", spec=["id"])
query_inst = (
self._make_one(parent).order_by("X.Y").start_after({"X": {"Y": u"Z"}})
)
structured_query_pb = query_inst._to_protobuf()
query_kwargs = {
"from_": [StructuredQuery.CollectionSelector(collection_id=parent.id)],
"order_by": [_make_order_pb("X.Y", StructuredQuery.Direction.ASCENDING)],
"start_at": query.Cursor(values=[document.Value(string_value=u"Z")]),
}
expected_pb = StructuredQuery(**query_kwargs)
self.assertEqual(structured_query_pb, expected_pb)
def test__to_protobuf_end_at_only(self):
# NOTE: "only" is wrong since we must have ``order_by`` as well.
from google.cloud.firestore_v1.types import StructuredQuery
from google.cloud.firestore_v1.types import document
from google.cloud.firestore_v1.types import query
parent = mock.Mock(id="ghoti", spec=["id"])
query_inst = self._make_one(parent).order_by("a").end_at({"a": 88})