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
|
/**
* Copyright (C) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* 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
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#include "mongo/platform/basic.h"
#include <boost/intrusive_ptr.hpp>
#include <deque>
#include <map>
#include <memory>
#include <string>
#include <vector>
#include "mongo/bson/bsonelement.h"
#include "mongo/bson/bsonmisc.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/bson/json.h"
#include "mongo/db/exec/document_value/document_value_test_util.h"
#include "mongo/db/exec/document_value/value_comparator.h"
#include "mongo/db/pipeline/aggregate_command_gen.h"
#include "mongo/db/pipeline/aggregation_context_fixture.h"
#include "mongo/db/pipeline/aggregation_request_helper.h"
#include "mongo/db/pipeline/dependencies.h"
#include "mongo/db/pipeline/document_source_group.h"
#include "mongo/db/pipeline/document_source_mock.h"
#include "mongo/db/pipeline/expression.h"
#include "mongo/db/pipeline/expression_context_for_test.h"
#include "mongo/db/query/query_test_service_context.h"
#include "mongo/dbtests/dbtests.h"
#include "mongo/stdx/unordered_set.h"
#include "mongo/unittest/temp_dir.h"
#include "mongo/unittest/unittest.h"
namespace mongo {
namespace {
using boost::intrusive_ptr;
using std::deque;
using std::map;
using std::string;
using std::vector;
static const char* const ns = "unittests.document_source_group_tests";
// This provides access to getExpCtx(), but we'll use a different name for this test suite.
using DocumentSourceGroupTest = AggregationContextFixture;
TEST_F(DocumentSourceGroupTest, ShouldBeAbleToPauseLoading) {
auto expCtx = getExpCtx();
expCtx->inMongos = true; // Disallow external sort.
// This is the only way to do this in a debug build.
auto&& parser = AccumulationStatement::getParser("$sum", boost::none);
auto accumulatorArg = BSON("" << 1);
auto accExpr = parser(expCtx.get(), accumulatorArg.firstElement(), expCtx->variablesParseState);
AccumulationStatement countStatement{"count", accExpr};
auto group = DocumentSourceGroup::create(
expCtx, ExpressionConstant::create(expCtx.get(), Value(BSONNULL)), {countStatement});
auto mock =
DocumentSourceMock::createForTest({DocumentSource::GetNextResult::makePauseExecution(),
Document(),
DocumentSource::GetNextResult::makePauseExecution(),
Document(),
Document(),
DocumentSource::GetNextResult::makePauseExecution(),
Document()},
expCtx);
group->setSource(mock.get());
// There were 3 pauses, so we should expect 3 paused results before any results can be returned.
ASSERT_TRUE(group->getNext().isPaused());
ASSERT_TRUE(group->getNext().isPaused());
ASSERT_TRUE(group->getNext().isPaused());
// There were 4 documents, so we expect a count of 4.
auto result = group->getNext();
ASSERT_TRUE(result.isAdvanced());
ASSERT_DOCUMENT_EQ(result.releaseDocument(), (Document{{"_id", BSONNULL}, {"count", 4}}));
}
TEST_F(DocumentSourceGroupTest, ShouldBeAbleToPauseLoadingWhileSpilled) {
auto expCtx = getExpCtx();
// Allow the $group stage to spill to disk.
TempDir tempDir("DocumentSourceGroupTest");
expCtx->tempDir = tempDir.path();
expCtx->allowDiskUse = true;
const size_t maxMemoryUsageBytes = 1000;
auto&& parser = AccumulationStatement::getParser("$push", boost::none);
auto accumulatorArg = BSON(""
<< "$largeStr");
auto accExpr = parser(expCtx.get(), accumulatorArg.firstElement(), expCtx->variablesParseState);
AccumulationStatement pushStatement{"spaceHog", accExpr};
auto groupByExpression =
ExpressionFieldPath::parse(expCtx.get(), "$_id", expCtx->variablesParseState);
auto group = DocumentSourceGroup::create(
expCtx, groupByExpression, {pushStatement}, maxMemoryUsageBytes);
string largeStr(maxMemoryUsageBytes, 'x');
auto mock =
DocumentSourceMock::createForTest({Document{{"_id", 0}, {"largeStr", largeStr}},
DocumentSource::GetNextResult::makePauseExecution(),
Document{{"_id", 1}, {"largeStr", largeStr}},
DocumentSource::GetNextResult::makePauseExecution(),
Document{{"_id", 2}, {"largeStr", largeStr}}},
expCtx);
group->setSource(mock.get());
// There were 2 pauses, so we should expect 2 paused results before any results can be returned.
ASSERT_TRUE(group->getNext().isPaused());
ASSERT_TRUE(group->getNext().isPaused());
// Now we expect to get the results back, although in no particular order.
stdx::unordered_set<int> idSet;
for (auto result = group->getNext(); result.isAdvanced(); result = group->getNext()) {
idSet.insert(result.releaseDocument()["_id"].coerceToInt());
}
ASSERT_TRUE(group->getNext().isEOF());
ASSERT_EQ(idSet.size(), 3UL);
ASSERT_EQ(idSet.count(0), 1UL);
ASSERT_EQ(idSet.count(1), 1UL);
ASSERT_EQ(idSet.count(2), 1UL);
}
TEST_F(DocumentSourceGroupTest, ShouldErrorIfNotAllowedToSpillToDiskAndResultSetIsTooLarge) {
auto expCtx = getExpCtx();
const size_t maxMemoryUsageBytes = 1000;
expCtx->inMongos = true; // Disallow external sort.
// This is the only way to do this in a debug build.
auto&& parser = AccumulationStatement::getParser("$push", boost::none);
auto accumulatorArg = BSON(""
<< "$largeStr");
auto accExpr = parser(expCtx.get(), accumulatorArg.firstElement(), expCtx->variablesParseState);
AccumulationStatement pushStatement{"spaceHog", accExpr};
auto groupByExpression =
ExpressionFieldPath::parse(expCtx.get(), "$_id", expCtx->variablesParseState);
auto group = DocumentSourceGroup::create(
expCtx, groupByExpression, {pushStatement}, maxMemoryUsageBytes);
string largeStr(maxMemoryUsageBytes, 'x');
auto mock = DocumentSourceMock::createForTest({Document{{"_id", 0}, {"largeStr", largeStr}},
Document{{"_id", 1}, {"largeStr", largeStr}}},
expCtx);
group->setSource(mock.get());
ASSERT_THROWS_CODE(
group->getNext(), AssertionException, ErrorCodes::QueryExceededMemoryLimitNoDiskUseAllowed);
}
TEST_F(DocumentSourceGroupTest, ShouldCorrectlyTrackMemoryUsageBetweenPauses) {
auto expCtx = getExpCtx();
const size_t maxMemoryUsageBytes = 1000;
expCtx->inMongos = true; // Disallow external sort.
// This is the only way to do this in a debug build.
auto&& parser = AccumulationStatement::getParser("$push", boost::none);
auto accumulatorArg = BSON(""
<< "$largeStr");
auto accExpr = parser(expCtx.get(), accumulatorArg.firstElement(), expCtx->variablesParseState);
AccumulationStatement pushStatement{"spaceHog", accExpr};
auto groupByExpression =
ExpressionFieldPath::parse(expCtx.get(), "$_id", expCtx->variablesParseState);
auto group = DocumentSourceGroup::create(
expCtx, groupByExpression, {pushStatement}, maxMemoryUsageBytes);
string largeStr(maxMemoryUsageBytes / 2, 'x');
auto mock =
DocumentSourceMock::createForTest({Document{{"_id", 0}, {"largeStr", largeStr}},
DocumentSource::GetNextResult::makePauseExecution(),
Document{{"_id", 1}, {"largeStr", largeStr}},
Document{{"_id", 2}, {"largeStr", largeStr}}},
expCtx);
group->setSource(mock.get());
// The first getNext() should pause.
ASSERT_TRUE(group->getNext().isPaused());
// The next should realize it's used too much memory.
ASSERT_THROWS_CODE(
group->getNext(), AssertionException, ErrorCodes::QueryExceededMemoryLimitNoDiskUseAllowed);
}
TEST_F(DocumentSourceGroupTest, ShouldReportSingleFieldGroupKeyAsARename) {
auto expCtx = getExpCtx();
VariablesParseState vps = expCtx->variablesParseState;
auto groupByExpression = ExpressionFieldPath::parse(expCtx.get(), "$x", vps);
auto group = DocumentSourceGroup::create(expCtx, groupByExpression, {});
auto modifiedPathsRet = group->getModifiedPaths();
ASSERT(modifiedPathsRet.type == DocumentSource::GetModPathsReturn::Type::kAllExcept);
ASSERT_EQ(modifiedPathsRet.paths.size(), 0UL);
ASSERT_EQ(modifiedPathsRet.renames.size(), 1UL);
ASSERT_EQ(modifiedPathsRet.renames["_id"], "x");
}
TEST_F(DocumentSourceGroupTest, ShouldReportMultipleFieldGroupKeysAsARename) {
auto expCtx = getExpCtx();
VariablesParseState vps = expCtx->variablesParseState;
auto x = ExpressionFieldPath::parse(expCtx.get(), "$x", vps);
auto y = ExpressionFieldPath::parse(expCtx.get(), "$y", vps);
auto groupByExpression = ExpressionObject::create(expCtx.get(), {{"x", x}, {"y", y}});
auto group = DocumentSourceGroup::create(expCtx, groupByExpression, {});
auto modifiedPathsRet = group->getModifiedPaths();
ASSERT(modifiedPathsRet.type == DocumentSource::GetModPathsReturn::Type::kAllExcept);
ASSERT_EQ(modifiedPathsRet.paths.size(), 0UL);
ASSERT_EQ(modifiedPathsRet.renames.size(), 2UL);
ASSERT_EQ(modifiedPathsRet.renames["_id.x"], "x");
ASSERT_EQ(modifiedPathsRet.renames["_id.y"], "y");
}
TEST_F(DocumentSourceGroupTest, ShouldNotReportDottedGroupKeyAsARename) {
auto expCtx = getExpCtx();
VariablesParseState vps = expCtx->variablesParseState;
auto xDotY = ExpressionFieldPath::parse(expCtx.get(), "$x.y", vps);
auto group = DocumentSourceGroup::create(expCtx, xDotY, {});
auto modifiedPathsRet = group->getModifiedPaths();
ASSERT(modifiedPathsRet.type == DocumentSource::GetModPathsReturn::Type::kAllExcept);
ASSERT_EQ(modifiedPathsRet.paths.size(), 0UL);
ASSERT_EQ(modifiedPathsRet.renames.size(), 0UL);
}
BSONObj toBson(const intrusive_ptr<DocumentSource>& source) {
vector<Value> arr;
source->serializeToArray(arr);
ASSERT_EQUALS(arr.size(), 1UL);
return arr[0].getDocument().toBson();
}
class Base : public ServiceContextTest {
public:
Base()
: _opCtx(makeOperationContext()),
_ctx(new ExpressionContextForTest(_opCtx.get(),
AggregateCommand(NamespaceString(ns), {}))),
_tempDir("DocumentSourceGroupTest") {}
protected:
void createGroup(const BSONObj& spec, bool inShard = false, bool inMongos = false) {
BSONObj namedSpec = BSON("$group" << spec);
BSONElement specElement = namedSpec.firstElement();
intrusive_ptr<ExpressionContextForTest> expressionContext =
new ExpressionContextForTest(_opCtx.get(), AggregateCommand(NamespaceString(ns), {}));
// For $group, 'inShard' implies 'fromMongos' and 'needsMerge'.
expressionContext->fromMongos = expressionContext->needsMerge = inShard;
expressionContext->inMongos = inMongos;
// Won't spill to disk properly if it needs to.
expressionContext->tempDir = _tempDir.path();
_group = DocumentSourceGroup::createFromBson(specElement, expressionContext);
assertRoundTrips(_group, expressionContext);
}
DocumentSourceGroup* group() {
return static_cast<DocumentSourceGroup*>(_group.get());
}
/** Assert that iterator state accessors consistently report the source is exhausted. */
void assertEOF(const intrusive_ptr<DocumentSource>& source) const {
// It should be safe to check doneness multiple times
ASSERT(source->getNext().isEOF());
ASSERT(source->getNext().isEOF());
ASSERT(source->getNext().isEOF());
}
intrusive_ptr<ExpressionContextForTest> ctx() const {
return _ctx;
}
private:
/** Check that the group's spec round trips. */
void assertRoundTrips(const intrusive_ptr<DocumentSource>& group,
const boost::intrusive_ptr<ExpressionContext>& expCtx) {
// We don't check against the spec that generated 'group' originally, because
// $const operators may be introduced in the first serialization.
BSONObj spec = toBson(group);
BSONElement specElement = spec.firstElement();
intrusive_ptr<DocumentSource> generated =
DocumentSourceGroup::createFromBson(specElement, expCtx);
ASSERT_BSONOBJ_EQ(spec, toBson(generated));
}
std::unique_ptr<QueryTestServiceContext> _queryServiceContext;
ServiceContext::UniqueOperationContext _opCtx;
intrusive_ptr<ExpressionContextForTest> _ctx;
intrusive_ptr<DocumentSource> _group;
TempDir _tempDir;
};
class ParseErrorBase : public Base {
public:
virtual ~ParseErrorBase() {}
void _doTest() final {
ASSERT_THROWS(createGroup(spec()), AssertionException);
}
protected:
virtual BSONObj spec() = 0;
};
class ExpressionBase : public Base {
public:
virtual ~ExpressionBase() {}
void _doTest() final {
createGroup(spec());
auto source = DocumentSourceMock::createForTest(Document(doc()), ctx());
group()->setSource(source.get());
// A group result is available.
auto next = group()->getNext();
ASSERT(next.isAdvanced());
// The constant _id value from the $group spec is passed through.
ASSERT_BSONOBJ_EQ(expected(), next.getDocument().toBson());
}
protected:
virtual BSONObj doc() = 0;
virtual BSONObj spec() = 0;
virtual BSONObj expected() = 0;
};
class IdConstantBase : public ExpressionBase {
virtual BSONObj doc() {
return BSONObj();
}
virtual BSONObj expected() {
// Since spec() specifies a constant _id, its value will be passed through.
return spec();
}
};
/** $group spec is not an object. */
class NonObject : public Base {
public:
void _doTest() final {
BSONObj spec = BSON("$group"
<< "foo");
BSONElement specElement = spec.firstElement();
ASSERT_THROWS(DocumentSourceGroup::createFromBson(specElement, ctx()), AssertionException);
}
};
/** $group spec is an empty object. */
class EmptySpec : public ParseErrorBase {
BSONObj spec() {
return BSONObj();
}
};
/** $group _id is an empty object. */
class IdEmptyObject : public IdConstantBase {
BSONObj spec() {
return BSON("_id" << BSONObj());
}
};
/** $group _id is computed from an object expression. */
class IdObjectExpression : public ExpressionBase {
BSONObj doc() {
return BSON("a" << 6);
}
BSONObj spec() {
return BSON("_id" << BSON("z"
<< "$a"));
}
BSONObj expected() {
return BSON("_id" << BSON("z" << 6));
}
};
/** $group _id is specified as an invalid object expression. */
class IdInvalidObjectExpression : public ParseErrorBase {
BSONObj spec() {
return BSON("_id" << BSON("$add" << 1 << "$and" << 1));
}
};
/** $group with two _id specs. */
class TwoIdSpecs : public ParseErrorBase {
BSONObj spec() {
return BSON("_id" << 1 << "_id" << 2);
}
};
/** $group _id is the empty string. */
class IdEmptyString : public IdConstantBase {
BSONObj spec() {
return BSON("_id"
<< "");
}
};
/** $group _id is a string constant. */
class IdStringConstant : public IdConstantBase {
BSONObj spec() {
return BSON("_id"
<< "abc");
}
};
/** $group _id is a field path expression. */
class IdFieldPath : public ExpressionBase {
BSONObj doc() {
return BSON("a" << 5);
}
BSONObj spec() {
return BSON("_id"
<< "$a");
}
BSONObj expected() {
return BSON("_id" << 5);
}
};
/** $group with _id set to an invalid field path. */
class IdInvalidFieldPath : public ParseErrorBase {
BSONObj spec() {
return BSON("_id"
<< "$a..");
}
};
/** $group _id is a numeric constant. */
class IdNumericConstant : public IdConstantBase {
BSONObj spec() {
return BSON("_id" << 2);
}
};
/** $group _id is an array constant. */
class IdArrayConstant : public IdConstantBase {
BSONObj spec() {
return BSON("_id" << BSON_ARRAY(1 << 2));
}
};
/** $group _id is a regular expression (not supported). */
class IdRegularExpression : public IdConstantBase {
BSONObj spec() {
return fromjson("{_id:/a/}");
}
};
/** The name of an aggregate field is specified with a $ prefix. */
class DollarAggregateFieldName : public ParseErrorBase {
BSONObj spec() {
return BSON("_id" << 1 << "$foo" << BSON("$sum" << 1));
}
};
/** An aggregate field spec that is not an object. */
class NonObjectAggregateSpec : public ParseErrorBase {
BSONObj spec() {
return BSON("_id" << 1 << "a" << 1);
}
};
/** An aggregate field spec that is not an object. */
class EmptyObjectAggregateSpec : public ParseErrorBase {
BSONObj spec() {
return BSON("_id" << 1 << "a" << BSONObj());
}
};
/** An aggregate field spec with an invalid accumulator operator. */
class BadAccumulator : public ParseErrorBase {
BSONObj spec() {
return BSON("_id" << 1 << "a" << BSON("$bad" << 1));
}
};
/** An aggregate field spec with an array argument. */
class SumArray : public ParseErrorBase {
BSONObj spec() {
return BSON("_id" << 1 << "a" << BSON("$sum" << BSONArray()));
}
};
/** Multiple accumulator operators for a field. */
class MultipleAccumulatorsForAField : public ParseErrorBase {
BSONObj spec() {
return BSON("_id" << 1 << "a" << BSON("$sum" << 1 << "$push" << 1));
}
};
/** Aggregation using duplicate field names is allowed currently. */
class DuplicateAggregateFieldNames : public ExpressionBase {
BSONObj doc() {
return BSONObj();
}
BSONObj spec() {
return BSON("_id" << 0 << "z" << BSON("$sum" << 1) << "z" << BSON("$push" << 1));
}
BSONObj expected() {
return BSON("_id" << 0 << "z" << 1 << "z" << BSON_ARRAY(1));
}
};
/** Aggregate the value of an object expression. */
class AggregateObjectExpression : public ExpressionBase {
BSONObj doc() {
return BSON("a" << 6);
}
BSONObj spec() {
return BSON("_id" << 0 << "z"
<< BSON("$first" << BSON("x"
<< "$a")));
}
BSONObj expected() {
return BSON("_id" << 0 << "z" << BSON("x" << 6));
}
};
/** Aggregate the value of an operator expression. */
class AggregateOperatorExpression : public ExpressionBase {
BSONObj doc() {
return BSON("a" << 6);
}
BSONObj spec() {
return BSON("_id" << 0 << "z"
<< BSON("$first"
<< "$a"));
}
BSONObj expected() {
return BSON("_id" << 0 << "z" << 6);
}
};
struct ValueCmp {
bool operator()(const Value& a, const Value& b) const {
return ValueComparator().evaluate(a < b);
}
};
typedef map<Value, Document, ValueCmp> IdMap;
class CheckResultsBase : public Base {
public:
virtual ~CheckResultsBase() {}
void _doTest() {
runSharded(false);
runSharded(true);
}
void runSharded(bool sharded) {
createGroup(groupSpec());
auto source = DocumentSourceMock::createForTest(inputData(), ctx());
group()->setSource(source.get());
intrusive_ptr<DocumentSource> sink = group();
if (sharded) {
sink = createMerger();
// Serialize and re-parse the shard stage.
createGroup(toBson(group())["$group"].Obj(), true);
group()->setSource(source.get());
sink->setSource(group());
}
checkResultSet(sink);
}
protected:
virtual deque<DocumentSource::GetNextResult> inputData() {
return {};
}
virtual BSONObj groupSpec() {
return BSON("_id" << 0);
}
/** Expected results. Must be sorted by _id to ensure consistent ordering. */
virtual BSONObj expectedResultSet() {
BSONObj wrappedResult =
// fromjson cannot parse an array, so place the array within an object.
fromjson(string("{'':") + expectedResultSetString() + "}");
return wrappedResult[""].embeddedObject().getOwned();
}
/** Expected results. Must be sorted by _id to ensure consistent ordering. */
virtual string expectedResultSetString() {
return "[]";
}
intrusive_ptr<DocumentSource> createMerger() {
// Set up a group merger to simulate merging results in the router. In this
// case only one shard is in use.
auto distributedPlanLogic = group()->distributedPlanLogic();
ASSERT(distributedPlanLogic);
ASSERT(distributedPlanLogic->mergingStage);
ASSERT_NOT_EQUALS(group(), distributedPlanLogic->mergingStage);
ASSERT_FALSE(static_cast<bool>(distributedPlanLogic->inputSortPattern));
return distributedPlanLogic->mergingStage;
}
void checkResultSet(const intrusive_ptr<DocumentSource>& sink) {
// Load the results from the DocumentSourceGroup and sort them by _id.
IdMap resultSet;
for (auto output = sink->getNext(); output.isAdvanced(); output = sink->getNext()) {
// Save the current result.
Value id = output.getDocument().getField("_id");
resultSet[id] = output.releaseDocument();
}
// Verify the DocumentSourceGroup is exhausted.
assertEOF(sink);
// Convert results to BSON once they all have been retrieved (to detect any errors
// resulting from incorrectly shared sub objects).
BSONArrayBuilder bsonResultSet;
for (IdMap::const_iterator i = resultSet.begin(); i != resultSet.end(); ++i) {
bsonResultSet << i->second;
}
// Check the result set.
ASSERT_BSONOBJ_EQ(expectedResultSet(), bsonResultSet.arr());
}
};
/** An empty collection generates no results. */
class EmptyCollection : public CheckResultsBase {};
/** A $group performed on a single document. */
class SingleDocument : public CheckResultsBase {
deque<DocumentSource::GetNextResult> inputData() {
return {DOC("a" << 1)};
}
virtual BSONObj groupSpec() {
return BSON("_id" << 0 << "a"
<< BSON("$sum"
<< "$a"));
}
virtual string expectedResultSetString() {
return "[{_id:0,a:1}]";
}
};
/** A $group performed on two values for a single key. */
class TwoValuesSingleKey : public CheckResultsBase {
deque<DocumentSource::GetNextResult> inputData() {
return {DOC("a" << 1), DOC("a" << 2)};
}
virtual BSONObj groupSpec() {
return BSON("_id" << 0 << "a"
<< BSON("$push"
<< "$a"));
}
virtual string expectedResultSetString() {
return "[{_id:0,a:[1,2]}]";
}
};
/** A $group performed on two values with one key each. */
class TwoValuesTwoKeys : public CheckResultsBase {
deque<DocumentSource::GetNextResult> inputData() {
return {DOC("_id" << 0 << "a" << 1), DOC("_id" << 1 << "a" << 2)};
}
virtual BSONObj groupSpec() {
return BSON("_id"
<< "$_id"
<< "a"
<< BSON("$push"
<< "$a"));
}
virtual string expectedResultSetString() {
return "[{_id:0,a:[1]},{_id:1,a:[2]}]";
}
};
/** A $group performed on two values with two keys each. */
class FourValuesTwoKeys : public CheckResultsBase {
deque<DocumentSource::GetNextResult> inputData() {
return {DOC("id" << 0 << "a" << 1),
DOC("id" << 1 << "a" << 2),
DOC("id" << 0 << "a" << 3),
DOC("id" << 1 << "a" << 4)};
}
virtual BSONObj groupSpec() {
return BSON("_id"
<< "$id"
<< "a"
<< BSON("$push"
<< "$a"));
}
virtual string expectedResultSetString() {
return "[{_id:0,a:[1,3]},{_id:1,a:[2,4]}]";
}
};
/** A $group performed on two values with two keys each and two accumulator operations. */
class FourValuesTwoKeysTwoAccumulators : public CheckResultsBase {
deque<DocumentSource::GetNextResult> inputData() {
return {DOC("id" << 0 << "a" << 1),
DOC("id" << 1 << "a" << 2),
DOC("id" << 0 << "a" << 3),
DOC("id" << 1 << "a" << 4)};
}
virtual BSONObj groupSpec() {
return BSON("_id"
<< "$id"
<< "list"
<< BSON("$push"
<< "$a")
<< "sum" << BSON("$sum" << BSON("$divide" << BSON_ARRAY("$a" << 2))));
}
virtual string expectedResultSetString() {
return "[{_id:0,list:[1,3],sum:2},{_id:1,list:[2,4],sum:3}]";
}
};
/** Null and undefined _id values are grouped together. */
class GroupNullUndefinedIds : public CheckResultsBase {
deque<DocumentSource::GetNextResult> inputData() {
return {DOC("a" << BSONNULL << "b" << 100), DOC("b" << 10)};
}
virtual BSONObj groupSpec() {
return BSON("_id"
<< "$a"
<< "sum"
<< BSON("$sum"
<< "$b"));
}
virtual string expectedResultSetString() {
return "[{_id:null,sum:110}]";
}
};
/** A complex _id expression. */
class ComplexId : public CheckResultsBase {
deque<DocumentSource::GetNextResult> inputData() {
return {DOC("a"
<< "de"_sd
<< "b"
<< "ad"_sd
<< "c"
<< "beef"_sd
<< "d"
<< ""_sd),
DOC("a"
<< "d"_sd
<< "b"
<< "eadbe"_sd
<< "c"
<< ""_sd
<< "d"
<< "ef"_sd)};
}
virtual BSONObj groupSpec() {
return BSON("_id" << BSON("$concat" << BSON_ARRAY("$a"
<< "$b"
<< "$c"
<< "$d")));
}
virtual string expectedResultSetString() {
return "[{_id:'deadbeef'}]";
}
};
/** An undefined accumulator value is dropped. */
class UndefinedAccumulatorValue : public CheckResultsBase {
deque<DocumentSource::GetNextResult> inputData() {
return {Document()};
}
virtual BSONObj groupSpec() {
return BSON("_id" << 0 << "first"
<< BSON("$first"
<< "$missing"));
}
virtual string expectedResultSetString() {
return "[{_id:0, first:null}]";
}
};
/** Simulate merging sharded results in the router. */
class RouterMerger : public CheckResultsBase {
public:
void _doTest() final {
auto source = DocumentSourceMock::createForTest({"{_id:0,list:[1,2]}",
"{_id:1,list:[3,4]}",
"{_id:0,list:[10,20]}",
"{_id:1,list:[30,40]}]}"},
ctx());
// Create a group source.
createGroup(BSON("_id"
<< "$x"
<< "list"
<< BSON("$push"
<< "$y")));
// Create a merger version of the source.
intrusive_ptr<DocumentSource> group = createMerger();
// Attach the merger to the synthetic shard results.
group->setSource(source.get());
// Check the merger's output.
checkResultSet(group);
}
private:
string expectedResultSetString() {
return "[{_id:0,list:[1,2,10,20]},{_id:1,list:[3,4,30,40]}]";
}
};
/** Dependant field paths. */
class Dependencies : public Base {
public:
void _doTest() final {
createGroup(fromjson("{_id:'$x',a:{$sum:'$y.z'},b:{$avg:{$add:['$u','$v']}}}"));
DepsTracker dependencies;
ASSERT_EQUALS(DepsTracker::State::EXHAUSTIVE_ALL, group()->getDependencies(&dependencies));
ASSERT_EQUALS(4U, dependencies.fields.size());
// Dependency from _id expression.
ASSERT_EQUALS(1U, dependencies.fields.count("x"));
// Dependencies from accumulator expressions.
ASSERT_EQUALS(1U, dependencies.fields.count("y.z"));
ASSERT_EQUALS(1U, dependencies.fields.count("u"));
ASSERT_EQUALS(1U, dependencies.fields.count("v"));
ASSERT_EQUALS(false, dependencies.needWholeDocument);
ASSERT_EQUALS(false, dependencies.getNeedsMetadata(DocumentMetadataFields::kTextScore));
}
};
/**
* A string constant (not a field path) as an _id expression and passed to an accumulator.
* SERVER-6766
*/
class StringConstantIdAndAccumulatorExpressions : public CheckResultsBase {
deque<DocumentSource::GetNextResult> inputData() {
return {Document()};
}
BSONObj groupSpec() {
return fromjson("{_id:{$const:'$_id...'},a:{$push:{$const:'$a...'}}}");
}
string expectedResultSetString() {
return "[{_id:'$_id...',a:['$a...']}]";
}
};
/** An array constant passed to an accumulator. */
class ArrayConstantAccumulatorExpression : public CheckResultsBase {
public:
void _doTest() final {
// A parse exception is thrown when a raw array is provided to an accumulator.
ASSERT_THROWS(createGroup(fromjson("{_id:1,a:{$push:[4,5,6]}}")), AssertionException);
// Run standard base tests.
CheckResultsBase::_doTest();
}
deque<DocumentSource::GetNextResult> inputData() {
return {Document()};
}
BSONObj groupSpec() {
// An array can be specified using $const.
return fromjson("{_id:[1,2,3],a:{$push:{$const:[4,5,6]}}}");
}
string expectedResultSetString() {
return "[{_id:[1,2,3],a:[[4,5,6]]}]";
}
};
class All : public OldStyleSuiteSpecification {
public:
All() : OldStyleSuiteSpecification("DocumentSourceGroupTests") {}
void setupTests() {
add<NonObject>();
add<EmptySpec>();
add<IdEmptyObject>();
add<IdObjectExpression>();
add<IdInvalidObjectExpression>();
add<TwoIdSpecs>();
add<IdEmptyString>();
add<IdStringConstant>();
add<IdFieldPath>();
add<IdInvalidFieldPath>();
add<IdNumericConstant>();
add<IdArrayConstant>();
add<IdRegularExpression>();
add<DollarAggregateFieldName>();
add<NonObjectAggregateSpec>();
add<EmptyObjectAggregateSpec>();
add<BadAccumulator>();
add<SumArray>();
add<MultipleAccumulatorsForAField>();
add<DuplicateAggregateFieldNames>();
add<AggregateObjectExpression>();
add<AggregateOperatorExpression>();
add<EmptyCollection>();
add<SingleDocument>();
add<TwoValuesSingleKey>();
add<TwoValuesTwoKeys>();
add<FourValuesTwoKeys>();
add<FourValuesTwoKeysTwoAccumulators>();
add<GroupNullUndefinedIds>();
add<ComplexId>();
add<UndefinedAccumulatorValue>();
add<RouterMerger>();
add<Dependencies>();
add<StringConstantIdAndAccumulatorExpressions>();
add<ArrayConstantAccumulatorExpression>();
#if 0
// Disabled tests until SERVER-23318 is implemented.
add<StreamingOptimization>();
add<StreamingWithMultipleIdFields>();
add<NoOptimizationIfMissingDoubleSort>();
add<NoOptimizationWithRawRoot>();
add<NoOptimizationIfUsingExpressions>();
add<StreamingWithMultipleLevels>();
add<StreamingWithConstant>();
add<StreamingWithEmptyId>();
add<StreamingWithRootSubfield>();
add<StreamingWithConstantAndFieldPath>();
add<StreamingWithFieldRepeated>();
#endif
}
};
OldStyleSuiteInitializer<All> myall;
} // namespace
} // namespace mongo
|